@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class TaskFilter extends Object implements Serializable, Cloneable, StructuredPojo
You can use API filters to narrow down the list of resources returned by ListTasks
. For example, to
retrieve all tasks on a source location, you can use ListTasks
with filter name LocationId
and Operator Equals
with the ARN for the location.
Constructor and Description |
---|
TaskFilter() |
Modifier and Type | Method and Description |
---|---|
TaskFilter |
clone() |
boolean |
equals(Object obj) |
String |
getName()
The name of the filter being used.
|
String |
getOperator()
The operator that is used to compare filter values (for example,
Equals or Contains ). |
List<String> |
getValues()
The values that you want to filter for.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setName(String name)
The name of the filter being used.
|
void |
setOperator(String operator)
The operator that is used to compare filter values (for example,
Equals or Contains ). |
void |
setValues(Collection<String> values)
The values that you want to filter for.
|
String |
toString()
Returns a string representation of this object.
|
TaskFilter |
withName(String name)
The name of the filter being used.
|
TaskFilter |
withName(TaskFilterName name)
The name of the filter being used.
|
TaskFilter |
withOperator(Operator operator)
The operator that is used to compare filter values (for example,
Equals or Contains ). |
TaskFilter |
withOperator(String operator)
The operator that is used to compare filter values (for example,
Equals or Contains ). |
TaskFilter |
withValues(Collection<String> values)
The values that you want to filter for.
|
TaskFilter |
withValues(String... values)
The values that you want to filter for.
|
public void setName(String name)
The name of the filter being used. Each API call supports a list of filters that are available for it. For
example, LocationId
for ListTasks
.
name
- The name of the filter being used. Each API call supports a list of filters that are available for it. For
example, LocationId
for ListTasks
.TaskFilterName
public String getName()
The name of the filter being used. Each API call supports a list of filters that are available for it. For
example, LocationId
for ListTasks
.
LocationId
for ListTasks
.TaskFilterName
public TaskFilter withName(String name)
The name of the filter being used. Each API call supports a list of filters that are available for it. For
example, LocationId
for ListTasks
.
name
- The name of the filter being used. Each API call supports a list of filters that are available for it. For
example, LocationId
for ListTasks
.TaskFilterName
public TaskFilter withName(TaskFilterName name)
The name of the filter being used. Each API call supports a list of filters that are available for it. For
example, LocationId
for ListTasks
.
name
- The name of the filter being used. Each API call supports a list of filters that are available for it. For
example, LocationId
for ListTasks
.TaskFilterName
public List<String> getValues()
The values that you want to filter for. For example, you might want to display only tasks for a specific destination location.
public void setValues(Collection<String> values)
The values that you want to filter for. For example, you might want to display only tasks for a specific destination location.
values
- The values that you want to filter for. For example, you might want to display only tasks for a specific
destination location.public TaskFilter withValues(String... values)
The values that you want to filter for. For example, you might want to display only tasks for a specific destination location.
NOTE: This method appends the values to the existing list (if any). Use
setValues(java.util.Collection)
or withValues(java.util.Collection)
if you want to override the
existing values.
values
- The values that you want to filter for. For example, you might want to display only tasks for a specific
destination location.public TaskFilter withValues(Collection<String> values)
The values that you want to filter for. For example, you might want to display only tasks for a specific destination location.
values
- The values that you want to filter for. For example, you might want to display only tasks for a specific
destination location.public void setOperator(String operator)
The operator that is used to compare filter values (for example, Equals
or Contains
).
For more about API filtering operators, see query-resources.
operator
- The operator that is used to compare filter values (for example, Equals
or
Contains
). For more about API filtering operators, see query-resources.Operator
public String getOperator()
The operator that is used to compare filter values (for example, Equals
or Contains
).
For more about API filtering operators, see query-resources.
Equals
or
Contains
). For more about API filtering operators, see query-resources.Operator
public TaskFilter withOperator(String operator)
The operator that is used to compare filter values (for example, Equals
or Contains
).
For more about API filtering operators, see query-resources.
operator
- The operator that is used to compare filter values (for example, Equals
or
Contains
). For more about API filtering operators, see query-resources.Operator
public TaskFilter withOperator(Operator operator)
The operator that is used to compare filter values (for example, Equals
or Contains
).
For more about API filtering operators, see query-resources.
operator
- The operator that is used to compare filter values (for example, Equals
or
Contains
). For more about API filtering operators, see query-resources.Operator
public String toString()
toString
in class Object
Object.toString()
public TaskFilter clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.