software.amazon.awssdk.services.kendra.model

Interface DocumentAttributeCondition.Builder

All Superinterfaces:

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

Enclosing class:

DocumentAttributeCondition

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

Method Summary

Modifier and Type	Method and Description
DocumentAttributeCondition.Builder	conditionDocumentAttributeKey(String conditionDocumentAttributeKey) The identifier of the document attribute used for the condition.
default DocumentAttributeCondition.Builder	conditionOnValue(Consumer<DocumentAttributeValue.Builder> conditionOnValue) The value used by the operator.
DocumentAttributeCondition.Builder	conditionOnValue(DocumentAttributeValue conditionOnValue) The value used by the operator.
DocumentAttributeCondition.Builder	operator(ConditionOperator operator) The condition operator.
DocumentAttributeCondition.Builder	operator(String operator) The condition operator.

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

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

conditionDocumentAttributeKey

DocumentAttributeCondition.Builder conditionDocumentAttributeKey(String conditionDocumentAttributeKey)

The identifier of the document attribute used for the condition.

For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.

Amazon Kendra currently does not support _document_body as an attribute key used for the condition.

Parameters:

conditionDocumentAttributeKey - The identifier of the document attribute used for the condition.

For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.

Amazon Kendra currently does not support _document_body as an attribute key used for the condition.

Returns:

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

operator

DocumentAttributeCondition.Builder operator(String operator)

The condition operator.

For example, you can use 'Contains' to partially match a string.

Parameters:

operator - The condition operator.

For example, you can use 'Contains' to partially match a string.

Returns:

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

See Also:

ConditionOperator, ConditionOperator

operator

DocumentAttributeCondition.Builder operator(ConditionOperator operator)

The condition operator.

For example, you can use 'Contains' to partially match a string.

Parameters:

operator - The condition operator.

For example, you can use 'Contains' to partially match a string.

Returns:

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

See Also:

ConditionOperator, ConditionOperator

conditionOnValue

DocumentAttributeCondition.Builder conditionOnValue(DocumentAttributeValue conditionOnValue)

The value used by the operator.

For example, you can specify the value 'financial' for strings in the 'Source_URI' field that partially match or contain this value.

Parameters:

conditionOnValue - The value used by the operator.

For example, you can specify the value 'financial' for strings in the 'Source_URI' field that partially match or contain this value.

Returns:

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

conditionOnValue

default DocumentAttributeCondition.Builder conditionOnValue(Consumer<DocumentAttributeValue.Builder> conditionOnValue)

The value used by the operator.

For example, you can specify the value 'financial' for strings in the 'Source_URI' field that partially match or contain this value.

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

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

Parameters:

conditionOnValue - a consumer that will call methods on DocumentAttributeValue.Builder

Returns:

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

See Also:

conditionOnValue(DocumentAttributeValue)