Package software.amazon.awssdk.services.appflow.model

Class SalesforceConnectorProfileCredentials

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

The connector-specific profile credentials required when using Salesforce.

See Also:

  • Method Details

    • accessToken

      public final String accessToken()

      The credentials used to access protected Salesforce resources.

      Returns:
      The credentials used to access protected Salesforce resources.

    • refreshToken

      public final String refreshToken()

      The credentials used to acquire new access tokens.

      Returns:
      The credentials used to acquire new access tokens.

    • oAuthRequest

      public final ConnectorOAuthRequest oAuthRequest()

      The OAuth requirement needed to request security tokens from the connector endpoint.

      Returns:
      The OAuth requirement needed to request security tokens from the connector endpoint.

    • clientCredentialsArn

      public final String clientCredentialsArn()

      The secret manager ARN, which contains the client ID and client secret of the connected app.

      Returns:
      The secret manager ARN, which contains the client ID and client secret of the connected app.

    • oAuth2GrantType

      public final OAuth2GrantType oAuth2GrantType()

      Specifies the OAuth 2.0 grant type that Amazon AppFlow uses when it requests an access token from Salesforce. Amazon AppFlow requires an access token each time it attempts to access your Salesforce records.

      You can specify one of the following values:

      AUTHORIZATION_CODE

      Amazon AppFlow passes an authorization code when it requests the access token from Salesforce. Amazon AppFlow receives the authorization code from Salesforce after you log in to your Salesforce account and authorize Amazon AppFlow to access your records.

      CLIENT_CREDENTIALS

      Amazon AppFlow passes client credentials (a client ID and client secret) when it requests the access token from Salesforce. You provide these credentials to Amazon AppFlow when you define the connection to your Salesforce account.

      JWT_BEARER

      Amazon AppFlow passes a JSON web token (JWT) when it requests the access token from Salesforce. You provide the JWT to Amazon AppFlow when you define the connection to your Salesforce account. When you use this grant type, you don't need to log in to your Salesforce account to authorize Amazon AppFlow to access your records.

      If the service returns an enum value that is not available in the current SDK version, oAuth2GrantType will return OAuth2GrantType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from oAuth2GrantTypeAsString().

      Returns:
      Specifies the OAuth 2.0 grant type that Amazon AppFlow uses when it requests an access token from Salesforce. Amazon AppFlow requires an access token each time it attempts to access your Salesforce records.

      You can specify one of the following values:

      AUTHORIZATION_CODE

      Amazon AppFlow passes an authorization code when it requests the access token from Salesforce. Amazon AppFlow receives the authorization code from Salesforce after you log in to your Salesforce account and authorize Amazon AppFlow to access your records.

      CLIENT_CREDENTIALS

      Amazon AppFlow passes client credentials (a client ID and client secret) when it requests the access token from Salesforce. You provide these credentials to Amazon AppFlow when you define the connection to your Salesforce account.

      JWT_BEARER

      Amazon AppFlow passes a JSON web token (JWT) when it requests the access token from Salesforce. You provide the JWT to Amazon AppFlow when you define the connection to your Salesforce account. When you use this grant type, you don't need to log in to your Salesforce account to authorize Amazon AppFlow to access your records.

      See Also:

    • oAuth2GrantTypeAsString

      public final String oAuth2GrantTypeAsString()

      Specifies the OAuth 2.0 grant type that Amazon AppFlow uses when it requests an access token from Salesforce. Amazon AppFlow requires an access token each time it attempts to access your Salesforce records.

      You can specify one of the following values:

      AUTHORIZATION_CODE

      Amazon AppFlow passes an authorization code when it requests the access token from Salesforce. Amazon AppFlow receives the authorization code from Salesforce after you log in to your Salesforce account and authorize Amazon AppFlow to access your records.

      CLIENT_CREDENTIALS

      Amazon AppFlow passes client credentials (a client ID and client secret) when it requests the access token from Salesforce. You provide these credentials to Amazon AppFlow when you define the connection to your Salesforce account.

      JWT_BEARER

      Amazon AppFlow passes a JSON web token (JWT) when it requests the access token from Salesforce. You provide the JWT to Amazon AppFlow when you define the connection to your Salesforce account. When you use this grant type, you don't need to log in to your Salesforce account to authorize Amazon AppFlow to access your records.

      If the service returns an enum value that is not available in the current SDK version, oAuth2GrantType will return OAuth2GrantType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from oAuth2GrantTypeAsString().

      Returns:
      Specifies the OAuth 2.0 grant type that Amazon AppFlow uses when it requests an access token from Salesforce. Amazon AppFlow requires an access token each time it attempts to access your Salesforce records.

      You can specify one of the following values:

      AUTHORIZATION_CODE

      Amazon AppFlow passes an authorization code when it requests the access token from Salesforce. Amazon AppFlow receives the authorization code from Salesforce after you log in to your Salesforce account and authorize Amazon AppFlow to access your records.

      CLIENT_CREDENTIALS

      Amazon AppFlow passes client credentials (a client ID and client secret) when it requests the access token from Salesforce. You provide these credentials to Amazon AppFlow when you define the connection to your Salesforce account.

      JWT_BEARER

      Amazon AppFlow passes a JSON web token (JWT) when it requests the access token from Salesforce. You provide the JWT to Amazon AppFlow when you define the connection to your Salesforce account. When you use this grant type, you don't need to log in to your Salesforce account to authorize Amazon AppFlow to access your records.

      See Also:

    • jwtToken

      public final String jwtToken()

      A JSON web token (JWT) that authorizes Amazon AppFlow to access your Salesforce records.

      Returns:
      A JSON web token (JWT) that authorizes Amazon AppFlow to access your Salesforce records.

    • toBuilder

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

    • builder

      public static SalesforceConnectorProfileCredentials.Builder builder()

    • serializableBuilderClass

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