com.amazonaws.services.kendra.model

Class SalesforceKnowledgeArticleConfiguration

java.lang.Object

com.amazonaws.services.kendra.model.SalesforceKnowledgeArticleConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

Provides the configuration information for the knowledge article types that Amazon Kendra indexes. Amazon Kendra indexes standard knowledge articles and the standard fields of knowledge articles, or the custom fields of custom knowledge articles, but not both

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
SalesforceKnowledgeArticleConfiguration()

Method Summary

Modifier and Type	Method and Description
SalesforceKnowledgeArticleConfiguration	clone()
boolean	equals(Object obj)
List<SalesforceCustomKnowledgeArticleTypeConfiguration>	getCustomKnowledgeArticleTypeConfigurations() Configuration information for custom Salesforce knowledge articles.
List<String>	getIncludedStates() Specifies the document states that should be included when Amazon Kendra indexes knowledge articles.
SalesforceStandardKnowledgeArticleTypeConfiguration	getStandardKnowledgeArticleTypeConfiguration() Configuration information for standard Salesforce knowledge articles.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setCustomKnowledgeArticleTypeConfigurations(Collection<SalesforceCustomKnowledgeArticleTypeConfiguration> customKnowledgeArticleTypeConfigurations) Configuration information for custom Salesforce knowledge articles.
void	setIncludedStates(Collection<String> includedStates) Specifies the document states that should be included when Amazon Kendra indexes knowledge articles.
void	setStandardKnowledgeArticleTypeConfiguration(SalesforceStandardKnowledgeArticleTypeConfiguration standardKnowledgeArticleTypeConfiguration) Configuration information for standard Salesforce knowledge articles.
String	toString() Returns a string representation of this object.
SalesforceKnowledgeArticleConfiguration	withCustomKnowledgeArticleTypeConfigurations(Collection<SalesforceCustomKnowledgeArticleTypeConfiguration> customKnowledgeArticleTypeConfigurations) Configuration information for custom Salesforce knowledge articles.
SalesforceKnowledgeArticleConfiguration	withCustomKnowledgeArticleTypeConfigurations(SalesforceCustomKnowledgeArticleTypeConfiguration... customKnowledgeArticleTypeConfigurations) Configuration information for custom Salesforce knowledge articles.
SalesforceKnowledgeArticleConfiguration	withIncludedStates(Collection<String> includedStates) Specifies the document states that should be included when Amazon Kendra indexes knowledge articles.
SalesforceKnowledgeArticleConfiguration	withIncludedStates(SalesforceKnowledgeArticleState... includedStates) Specifies the document states that should be included when Amazon Kendra indexes knowledge articles.
SalesforceKnowledgeArticleConfiguration	withIncludedStates(String... includedStates) Specifies the document states that should be included when Amazon Kendra indexes knowledge articles.
SalesforceKnowledgeArticleConfiguration	withStandardKnowledgeArticleTypeConfiguration(SalesforceStandardKnowledgeArticleTypeConfiguration standardKnowledgeArticleTypeConfiguration) Configuration information for standard Salesforce knowledge articles.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SalesforceKnowledgeArticleConfiguration

public SalesforceKnowledgeArticleConfiguration()

Method Detail

getIncludedStates

public List<String> getIncludedStates()

Specifies the document states that should be included when Amazon Kendra indexes knowledge articles. You must specify at least one state.

Returns:

Specifies the document states that should be included when Amazon Kendra indexes knowledge articles. You must specify at least one state.

See Also:

SalesforceKnowledgeArticleState

setIncludedStates

public void setIncludedStates(Collection<String> includedStates)

Specifies the document states that should be included when Amazon Kendra indexes knowledge articles. You must specify at least one state.

Parameters:

includedStates - Specifies the document states that should be included when Amazon Kendra indexes knowledge articles. You must specify at least one state.

See Also:

SalesforceKnowledgeArticleState

withIncludedStates

public SalesforceKnowledgeArticleConfiguration withIncludedStates(String... includedStates)

Specifies the document states that should be included when Amazon Kendra indexes knowledge articles. You must specify at least one state.

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

Parameters:

includedStates - Specifies the document states that should be included when Amazon Kendra indexes knowledge articles. You must specify at least one state.

Returns:

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

See Also:

SalesforceKnowledgeArticleState

withIncludedStates

public SalesforceKnowledgeArticleConfiguration withIncludedStates(Collection<String> includedStates)

Specifies the document states that should be included when Amazon Kendra indexes knowledge articles. You must specify at least one state.

Parameters:

includedStates - Specifies the document states that should be included when Amazon Kendra indexes knowledge articles. You must specify at least one state.

Returns:

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

See Also:

SalesforceKnowledgeArticleState

withIncludedStates

public SalesforceKnowledgeArticleConfiguration withIncludedStates(SalesforceKnowledgeArticleState... includedStates)

Specifies the document states that should be included when Amazon Kendra indexes knowledge articles. You must specify at least one state.

Parameters:

includedStates - Specifies the document states that should be included when Amazon Kendra indexes knowledge articles. You must specify at least one state.

Returns:

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

See Also:

SalesforceKnowledgeArticleState

setStandardKnowledgeArticleTypeConfiguration

public void setStandardKnowledgeArticleTypeConfiguration(SalesforceStandardKnowledgeArticleTypeConfiguration standardKnowledgeArticleTypeConfiguration)

Configuration information for standard Salesforce knowledge articles.

Parameters:

standardKnowledgeArticleTypeConfiguration - Configuration information for standard Salesforce knowledge articles.

getStandardKnowledgeArticleTypeConfiguration

public SalesforceStandardKnowledgeArticleTypeConfiguration getStandardKnowledgeArticleTypeConfiguration()

Configuration information for standard Salesforce knowledge articles.

Returns:

Configuration information for standard Salesforce knowledge articles.

withStandardKnowledgeArticleTypeConfiguration

public SalesforceKnowledgeArticleConfiguration withStandardKnowledgeArticleTypeConfiguration(SalesforceStandardKnowledgeArticleTypeConfiguration standardKnowledgeArticleTypeConfiguration)

Configuration information for standard Salesforce knowledge articles.

Parameters:

standardKnowledgeArticleTypeConfiguration - Configuration information for standard Salesforce knowledge articles.

Returns:

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

getCustomKnowledgeArticleTypeConfigurations

public List<SalesforceCustomKnowledgeArticleTypeConfiguration> getCustomKnowledgeArticleTypeConfigurations()

Configuration information for custom Salesforce knowledge articles.

Returns:

Configuration information for custom Salesforce knowledge articles.

setCustomKnowledgeArticleTypeConfigurations

public void setCustomKnowledgeArticleTypeConfigurations(Collection<SalesforceCustomKnowledgeArticleTypeConfiguration> customKnowledgeArticleTypeConfigurations)

Configuration information for custom Salesforce knowledge articles.

Parameters:

customKnowledgeArticleTypeConfigurations - Configuration information for custom Salesforce knowledge articles.

withCustomKnowledgeArticleTypeConfigurations

public SalesforceKnowledgeArticleConfiguration withCustomKnowledgeArticleTypeConfigurations(SalesforceCustomKnowledgeArticleTypeConfiguration... customKnowledgeArticleTypeConfigurations)

Configuration information for custom Salesforce knowledge articles.

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

Parameters:

customKnowledgeArticleTypeConfigurations - Configuration information for custom Salesforce knowledge articles.

Returns:

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

withCustomKnowledgeArticleTypeConfigurations

public SalesforceKnowledgeArticleConfiguration withCustomKnowledgeArticleTypeConfigurations(Collection<SalesforceCustomKnowledgeArticleTypeConfiguration> customKnowledgeArticleTypeConfigurations)

Configuration information for custom Salesforce knowledge articles.

Parameters:

customKnowledgeArticleTypeConfigurations - Configuration information for custom Salesforce knowledge articles.

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