Class DocumentsMetadataConfiguration

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

Document metadata files that contain information such as the document access control information, source URI, document author, and custom attributes. Each metadata file contains metadata about a single document.

See Also:

  • Method Details

    • s3Prefix

      public final String s3Prefix()

      A prefix used to filter metadata configuration files in the Amazon Web Services S3 bucket. The S3 bucket might contain multiple metadata files. Use S3Prefix to include only the desired metadata files.

      Returns:
      A prefix used to filter metadata configuration files in the Amazon Web Services S3 bucket. The S3 bucket might contain multiple metadata files. Use S3Prefix to include only the desired metadata files.

    • toBuilder

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

    • builder

      public static DocumentsMetadataConfiguration.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.