Struct SalesforceDestinationProperties

#[non_exhaustive]
pub struct SalesforceDestinationProperties {
    pub object: String,
    pub id_field_names: Option<Vec<String>>,
    pub error_handling_config: Option<ErrorHandlingConfig>,
    pub write_operation_type: Option<WriteOperationType>,
    pub data_transfer_api: Option<SalesforceDataTransferApi>,
}

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

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

object: String

The object specified in the Salesforce flow destination.

id_field_names: Option<Vec<String>>

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

error_handling_config: Option<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.

write_operation_type: Option<WriteOperationType>

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

data_transfer_api: Option<SalesforceDataTransferApi>

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.

Implementations

impl SalesforceDestinationProperties

pub fn object(&self) -> &str

The object specified in the Salesforce flow destination.

pub fn id_field_names(&self) -> &[String]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .id_field_names.is_none().

pub fn error_handling_config(&self) -> Option<&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.

pub fn write_operation_type(&self) -> Option<&WriteOperationType>

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

pub fn data_transfer_api(&self) -> Option<&SalesforceDataTransferApi>

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.

impl SalesforceDestinationProperties

pub fn builder() -> SalesforceDestinationPropertiesBuilder

Creates a new builder-style object to manufacture SalesforceDestinationProperties.

Trait Implementations

impl Clone for SalesforceDestinationProperties

fn clone(&self) -> SalesforceDestinationProperties

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SalesforceDestinationProperties

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for SalesforceDestinationProperties

fn eq(&self, other: &SalesforceDestinationProperties) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for SalesforceDestinationProperties