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

Class ConfluenceAttachmentConfiguration

java.lang.Object

software.amazon.awssdk.services.kendra.model.ConfluenceAttachmentConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ConfluenceAttachmentConfiguration.Builder,ConfluenceAttachmentConfiguration>

@Generated("software.amazon.awssdk:codegen")
public final class ConfluenceAttachmentConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ConfluenceAttachmentConfiguration.Builder,ConfluenceAttachmentConfiguration>

Configuration of attachment settings for the Confluence data source. Attachment settings are optional, if you don't specify settings attachments, Amazon Kendra won't index them.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ConfluenceAttachmentConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
List<ConfluenceAttachmentToIndexFieldMapping>	attachmentFieldMappings()	Maps attributes or field names of Confluence attachments to Amazon Kendra index field names.
static ConfluenceAttachmentConfiguration.Builder	builder()
Boolean	crawlAttachments()	TRUE to index attachments of pages and blogs in Confluence.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAttachmentFieldMappings()	For responses, this returns true if the service returned a value for the AttachmentFieldMappings property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends ConfluenceAttachmentConfiguration.Builder>	serializableBuilderClass()
ConfluenceAttachmentConfiguration.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

crawlAttachments

public final Boolean crawlAttachments()

TRUE to index attachments of pages and blogs in Confluence.

Returns:

TRUE to index attachments of pages and blogs in Confluence.

hasAttachmentFieldMappings

public final boolean hasAttachmentFieldMappings()

For responses, this returns true if the service returned a value for the AttachmentFieldMappings 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.

attachmentFieldMappings

public final List<ConfluenceAttachmentToIndexFieldMapping> attachmentFieldMappings()

Maps attributes or field names of Confluence attachments 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.

If you specify the AttachentFieldMappings parameter, you must specify at least one field mapping.

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 hasAttachmentFieldMappings() method.

Returns:

Maps attributes or field names of Confluence attachments 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.

If you specify the AttachentFieldMappings parameter, you must specify at least one field mapping.

toBuilder

public ConfluenceAttachmentConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ConfluenceAttachmentConfiguration.Builder,ConfluenceAttachmentConfiguration>

builder

public static ConfluenceAttachmentConfiguration.Builder builder()

serializableBuilderClass

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