Class ConfluenceSpaceToIndexFieldMapping
- java.lang.Object
-
- software.amazon.awssdk.services.kendra.model.ConfluenceSpaceToIndexFieldMapping
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<ConfluenceSpaceToIndexFieldMapping.Builder,ConfluenceSpaceToIndexFieldMapping>
@Generated("software.amazon.awssdk:codegen") public final class ConfluenceSpaceToIndexFieldMapping extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ConfluenceSpaceToIndexFieldMapping.Builder,ConfluenceSpaceToIndexFieldMapping>
Maps attributes or field names of Confluence spaces to Amazon Kendra index field names. To create custom fields, use the
UpdateIndexAPI 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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceConfluenceSpaceToIndexFieldMapping.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ConfluenceSpaceToIndexFieldMapping.Builderbuilder()ConfluenceSpaceFieldNamedataSourceFieldName()The name of the field in the data source.StringdataSourceFieldNameAsString()The name of the field in the data source.StringdateFieldFormat()The format for date fields in the data source.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()StringindexFieldName()The name of the index field to map to the Confluence data source field.List<SdkField<?>>sdkFields()static Class<? extends ConfluenceSpaceToIndexFieldMapping.Builder>serializableBuilderClass()ConfluenceSpaceToIndexFieldMapping.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
dataSourceFieldName
public final ConfluenceSpaceFieldName 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,
dataSourceFieldNamewill returnConfluenceSpaceFieldName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromdataSourceFieldNameAsString().- Returns:
- The name of the field in the data source.
- See Also:
ConfluenceSpaceFieldName
-
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,
dataSourceFieldNamewill returnConfluenceSpaceFieldName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromdataSourceFieldNameAsString().- Returns:
- The name of the field in the data source.
- See Also:
ConfluenceSpaceFieldName
-
dateFieldFormat
public final String dateFieldFormat()
The format for date fields in the data source. If the field specified in
DataSourceFieldNameis 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
DataSourceFieldNameis 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 ConfluenceSpaceToIndexFieldMapping.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<ConfluenceSpaceToIndexFieldMapping.Builder,ConfluenceSpaceToIndexFieldMapping>
-
builder
public static ConfluenceSpaceToIndexFieldMapping.Builder builder()
-
serializableBuilderClass
public static Class<? extends ConfluenceSpaceToIndexFieldMapping.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-