Package software.amazon.awssdk.services.datasync.model

Class TaskFilter

java.lang.Object

software.amazon.awssdk.services.datasync.model.TaskFilter

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<TaskFilter.Builder,TaskFilter>

@Generated("software.amazon.awssdk:codegen")
public final class TaskFilter
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<TaskFilter.Builder,TaskFilter>

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TaskFilter.Builder

Method Summary

Modifier and Type	Method	Description
static TaskFilter.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasValues()	For responses, this returns true if the service returned a value for the Values property.
TaskFilterName	name()	The name of the filter being used.
String	nameAsString()	The name of the filter being used.
Operator	operator()	The operator that is used to compare filter values (for example, Equals or Contains).
String	operatorAsString()	The operator that is used to compare filter values (for example, Equals or Contains).
List<SdkField<?>>	sdkFields()
static Class<? extends TaskFilter.Builder>	serializableBuilderClass()
TaskFilter.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
List<String>	values()	The values that you want to filter for.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

name

public final 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.

If the service returns an enum value that is not available in the current SDK version, name will return TaskFilterName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from nameAsString().

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

nameAsString

public final String nameAsString()

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.

If the service returns an enum value that is not available in the current SDK version, name will return TaskFilterName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from nameAsString().

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

hasValues

public final boolean hasValues()

For responses, this returns true if the service returned a value for the Values property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

values

public final List<String> values()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasValues() method.

Returns:

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

operator

public final Operator operator()

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

If the service returns an enum value that is not available in the current SDK version, operator will return Operator.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from operatorAsString().

Returns:

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

See Also:

Operator

operatorAsString

public final String operatorAsString()

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

If the service returns an enum value that is not available in the current SDK version, operator will return Operator.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from operatorAsString().

Returns:

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

See Also:

Operator

toBuilder

public TaskFilter.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<TaskFilter.Builder,TaskFilter>

builder

public static TaskFilter.Builder builder()

serializableBuilderClass

public static Class<? extends TaskFilter.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo