Class SalesforceMetadata
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<SalesforceMetadata.Builder,
SalesforceMetadata>
The connector metadata specific to Salesforce.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic SalesforceMetadata.Builder
builder()
final List
<SalesforceDataTransferApi> The Salesforce APIs that you can have Amazon AppFlow use when your flows transfers data to or from Salesforce.The Salesforce APIs that you can have Amazon AppFlow use when your flows transfers data to or from Salesforce.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the DataTransferApis property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Oauth2GrantTypesSupported property.final boolean
For responses, this returns true if the service returned a value for the OAuthScopes property.final List
<OAuth2GrantType> The OAuth 2.0 grant types that Amazon AppFlow can use when it requests an access token from Salesforce.The OAuth 2.0 grant types that Amazon AppFlow can use when it requests an access token from Salesforce.The desired authorization scope for the Salesforce account.static Class
<? extends SalesforceMetadata.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
hasOAuthScopes
public final boolean hasOAuthScopes()For responses, this returns true if the service returned a value for the OAuthScopes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
oAuthScopes
The desired authorization scope for the Salesforce account.
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
hasOAuthScopes()
method.- Returns:
- The desired authorization scope for the Salesforce account.
-
dataTransferApis
The Salesforce APIs that you can have Amazon AppFlow use when your flows transfers data to or from Salesforce.
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
hasDataTransferApis()
method.- Returns:
- The Salesforce APIs that you can have Amazon AppFlow use when your flows transfers data to or from Salesforce.
-
hasDataTransferApis
public final boolean hasDataTransferApis()For responses, this returns true if the service returned a value for the DataTransferApis property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
dataTransferApisAsStrings
The Salesforce APIs that you can have Amazon AppFlow use when your flows transfers data to or from Salesforce.
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
hasDataTransferApis()
method.- Returns:
- The Salesforce APIs that you can have Amazon AppFlow use when your flows transfers data to or from Salesforce.
-
oauth2GrantTypesSupported
The OAuth 2.0 grant types that Amazon AppFlow can use when it requests an access token from Salesforce. Amazon AppFlow requires an access token each time it attempts to access your Salesforce records.
- 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.
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
hasOauth2GrantTypesSupported()
method.- Returns:
- The OAuth 2.0 grant types that Amazon AppFlow can use when it requests an access token from Salesforce.
Amazon AppFlow requires an access token each time it attempts to access your Salesforce records.
- 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.
-
hasOauth2GrantTypesSupported
public final boolean hasOauth2GrantTypesSupported()For responses, this returns true if the service returned a value for the Oauth2GrantTypesSupported property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
oauth2GrantTypesSupportedAsStrings
The OAuth 2.0 grant types that Amazon AppFlow can use when it requests an access token from Salesforce. Amazon AppFlow requires an access token each time it attempts to access your Salesforce records.
- 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.
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
hasOauth2GrantTypesSupported()
method.- Returns:
- The OAuth 2.0 grant types that Amazon AppFlow can use when it requests an access token from Salesforce.
Amazon AppFlow requires an access token each time it attempts to access your Salesforce records.
- 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.
-
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 interfaceToCopyableBuilder<SalesforceMetadata.Builder,
SalesforceMetadata> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-