Share via

SalesforceV2Sink Class

  • Reference

A copy activity Salesforce V2 sink.

All required parameters must be populated in order to send to server.

Inheritance
azure.mgmt.datafactory.models._models_py3.CopySink
SalesforceV2Sink

Constructor

SalesforceV2Sink(*, additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, write_batch_size: MutableMapping[str, Any] | None = None, write_batch_timeout: MutableMapping[str, Any] | None = None, sink_retry_count: MutableMapping[str, Any] | None = None, sink_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections: MutableMapping[str, Any] | None = None, disable_metrics_collection: MutableMapping[str, Any] | None = None, write_behavior: str | _models.SalesforceV2SinkWriteBehavior | None = None, external_id_field_name: MutableMapping[str, Any] | None = None, ignore_null_values: MutableMapping[str, Any] | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
additional_properties
dict[str, <xref:JSON>]

Unmatched properties from the message are deserialized to this collection.
write_batch_size
<xref:JSON>

Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.
write_batch_timeout
<xref:JSON>

Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).
sink_retry_count
<xref:JSON>

Sink retry count. Type: integer (or Expression with resultType integer).
sink_retry_wait
<xref:JSON>

Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).
max_concurrent_connections
<xref:JSON>

The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).
disable_metrics_collection
<xref:JSON>

If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
write_behavior
str or SalesforceV2SinkWriteBehavior

The write behavior for the operation. Default is Insert. Known values are: "Insert" and "Upsert".
external_id_field_name
<xref:JSON>

The name of the external ID field for upsert operation. Default value is 'Id' column. Type: string (or Expression with resultType string).
ignore_null_values
<xref:JSON>

The flag indicating whether or not to ignore null values from input dataset (except key fields) during write operation. Default value is false. If set it to true, it means ADF will leave the data in the destination object unchanged when doing upsert/update operation and insert defined default value when doing insert operation, versus ADF will update the data in the destination object to NULL when doing upsert/update operation and insert NULL value when doing insert operation. Type: boolean (or Expression with resultType boolean).

Variables

Name Description
additional_properties
dict[str, <xref:JSON>]

Unmatched properties from the message are deserialized to this collection.
type
str

Copy sink type. Required.
write_batch_size
<xref:JSON>

Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.
write_batch_timeout
<xref:JSON>

Write batch timeout. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).
sink_retry_count
<xref:JSON>

Sink retry count. Type: integer (or Expression with resultType integer).
sink_retry_wait
<xref:JSON>

Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).
max_concurrent_connections
<xref:JSON>

The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).
disable_metrics_collection
<xref:JSON>

If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
write_behavior
str or SalesforceV2SinkWriteBehavior

The write behavior for the operation. Default is Insert. Known values are: "Insert" and "Upsert".
external_id_field_name
<xref:JSON>

The name of the external ID field for upsert operation. Default value is 'Id' column. Type: string (or Expression with resultType string).
ignore_null_values
<xref:JSON>

The flag indicating whether or not to ignore null values from input dataset (except key fields) during write operation. Default value is false. If set it to true, it means ADF will leave the data in the destination object unchanged when doing upsert/update operation and insert defined default value when doing insert operation, versus ADF will update the data in the destination object to NULL when doing upsert/update operation and insert NULL value when doing insert operation. Type: boolean (or Expression with resultType boolean).