Class ConfluencePageToIndexFieldMapping

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

Maps attributes or field names of Confluence pages to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Confluence fields. For more information, see Mapping data source fields. The Confluence data source field names must exist in your Confluence custom metadata.

See Also:

  • Method Details

    • dataSourceFieldName

      public final ConfluencePageFieldName dataSourceFieldName()

      The name of the field in the data source.

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

      Returns:
      The name of the field in the data source.
      See Also:

    • dataSourceFieldNameAsString

      public final String dataSourceFieldNameAsString()

      The name of the field in the data source.

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

      Returns:
      The name of the field in the data source.
      See Also:

    • dateFieldFormat

      public final String dateFieldFormat()

      The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field you must specify the date format. If the field is not a date field, an exception is thrown.

      Returns:
      The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field you must specify the date format. If the field is not a date field, an exception is thrown.

    • indexFieldName

      public final String indexFieldName()

      The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.

      Returns:
      The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.

    • toBuilder

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

    • builder

      public static ConfluencePageToIndexFieldMapping.Builder builder()

    • serializableBuilderClass

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