Package software.amazon.awssdk.services.bedrockagentruntime.model

Interface RetrievalFilter.Builder

All Superinterfaces:

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

Enclosing class:

RetrievalFilter

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

Method Summary

Modifier and Type	Method	Description
RetrievalFilter.Builder	andAll(Collection<RetrievalFilter> andAll)	Knowledge base data sources whose metadata attributes fulfill all the filter conditions inside this list are returned.
RetrievalFilter.Builder	andAll(Consumer<RetrievalFilter.Builder>... andAll)	Knowledge base data sources whose metadata attributes fulfill all the filter conditions inside this list are returned.
RetrievalFilter.Builder	andAll(RetrievalFilter... andAll)	Knowledge base data sources whose metadata attributes fulfill all the filter conditions inside this list are returned.
default RetrievalFilter.Builder	equalsValue(Consumer<FilterAttribute.Builder> equalsValue)	Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value matches the value in this object are returned.
RetrievalFilter.Builder	equalsValue(FilterAttribute equalsValue)	Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value matches the value in this object are returned.
default RetrievalFilter.Builder	greaterThan(Consumer<FilterAttribute.Builder> greaterThan)	Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is greater than the value in this object are returned.
RetrievalFilter.Builder	greaterThan(FilterAttribute greaterThan)	Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is greater than the value in this object are returned.
default RetrievalFilter.Builder	greaterThanOrEquals(Consumer<FilterAttribute.Builder> greaterThanOrEquals)	Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is greater than or equal to the value in this object are returned.
RetrievalFilter.Builder	greaterThanOrEquals(FilterAttribute greaterThanOrEquals)	Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is greater than or equal to the value in this object are returned.
default RetrievalFilter.Builder	in(Consumer<FilterAttribute.Builder> in)	Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is in the list specified in the value in this object are returned.
RetrievalFilter.Builder	in(FilterAttribute in)	Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is in the list specified in the value in this object are returned.
default RetrievalFilter.Builder	lessThan(Consumer<FilterAttribute.Builder> lessThan)	Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is less than the value in this object are returned.
RetrievalFilter.Builder	lessThan(FilterAttribute lessThan)	Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is less than the value in this object are returned.
default RetrievalFilter.Builder	lessThanOrEquals(Consumer<FilterAttribute.Builder> lessThanOrEquals)	Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is less than or equal to the value in this object are returned.
RetrievalFilter.Builder	lessThanOrEquals(FilterAttribute lessThanOrEquals)	Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is less than or equal to the value in this object are returned.
default RetrievalFilter.Builder	notEquals(Consumer<FilterAttribute.Builder> notEquals)	Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value doesn't match the value in this object are returned.
RetrievalFilter.Builder	notEquals(FilterAttribute notEquals)	Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value doesn't match the value in this object are returned.
default RetrievalFilter.Builder	notIn(Consumer<FilterAttribute.Builder> notIn)	Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value isn't in the list specified in the value in this object are returned.
RetrievalFilter.Builder	notIn(FilterAttribute notIn)	Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value isn't in the list specified in the value in this object are returned.
RetrievalFilter.Builder	orAll(Collection<RetrievalFilter> orAll)	Knowledge base data sources whose metadata attributes fulfill at least one of the filter conditions inside this list are returned.
RetrievalFilter.Builder	orAll(Consumer<RetrievalFilter.Builder>... orAll)	Knowledge base data sources whose metadata attributes fulfill at least one of the filter conditions inside this list are returned.
RetrievalFilter.Builder	orAll(RetrievalFilter... orAll)	Knowledge base data sources whose metadata attributes fulfill at least one of the filter conditions inside this list are returned.
default RetrievalFilter.Builder	startsWith(Consumer<FilterAttribute.Builder> startsWith)	Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value starts with the value in this object are returned.
RetrievalFilter.Builder	startsWith(FilterAttribute startsWith)	Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value starts with the value in this object are returned.

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

andAll

RetrievalFilter.Builder andAll(Collection<RetrievalFilter> andAll)

Knowledge base data sources whose metadata attributes fulfill all the filter conditions inside this list are returned.

Parameters:

andAll - Knowledge base data sources whose metadata attributes fulfill all the filter conditions inside this list are returned.

Returns:

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

andAll

RetrievalFilter.Builder andAll(RetrievalFilter... andAll)

Knowledge base data sources whose metadata attributes fulfill all the filter conditions inside this list are returned.

Parameters:

andAll - Knowledge base data sources whose metadata attributes fulfill all the filter conditions inside this list are returned.

Returns:

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

andAll

RetrievalFilter.Builder andAll(Consumer<RetrievalFilter.Builder>... andAll)

Knowledge base data sources whose metadata attributes fulfill all the filter conditions inside this list are returned.

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

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

Parameters:

andAll - a consumer that will call methods on RetrievalFilter.Builder

Returns:

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

See Also:

#andAll(java.util.Collection)

equalsValue

RetrievalFilter.Builder equalsValue(FilterAttribute equalsValue)

Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value matches the value in this object are returned.

Parameters:

equalsValue - Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value matches the value in this object are returned.

Returns:

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

equalsValue

default RetrievalFilter.Builder equalsValue(Consumer<FilterAttribute.Builder> equalsValue)

Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value matches the value in this object are returned.

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

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

Parameters:

equalsValue - a consumer that will call methods on FilterAttribute.Builder

Returns:

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

See Also:

equalsValue(FilterAttribute)

greaterThan

RetrievalFilter.Builder greaterThan(FilterAttribute greaterThan)

Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is greater than the value in this object are returned.

Parameters:

greaterThan - Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is greater than the value in this object are returned.

Returns:

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

greaterThan

default RetrievalFilter.Builder greaterThan(Consumer<FilterAttribute.Builder> greaterThan)

Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is greater than the value in this object are returned.

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

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

Parameters:

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

Returns:

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

See Also:

greaterThan(FilterAttribute)

greaterThanOrEquals

RetrievalFilter.Builder greaterThanOrEquals(FilterAttribute greaterThanOrEquals)

Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is greater than or equal to the value in this object are returned.

Parameters:

greaterThanOrEquals - Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is greater than or equal to the value in this object are returned.

Returns:

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

greaterThanOrEquals

default RetrievalFilter.Builder greaterThanOrEquals(Consumer<FilterAttribute.Builder> greaterThanOrEquals)

Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is greater than or equal to the value in this object are returned.

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

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

Parameters:

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

Returns:

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

See Also:

greaterThanOrEquals(FilterAttribute)

in

RetrievalFilter.Builder in(FilterAttribute in)

Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is in the list specified in the value in this object are returned.

Parameters:

in - Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is in the list specified in the value in this object are returned.

Returns:

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

in

default RetrievalFilter.Builder in(Consumer<FilterAttribute.Builder> in)

Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is in the list specified in the value in this object are returned.

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

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

Parameters:

in - a consumer that will call methods on FilterAttribute.Builder

Returns:

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

See Also:

in(FilterAttribute)

lessThan

RetrievalFilter.Builder lessThan(FilterAttribute lessThan)

Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is less than the value in this object are returned.

Parameters:

lessThan - Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is less than the value in this object are returned.

Returns:

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

lessThan

default RetrievalFilter.Builder lessThan(Consumer<FilterAttribute.Builder> lessThan)

Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is less than the value in this object are returned.

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

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

Parameters:

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

Returns:

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

See Also:

lessThan(FilterAttribute)

lessThanOrEquals

RetrievalFilter.Builder lessThanOrEquals(FilterAttribute lessThanOrEquals)

Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is less than or equal to the value in this object are returned.

Parameters:

lessThanOrEquals - Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is less than or equal to the value in this object are returned.

Returns:

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

lessThanOrEquals

default RetrievalFilter.Builder lessThanOrEquals(Consumer<FilterAttribute.Builder> lessThanOrEquals)

Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is less than or equal to the value in this object are returned.

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

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

Parameters:

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

Returns:

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

See Also:

lessThanOrEquals(FilterAttribute)

notEquals

RetrievalFilter.Builder notEquals(FilterAttribute notEquals)

Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value doesn't match the value in this object are returned.

Parameters:

notEquals - Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value doesn't match the value in this object are returned.

Returns:

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

notEquals

default RetrievalFilter.Builder notEquals(Consumer<FilterAttribute.Builder> notEquals)

Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value doesn't match the value in this object are returned.

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

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

Parameters:

notEquals - a consumer that will call methods on FilterAttribute.Builder

Returns:

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

See Also:

notEquals(FilterAttribute)

notIn

RetrievalFilter.Builder notIn(FilterAttribute notIn)

Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value isn't in the list specified in the value in this object are returned.

Parameters:

notIn - Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value isn't in the list specified in the value in this object are returned.

Returns:

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

notIn

default RetrievalFilter.Builder notIn(Consumer<FilterAttribute.Builder> notIn)

Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value isn't in the list specified in the value in this object are returned.

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

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

Parameters:

notIn - a consumer that will call methods on FilterAttribute.Builder

Returns:

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

See Also:

notIn(FilterAttribute)

orAll

RetrievalFilter.Builder orAll(Collection<RetrievalFilter> orAll)

Knowledge base data sources whose metadata attributes fulfill at least one of the filter conditions inside this list are returned.

Parameters:

orAll - Knowledge base data sources whose metadata attributes fulfill at least one of the filter conditions inside this list are returned.

Returns:

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

orAll

RetrievalFilter.Builder orAll(RetrievalFilter... orAll)

Knowledge base data sources whose metadata attributes fulfill at least one of the filter conditions inside this list are returned.

Parameters:

orAll - Knowledge base data sources whose metadata attributes fulfill at least one of the filter conditions inside this list are returned.

Returns:

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

orAll

RetrievalFilter.Builder orAll(Consumer<RetrievalFilter.Builder>... orAll)

Knowledge base data sources whose metadata attributes fulfill at least one of the filter conditions inside this list are returned.

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

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

Parameters:

orAll - a consumer that will call methods on RetrievalFilter.Builder

Returns:

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

See Also:

#orAll(java.util.Collection)

startsWith

RetrievalFilter.Builder startsWith(FilterAttribute startsWith)

Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value starts with the value in this object are returned. This filter is currently only supported for Amazon OpenSearch Serverless vector stores.

Parameters:

startsWith - Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value starts with the value in this object are returned. This filter is currently only supported for Amazon OpenSearch Serverless vector stores.

Returns:

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

startsWith

default RetrievalFilter.Builder startsWith(Consumer<FilterAttribute.Builder> startsWith)

Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value starts with the value in this object are returned. This filter is currently only supported for Amazon OpenSearch Serverless vector stores.

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

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

Parameters:

startsWith - a consumer that will call methods on FilterAttribute.Builder

Returns:

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

See Also:

startsWith(FilterAttribute)