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

Class DocumentAttributeTarget

java.lang.Object
software.amazon.awssdk.services.kendra.model.DocumentAttributeTarget
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<DocumentAttributeTarget.Builder,DocumentAttributeTarget>
@Generated("software.amazon.awssdk:codegen") public final class DocumentAttributeTarget extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DocumentAttributeTarget.Builder,DocumentAttributeTarget>

The target document attribute or metadata field you want to alter when ingesting documents into Amazon Kendra.

For example, you can delete customer identification numbers associated with the documents, stored in the document metadata field called 'Customer_ID'. You set the target key as 'Customer_ID' and the deletion flag to TRUE. This removes all customer ID values in the field 'Customer_ID'. This would scrub personally identifiable information from each document's metadata.

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.

You can also use this with DocumentAttributeCondition.

See Also:

  • Method Details

    • targetDocumentAttributeKey

      public final String targetDocumentAttributeKey()

      The identifier of the target document attribute or metadata field.

      For example, 'Department' could be an identifier for the target attribute or metadata field that includes the department names associated with the documents.

      Returns:
      The identifier of the target document attribute or metadata field.

      For example, 'Department' could be an identifier for the target attribute or metadata field that includes the department names associated with the documents.

    • targetDocumentAttributeValueDeletion

      public final Boolean targetDocumentAttributeValueDeletion()

      TRUE to delete the existing target value for your specified target attribute key. You cannot create a target value and set this to TRUE. To create a target value ( TargetDocumentAttributeValue), set this to FALSE.

      Returns:
      TRUE to delete the existing target value for your specified target attribute key. You cannot create a target value and set this to TRUE. To create a target value ( TargetDocumentAttributeValue), set this to FALSE.

    • targetDocumentAttributeValue

      public final DocumentAttributeValue targetDocumentAttributeValue()

      The target value you want to create for the target attribute.

      For example, 'Finance' could be the target value for the target attribute key 'Department'.

      Returns:
      The target value you want to create for the target attribute.

      For example, 'Finance' could be the target value for the target attribute key 'Department'.

    • toBuilder

      public DocumentAttributeTarget.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<DocumentAttributeTarget.Builder,DocumentAttributeTarget>
      Returns:
      a builder for type T

    • builder

      public static DocumentAttributeTarget.Builder builder()

    • serializableBuilderClass

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