Package software.amazon.awssdk.services.kendra.model

Interface AttributeFilter.Builder

All Superinterfaces:

Buildable, CopyableBuilder<AttributeFilter.Builder,AttributeFilter>, SdkBuilder<AttributeFilter.Builder,AttributeFilter>, SdkPojo

Enclosing class:

AttributeFilter

public static interface AttributeFilter.Builder
extends SdkPojo, CopyableBuilder<AttributeFilter.Builder,AttributeFilter>

Method Summary

Modifier and Type	Method	Description
AttributeFilter.Builder	andAllFilters(Collection<AttributeFilter> andAllFilters)	Performs a logical AND operation on all filters that you specify.
AttributeFilter.Builder	andAllFilters(Consumer<AttributeFilter.Builder>... andAllFilters)	Performs a logical AND operation on all filters that you specify.
AttributeFilter.Builder	andAllFilters(AttributeFilter... andAllFilters)	Performs a logical AND operation on all filters that you specify.
default AttributeFilter.Builder	containsAll(Consumer<DocumentAttribute.Builder> containsAll)	Returns true when a document contains all of the specified document attributes/fields.
AttributeFilter.Builder	containsAll(DocumentAttribute containsAll)	Returns true when a document contains all of the specified document attributes/fields.
default AttributeFilter.Builder	containsAny(Consumer<DocumentAttribute.Builder> containsAny)	Returns true when a document contains any of the specified document attributes/fields.
AttributeFilter.Builder	containsAny(DocumentAttribute containsAny)	Returns true when a document contains any of the specified document attributes/fields.
default AttributeFilter.Builder	equalsTo(Consumer<DocumentAttribute.Builder> equalsTo)	Performs an equals operation on document attributes/fields and their values.
AttributeFilter.Builder	equalsTo(DocumentAttribute equalsTo)	Performs an equals operation on document attributes/fields and their values.
default AttributeFilter.Builder	greaterThan(Consumer<DocumentAttribute.Builder> greaterThan)	Performs a greater than operation on document attributes/fields and their values.
AttributeFilter.Builder	greaterThan(DocumentAttribute greaterThan)	Performs a greater than operation on document attributes/fields and their values.
default AttributeFilter.Builder	greaterThanOrEquals(Consumer<DocumentAttribute.Builder> greaterThanOrEquals)	Performs a greater or equals than operation on document attributes/fields and their values.
AttributeFilter.Builder	greaterThanOrEquals(DocumentAttribute greaterThanOrEquals)	Performs a greater or equals than operation on document attributes/fields and their values.
default AttributeFilter.Builder	lessThan(Consumer<DocumentAttribute.Builder> lessThan)	Performs a less than operation on document attributes/fields and their values.
AttributeFilter.Builder	lessThan(DocumentAttribute lessThan)	Performs a less than operation on document attributes/fields and their values.
default AttributeFilter.Builder	lessThanOrEquals(Consumer<DocumentAttribute.Builder> lessThanOrEquals)	Performs a less than or equals operation on document attributes/fields and their values.
AttributeFilter.Builder	lessThanOrEquals(DocumentAttribute lessThanOrEquals)	Performs a less than or equals operation on document attributes/fields and their values.
default AttributeFilter.Builder	notFilter(Consumer<AttributeFilter.Builder> notFilter)	Performs a logical NOT operation on all filters that you specify.
AttributeFilter.Builder	notFilter(AttributeFilter notFilter)	Performs a logical NOT operation on all filters that you specify.
AttributeFilter.Builder	orAllFilters(Collection<AttributeFilter> orAllFilters)	Performs a logical OR operation on all filters that you specify.
AttributeFilter.Builder	orAllFilters(Consumer<AttributeFilter.Builder>... orAllFilters)	Performs a logical OR operation on all filters that you specify.
AttributeFilter.Builder	orAllFilters(AttributeFilter... orAllFilters)	Performs a logical OR operation on all filters that you specify.

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Detail

andAllFilters

AttributeFilter.Builder andAllFilters(Collection<AttributeFilter> andAllFilters)

Performs a logical AND operation on all filters that you specify.

Parameters:

andAllFilters - Performs a logical AND operation on all filters that you specify.

Returns:

Returns a reference to this object so that method calls can be chained together.

andAllFilters

AttributeFilter.Builder andAllFilters(AttributeFilter... andAllFilters)

Performs a logical AND operation on all filters that you specify.

Parameters:

andAllFilters - Performs a logical AND operation on all filters that you specify.

Returns:

Returns a reference to this object so that method calls can be chained together.

andAllFilters

AttributeFilter.Builder andAllFilters(Consumer<AttributeFilter.Builder>... andAllFilters)

Performs a logical AND operation on all filters that you specify.

This is a convenience method that creates an instance of the AttributeFilter.Builder avoiding the need to create one manually via AttributeFilter.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #andAllFilters(List).

Parameters:

andAllFilters - a consumer that will call methods on AttributeFilter.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#andAllFilters(java.util.Collection)

orAllFilters

AttributeFilter.Builder orAllFilters(Collection<AttributeFilter> orAllFilters)

Performs a logical OR operation on all filters that you specify.

Parameters:

orAllFilters - Performs a logical OR operation on all filters that you specify.

Returns:

Returns a reference to this object so that method calls can be chained together.

orAllFilters

AttributeFilter.Builder orAllFilters(AttributeFilter... orAllFilters)

Performs a logical OR operation on all filters that you specify.

Parameters:

orAllFilters - Performs a logical OR operation on all filters that you specify.

Returns:

Returns a reference to this object so that method calls can be chained together.

orAllFilters

AttributeFilter.Builder orAllFilters(Consumer<AttributeFilter.Builder>... orAllFilters)

Performs a logical OR operation on all filters that you specify.

This is a convenience method that creates an instance of the AttributeFilter.Builder avoiding the need to create one manually via AttributeFilter.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #orAllFilters(List).

Parameters:

orAllFilters - a consumer that will call methods on AttributeFilter.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#orAllFilters(java.util.Collection)

notFilter

AttributeFilter.Builder notFilter(AttributeFilter notFilter)

Performs a logical NOT operation on all filters that you specify.

Parameters:

notFilter - Performs a logical NOT operation on all filters that you specify.

Returns:

Returns a reference to this object so that method calls can be chained together.

notFilter

default AttributeFilter.Builder notFilter(Consumer<AttributeFilter.Builder> notFilter)

Performs a logical NOT operation on all filters that you specify.

This is a convenience method that creates an instance of the AttributeFilter.Builder avoiding the need to create one manually via AttributeFilter.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to notFilter(AttributeFilter).

Parameters:

notFilter - a consumer that will call methods on AttributeFilter.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

notFilter(AttributeFilter)

equalsTo

AttributeFilter.Builder equalsTo(DocumentAttribute equalsTo)

Performs an equals operation on document attributes/fields and their values.

Parameters:

equalsTo - Performs an equals operation on document attributes/fields and their values.

Returns:

Returns a reference to this object so that method calls can be chained together.

equalsTo

default AttributeFilter.Builder equalsTo(Consumer<DocumentAttribute.Builder> equalsTo)

Performs an equals operation on document attributes/fields and their values.

This is a convenience method that creates an instance of the DocumentAttribute.Builder avoiding the need to create one manually via DocumentAttribute.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to equalsTo(DocumentAttribute).

Parameters:

equalsTo - a consumer that will call methods on DocumentAttribute.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

equalsTo(DocumentAttribute)

containsAll

AttributeFilter.Builder containsAll(DocumentAttribute containsAll)

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

Parameters:

containsAll - Returns true when a document contains all of the specified document attributes/fields. This filter is only applicable to StringListValue.

Returns:

Returns a reference to this object so that method calls can be chained together.

containsAll

default AttributeFilter.Builder containsAll(Consumer<DocumentAttribute.Builder> containsAll)

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

This is a convenience method that creates an instance of the DocumentAttribute.Builder avoiding the need to create one manually via DocumentAttribute.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to containsAll(DocumentAttribute).

Parameters:

containsAll - a consumer that will call methods on DocumentAttribute.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

containsAll(DocumentAttribute)

containsAny

AttributeFilter.Builder containsAny(DocumentAttribute containsAny)

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

Parameters:

containsAny - Returns true when a document contains any of the specified document attributes/fields. This filter is only applicable to StringListValue.

Returns:

Returns a reference to this object so that method calls can be chained together.

containsAny

default AttributeFilter.Builder containsAny(Consumer<DocumentAttribute.Builder> containsAny)

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

This is a convenience method that creates an instance of the DocumentAttribute.Builder avoiding the need to create one manually via DocumentAttribute.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to containsAny(DocumentAttribute).

Parameters:

containsAny - a consumer that will call methods on DocumentAttribute.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

containsAny(DocumentAttribute)

greaterThan

AttributeFilter.Builder greaterThan(DocumentAttribute greaterThan)

Performs a greater than operation on document attributes/fields and their values. Use with the document attribute type Date or Long.

Parameters:

greaterThan - Performs a greater than operation on document attributes/fields and their values. Use with the document attribute type Date or Long.

Returns:

Returns a reference to this object so that method calls can be chained together.

greaterThan

default AttributeFilter.Builder greaterThan(Consumer<DocumentAttribute.Builder> greaterThan)

Performs a greater than operation on document attributes/fields and their values. Use with the document attribute type Date or Long.

This is a convenience method that creates an instance of the DocumentAttribute.Builder avoiding the need to create one manually via DocumentAttribute.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to greaterThan(DocumentAttribute).

Parameters:

greaterThan - a consumer that will call methods on DocumentAttribute.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

greaterThan(DocumentAttribute)

greaterThanOrEquals

AttributeFilter.Builder greaterThanOrEquals(DocumentAttribute greaterThanOrEquals)

Performs a greater or equals than operation on document attributes/fields and their values. Use with the document attribute type Date or Long.

Parameters:

greaterThanOrEquals - Performs a greater or equals than operation on document attributes/fields and their values. Use with the document attribute type Date or Long.

Returns:

Returns a reference to this object so that method calls can be chained together.

greaterThanOrEquals

default AttributeFilter.Builder greaterThanOrEquals(Consumer<DocumentAttribute.Builder> greaterThanOrEquals)

Performs a greater or equals than operation on document attributes/fields and their values. Use with the document attribute type Date or Long.

This is a convenience method that creates an instance of the DocumentAttribute.Builder avoiding the need to create one manually via DocumentAttribute.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to greaterThanOrEquals(DocumentAttribute).

Parameters:

greaterThanOrEquals - a consumer that will call methods on DocumentAttribute.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

greaterThanOrEquals(DocumentAttribute)

lessThan

AttributeFilter.Builder lessThan(DocumentAttribute lessThan)

Performs a less than operation on document attributes/fields and their values. Use with the document attribute type Date or Long.

Parameters:

lessThan - Performs a less than operation on document attributes/fields and their values. Use with the document attribute type Date or Long.

Returns:

Returns a reference to this object so that method calls can be chained together.

lessThan

default AttributeFilter.Builder lessThan(Consumer<DocumentAttribute.Builder> lessThan)

Performs a less than operation on document attributes/fields and their values. Use with the document attribute type Date or Long.

This is a convenience method that creates an instance of the DocumentAttribute.Builder avoiding the need to create one manually via DocumentAttribute.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to lessThan(DocumentAttribute).

Parameters:

lessThan - a consumer that will call methods on DocumentAttribute.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

lessThan(DocumentAttribute)

lessThanOrEquals

AttributeFilter.Builder lessThanOrEquals(DocumentAttribute lessThanOrEquals)

Performs a less than or equals operation on document attributes/fields and their values. Use with the document attribute type Date or Long.

Parameters:

lessThanOrEquals - Performs a less than or equals operation on document attributes/fields and their values. Use with the document attribute type Date or Long.

Returns:

Returns a reference to this object so that method calls can be chained together.

lessThanOrEquals

default AttributeFilter.Builder lessThanOrEquals(Consumer<DocumentAttribute.Builder> lessThanOrEquals)

Performs a less than or equals operation on document attributes/fields and their values. Use with the document attribute type Date or Long.

This is a convenience method that creates an instance of the DocumentAttribute.Builder avoiding the need to create one manually via DocumentAttribute.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to lessThanOrEquals(DocumentAttribute).

Parameters:

lessThanOrEquals - a consumer that will call methods on DocumentAttribute.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

lessThanOrEquals(DocumentAttribute)