Package software.amazon.awssdk.services.kendra.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ConfluencePageToIndexFieldMapping.Builder

Method Summary

Modifier and Type	Method	Description
static ConfluencePageToIndexFieldMapping.Builder	builder()
ConfluencePageFieldName	dataSourceFieldName()	The name of the field in the data source.
String	dataSourceFieldNameAsString()	The name of the field in the data source.
String	dateFieldFormat()	The format for date fields in the data source.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	indexFieldName()	The name of the index field to map to the Confluence data source field.
List<SdkField<?>>	sdkFields()
static Class<? extends ConfluencePageToIndexFieldMapping.Builder>	serializableBuilderClass()
ConfluencePageToIndexFieldMapping.Builder	toBuilder()
String	toString()	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 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:

ConfluencePageFieldName

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:

ConfluencePageFieldName

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()

Specified by:

toBuilder in interface ToCopyableBuilder<ConfluencePageToIndexFieldMapping.Builder,ConfluencePageToIndexFieldMapping>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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