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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceSalesforceConnectorProfileCredentials.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StringaccessToken()The credentials used to access protected Salesforce resources.static SalesforceConnectorProfileCredentials.Builderbuilder()StringclientCredentialsArn()The secret manager ARN, which contains the client ID and client secret of the connected app.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()StringjwtToken()A JSON web token (JWT) that authorizes Amazon AppFlow to access your Salesforce records.OAuth2GrantTypeoAuth2GrantType()Specifies the OAuth 2.0 grant type that Amazon AppFlow uses when it requests an access token from Salesforce.StringoAuth2GrantTypeAsString()Specifies the OAuth 2.0 grant type that Amazon AppFlow uses when it requests an access token from Salesforce.ConnectorOAuthRequestoAuthRequest()The OAuth requirement needed to request security tokens from the connector endpoint.StringrefreshToken()The credentials used to acquire new access tokens.List<SdkField<?>>sdkFields()static Class<? extends SalesforceConnectorProfileCredentials.Builder>serializableBuilderClass()SalesforceConnectorProfileCredentials.BuildertoBuilder()StringtoString()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
-
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,
oAuth2GrantTypewill returnOAuth2GrantType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromoAuth2GrantTypeAsString().- 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:
OAuth2GrantType
-
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,
oAuth2GrantTypewill returnOAuth2GrantType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromoAuth2GrantTypeAsString().- 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:
OAuth2GrantType
-
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()
- Specified by:
toBuilderin interfaceToCopyableBuilder<SalesforceConnectorProfileCredentials.Builder,SalesforceConnectorProfileCredentials>
-
builder
public static SalesforceConnectorProfileCredentials.Builder builder()
-
serializableBuilderClass
public static Class<? extends SalesforceConnectorProfileCredentials.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-