Package software.amazon.awssdk.services.kendra.model

Class SalesforceConfiguration

java.lang.Object
software.amazon.awssdk.services.kendra.model.SalesforceConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<SalesforceConfiguration.Builder,SalesforceConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class SalesforceConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<SalesforceConfiguration.Builder,SalesforceConfiguration>

Provides the configuration information to connect to Salesforce as your data source.

See Also:

  • Method Details

    • serverUrl

      public final 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 final 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.

      Returns:
      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.

    • hasStandardObjectConfigurations

      public final boolean hasStandardObjectConfigurations()
      For responses, this returns true if the service returned a value for the StandardObjectConfigurations property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • standardObjectConfigurations

      public final List<SalesforceStandardObjectConfiguration> standardObjectConfigurations()

      Configuration of the Salesforce standard objects that Amazon Kendra indexes.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasStandardObjectConfigurations() method.

      Returns:
      Configuration of the Salesforce standard objects that Amazon Kendra indexes.

    • knowledgeArticleConfiguration

      public final 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.

      Returns:
      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.

    • chatterFeedConfiguration

      public final SalesforceChatterFeedConfiguration chatterFeedConfiguration()

      Configuration information for Salesforce chatter feeds.

      Returns:
      Configuration information for Salesforce chatter feeds.

    • crawlAttachments

      public final 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 final SalesforceStandardObjectAttachmentConfiguration standardObjectAttachmentConfiguration()

      Configuration information for processing attachments to Salesforce standard objects.

      Returns:
      Configuration information for processing attachments to Salesforce standard objects.

    • hasIncludeAttachmentFilePatterns

      public final boolean hasIncludeAttachmentFilePatterns()
      For responses, this returns true if the service returned a value for the IncludeAttachmentFilePatterns property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • includeAttachmentFilePatterns

      public final List<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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasIncludeAttachmentFilePatterns() method.

      Returns:
      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.

    • hasExcludeAttachmentFilePatterns

      public final boolean hasExcludeAttachmentFilePatterns()
      For responses, this returns true if the service returned a value for the ExcludeAttachmentFilePatterns property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • excludeAttachmentFilePatterns

      public final List<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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasExcludeAttachmentFilePatterns() method.

      Returns:
      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.

    • toBuilder

      public SalesforceConfiguration.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<SalesforceConfiguration.Builder,SalesforceConfiguration>
      Returns:
      a builder for type T

    • builder

      public static SalesforceConfiguration.Builder builder()

    • serializableBuilderClass

      public static Class<? extends SalesforceConfiguration.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final 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 final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.