Class AttributeFilter
- java.lang.Object
-
- software.amazon.awssdk.services.qapps.model.AttributeFilter
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<AttributeFilter.Builder,AttributeFilter>
@Generated("software.amazon.awssdk:codegen") public final class AttributeFilter extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AttributeFilter.Builder,AttributeFilter>
The filter criteria used on responses based on document attributes or metadata fields.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceAttributeFilter.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description List<AttributeFilter>andAllFilters()Performs a logicalANDoperation on all supplied filters.static AttributeFilter.Builderbuilder()DocumentAttributecontainsAll()Returnstruewhen a document contains all the specified document attributes or metadata fields.DocumentAttributecontainsAny()Returnstruewhen a document contains any of the specified document attributes or metadata fields.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)DocumentAttributeequalsTo()Performs an equals operation on two document attributes or metadata fields.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)DocumentAttributegreaterThan()Performs a greater than operation on two document attributes or metadata fields.DocumentAttributegreaterThanOrEquals()Performs a greater than or equals operation on two document attributes or metadata fields.booleanhasAndAllFilters()For responses, this returns true if the service returned a value for the AndAllFilters property.inthashCode()booleanhasOrAllFilters()For responses, this returns true if the service returned a value for the OrAllFilters property.DocumentAttributelessThan()Performs a less than operation on two document attributes or metadata fields.DocumentAttributelessThanOrEquals()Performs a less than or equals operation on two document attributes or metadata fields.Supported for the following document attribute value type:dateValueandlongValue.AttributeFilternotFilter()Performs a logicalNOToperation on all supplied filters.List<AttributeFilter>orAllFilters()Performs a logicalORoperation on all supplied filters.List<SdkField<?>>sdkFields()static Class<? extends AttributeFilter.Builder>serializableBuilderClass()AttributeFilter.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
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
-
hasAndAllFilters
public final boolean hasAndAllFilters()
For responses, this returns true if the service returned a value for the AndAllFilters 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.
-
andAllFilters
public final List<AttributeFilter> andAllFilters()
Performs a logical
ANDoperation on all supplied filters.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
hasAndAllFilters()method.- Returns:
- Performs a logical
ANDoperation on all supplied filters.
-
hasOrAllFilters
public final boolean hasOrAllFilters()
For responses, this returns true if the service returned a value for the OrAllFilters 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.
-
orAllFilters
public final List<AttributeFilter> orAllFilters()
Performs a logical
ORoperation on all supplied filters.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
hasOrAllFilters()method.- Returns:
- Performs a logical
ORoperation on all supplied filters.
-
notFilter
public final AttributeFilter notFilter()
Performs a logical
NOToperation on all supplied filters.- Returns:
- Performs a logical
NOToperation on all supplied filters.
-
equalsTo
public final DocumentAttribute equalsTo()
Performs an equals operation on two document attributes or metadata fields. Supported for the following document attribute value types:
dateValue,longValue,stringListValueandstringValue.- Returns:
- Performs an equals operation on two document attributes or metadata fields. Supported for the
following document
attribute value types:
dateValue,longValue,stringListValueandstringValue.
-
containsAll
public final DocumentAttribute containsAll()
Returns
truewhen a document contains all the specified document attributes or metadata fields. Supported for the following document attribute value types:stringListValue.- Returns:
- Returns
truewhen a document contains all the specified document attributes or metadata fields. Supported for the following document attribute value types:stringListValue.
-
containsAny
public final DocumentAttribute containsAny()
Returns
truewhen a document contains any of the specified document attributes or metadata fields. Supported for the following document attribute value types:stringListValue.- Returns:
- Returns
truewhen a document contains any of the specified document attributes or metadata fields. Supported for the following document attribute value types:stringListValue.
-
greaterThan
public final DocumentAttribute greaterThan()
Performs a greater than operation on two document attributes or metadata fields. Supported for the following document attribute value types:
dateValueandlongValue.- Returns:
- Performs a greater than operation on two document attributes or metadata fields. Supported for the
following document
attribute value types:
dateValueandlongValue.
-
greaterThanOrEquals
public final DocumentAttribute greaterThanOrEquals()
Performs a greater than or equals operation on two document attributes or metadata fields. Supported for the following document attribute value types:
dateValueandlongValue.- Returns:
- Performs a greater than or equals operation on two document attributes or metadata fields.
Supported for the following document
attribute value types:
dateValueandlongValue.
-
lessThan
public final DocumentAttribute lessThan()
Performs a less than operation on two document attributes or metadata fields. Supported for the following document attribute value types:
dateValueandlongValue.- Returns:
- Performs a less than operation on two document attributes or metadata fields. Supported for the
following document
attribute value types:
dateValueandlongValue.
-
lessThanOrEquals
public final DocumentAttribute lessThanOrEquals()
Performs a less than or equals operation on two document attributes or metadata fields.Supported for the following document attribute value type:
dateValueandlongValue.- Returns:
- Performs a less than or equals operation on two document attributes or metadata fields.Supported
for the following document
attribute value type:
dateValueandlongValue.
-
toBuilder
public AttributeFilter.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<AttributeFilter.Builder,AttributeFilter>
-
builder
public static AttributeFilter.Builder builder()
-
serializableBuilderClass
public static Class<? extends AttributeFilter.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.
-
-