Class Filter
- java.lang.Object
-
- software.amazon.awssdk.services.omics.model.Filter
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<Filter.Builder,Filter>
@Generated("software.amazon.awssdk:codegen") public final class Filter extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Filter.Builder,Filter>
Use filters to return a subset of resources. You can define filters for specific parameters, such as the resource status.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceFilter.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static Filter.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasResourceArns()For responses, this returns true if the service returned a value for the ResourceArns property.booleanhasStatus()For responses, this returns true if the service returned a value for the Status property.booleanhasType()For responses, this returns true if the service returned a value for the Type property.List<String>resourceArns()Filter based on the Amazon Resource Number (ARN) of the resource.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends Filter.Builder>serializableBuilderClass()List<ShareStatus>status()Filter based on the resource status.List<String>statusAsStrings()Filter based on the resource status.Filter.BuildertoBuilder()StringtoString()Returns a string representation of this object.List<ShareResourceType>type()The type of resources to be filtered.List<String>typeAsStrings()The type of resources to be filtered.-
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
-
hasResourceArns
public final boolean hasResourceArns()
For responses, this returns true if the service returned a value for the ResourceArns property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
resourceArns
public final List<String> resourceArns()
Filter based on the Amazon Resource Number (ARN) of the resource. You can specify up to 10 values.
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
hasResourceArns()method.- Returns:
- Filter based on the Amazon Resource Number (ARN) of the resource. You can specify up to 10 values.
-
status
public final List<ShareStatus> status()
Filter based on the resource status. You can specify up to 10 values.
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
hasStatus()method.- Returns:
- Filter based on the resource status. You can specify up to 10 values.
-
hasStatus
public final boolean hasStatus()
For responses, this returns true if the service returned a value for the Status property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
statusAsStrings
public final List<String> statusAsStrings()
Filter based on the resource status. You can specify up to 10 values.
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
hasStatus()method.- Returns:
- Filter based on the resource status. You can specify up to 10 values.
-
type
public final List<ShareResourceType> type()
The type of resources to be filtered. You can specify one or more of the resource types.
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
hasType()method.- Returns:
- The type of resources to be filtered. You can specify one or more of the resource types.
-
hasType
public final boolean hasType()
For responses, this returns true if the service returned a value for the Type property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
typeAsStrings
public final List<String> typeAsStrings()
The type of resources to be filtered. You can specify one or more of the resource types.
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
hasType()method.- Returns:
- The type of resources to be filtered. You can specify one or more of the resource types.
-
toBuilder
public Filter.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<Filter.Builder,Filter>
-
builder
public static Filter.Builder builder()
-
serializableBuilderClass
public static Class<? extends Filter.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-