com.amazonaws.services.kendra.model

Class SalesforceStandardKnowledgeArticleTypeConfiguration

java.lang.Object

com.amazonaws.services.kendra.model.SalesforceStandardKnowledgeArticleTypeConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

Provides the configuration information for standard Salesforce knowledge articles.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
SalesforceStandardKnowledgeArticleTypeConfiguration()

Method Summary

Modifier and Type	Method and Description
SalesforceStandardKnowledgeArticleTypeConfiguration	clone()
boolean	equals(Object obj)
String	getDocumentDataFieldName() The name of the field that contains the document data to index.
String	getDocumentTitleFieldName() The name of the field that contains the document title.
List<DataSourceToIndexFieldMapping>	getFieldMappings() Maps attributes or field names of the knowledge article to Amazon Kendra index field names.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setDocumentDataFieldName(String documentDataFieldName) The name of the field that contains the document data to index.
void	setDocumentTitleFieldName(String documentTitleFieldName) The name of the field that contains the document title.
void	setFieldMappings(Collection<DataSourceToIndexFieldMapping> fieldMappings) Maps attributes or field names of the knowledge article to Amazon Kendra index field names.
String	toString() Returns a string representation of this object.
SalesforceStandardKnowledgeArticleTypeConfiguration	withDocumentDataFieldName(String documentDataFieldName) The name of the field that contains the document data to index.
SalesforceStandardKnowledgeArticleTypeConfiguration	withDocumentTitleFieldName(String documentTitleFieldName) The name of the field that contains the document title.
SalesforceStandardKnowledgeArticleTypeConfiguration	withFieldMappings(Collection<DataSourceToIndexFieldMapping> fieldMappings) Maps attributes or field names of the knowledge article to Amazon Kendra index field names.
SalesforceStandardKnowledgeArticleTypeConfiguration	withFieldMappings(DataSourceToIndexFieldMapping... fieldMappings) Maps attributes or field names of the knowledge article to Amazon Kendra index field names.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SalesforceStandardKnowledgeArticleTypeConfiguration

public SalesforceStandardKnowledgeArticleTypeConfiguration()

Method Detail

setDocumentDataFieldName

public void setDocumentDataFieldName(String documentDataFieldName)

The name of the field that contains the document data to index.

Parameters:

documentDataFieldName - The name of the field that contains the document data to index.

getDocumentDataFieldName

public String getDocumentDataFieldName()

The name of the field that contains the document data to index.

Returns:

The name of the field that contains the document data to index.

withDocumentDataFieldName

public SalesforceStandardKnowledgeArticleTypeConfiguration withDocumentDataFieldName(String documentDataFieldName)

The name of the field that contains the document data to index.

Parameters:

documentDataFieldName - The name of the field that contains the document data to index.

Returns:

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

setDocumentTitleFieldName

public void setDocumentTitleFieldName(String documentTitleFieldName)

The name of the field that contains the document title.

Parameters:

documentTitleFieldName - The name of the field that contains the document title.

getDocumentTitleFieldName

public String getDocumentTitleFieldName()

The name of the field that contains the document title.

Returns:

The name of the field that contains the document title.

withDocumentTitleFieldName

public SalesforceStandardKnowledgeArticleTypeConfiguration withDocumentTitleFieldName(String documentTitleFieldName)

The name of the field that contains the document title.

Parameters:

documentTitleFieldName - The name of the field that contains the document title.

Returns:

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

getFieldMappings

public List<DataSourceToIndexFieldMapping> getFieldMappings()

Maps attributes or field names of the knowledge article to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Salesforce fields. For more information, see Mapping data source fields. The Salesforce data source field names must exist in your Salesforce custom metadata.

Returns:

Maps attributes or field names of the knowledge article to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Salesforce fields. For more information, see Mapping data source fields. The Salesforce data source field names must exist in your Salesforce custom metadata.

setFieldMappings

public void setFieldMappings(Collection<DataSourceToIndexFieldMapping> fieldMappings)

Maps attributes or field names of the knowledge article to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Salesforce fields. For more information, see Mapping data source fields. The Salesforce data source field names must exist in your Salesforce custom metadata.

Parameters:

fieldMappings - Maps attributes or field names of the knowledge article to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Salesforce fields. For more information, see Mapping data source fields. The Salesforce data source field names must exist in your Salesforce custom metadata.

withFieldMappings

public SalesforceStandardKnowledgeArticleTypeConfiguration withFieldMappings(DataSourceToIndexFieldMapping... fieldMappings)

Maps attributes or field names of the knowledge article to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Salesforce fields. For more information, see Mapping data source fields. The Salesforce data source field names must exist in your Salesforce custom metadata.

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

Parameters:

fieldMappings - Maps attributes or field names of the knowledge article to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Salesforce fields. For more information, see Mapping data source fields. The Salesforce data source field names must exist in your Salesforce custom metadata.

Returns:

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

withFieldMappings

public SalesforceStandardKnowledgeArticleTypeConfiguration withFieldMappings(Collection<DataSourceToIndexFieldMapping> fieldMappings)

Maps attributes or field names of the knowledge article to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Salesforce fields. For more information, see Mapping data source fields. The Salesforce data source field names must exist in your Salesforce custom metadata.

Parameters:

fieldMappings - Maps attributes or field names of the knowledge article to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Salesforce fields. For more information, see Mapping data source fields. The Salesforce data source field names must exist in your Salesforce custom metadata.

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