Package software.amazon.awssdk.services.fsx.model

Class DataRepositoryTaskFilter

java.lang.Object

software.amazon.awssdk.services.fsx.model.DataRepositoryTaskFilter

All Implemented Interfaces:

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

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

(Optional) An array of filter objects you can use to filter the response of data repository tasks you will see in the the response. You can filter the tasks returned in the response by one or more file system IDs, task lifecycles, and by task type. A filter object consists of a filter Name, and one or more Values for the filter.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DataRepositoryTaskFilter.Builder

Method Summary

Modifier and Type	Method	Description
static DataRepositoryTaskFilter.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.
DataRepositoryTaskFilterName	name()	Name of the task property to use in filtering the tasks returned in the response.
String	nameAsString()	Name of the task property to use in filtering the tasks returned in the response.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends DataRepositoryTaskFilter.Builder>	serializableBuilderClass()
DataRepositoryTaskFilter.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
List<String>	values()	Use Values to include the specific file system IDs and task lifecycle states for the filters you are using.

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 DataRepositoryTaskFilterName name()

Name of the task property to use in filtering the tasks returned in the response.

• Use file-system-id to retrieve data repository tasks for specific file systems.

• Use task-lifecycle to retrieve data repository tasks with one or more specific lifecycle states, as follows: CANCELED, EXECUTING, FAILED, PENDING, and SUCCEEDED.

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

Returns:

Name of the task property to use in filtering the tasks returned in the response.

• Use file-system-id to retrieve data repository tasks for specific file systems.

• Use task-lifecycle to retrieve data repository tasks with one or more specific lifecycle states, as follows: CANCELED, EXECUTING, FAILED, PENDING, and SUCCEEDED.

See Also:

DataRepositoryTaskFilterName

nameAsString

public final String nameAsString()

Name of the task property to use in filtering the tasks returned in the response.

• Use file-system-id to retrieve data repository tasks for specific file systems.

• Use task-lifecycle to retrieve data repository tasks with one or more specific lifecycle states, as follows: CANCELED, EXECUTING, FAILED, PENDING, and SUCCEEDED.

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

Returns:

Name of the task property to use in filtering the tasks returned in the response.

• Use file-system-id to retrieve data repository tasks for specific file systems.

• Use task-lifecycle to retrieve data repository tasks with one or more specific lifecycle states, as follows: CANCELED, EXECUTING, FAILED, PENDING, and SUCCEEDED.

See Also:

DataRepositoryTaskFilterName

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

Use Values to include the specific file system IDs and task lifecycle states for the filters you are using.

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:

Use Values to include the specific file system IDs and task lifecycle states for the filters you are using.

toBuilder

public DataRepositoryTaskFilter.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DataRepositoryTaskFilter.Builder,DataRepositoryTaskFilter>

builder

public static DataRepositoryTaskFilter.Builder builder()

serializableBuilderClass

public static Class<? extends DataRepositoryTaskFilter.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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo