software.amazon.awssdk.services.kendra.model

Class AttributeFilter

java.lang.Object

software.amazon.awssdk.services.kendra.model.AttributeFilter

All Implemented Interfaces:

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

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

Provides filtering the query results based on document attributes.

When you use the AndAllFilters or OrAllFilters, filters you can use 2 layers under the first attribute filter. For example, you can use:

<AndAllFilters>

1. <OrAllFilters>

2. <EqualTo>

If you use more than 2 layers, you receive a ValidationException exception with the message " AttributeFilter cannot have a depth of more than 2."

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AttributeFilter.Builder

Method Summary

Modifier and Type	Method and 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 of the specified document attributes.
DocumentAttribute	containsAny() Returns true when a document contains any of the specified document attributes.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
DocumentAttribute	equalsTo() Performs an equals operation on two document attributes.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
DocumentAttribute	greaterThan() Performs a greater than operation on two document attributes.
DocumentAttribute	greaterThanOrEquals() Performs a greater or equals than operation on two document attributes.
boolean	hasAndAllFilters() Returns true if the AndAllFilters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
boolean	hasOrAllFilters() Returns true if the OrAllFilters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
DocumentAttribute	lessThan() Performs a less than operation on two document attributes.
DocumentAttribute	lessThanOrEquals() Performs a less than or equals operation on two document attributes.
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 boolean hasAndAllFilters()

Returns true if the AndAllFilters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

andAllFilters

public 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.

You can use hasAndAllFilters() to see if a value was sent in this field.

Returns:

Performs a logical AND operation on all supplied filters.

hasOrAllFilters

public boolean hasOrAllFilters()

Returns true if the OrAllFilters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

orAllFilters

public 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.

You can use hasOrAllFilters() to see if a value was sent in this field.

Returns:

Performs a logical OR operation on all supplied filters.

notFilter

public AttributeFilter notFilter()

Performs a logical NOT operation on all supplied filters.

Returns:

Performs a logical NOT operation on all supplied filters.

equalsTo

public DocumentAttribute equalsTo()

Performs an equals operation on two document attributes.

Returns:

Performs an equals operation on two document attributes.

containsAll

public DocumentAttribute containsAll()

Returns true when a document contains all of the specified document attributes. This filter is only applicable to StringListValue metadata.

Returns:

Returns true when a document contains all of the specified document attributes. This filter is only applicable to StringListValue metadata.

containsAny

public DocumentAttribute containsAny()

Returns true when a document contains any of the specified document attributes. This filter is only applicable to StringListValue metadata.

Returns:

Returns true when a document contains any of the specified document attributes. This filter is only applicable to StringListValue metadata.

greaterThan

public DocumentAttribute greaterThan()

Performs a greater than operation on two document attributes. Use with a document attribute of type Integer or Long.

Returns:

Performs a greater than operation on two document attributes. Use with a document attribute of type Integer or Long.

greaterThanOrEquals

public DocumentAttribute greaterThanOrEquals()

Performs a greater or equals than operation on two document attributes. Use with a document attribute of type Integer or Long.

Returns:

Performs a greater or equals than operation on two document attributes. Use with a document attribute of type Integer or Long.

lessThan

public DocumentAttribute lessThan()

Performs a less than operation on two document attributes. Use with a document attribute of type Integer or Long.

Returns:

Performs a less than operation on two document attributes. Use with a document attribute of type Integer or Long.

lessThanOrEquals

public DocumentAttribute lessThanOrEquals()

Performs a less than or equals operation on two document attributes. Use with a document attribute of type Integer or Long.

Returns:

Performs a less than or equals operation on two document attributes. Use with a document attribute of type Integer or Long.

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

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo