java.lang.Object
- software.amazon.awssdk.services.qbusiness.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>
```
Enables filtering of responses based on document attributes or metadata fields.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface AttributeFilter.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`List<AttributeFilter>`	`andAllFilters()`	Performs a logical `AND` operation on all supplied filters.
`static AttributeFilter.Builder`	`builder()`
`DocumentAttribute`	`containsAll()`	Returns `true` when a document contains all the specified document attributes or metadata fields.
`DocumentAttribute`	`containsAny()`	Returns `true` when a document contains any of the specified document attributes or metadata fields.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`DocumentAttribute`	`equalsTo()`	Performs an equals operation on two document attributes or metadata fields.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`DocumentAttribute`	`greaterThan()`	Performs a greater than operation on two document attributes or metadata fields.
`DocumentAttribute`	`greaterThanOrEquals()`	Performs a greater or equals than operation on two document attributes or metadata fields.
`boolean`	`hasAndAllFilters()`	For responses, this returns true if the service returned a value for the AndAllFilters property.
`int`	`hashCode()`
`boolean`	`hasOrAllFilters()`	For responses, this returns true if the service returned a value for the OrAllFilters property.
`DocumentAttribute`	`lessThan()`	Performs a less than operation on two document attributes or metadata fields.
`DocumentAttribute`	`lessThanOrEquals()`	Performs a less than or equals operation on two document attributes or metadata fields.
`AttributeFilter`	`notFilter()`	Performs a logical `NOT` operation on all supplied filters.
`List<AttributeFilter>`	`orAllFilters()`	Performs a logical `OR` operation on all supplied filters.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends AttributeFilter.Builder>`	`serializableBuilderClass()`
`AttributeFilter.Builder`	`toBuilder()`
`String`	`toString()`	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 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.
  - andAllFilters
```
public final List<AttributeFilter> andAllFilters()
```
    Performs a logical AND operation 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 AND operation on all supplied filters.
  - containsAll
```
public final DocumentAttribute containsAll()
```
    Returns true when a document contains all the specified document attributes or metadata fields.
    
    Returns:
    
    Returns true when a document contains all the specified document attributes or metadata fields.
  - containsAny
```
public final DocumentAttribute containsAny()
```
    Returns true when a document contains any of the specified document attributes or metadata fields.
    
    Returns:
    
    Returns true when a document contains any of the specified document attributes or metadata fields.
  - equalsTo
```
public final DocumentAttribute equalsTo()
```
    Performs an equals operation on two document attributes or metadata fields.
    
    Returns:
    
    Performs an equals operation on two document attributes or metadata fields.
  - greaterThan
```
public final DocumentAttribute greaterThan()
```
    Performs a greater than operation on two document attributes or metadata fields. Use with a document attribute of type Date or Long.
    
    Returns:
    
    Performs a greater than operation on two document attributes or metadata fields. Use with a document attribute of type Date or Long.
  - greaterThanOrEquals
```
public final DocumentAttribute greaterThanOrEquals()
```
    Performs a greater or equals than operation on two document attributes or metadata fields. Use with a document attribute of type Date or Long.
    
    Returns:
    
    Performs a greater or equals than operation on two document attributes or metadata fields. Use with a document attribute of type Date or Long.
  - lessThan
```
public final DocumentAttribute lessThan()
```
    Performs a less than operation on two document attributes or metadata fields. Use with a document attribute of type Date or Long.
    
    Returns:
    
    Performs a less than operation on two document attributes or metadata fields. Use with a document attribute of type Date or Long.
  - lessThanOrEquals
```
public final DocumentAttribute lessThanOrEquals()
```
    Performs a less than or equals operation on two document attributes or metadata fields. Use with a document attribute of type Date or Long.
    
    Returns:
    
    Performs a less than or equals operation on two document attributes or metadata fields. Use with a document attribute of type Date or Long.
  - notFilter
```
public final AttributeFilter notFilter()
```
    Performs a logical NOT operation on all supplied filters.
    
    Returns:
    
    Performs a logical NOT operation 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 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.
  - orAllFilters
```
public final List<AttributeFilter> orAllFilters()
```
    Performs a logical OR operation 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 OR operation on all supplied filters.
  - toBuilder
```
public AttributeFilter.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<AttributeFilter.Builder,AttributeFilter>
  - builder
```
public static AttributeFilter.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends AttributeFilter.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

Class AttributeFilter

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

hasAndAllFilters

andAllFilters

containsAll

containsAny

equalsTo

greaterThan

greaterThanOrEquals

lessThan

lessThanOrEquals

notFilter

hasOrAllFilters

orAllFilters

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields