SalesforceCustomKnowledgeArticleTypeConfiguration (AWS Java SDK for AWSKendraFrontend 1.11.840 API)

java.lang.Object
- com.amazonaws.services.kendra.model.SalesforceCustomKnowledgeArticleTypeConfiguration

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

Provides configuration information for indexing Salesforce custom articles.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

SalesforceCustomKnowledgeArticleTypeConfiguration()

Constructors
Constructor and Description
`SalesforceCustomKnowledgeArticleTypeConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SalesforceCustomKnowledgeArticleTypeConfiguration`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getDocumentDataFieldName()` The name of the field in the custom knowledge article that contains the document data to index.
`String`	`getDocumentTitleFieldName()` The name of the field in the custom knowledge article that contains the document title.
`List<DataSourceToIndexFieldMapping>`	`getFieldMappings()` One or more objects that map fields in the custom knowledge article to fields in the Amazon Kendra index.
`String`	`getName()` The name of the configuration.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setDocumentDataFieldName(String documentDataFieldName)` The name of the field in the custom knowledge article that contains the document data to index.
`void`	`setDocumentTitleFieldName(String documentTitleFieldName)` The name of the field in the custom knowledge article that contains the document title.
`void`	`setFieldMappings(Collection<DataSourceToIndexFieldMapping> fieldMappings)` One or more objects that map fields in the custom knowledge article to fields in the Amazon Kendra index.
`void`	`setName(String name)` The name of the configuration.
`String`	`toString()` Returns a string representation of this object.
`SalesforceCustomKnowledgeArticleTypeConfiguration`	`withDocumentDataFieldName(String documentDataFieldName)` The name of the field in the custom knowledge article that contains the document data to index.
`SalesforceCustomKnowledgeArticleTypeConfiguration`	`withDocumentTitleFieldName(String documentTitleFieldName)` The name of the field in the custom knowledge article that contains the document title.
`SalesforceCustomKnowledgeArticleTypeConfiguration`	`withFieldMappings(Collection<DataSourceToIndexFieldMapping> fieldMappings)` One or more objects that map fields in the custom knowledge article to fields in the Amazon Kendra index.
`SalesforceCustomKnowledgeArticleTypeConfiguration`	`withFieldMappings(DataSourceToIndexFieldMapping... fieldMappings)` One or more objects that map fields in the custom knowledge article to fields in the Amazon Kendra index.
`SalesforceCustomKnowledgeArticleTypeConfiguration`	`withName(String name)` The name of the configuration.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SalesforceCustomKnowledgeArticleTypeConfiguration
```
public SalesforceCustomKnowledgeArticleTypeConfiguration()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The name of the configuration.
    
    Parameters:
    
    name - The name of the configuration.
  - getName
```
public String getName()
```
    The name of the configuration.
    
    Returns:
    
    The name of the configuration.
  - withName
```
public SalesforceCustomKnowledgeArticleTypeConfiguration withName(String name)
```
    The name of the configuration.
    
    Parameters:
    
    name - The name of the configuration.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDocumentDataFieldName
```
public void setDocumentDataFieldName(String documentDataFieldName)
```
    The name of the field in the custom knowledge article that contains the document data to index.
    
    Parameters:
    
    documentDataFieldName - The name of the field in the custom knowledge article that contains the document data to index.
  - getDocumentDataFieldName
```
public String getDocumentDataFieldName()
```
    The name of the field in the custom knowledge article that contains the document data to index.
    
    Returns:
    
    The name of the field in the custom knowledge article that contains the document data to index.
  - withDocumentDataFieldName
```
public SalesforceCustomKnowledgeArticleTypeConfiguration withDocumentDataFieldName(String documentDataFieldName)
```
    The name of the field in the custom knowledge article that contains the document data to index.
    
    Parameters:
    
    documentDataFieldName - The name of the field in the custom knowledge article 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 in the custom knowledge article that contains the document title.
    
    Parameters:
    
    documentTitleFieldName - The name of the field in the custom knowledge article that contains the document title.
  - getDocumentTitleFieldName
```
public String getDocumentTitleFieldName()
```
    The name of the field in the custom knowledge article that contains the document title.
    
    Returns:
    
    The name of the field in the custom knowledge article that contains the document title.
  - withDocumentTitleFieldName
```
public SalesforceCustomKnowledgeArticleTypeConfiguration withDocumentTitleFieldName(String documentTitleFieldName)
```
    The name of the field in the custom knowledge article that contains the document title.
    
    Parameters:
    
    documentTitleFieldName - The name of the field in the custom knowledge article 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()
```
    One or more objects that map fields in the custom knowledge article to fields in the Amazon Kendra index.
    
    Returns:
    
    One or more objects that map fields in the custom knowledge article to fields in the Amazon Kendra index.
  - setFieldMappings
```
public void setFieldMappings(Collection<DataSourceToIndexFieldMapping> fieldMappings)
```
    One or more objects that map fields in the custom knowledge article to fields in the Amazon Kendra index.
    
    Parameters:
    
    fieldMappings - One or more objects that map fields in the custom knowledge article to fields in the Amazon Kendra index.
  - withFieldMappings
```
public SalesforceCustomKnowledgeArticleTypeConfiguration withFieldMappings(DataSourceToIndexFieldMapping... fieldMappings)
```
    One or more objects that map fields in the custom knowledge article to fields in the Amazon Kendra index.
    
    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 - One or more objects that map fields in the custom knowledge article to fields in the Amazon Kendra index.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withFieldMappings
```
public SalesforceCustomKnowledgeArticleTypeConfiguration withFieldMappings(Collection<DataSourceToIndexFieldMapping> fieldMappings)
```
    One or more objects that map fields in the custom knowledge article to fields in the Amazon Kendra index.
    
    Parameters:
    
    fieldMappings - One or more objects that map fields in the custom knowledge article to fields in the Amazon Kendra index.
    
    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 SalesforceCustomKnowledgeArticleTypeConfiguration clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class SalesforceCustomKnowledgeArticleTypeConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SalesforceCustomKnowledgeArticleTypeConfiguration

Method Detail

setName

getName

withName

setDocumentDataFieldName

getDocumentDataFieldName

withDocumentDataFieldName

setDocumentTitleFieldName

getDocumentTitleFieldName

withDocumentTitleFieldName

getFieldMappings

setFieldMappings

withFieldMappings

withFieldMappings

toString

equals

hashCode

clone

marshall