Class SalesforceConnectorProfileProperties

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

The connector-specific profile properties required when using Salesforce.

See Also:

  • Method Details

    • instanceUrl

      public final String instanceUrl()

      The location of the Salesforce resource.

      Returns:
      The location of the Salesforce resource.

    • isSandboxEnvironment

      public final Boolean isSandboxEnvironment()

      Indicates whether the connector profile applies to a sandbox or production environment.

      Returns:
      Indicates whether the connector profile applies to a sandbox or production environment.

    • usePrivateLinkForMetadataAndAuthorization

      public final Boolean usePrivateLinkForMetadataAndAuthorization()

      If the connection mode for the connector profile is private, this parameter sets whether Amazon AppFlow uses the private network to send metadata and authorization calls to Salesforce. Amazon AppFlow sends private calls through Amazon Web Services PrivateLink. These calls travel through Amazon Web Services infrastructure without being exposed to the public internet.

      Set either of the following values:

      true

      Amazon AppFlow sends all calls to Salesforce over the private network.

      These private calls are:

      • Calls to get metadata about your Salesforce records. This metadata describes your Salesforce objects and their fields.

      • Calls to get or refresh access tokens that allow Amazon AppFlow to access your Salesforce records.

      • Calls to transfer your Salesforce records as part of a flow run.

      false

      The default value. Amazon AppFlow sends some calls to Salesforce privately and other calls over the public internet.

      The public calls are:

      • Calls to get metadata about your Salesforce records.

      • Calls to get or refresh access tokens.

      The private calls are:

      • Calls to transfer your Salesforce records as part of a flow run.

      Returns:
      If the connection mode for the connector profile is private, this parameter sets whether Amazon AppFlow uses the private network to send metadata and authorization calls to Salesforce. Amazon AppFlow sends private calls through Amazon Web Services PrivateLink. These calls travel through Amazon Web Services infrastructure without being exposed to the public internet.

      Set either of the following values:

      true

      Amazon AppFlow sends all calls to Salesforce over the private network.

      These private calls are:

      • Calls to get metadata about your Salesforce records. This metadata describes your Salesforce objects and their fields.

      • Calls to get or refresh access tokens that allow Amazon AppFlow to access your Salesforce records.

      • Calls to transfer your Salesforce records as part of a flow run.

      false

      The default value. Amazon AppFlow sends some calls to Salesforce privately and other calls over the public internet.

      The public calls are:

      • Calls to get metadata about your Salesforce records.

      • Calls to get or refresh access tokens.

      The private calls are:

      • Calls to transfer your Salesforce records as part of a flow run.

    • toBuilder

      public SalesforceConnectorProfileProperties.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<SalesforceConnectorProfileProperties.Builder,SalesforceConnectorProfileProperties>
      Returns:
      a builder for type T

    • builder

      public static SalesforceConnectorProfileProperties.Builder builder()

    • serializableBuilderClass

      public static Class<? extends SalesforceConnectorProfileProperties.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.