/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.kendra.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *
* Provides the configuration information to connect to Salesforce as your data source. *
* * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class SalesforceConfiguration implements Serializable, Cloneable, StructuredPojo { /** ** The instance URL for the Salesforce site that you want to index. *
*/ private String serverUrl; /** ** 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. *
** Configuration of the Salesforce standard objects that Amazon Kendra indexes. *
*/ private java.util.List* 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. *
*/ private SalesforceKnowledgeArticleConfiguration knowledgeArticleConfiguration; /** ** Configuration information for Salesforce chatter feeds. *
*/ private SalesforceChatterFeedConfiguration chatterFeedConfiguration; /** ** Indicates whether Amazon Kendra should index attachments to Salesforce objects. *
*/ private Boolean crawlAttachments; /** ** Configuration information for processing attachments to Salesforce standard objects. *
*/ private SalesforceStandardObjectAttachmentConfiguration standardObjectAttachmentConfiguration; /** ** 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. *
*/ private java.util.List* 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. *
*/ private java.util.List* The instance URL for the Salesforce site that you want to index. *
* * @param serverUrl * The instance URL for the Salesforce site that you want to index. */ public void setServerUrl(String serverUrl) { this.serverUrl = serverUrl; } /** ** The instance URL for the Salesforce site that you want to index. *
* * @return The instance URL for the Salesforce site that you want to index. */ public String getServerUrl() { return this.serverUrl; } /** ** The instance URL for the Salesforce site that you want to index. *
* * @param serverUrl * The instance URL for the Salesforce site that you want to index. * @return Returns a reference to this object so that method calls can be chained together. */ public SalesforceConfiguration withServerUrl(String serverUrl) { setServerUrl(serverUrl); return this; } /** ** 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. *
** 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. *
** 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. *
** Configuration of the Salesforce standard objects that Amazon Kendra indexes. *
* * @return Configuration of the Salesforce standard objects that Amazon Kendra indexes. */ public java.util.List* Configuration of the Salesforce standard objects that Amazon Kendra indexes. *
* * @param standardObjectConfigurations * Configuration of the Salesforce standard objects that Amazon Kendra indexes. */ public void setStandardObjectConfigurations(java.util.Collection* Configuration of the Salesforce standard objects that Amazon Kendra indexes. *
** NOTE: This method appends the values to the existing list (if any). Use * {@link #setStandardObjectConfigurations(java.util.Collection)} or * {@link #withStandardObjectConfigurations(java.util.Collection)} if you want to override the existing values. *
* * @param standardObjectConfigurations * Configuration of the Salesforce standard objects that Amazon Kendra indexes. * @return Returns a reference to this object so that method calls can be chained together. */ public SalesforceConfiguration withStandardObjectConfigurations(SalesforceStandardObjectConfiguration... standardObjectConfigurations) { if (this.standardObjectConfigurations == null) { setStandardObjectConfigurations(new java.util.ArrayList* Configuration of the Salesforce standard objects that Amazon Kendra indexes. *
* * @param standardObjectConfigurations * Configuration of the Salesforce standard objects that Amazon Kendra indexes. * @return Returns a reference to this object so that method calls can be chained together. */ public SalesforceConfiguration withStandardObjectConfigurations(java.util.Collection* 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. *
* * @param 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 setKnowledgeArticleConfiguration(SalesforceKnowledgeArticleConfiguration knowledgeArticleConfiguration) { this.knowledgeArticleConfiguration = 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. *
* * @return 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() { return this.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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public SalesforceConfiguration withKnowledgeArticleConfiguration(SalesforceKnowledgeArticleConfiguration knowledgeArticleConfiguration) { setKnowledgeArticleConfiguration(knowledgeArticleConfiguration); return this; } /** ** Configuration information for Salesforce chatter feeds. *
* * @param chatterFeedConfiguration * Configuration information for Salesforce chatter feeds. */ public void setChatterFeedConfiguration(SalesforceChatterFeedConfiguration chatterFeedConfiguration) { this.chatterFeedConfiguration = chatterFeedConfiguration; } /** ** Configuration information for Salesforce chatter feeds. *
* * @return Configuration information for Salesforce chatter feeds. */ public SalesforceChatterFeedConfiguration getChatterFeedConfiguration() { return this.chatterFeedConfiguration; } /** ** Configuration information for Salesforce chatter feeds. *
* * @param chatterFeedConfiguration * Configuration information for Salesforce chatter feeds. * @return Returns a reference to this object so that method calls can be chained together. */ public SalesforceConfiguration withChatterFeedConfiguration(SalesforceChatterFeedConfiguration chatterFeedConfiguration) { setChatterFeedConfiguration(chatterFeedConfiguration); return this; } /** ** Indicates whether Amazon Kendra should index attachments to Salesforce objects. *
* * @param crawlAttachments * Indicates whether Amazon Kendra should index attachments to Salesforce objects. */ public void setCrawlAttachments(Boolean crawlAttachments) { this.crawlAttachments = crawlAttachments; } /** ** Indicates whether Amazon Kendra should index attachments to Salesforce objects. *
* * @return Indicates whether Amazon Kendra should index attachments to Salesforce objects. */ public Boolean getCrawlAttachments() { return this.crawlAttachments; } /** ** Indicates whether Amazon Kendra should index attachments to Salesforce objects. *
* * @param crawlAttachments * Indicates whether Amazon Kendra should index attachments to Salesforce objects. * @return Returns a reference to this object so that method calls can be chained together. */ public SalesforceConfiguration withCrawlAttachments(Boolean crawlAttachments) { setCrawlAttachments(crawlAttachments); return this; } /** ** Indicates whether Amazon Kendra should index attachments to Salesforce objects. *
* * @return Indicates whether Amazon Kendra should index attachments to Salesforce objects. */ public Boolean isCrawlAttachments() { return this.crawlAttachments; } /** ** Configuration information for processing attachments to Salesforce standard objects. *
* * @param standardObjectAttachmentConfiguration * Configuration information for processing attachments to Salesforce standard objects. */ public void setStandardObjectAttachmentConfiguration(SalesforceStandardObjectAttachmentConfiguration standardObjectAttachmentConfiguration) { this.standardObjectAttachmentConfiguration = standardObjectAttachmentConfiguration; } /** ** Configuration information for processing attachments to Salesforce standard objects. *
* * @return Configuration information for processing attachments to Salesforce standard objects. */ public SalesforceStandardObjectAttachmentConfiguration getStandardObjectAttachmentConfiguration() { return this.standardObjectAttachmentConfiguration; } /** ** Configuration information for processing attachments to Salesforce standard objects. *
* * @param standardObjectAttachmentConfiguration * Configuration information for processing attachments to Salesforce standard objects. * @return Returns a reference to this object so that method calls can be chained together. */ public SalesforceConfiguration withStandardObjectAttachmentConfiguration( SalesforceStandardObjectAttachmentConfiguration standardObjectAttachmentConfiguration) { setStandardObjectAttachmentConfiguration(standardObjectAttachmentConfiguration); return this; } /** ** 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. *
* * @return 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 java.util.List
* 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(java.util.Collection
* 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
* {@link #setIncludeAttachmentFilePatterns(java.util.Collection)} or
* {@link #withIncludeAttachmentFilePatterns(java.util.Collection)} if you want to override the existing values.
*
* The pattern is applied to the name of the attached file.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SalesforceConfiguration withIncludeAttachmentFilePatterns(String... includeAttachmentFilePatterns) {
if (this.includeAttachmentFilePatterns == null) {
setIncludeAttachmentFilePatterns(new java.util.ArrayList
* 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SalesforceConfiguration withIncludeAttachmentFilePatterns(java.util.Collection
* 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 java.util.List
* 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(java.util.Collection
* 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
* {@link #setExcludeAttachmentFilePatterns(java.util.Collection)} or
* {@link #withExcludeAttachmentFilePatterns(java.util.Collection)} if you want to override the existing values.
*
* The pattern is applied to the name of the attached file.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SalesforceConfiguration withExcludeAttachmentFilePatterns(String... excludeAttachmentFilePatterns) {
if (this.excludeAttachmentFilePatterns == null) {
setExcludeAttachmentFilePatterns(new java.util.ArrayList
* 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SalesforceConfiguration withExcludeAttachmentFilePatterns(java.util.Collection