Class SalesforceMetadata
- java.lang.Object
-
- software.amazon.awssdk.services.appflow.model.SalesforceMetadata
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<SalesforceMetadata.Builder,SalesforceMetadata>
@Generated("software.amazon.awssdk:codegen") public final class SalesforceMetadata extends Object implements SdkPojo, Serializable, ToCopyableBuilder<SalesforceMetadata.Builder,SalesforceMetadata>
The connector metadata specific to Salesforce.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceSalesforceMetadata.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static SalesforceMetadata.Builderbuilder()List<SalesforceDataTransferApi>dataTransferApis()The Salesforce APIs that you can have Amazon AppFlow use when your flows transfers data to or from Salesforce.List<String>dataTransferApisAsStrings()The Salesforce APIs that you can have Amazon AppFlow use when your flows transfers data to or from Salesforce.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasDataTransferApis()For responses, this returns true if the service returned a value for the DataTransferApis property.inthashCode()booleanhasOauth2GrantTypesSupported()For responses, this returns true if the service returned a value for the Oauth2GrantTypesSupported property.booleanhasOAuthScopes()For responses, this returns true if the service returned a value for the OAuthScopes property.List<OAuth2GrantType>oauth2GrantTypesSupported()The OAuth 2.0 grant types that Amazon AppFlow can use when it requests an access token from Salesforce.List<String>oauth2GrantTypesSupportedAsStrings()The OAuth 2.0 grant types that Amazon AppFlow can use when it requests an access token from Salesforce.List<String>oAuthScopes()The desired authorization scope for the Salesforce account.List<SdkField<?>>sdkFields()static Class<? extends SalesforceMetadata.Builder>serializableBuilderClass()SalesforceMetadata.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
-
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
public final List<String> 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
public final List<SalesforceDataTransferApi> 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
public final List<String> 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
public final List<OAuth2GrantType> 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
public final List<String> 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
public SalesforceMetadata.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<SalesforceMetadata.Builder,SalesforceMetadata>
-
builder
public static SalesforceMetadata.Builder builder()
-
serializableBuilderClass
public static Class<? extends SalesforceMetadata.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.
-
-