software.amazon.awssdk.services.appflow.model

Class SalesforceDestinationProperties

java.lang.Object

software.amazon.awssdk.services.appflow.model.SalesforceDestinationProperties

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SalesforceDestinationProperties.Builder,SalesforceDestinationProperties>

@Generated(value="software.amazon.awssdk:codegen")
public final class SalesforceDestinationProperties
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<SalesforceDestinationProperties.Builder,SalesforceDestinationProperties>

The properties that are applied when Salesforce is being used as a destination.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SalesforceDestinationProperties.Builder

Method Summary

Modifier and Type	Method and Description
static SalesforceDestinationProperties.Builder	builder()
SalesforceDataTransferApi	dataTransferApi() Specifies which Salesforce API is used by Amazon AppFlow when your flow transfers data to Salesforce.
String	dataTransferApiAsString() Specifies which Salesforce API is used by Amazon AppFlow when your flow transfers data to Salesforce.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
ErrorHandlingConfig	errorHandlingConfig() The settings that determine how Amazon AppFlow handles an error when placing data in the Salesforce destination.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasIdFieldNames() For responses, this returns true if the service returned a value for the IdFieldNames property.
List<String>	idFieldNames() The name of the field that Amazon AppFlow uses as an ID when performing a write operation such as update or delete.
String	object() The object specified in the Salesforce flow destination.
List<SdkField<?>>	sdkFields()
static Class<? extends SalesforceDestinationProperties.Builder>	serializableBuilderClass()
SalesforceDestinationProperties.Builder	toBuilder()
String	toString() Returns a string representation of this object.
WriteOperationType	writeOperationType() This specifies the type of write operation to be performed in Salesforce.
String	writeOperationTypeAsString() This specifies the type of write operation to be performed in Salesforce.

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

object

public final String object()

The object specified in the Salesforce flow destination.

Returns:

The object specified in the Salesforce flow destination.

hasIdFieldNames

public final boolean hasIdFieldNames()

For responses, this returns true if the service returned a value for the IdFieldNames property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

idFieldNames

public final List<String> idFieldNames()

The name of the field that Amazon AppFlow uses as an ID when performing a write operation such as update or delete.

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 hasIdFieldNames() method.

Returns:

The name of the field that Amazon AppFlow uses as an ID when performing a write operation such as update or delete.

errorHandlingConfig

public final ErrorHandlingConfig errorHandlingConfig()

The settings that determine how Amazon AppFlow handles an error when placing data in the Salesforce destination. For example, this setting would determine if the flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure. ErrorHandlingConfig is a part of the destination connector details.

Returns:

The settings that determine how Amazon AppFlow handles an error when placing data in the Salesforce destination. For example, this setting would determine if the flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure. ErrorHandlingConfig is a part of the destination connector details.

writeOperationType

public final WriteOperationType writeOperationType()

This specifies the type of write operation to be performed in Salesforce. When the value is UPSERT, then idFieldNames is required.

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

Returns:

This specifies the type of write operation to be performed in Salesforce. When the value is UPSERT, then idFieldNames is required.

See Also:

WriteOperationType

writeOperationTypeAsString

public final String writeOperationTypeAsString()

This specifies the type of write operation to be performed in Salesforce. When the value is UPSERT, then idFieldNames is required.

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

Returns:

This specifies the type of write operation to be performed in Salesforce. When the value is UPSERT, then idFieldNames is required.

See Also:

WriteOperationType

dataTransferApi

public final SalesforceDataTransferApi dataTransferApi()

Specifies which Salesforce API is used by Amazon AppFlow when your flow transfers data to Salesforce.

AUTOMATIC

The default. Amazon AppFlow selects which API to use based on the number of records that your flow transfers to Salesforce. If your flow transfers fewer than 1,000 records, Amazon AppFlow uses Salesforce REST API. If your flow transfers 1,000 records or more, Amazon AppFlow uses Salesforce Bulk API 2.0.

Each of these Salesforce APIs structures data differently. If Amazon AppFlow selects the API automatically, be aware that, for recurring flows, the data output might vary from one flow run to the next. For example, if a flow runs daily, it might use REST API on one day to transfer 900 records, and it might use Bulk API 2.0 on the next day to transfer 1,100 records. For each of these flow runs, the respective Salesforce API formats the data differently. Some of the differences include how dates are formatted and null values are represented. Also, Bulk API 2.0 doesn't transfer Salesforce compound fields.

By choosing this option, you optimize flow performance for both small and large data transfers, but the tradeoff is inconsistent formatting in the output.

BULKV2

Amazon AppFlow uses only Salesforce Bulk API 2.0. This API runs asynchronous data transfers, and it's optimal for large sets of data. By choosing this option, you ensure that your flow writes consistent output, but you optimize performance only for large data transfers.

Note that Bulk API 2.0 does not transfer Salesforce compound fields.

REST_SYNC

Amazon AppFlow uses only Salesforce REST API. By choosing this option, you ensure that your flow writes consistent output, but you decrease performance for large data transfers that are better suited for Bulk API 2.0. In some cases, if your flow attempts to transfer a vary large set of data, it might fail with a timed out error.

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

Returns:

Specifies which Salesforce API is used by Amazon AppFlow when your flow transfers data to Salesforce.

AUTOMATIC

The default. Amazon AppFlow selects which API to use based on the number of records that your flow transfers to Salesforce. If your flow transfers fewer than 1,000 records, Amazon AppFlow uses Salesforce REST API. If your flow transfers 1,000 records or more, Amazon AppFlow uses Salesforce Bulk API 2.0.

Each of these Salesforce APIs structures data differently. If Amazon AppFlow selects the API automatically, be aware that, for recurring flows, the data output might vary from one flow run to the next. For example, if a flow runs daily, it might use REST API on one day to transfer 900 records, and it might use Bulk API 2.0 on the next day to transfer 1,100 records. For each of these flow runs, the respective Salesforce API formats the data differently. Some of the differences include how dates are formatted and null values are represented. Also, Bulk API 2.0 doesn't transfer Salesforce compound fields.

By choosing this option, you optimize flow performance for both small and large data transfers, but the tradeoff is inconsistent formatting in the output.

BULKV2

Amazon AppFlow uses only Salesforce Bulk API 2.0. This API runs asynchronous data transfers, and it's optimal for large sets of data. By choosing this option, you ensure that your flow writes consistent output, but you optimize performance only for large data transfers.

Note that Bulk API 2.0 does not transfer Salesforce compound fields.

REST_SYNC

Amazon AppFlow uses only Salesforce REST API. By choosing this option, you ensure that your flow writes consistent output, but you decrease performance for large data transfers that are better suited for Bulk API 2.0. In some cases, if your flow attempts to transfer a vary large set of data, it might fail with a timed out error.

See Also:

SalesforceDataTransferApi

dataTransferApiAsString

public final String dataTransferApiAsString()

Specifies which Salesforce API is used by Amazon AppFlow when your flow transfers data to Salesforce.

AUTOMATIC

The default. Amazon AppFlow selects which API to use based on the number of records that your flow transfers to Salesforce. If your flow transfers fewer than 1,000 records, Amazon AppFlow uses Salesforce REST API. If your flow transfers 1,000 records or more, Amazon AppFlow uses Salesforce Bulk API 2.0.

Each of these Salesforce APIs structures data differently. If Amazon AppFlow selects the API automatically, be aware that, for recurring flows, the data output might vary from one flow run to the next. For example, if a flow runs daily, it might use REST API on one day to transfer 900 records, and it might use Bulk API 2.0 on the next day to transfer 1,100 records. For each of these flow runs, the respective Salesforce API formats the data differently. Some of the differences include how dates are formatted and null values are represented. Also, Bulk API 2.0 doesn't transfer Salesforce compound fields.

By choosing this option, you optimize flow performance for both small and large data transfers, but the tradeoff is inconsistent formatting in the output.

BULKV2

Amazon AppFlow uses only Salesforce Bulk API 2.0. This API runs asynchronous data transfers, and it's optimal for large sets of data. By choosing this option, you ensure that your flow writes consistent output, but you optimize performance only for large data transfers.

Note that Bulk API 2.0 does not transfer Salesforce compound fields.

REST_SYNC

Amazon AppFlow uses only Salesforce REST API. By choosing this option, you ensure that your flow writes consistent output, but you decrease performance for large data transfers that are better suited for Bulk API 2.0. In some cases, if your flow attempts to transfer a vary large set of data, it might fail with a timed out error.

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

Returns:

Specifies which Salesforce API is used by Amazon AppFlow when your flow transfers data to Salesforce.

AUTOMATIC

The default. Amazon AppFlow selects which API to use based on the number of records that your flow transfers to Salesforce. If your flow transfers fewer than 1,000 records, Amazon AppFlow uses Salesforce REST API. If your flow transfers 1,000 records or more, Amazon AppFlow uses Salesforce Bulk API 2.0.

Each of these Salesforce APIs structures data differently. If Amazon AppFlow selects the API automatically, be aware that, for recurring flows, the data output might vary from one flow run to the next. For example, if a flow runs daily, it might use REST API on one day to transfer 900 records, and it might use Bulk API 2.0 on the next day to transfer 1,100 records. For each of these flow runs, the respective Salesforce API formats the data differently. Some of the differences include how dates are formatted and null values are represented. Also, Bulk API 2.0 doesn't transfer Salesforce compound fields.

By choosing this option, you optimize flow performance for both small and large data transfers, but the tradeoff is inconsistent formatting in the output.

BULKV2

Amazon AppFlow uses only Salesforce Bulk API 2.0. This API runs asynchronous data transfers, and it's optimal for large sets of data. By choosing this option, you ensure that your flow writes consistent output, but you optimize performance only for large data transfers.

Note that Bulk API 2.0 does not transfer Salesforce compound fields.

REST_SYNC

Amazon AppFlow uses only Salesforce REST API. By choosing this option, you ensure that your flow writes consistent output, but you decrease performance for large data transfers that are better suited for Bulk API 2.0. In some cases, if your flow attempts to transfer a vary large set of data, it might fail with a timed out error.

See Also:

SalesforceDataTransferApi

toBuilder

public SalesforceDestinationProperties.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SalesforceDestinationProperties.Builder,SalesforceDestinationProperties>

builder

public static SalesforceDestinationProperties.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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