Class ConfluencePageToIndexFieldMapping
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final ConfluencePageFieldName
The name of the field in the data source.final String
The name of the field in the data source.final String
The format for date fields in the data source.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
The name of the index field to map to the Confluence data source field.static Class
<? extends ConfluencePageToIndexFieldMapping.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 returnConfluencePageFieldName.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:
-
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 returnConfluencePageFieldName.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:
-
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
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
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 interfaceToCopyableBuilder<ConfluencePageToIndexFieldMapping.Builder,
ConfluencePageToIndexFieldMapping> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-