com.amazonaws.services.kendra.model

Class ConfluencePageConfiguration

java.lang.Object

com.amazonaws.services.kendra.model.ConfluencePageConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

Configuration of the page settings for the Confluence data source.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ConfluencePageConfiguration()

Method Summary

Modifier and Type	Method and Description
ConfluencePageConfiguration	clone()
boolean	equals(Object obj)
List<ConfluencePageToIndexFieldMapping>	getPageFieldMappings() Maps attributes or field names of Confluence pages to Amazon Kendra index field names.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setPageFieldMappings(Collection<ConfluencePageToIndexFieldMapping> pageFieldMappings) Maps attributes or field names of Confluence pages to Amazon Kendra index field names.
String	toString() Returns a string representation of this object.
ConfluencePageConfiguration	withPageFieldMappings(Collection<ConfluencePageToIndexFieldMapping> pageFieldMappings) Maps attributes or field names of Confluence pages to Amazon Kendra index field names.
ConfluencePageConfiguration	withPageFieldMappings(ConfluencePageToIndexFieldMapping... pageFieldMappings) Maps attributes or field names of Confluence pages to Amazon Kendra index field names.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ConfluencePageConfiguration

public ConfluencePageConfiguration()

Method Detail

getPageFieldMappings

public List<ConfluencePageToIndexFieldMapping> getPageFieldMappings()

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.

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

Returns:

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.

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

setPageFieldMappings

public void setPageFieldMappings(Collection<ConfluencePageToIndexFieldMapping> pageFieldMappings)

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.

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

Parameters:

pageFieldMappings - 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.

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

withPageFieldMappings

public ConfluencePageConfiguration withPageFieldMappings(ConfluencePageToIndexFieldMapping... pageFieldMappings)

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.

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

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

Parameters:

pageFieldMappings - 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.

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

Returns:

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

withPageFieldMappings

public ConfluencePageConfiguration withPageFieldMappings(Collection<ConfluencePageToIndexFieldMapping> pageFieldMappings)

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.

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

Parameters:

pageFieldMappings - 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.

If you specify the PageFieldMappings 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 ConfluencePageConfiguration 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.