com.amazonaws.services.kendra.model

Class ConfluenceAttachmentConfiguration

java.lang.Object

com.amazonaws.services.kendra.model.ConfluenceAttachmentConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ConfluenceAttachmentConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo

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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ConfluenceAttachmentConfiguration()

Method Summary

Modifier and Type	Method and Description
ConfluenceAttachmentConfiguration	clone()
boolean	equals(Object obj)
List<ConfluenceAttachmentToIndexFieldMapping>	getAttachmentFieldMappings() Maps attributes or field names of Confluence attachments to Amazon Kendra index field names.
Boolean	getCrawlAttachments() TRUE to index attachments of pages and blogs in Confluence.
int	hashCode()
Boolean	isCrawlAttachments() TRUE to index attachments of pages and blogs in Confluence.
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setAttachmentFieldMappings(Collection<ConfluenceAttachmentToIndexFieldMapping> attachmentFieldMappings) Maps attributes or field names of Confluence attachments to Amazon Kendra index field names.
void	setCrawlAttachments(Boolean crawlAttachments) TRUE to index attachments of pages and blogs in Confluence.
String	toString() Returns a string representation of this object.
ConfluenceAttachmentConfiguration	withAttachmentFieldMappings(Collection<ConfluenceAttachmentToIndexFieldMapping> attachmentFieldMappings) Maps attributes or field names of Confluence attachments to Amazon Kendra index field names.
ConfluenceAttachmentConfiguration	withAttachmentFieldMappings(ConfluenceAttachmentToIndexFieldMapping... attachmentFieldMappings) Maps attributes or field names of Confluence attachments to Amazon Kendra index field names.
ConfluenceAttachmentConfiguration	withCrawlAttachments(Boolean crawlAttachments) TRUE to index attachments of pages and blogs in Confluence.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ConfluenceAttachmentConfiguration

public ConfluenceAttachmentConfiguration()

Method Detail

setCrawlAttachments

public void setCrawlAttachments(Boolean crawlAttachments)

TRUE to index attachments of pages and blogs in Confluence.

Parameters:

crawlAttachments - TRUE to index attachments of pages and blogs in Confluence.

getCrawlAttachments

public Boolean getCrawlAttachments()

TRUE to index attachments of pages and blogs in Confluence.

Returns:

TRUE to index attachments of pages and blogs in Confluence.

withCrawlAttachments

public ConfluenceAttachmentConfiguration withCrawlAttachments(Boolean crawlAttachments)

TRUE to index attachments of pages and blogs in Confluence.

Parameters:

crawlAttachments - TRUE to index attachments of pages and blogs in Confluence.

Returns:

Returns a reference to this object so that method calls can be chained together.

isCrawlAttachments

public Boolean isCrawlAttachments()

TRUE to index attachments of pages and blogs in Confluence.

Returns:

TRUE to index attachments of pages and blogs in Confluence.

getAttachmentFieldMappings

public List<ConfluenceAttachmentToIndexFieldMapping> getAttachmentFieldMappings()

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.

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.

setAttachmentFieldMappings

public void setAttachmentFieldMappings(Collection<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.

Parameters:

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.

withAttachmentFieldMappings

public ConfluenceAttachmentConfiguration withAttachmentFieldMappings(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.

NOTE: This method appends the values to the existing list (if any). Use setAttachmentFieldMappings(java.util.Collection) or withAttachmentFieldMappings(java.util.Collection) if you want to override the existing values.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

withAttachmentFieldMappings

public ConfluenceAttachmentConfiguration withAttachmentFieldMappings(Collection<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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ConfluenceAttachmentConfiguration clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.