Package software.amazon.awssdk.services.qbusiness.model

Class DocumentAttributeCondition

java.lang.Object

software.amazon.awssdk.services.qbusiness.model.DocumentAttributeCondition

All Implemented Interfaces:

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

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

The condition used for the target document attribute or metadata field when ingesting documents into Amazon Q. You use this with DocumentAttributeTarget to apply the condition.

For example, you can create the 'Department' target field and have it prefill department names associated with the documents based on information in the 'Source_URI' field. Set the condition that if the 'Source_URI' field contains 'financial' in its URI value, then prefill the target field 'Department' with the target value 'Finance' for the document.

Amazon Q can't create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using DocumentAttributeTarget. Amazon Q then will map your newly created metadata field to your index field.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DocumentAttributeCondition.Builder

Method Summary

Modifier and Type	Method	Description
static DocumentAttributeCondition.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	key()	The identifier of the document attribute used for the condition.
DocumentEnrichmentConditionOperator	operator()	The identifier of the document attribute used for the condition.
String	operatorAsString()	The identifier of the document attribute used for the condition.
List<SdkField<?>>	sdkFields()
static Class<? extends DocumentAttributeCondition.Builder>	serializableBuilderClass()
DocumentAttributeCondition.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
DocumentAttributeValue	value()	Returns the value of the Value property for 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

key

public final String key()

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 Q currently doesn't support _document_body as an attribute key used for the condition.

Returns:

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 Q currently doesn't support _document_body as an attribute key used for the condition.

operator

public final DocumentEnrichmentConditionOperator operator()

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.

If the service returns an enum value that is not available in the current SDK version, operator will return DocumentEnrichmentConditionOperator.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from operatorAsString().

Returns:

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.

See Also:

DocumentEnrichmentConditionOperator

operatorAsString

public final String operatorAsString()

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.

If the service returns an enum value that is not available in the current SDK version, operator will return DocumentEnrichmentConditionOperator.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from operatorAsString().

Returns:

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.

See Also:

DocumentEnrichmentConditionOperator

value

public final DocumentAttributeValue value()

Returns the value of the Value property for this object.

Returns:

The value of the Value property for this object.

toBuilder

public DocumentAttributeCondition.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DocumentAttributeCondition.Builder,DocumentAttributeCondition>

builder

public static DocumentAttributeCondition.Builder builder()

serializableBuilderClass

public static Class<? extends DocumentAttributeCondition.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