Class ColumnConfiguration

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

Provides information about how Amazon Kendra should use the columns of a database in an index.

See Also:

  • Method Details

    • documentIdColumnName

      public final String documentIdColumnName()

      The column that provides the document's identifier.

      Returns:
      The column that provides the document's identifier.

    • documentDataColumnName

      public final String documentDataColumnName()

      The column that contains the contents of the document.

      Returns:
      The column that contains the contents of the document.

    • documentTitleColumnName

      public final String documentTitleColumnName()

      The column that contains the title of the document.

      Returns:
      The column that contains the title of the document.

    • hasFieldMappings

      public final boolean hasFieldMappings()
      For responses, this returns true if the service returned a value for the FieldMappings property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • fieldMappings

      public final List<DataSourceToIndexFieldMapping> fieldMappings()

      An array of objects that map database column names to the corresponding fields in an index. You must first create the fields in the index using the UpdateIndex API.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFieldMappings() method.

      Returns:
      An array of objects that map database column names to the corresponding fields in an index. You must first create the fields in the index using the UpdateIndex API.

    • hasChangeDetectingColumns

      public final boolean hasChangeDetectingColumns()
      For responses, this returns true if the service returned a value for the ChangeDetectingColumns property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • changeDetectingColumns

      public final List<String> changeDetectingColumns()

      One to five columns that indicate when a document in the database has changed.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasChangeDetectingColumns() method.

      Returns:
      One to five columns that indicate when a document in the database has changed.

    • toBuilder

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

    • builder

      public static ColumnConfiguration.Builder builder()

    • serializableBuilderClass

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