@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class SalesforceConfiguration extends Object implements Serializable, Cloneable, StructuredPojo
Provides the configuration information to connect to Salesforce as your data source.
Constructor and Description |
---|
SalesforceConfiguration() |
Modifier and Type | Method and Description |
---|---|
SalesforceConfiguration |
clone() |
boolean |
equals(Object obj) |
SalesforceChatterFeedConfiguration |
getChatterFeedConfiguration()
Configuration information for Salesforce chatter feeds.
|
Boolean |
getCrawlAttachments()
Indicates whether Amazon Kendra should index attachments to Salesforce objects.
|
List<String> |
getExcludeAttachmentFilePatterns()
A list of regular expression patterns to exclude certain documents in your Salesforce.
|
List<String> |
getIncludeAttachmentFilePatterns()
A list of regular expression patterns to include certain documents in your Salesforce.
|
SalesforceKnowledgeArticleConfiguration |
getKnowledgeArticleConfiguration()
Configuration information for the knowledge article types that Amazon Kendra indexes.
|
String |
getSecretArn()
The Amazon Resource Name (ARN) of an Secrets Managersecret that contains the key/value pairs required to connect
to your Salesforce instance.
|
String |
getServerUrl()
The instance URL for the Salesforce site that you want to index.
|
SalesforceStandardObjectAttachmentConfiguration |
getStandardObjectAttachmentConfiguration()
Configuration information for processing attachments to Salesforce standard objects.
|
List<SalesforceStandardObjectConfiguration> |
getStandardObjectConfigurations()
Configuration of the Salesforce standard objects that Amazon Kendra indexes.
|
int |
hashCode() |
Boolean |
isCrawlAttachments()
Indicates whether Amazon Kendra should index attachments to Salesforce objects.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setChatterFeedConfiguration(SalesforceChatterFeedConfiguration chatterFeedConfiguration)
Configuration information for Salesforce chatter feeds.
|
void |
setCrawlAttachments(Boolean crawlAttachments)
Indicates whether Amazon Kendra should index attachments to Salesforce objects.
|
void |
setExcludeAttachmentFilePatterns(Collection<String> excludeAttachmentFilePatterns)
A list of regular expression patterns to exclude certain documents in your Salesforce.
|
void |
setIncludeAttachmentFilePatterns(Collection<String> includeAttachmentFilePatterns)
A list of regular expression patterns to include certain documents in your Salesforce.
|
void |
setKnowledgeArticleConfiguration(SalesforceKnowledgeArticleConfiguration knowledgeArticleConfiguration)
Configuration information for the knowledge article types that Amazon Kendra indexes.
|
void |
setSecretArn(String secretArn)
The Amazon Resource Name (ARN) of an Secrets Managersecret that contains the key/value pairs required to connect
to your Salesforce instance.
|
void |
setServerUrl(String serverUrl)
The instance URL for the Salesforce site that you want to index.
|
void |
setStandardObjectAttachmentConfiguration(SalesforceStandardObjectAttachmentConfiguration standardObjectAttachmentConfiguration)
Configuration information for processing attachments to Salesforce standard objects.
|
void |
setStandardObjectConfigurations(Collection<SalesforceStandardObjectConfiguration> standardObjectConfigurations)
Configuration of the Salesforce standard objects that Amazon Kendra indexes.
|
String |
toString()
Returns a string representation of this object.
|
SalesforceConfiguration |
withChatterFeedConfiguration(SalesforceChatterFeedConfiguration chatterFeedConfiguration)
Configuration information for Salesforce chatter feeds.
|
SalesforceConfiguration |
withCrawlAttachments(Boolean crawlAttachments)
Indicates whether Amazon Kendra should index attachments to Salesforce objects.
|
SalesforceConfiguration |
withExcludeAttachmentFilePatterns(Collection<String> excludeAttachmentFilePatterns)
A list of regular expression patterns to exclude certain documents in your Salesforce.
|
SalesforceConfiguration |
withExcludeAttachmentFilePatterns(String... excludeAttachmentFilePatterns)
A list of regular expression patterns to exclude certain documents in your Salesforce.
|
SalesforceConfiguration |
withIncludeAttachmentFilePatterns(Collection<String> includeAttachmentFilePatterns)
A list of regular expression patterns to include certain documents in your Salesforce.
|
SalesforceConfiguration |
withIncludeAttachmentFilePatterns(String... includeAttachmentFilePatterns)
A list of regular expression patterns to include certain documents in your Salesforce.
|
SalesforceConfiguration |
withKnowledgeArticleConfiguration(SalesforceKnowledgeArticleConfiguration knowledgeArticleConfiguration)
Configuration information for the knowledge article types that Amazon Kendra indexes.
|
SalesforceConfiguration |
withSecretArn(String secretArn)
The Amazon Resource Name (ARN) of an Secrets Managersecret that contains the key/value pairs required to connect
to your Salesforce instance.
|
SalesforceConfiguration |
withServerUrl(String serverUrl)
The instance URL for the Salesforce site that you want to index.
|
SalesforceConfiguration |
withStandardObjectAttachmentConfiguration(SalesforceStandardObjectAttachmentConfiguration standardObjectAttachmentConfiguration)
Configuration information for processing attachments to Salesforce standard objects.
|
SalesforceConfiguration |
withStandardObjectConfigurations(Collection<SalesforceStandardObjectConfiguration> standardObjectConfigurations)
Configuration of the Salesforce standard objects that Amazon Kendra indexes.
|
SalesforceConfiguration |
withStandardObjectConfigurations(SalesforceStandardObjectConfiguration... standardObjectConfigurations)
Configuration of the Salesforce standard objects that Amazon Kendra indexes.
|
public void setServerUrl(String serverUrl)
The instance URL for the Salesforce site that you want to index.
serverUrl
- The instance URL for the Salesforce site that you want to index.public String getServerUrl()
The instance URL for the Salesforce site that you want to index.
public SalesforceConfiguration withServerUrl(String serverUrl)
The instance URL for the Salesforce site that you want to index.
serverUrl
- The instance URL for the Salesforce site that you want to index.public void setSecretArn(String secretArn)
The Amazon Resource Name (ARN) of an Secrets Managersecret that contains the key/value pairs required to connect to your Salesforce instance. The secret must contain a JSON structure with the following keys:
authenticationUrl - The OAUTH endpoint that Amazon Kendra connects to get an OAUTH token.
consumerKey - The application public key generated when you created your Salesforce application.
consumerSecret - The application private key generated when you created your Salesforce application.
password - The password associated with the user logging in to the Salesforce instance.
securityToken - The token associated with the user logging in to the Salesforce instance.
username - The user name of the user logging in to the Salesforce instance.
secretArn
- The Amazon Resource Name (ARN) of an Secrets Managersecret that contains the key/value pairs required to
connect to your Salesforce instance. The secret must contain a JSON structure with the following keys:
authenticationUrl - The OAUTH endpoint that Amazon Kendra connects to get an OAUTH token.
consumerKey - The application public key generated when you created your Salesforce application.
consumerSecret - The application private key generated when you created your Salesforce application.
password - The password associated with the user logging in to the Salesforce instance.
securityToken - The token associated with the user logging in to the Salesforce instance.
username - The user name of the user logging in to the Salesforce instance.
public String getSecretArn()
The Amazon Resource Name (ARN) of an Secrets Managersecret that contains the key/value pairs required to connect to your Salesforce instance. The secret must contain a JSON structure with the following keys:
authenticationUrl - The OAUTH endpoint that Amazon Kendra connects to get an OAUTH token.
consumerKey - The application public key generated when you created your Salesforce application.
consumerSecret - The application private key generated when you created your Salesforce application.
password - The password associated with the user logging in to the Salesforce instance.
securityToken - The token associated with the user logging in to the Salesforce instance.
username - The user name of the user logging in to the Salesforce instance.
authenticationUrl - The OAUTH endpoint that Amazon Kendra connects to get an OAUTH token.
consumerKey - The application public key generated when you created your Salesforce application.
consumerSecret - The application private key generated when you created your Salesforce application.
password - The password associated with the user logging in to the Salesforce instance.
securityToken - The token associated with the user logging in to the Salesforce instance.
username - The user name of the user logging in to the Salesforce instance.
public SalesforceConfiguration withSecretArn(String secretArn)
The Amazon Resource Name (ARN) of an Secrets Managersecret that contains the key/value pairs required to connect to your Salesforce instance. The secret must contain a JSON structure with the following keys:
authenticationUrl - The OAUTH endpoint that Amazon Kendra connects to get an OAUTH token.
consumerKey - The application public key generated when you created your Salesforce application.
consumerSecret - The application private key generated when you created your Salesforce application.
password - The password associated with the user logging in to the Salesforce instance.
securityToken - The token associated with the user logging in to the Salesforce instance.
username - The user name of the user logging in to the Salesforce instance.
secretArn
- The Amazon Resource Name (ARN) of an Secrets Managersecret that contains the key/value pairs required to
connect to your Salesforce instance. The secret must contain a JSON structure with the following keys:
authenticationUrl - The OAUTH endpoint that Amazon Kendra connects to get an OAUTH token.
consumerKey - The application public key generated when you created your Salesforce application.
consumerSecret - The application private key generated when you created your Salesforce application.
password - The password associated with the user logging in to the Salesforce instance.
securityToken - The token associated with the user logging in to the Salesforce instance.
username - The user name of the user logging in to the Salesforce instance.
public List<SalesforceStandardObjectConfiguration> getStandardObjectConfigurations()
Configuration of the Salesforce standard objects that Amazon Kendra indexes.
public void setStandardObjectConfigurations(Collection<SalesforceStandardObjectConfiguration> standardObjectConfigurations)
Configuration of the Salesforce standard objects that Amazon Kendra indexes.
standardObjectConfigurations
- Configuration of the Salesforce standard objects that Amazon Kendra indexes.public SalesforceConfiguration withStandardObjectConfigurations(SalesforceStandardObjectConfiguration... standardObjectConfigurations)
Configuration of the Salesforce standard objects that Amazon Kendra indexes.
NOTE: This method appends the values to the existing list (if any). Use
setStandardObjectConfigurations(java.util.Collection)
or
withStandardObjectConfigurations(java.util.Collection)
if you want to override the existing values.
standardObjectConfigurations
- Configuration of the Salesforce standard objects that Amazon Kendra indexes.public SalesforceConfiguration withStandardObjectConfigurations(Collection<SalesforceStandardObjectConfiguration> standardObjectConfigurations)
Configuration of the Salesforce standard objects that Amazon Kendra indexes.
standardObjectConfigurations
- Configuration of the Salesforce standard objects that Amazon Kendra indexes.public void setKnowledgeArticleConfiguration(SalesforceKnowledgeArticleConfiguration knowledgeArticleConfiguration)
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.
knowledgeArticleConfiguration
- 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.public SalesforceKnowledgeArticleConfiguration getKnowledgeArticleConfiguration()
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.
public SalesforceConfiguration withKnowledgeArticleConfiguration(SalesforceKnowledgeArticleConfiguration knowledgeArticleConfiguration)
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.
knowledgeArticleConfiguration
- 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.public void setChatterFeedConfiguration(SalesforceChatterFeedConfiguration chatterFeedConfiguration)
Configuration information for Salesforce chatter feeds.
chatterFeedConfiguration
- Configuration information for Salesforce chatter feeds.public SalesforceChatterFeedConfiguration getChatterFeedConfiguration()
Configuration information for Salesforce chatter feeds.
public SalesforceConfiguration withChatterFeedConfiguration(SalesforceChatterFeedConfiguration chatterFeedConfiguration)
Configuration information for Salesforce chatter feeds.
chatterFeedConfiguration
- Configuration information for Salesforce chatter feeds.public void setCrawlAttachments(Boolean crawlAttachments)
Indicates whether Amazon Kendra should index attachments to Salesforce objects.
crawlAttachments
- Indicates whether Amazon Kendra should index attachments to Salesforce objects.public Boolean getCrawlAttachments()
Indicates whether Amazon Kendra should index attachments to Salesforce objects.
public SalesforceConfiguration withCrawlAttachments(Boolean crawlAttachments)
Indicates whether Amazon Kendra should index attachments to Salesforce objects.
crawlAttachments
- Indicates whether Amazon Kendra should index attachments to Salesforce objects.public Boolean isCrawlAttachments()
Indicates whether Amazon Kendra should index attachments to Salesforce objects.
public void setStandardObjectAttachmentConfiguration(SalesforceStandardObjectAttachmentConfiguration standardObjectAttachmentConfiguration)
Configuration information for processing attachments to Salesforce standard objects.
standardObjectAttachmentConfiguration
- Configuration information for processing attachments to Salesforce standard objects.public SalesforceStandardObjectAttachmentConfiguration getStandardObjectAttachmentConfiguration()
Configuration information for processing attachments to Salesforce standard objects.
public SalesforceConfiguration withStandardObjectAttachmentConfiguration(SalesforceStandardObjectAttachmentConfiguration standardObjectAttachmentConfiguration)
Configuration information for processing attachments to Salesforce standard objects.
standardObjectAttachmentConfiguration
- Configuration information for processing attachments to Salesforce standard objects.public List<String> getIncludeAttachmentFilePatterns()
A list of regular expression patterns to include certain documents in your Salesforce. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.
The pattern is applied to the name of the attached file.
The pattern is applied to the name of the attached file.
public void setIncludeAttachmentFilePatterns(Collection<String> includeAttachmentFilePatterns)
A list of regular expression patterns to include certain documents in your Salesforce. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.
The pattern is applied to the name of the attached file.
includeAttachmentFilePatterns
- A list of regular expression patterns to include certain documents in your Salesforce. Documents that
match the patterns are included in the index. Documents that don't match the patterns are excluded from
the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes
precedence and the document isn't included in the index.
The pattern is applied to the name of the attached file.
public SalesforceConfiguration withIncludeAttachmentFilePatterns(String... includeAttachmentFilePatterns)
A list of regular expression patterns to include certain documents in your Salesforce. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.
The pattern is applied to the name of the attached file.
NOTE: This method appends the values to the existing list (if any). Use
setIncludeAttachmentFilePatterns(java.util.Collection)
or
withIncludeAttachmentFilePatterns(java.util.Collection)
if you want to override the existing values.
includeAttachmentFilePatterns
- A list of regular expression patterns to include certain documents in your Salesforce. Documents that
match the patterns are included in the index. Documents that don't match the patterns are excluded from
the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes
precedence and the document isn't included in the index.
The pattern is applied to the name of the attached file.
public SalesforceConfiguration withIncludeAttachmentFilePatterns(Collection<String> includeAttachmentFilePatterns)
A list of regular expression patterns to include certain documents in your Salesforce. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.
The pattern is applied to the name of the attached file.
includeAttachmentFilePatterns
- A list of regular expression patterns to include certain documents in your Salesforce. Documents that
match the patterns are included in the index. Documents that don't match the patterns are excluded from
the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes
precedence and the document isn't included in the index.
The pattern is applied to the name of the attached file.
public List<String> getExcludeAttachmentFilePatterns()
A list of regular expression patterns to exclude certain documents in your Salesforce. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.
The pattern is applied to the name of the attached file.
The pattern is applied to the name of the attached file.
public void setExcludeAttachmentFilePatterns(Collection<String> excludeAttachmentFilePatterns)
A list of regular expression patterns to exclude certain documents in your Salesforce. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.
The pattern is applied to the name of the attached file.
excludeAttachmentFilePatterns
- A list of regular expression patterns to exclude certain documents in your Salesforce. Documents that
match the patterns are excluded from the index. Documents that don't match the patterns are included in
the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes
precedence and the document isn't included in the index.
The pattern is applied to the name of the attached file.
public SalesforceConfiguration withExcludeAttachmentFilePatterns(String... excludeAttachmentFilePatterns)
A list of regular expression patterns to exclude certain documents in your Salesforce. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.
The pattern is applied to the name of the attached file.
NOTE: This method appends the values to the existing list (if any). Use
setExcludeAttachmentFilePatterns(java.util.Collection)
or
withExcludeAttachmentFilePatterns(java.util.Collection)
if you want to override the existing values.
excludeAttachmentFilePatterns
- A list of regular expression patterns to exclude certain documents in your Salesforce. Documents that
match the patterns are excluded from the index. Documents that don't match the patterns are included in
the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes
precedence and the document isn't included in the index.
The pattern is applied to the name of the attached file.
public SalesforceConfiguration withExcludeAttachmentFilePatterns(Collection<String> excludeAttachmentFilePatterns)
A list of regular expression patterns to exclude certain documents in your Salesforce. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.
The pattern is applied to the name of the attached file.
excludeAttachmentFilePatterns
- A list of regular expression patterns to exclude certain documents in your Salesforce. Documents that
match the patterns are excluded from the index. Documents that don't match the patterns are included in
the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes
precedence and the document isn't included in the index.
The pattern is applied to the name of the attached file.
public String toString()
toString
in class Object
Object.toString()
public SalesforceConfiguration clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.