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

Specifies 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() Defines how page metadata fields should be mapped to index fields.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setPageFieldMappings(Collection<ConfluencePageToIndexFieldMapping> pageFieldMappings) Defines how page metadata fields should be mapped to index fields.
String	toString() Returns a string representation of this object.
ConfluencePageConfiguration	withPageFieldMappings(Collection<ConfluencePageToIndexFieldMapping> pageFieldMappings) Defines how page metadata fields should be mapped to index fields.
ConfluencePageConfiguration	withPageFieldMappings(ConfluencePageToIndexFieldMapping... pageFieldMappings) Defines how page metadata fields should be mapped to index fields.

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

Defines how page metadata fields should be mapped to index fields. Before you can map a field, you must first create an index field with a matching type using the console or the UpdateIndex operation.

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

Returns:

Defines how page metadata fields should be mapped to index fields. Before you can map a field, you must first create an index field with a matching type using the console or the UpdateIndex operation.

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

setPageFieldMappings

public void setPageFieldMappings(Collection<ConfluencePageToIndexFieldMapping> pageFieldMappings)

Defines how page metadata fields should be mapped to index fields. Before you can map a field, you must first create an index field with a matching type using the console or the UpdateIndex operation.

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

Parameters:

pageFieldMappings - Defines how page metadata fields should be mapped to index fields. Before you can map a field, you must first create an index field with a matching type using the console or the UpdateIndex operation.

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

withPageFieldMappings

public ConfluencePageConfiguration withPageFieldMappings(ConfluencePageToIndexFieldMapping... pageFieldMappings)

Defines how page metadata fields should be mapped to index fields. Before you can map a field, you must first create an index field with a matching type using the console or the UpdateIndex operation.

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 - Defines how page metadata fields should be mapped to index fields. Before you can map a field, you must first create an index field with a matching type using the console or the UpdateIndex operation.

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)

Defines how page metadata fields should be mapped to index fields. Before you can map a field, you must first create an index field with a matching type using the console or the UpdateIndex operation.

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

Parameters:

pageFieldMappings - Defines how page metadata fields should be mapped to index fields. Before you can map a field, you must first create an index field with a matching type using the console or the UpdateIndex operation.

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.