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

Class DocumentAttributeCondition

java.lang.Object
software.amazon.awssdk.services.kendra.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 Kendra. 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 Kendra cannot 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 Kendra then will map your newly created metadata field to your index field.

See Also:

  • Method Details

    • conditionDocumentAttributeKey

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

      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.

    • operator

      public final ConditionOperator operator()

      The condition operator.

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

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

      Returns:
      The condition operator.

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

      See Also:

    • operatorAsString

      public final String operatorAsString()

      The condition operator.

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

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

      Returns:
      The condition operator.

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

      See Also:

    • conditionOnValue

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

      Returns:
      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.

    • toBuilder

      public DocumentAttributeCondition.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<DocumentAttributeCondition.Builder,DocumentAttributeCondition>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.