Class S3ItemFilter
- java.lang.Object
-
- software.amazon.awssdk.services.backupsearch.model.S3ItemFilter
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<S3ItemFilter.Builder,S3ItemFilter>
@Generated("software.amazon.awssdk:codegen") public final class S3ItemFilter extends Object implements SdkPojo, Serializable, ToCopyableBuilder<S3ItemFilter.Builder,S3ItemFilter>
This contains arrays of objects, which may include ObjectKeys, Sizes, CreationTimes, VersionIds, and/or Etags.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceS3ItemFilter.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static S3ItemFilter.Builderbuilder()List<TimeCondition>creationTimes()You can include 1 to 10 values.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)List<StringCondition>eTags()You can include 1 to 10 values.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasCreationTimes()For responses, this returns true if the service returned a value for the CreationTimes property.booleanhasETags()For responses, this returns true if the service returned a value for the ETags property.inthashCode()booleanhasObjectKeys()For responses, this returns true if the service returned a value for the ObjectKeys property.booleanhasSizes()For responses, this returns true if the service returned a value for the Sizes property.booleanhasVersionIds()For responses, this returns true if the service returned a value for the VersionIds property.List<StringCondition>objectKeys()You can include 1 to 10 values.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends S3ItemFilter.Builder>serializableBuilderClass()List<LongCondition>sizes()You can include 1 to 10 values.S3ItemFilter.BuildertoBuilder()StringtoString()Returns a string representation of this object.List<StringCondition>versionIds()You can include 1 to 10 values.-
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
-
hasObjectKeys
public final boolean hasObjectKeys()
For responses, this returns true if the service returned a value for the ObjectKeys 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.
-
objectKeys
public final List<StringCondition> objectKeys()
You can include 1 to 10 values.
If one value is included, the results will return only items that match the value.
If more than one value is included, the results will return all items that match any of the 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
hasObjectKeys()method.- Returns:
- You can include 1 to 10 values.
If one value is included, the results will return only items that match the value.
If more than one value is included, the results will return all items that match any of the values.
-
hasSizes
public final boolean hasSizes()
For responses, this returns true if the service returned a value for the Sizes 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.
-
sizes
public final List<LongCondition> sizes()
You can include 1 to 10 values.
If one value is included, the results will return only items that match the value.
If more than one value is included, the results will return all items that match any of the 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
hasSizes()method.- Returns:
- You can include 1 to 10 values.
If one value is included, the results will return only items that match the value.
If more than one value is included, the results will return all items that match any of the values.
-
hasCreationTimes
public final boolean hasCreationTimes()
For responses, this returns true if the service returned a value for the CreationTimes 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.
-
creationTimes
public final List<TimeCondition> creationTimes()
You can include 1 to 10 values.
If one value is included, the results will return only items that match the value.
If more than one value is included, the results will return all items that match any of the 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
hasCreationTimes()method.- Returns:
- You can include 1 to 10 values.
If one value is included, the results will return only items that match the value.
If more than one value is included, the results will return all items that match any of the values.
-
hasVersionIds
public final boolean hasVersionIds()
For responses, this returns true if the service returned a value for the VersionIds 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.
-
versionIds
public final List<StringCondition> versionIds()
You can include 1 to 10 values.
If one value is included, the results will return only items that match the value.
If more than one value is included, the results will return all items that match any of the 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
hasVersionIds()method.- Returns:
- You can include 1 to 10 values.
If one value is included, the results will return only items that match the value.
If more than one value is included, the results will return all items that match any of the values.
-
hasETags
public final boolean hasETags()
For responses, this returns true if the service returned a value for the ETags 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.
-
eTags
public final List<StringCondition> eTags()
You can include 1 to 10 values.
If one value is included, the results will return only items that match the value.
If more than one value is included, the results will return all items that match any of the 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
hasETags()method.- Returns:
- You can include 1 to 10 values.
If one value is included, the results will return only items that match the value.
If more than one value is included, the results will return all items that match any of the values.
-
toBuilder
public S3ItemFilter.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<S3ItemFilter.Builder,S3ItemFilter>
-
builder
public static S3ItemFilter.Builder builder()
-
serializableBuilderClass
public static Class<? extends S3ItemFilter.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
-
-