SalesforceConfiguration (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.kendra.model.SalesforceConfiguration

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<SalesforceConfiguration.Builder,SalesforceConfiguration>

@Generated(value="software.amazon.awssdk:codegen")
public final class SalesforceConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<SalesforceConfiguration.Builder,SalesforceConfiguration>

Provides configuration information for connecting to a Salesforce data source.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface SalesforceConfiguration.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`SalesforceConfiguration.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static SalesforceConfiguration.Builder`	`builder()`
`SalesforceChatterFeedConfiguration`	`chatterFeedConfiguration()` Specifies configuration information for Salesforce chatter feeds.
`Boolean`	`crawlAttachments()` Indicates whether Amazon Kendra should index attachments to Salesforce objects.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<String>`	`excludeAttachmentFilePatterns()` A list of regular expression patterns.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasExcludeAttachmentFilePatterns()` Returns true if the ExcludeAttachmentFilePatterns property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasIncludeAttachmentFilePatterns()` Returns true if the IncludeAttachmentFilePatterns property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasStandardObjectConfigurations()` Returns true if the StandardObjectConfigurations property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`List<String>`	`includeAttachmentFilePatterns()` A list of regular expression patterns.
`SalesforceKnowledgeArticleConfiguration`	`knowledgeArticleConfiguration()` Specifies configuration information for the knowlege article types that Amazon Kendra indexes.
`List<SdkField<?>>`	`sdkFields()`
`String`	`secretArn()` The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the key/value pairs required to connect to your Salesforce instance.
`static Class<? extends SalesforceConfiguration.Builder>`	`serializableBuilderClass()`
`String`	`serverUrl()` The instance URL for the Salesforce site that you want to index.
`SalesforceStandardObjectAttachmentConfiguration`	`standardObjectAttachmentConfiguration()` Provides configuration information for processing attachments to Salesforce standard objects.
`List<SalesforceStandardObjectConfiguration>`	`standardObjectConfigurations()` Specifies the Salesforce standard objects that Amazon Kendra indexes.
`SalesforceConfiguration.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - serverUrl
```
public String serverUrl()
```
    The instance URL for the Salesforce site that you want to index.
    
    Returns:
    
    The instance URL for the Salesforce site that you want to index.
  - secretArn
```
public String secretArn()
```
    The Amazon Resource Name (ARN) of an AWS Secrets Manager secret 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 account logging in to the Salesforce instance.
    - username - The user name of the user logging in to the Salesforce instance.
    Returns:
    The Amazon Resource Name (ARN) of an AWS Secrets Manager secret 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 account logging in to the Salesforce instance.
    
    username - The user name of the user logging in to the Salesforce instance.
  - hasStandardObjectConfigurations
```
public boolean hasStandardObjectConfigurations()
```
    Returns true if the StandardObjectConfigurations property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - standardObjectConfigurations
```
public List<SalesforceStandardObjectConfiguration> standardObjectConfigurations()
```
    Specifies the Salesforce standard objects that Amazon Kendra indexes.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasStandardObjectConfigurations() to see if a value was sent in this field.
    
    Returns:
    
    Specifies the Salesforce standard objects that Amazon Kendra indexes.
  - knowledgeArticleConfiguration
```
public SalesforceKnowledgeArticleConfiguration knowledgeArticleConfiguration()
```
    Specifies configuration information for the knowlege 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.
    
    Returns:
    
    Specifies configuration information for the knowlege 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.
  - chatterFeedConfiguration
```
public SalesforceChatterFeedConfiguration chatterFeedConfiguration()
```
    Specifies configuration information for Salesforce chatter feeds.
    
    Returns:
    
    Specifies configuration information for Salesforce chatter feeds.
  - crawlAttachments
```
public Boolean crawlAttachments()
```
    Indicates whether Amazon Kendra should index attachments to Salesforce objects.
    
    Returns:
    
    Indicates whether Amazon Kendra should index attachments to Salesforce objects.
  - standardObjectAttachmentConfiguration
```
public SalesforceStandardObjectAttachmentConfiguration standardObjectAttachmentConfiguration()
```
    Provides configuration information for processing attachments to Salesforce standard objects.
    
    Returns:
    
    Provides configuration information for processing attachments to Salesforce standard objects.
  - hasIncludeAttachmentFilePatterns
```
public boolean hasIncludeAttachmentFilePatterns()
```
    Returns true if the IncludeAttachmentFilePatterns property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - includeAttachmentFilePatterns
```
public List<String> includeAttachmentFilePatterns()
```
    A list of regular expression patterns. 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 pattern and an exclusion pattern, the document is not included in the index.
    
    The regex is applied to the name of the attached file.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasIncludeAttachmentFilePatterns() to see if a value was sent in this field.
    
    Returns:
    
    A list of regular expression patterns. 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 pattern and an exclusion pattern, the document is not included in the index.
    
    The regex is applied to the name of the attached file.
  - hasExcludeAttachmentFilePatterns
```
public boolean hasExcludeAttachmentFilePatterns()
```
    Returns true if the ExcludeAttachmentFilePatterns property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - excludeAttachmentFilePatterns
```
public List<String> excludeAttachmentFilePatterns()
```
    A list of regular expression patterns. 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 exclusion pattern and an inclusion pattern, the document is not included in the index.
    
    The regex is applied to the name of the attached file.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasExcludeAttachmentFilePatterns() to see if a value was sent in this field.
    
    Returns:
    
    A list of regular expression patterns. 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 exclusion pattern and an inclusion pattern, the document is not included in the index.
    
    The regex is applied to the name of the attached file.
  - toBuilder
```
public SalesforceConfiguration.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<SalesforceConfiguration.Builder,SalesforceConfiguration>
  - builder
```
public static SalesforceConfiguration.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends SalesforceConfiguration.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class SalesforceConfiguration

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

serverUrl

secretArn

hasStandardObjectConfigurations

standardObjectConfigurations

knowledgeArticleConfiguration

chatterFeedConfiguration

crawlAttachments

standardObjectAttachmentConfiguration

hasIncludeAttachmentFilePatterns

includeAttachmentFilePatterns

hasExcludeAttachmentFilePatterns

excludeAttachmentFilePatterns

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields