com.amazonaws.services.datasync.model

Class TaskFilter

java.lang.Object

com.amazonaws.services.datasync.model.TaskFilter

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@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.

For more information, see filtering DataSync resources.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
TaskFilter()

Method Summary

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)
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.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TaskFilter

public TaskFilter()

Method Detail

setName

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.

Parameters:

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.

See Also:

TaskFilterName

getName

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.

Returns:

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.

See Also:

TaskFilterName

withName

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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

TaskFilterName

withName

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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

TaskFilterName

getValues

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.

Returns:

The values that you want to filter for. For example, you might want to display only tasks for a specific destination location.

setValues

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.

Parameters:

values - The values that you want to filter for. For example, you might want to display only tasks for a specific destination location.

withValues

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.

Parameters:

values - The values that you want to filter for. For example, you might want to display only tasks for a specific destination location.

Returns:

Returns a reference to this object so that method calls can be chained together.

withValues

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.

Parameters:

values - The values that you want to filter for. For example, you might want to display only tasks for a specific destination location.

Returns:

Returns a reference to this object so that method calls can be chained together.

setOperator

public void setOperator(String operator)

The operator that is used to compare filter values (for example, Equals or Contains).

Parameters:

operator - The operator that is used to compare filter values (for example, Equals or Contains).

See Also:

Operator

getOperator

public String getOperator()

The operator that is used to compare filter values (for example, Equals or Contains).

Returns:

The operator that is used to compare filter values (for example, Equals or Contains).

See Also:

Operator

withOperator

public TaskFilter withOperator(String operator)

The operator that is used to compare filter values (for example, Equals or Contains).

Parameters:

operator - The operator that is used to compare filter values (for example, Equals or Contains).

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Operator

withOperator

public TaskFilter withOperator(Operator operator)

The operator that is used to compare filter values (for example, Equals or Contains).

Parameters:

operator - The operator that is used to compare filter values (for example, Equals or Contains).

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Operator

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public TaskFilter clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo