Share via

SalesforceV2Source Class

  • Reference

A copy activity Salesforce V2 source.

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

Inheritance
azure.mgmt.datafactory.models._models_py3.TabularSource
SalesforceV2Source

Constructor

SalesforceV2Source(*, additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, source_retry_count: MutableMapping[str, Any] | None = None, source_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections: MutableMapping[str, Any] | None = None, disable_metrics_collection: MutableMapping[str, Any] | None = None, query_timeout: MutableMapping[str, Any] | None = None, additional_columns: MutableMapping[str, Any] | None = None, soql_query: MutableMapping[str, Any] | None = None, query: MutableMapping[str, Any] | None = None, include_deleted_objects: 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.
source_retry_count
<xref:JSON>

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

Source 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 source 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).
query_timeout
<xref:JSON>

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

Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
soql_query
<xref:JSON>

Deprecating, please use 'query' property instead. Type: string (or Expression with resultType string).
query
<xref:JSON>

You can only use Salesforce Object Query Language (SOQL) query with limitations. For SOQL limitations, see this article: https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/queries.htm#SOQL%20Considerations. If query is not specified, all the data of the Salesforce object specified in ObjectApiName/reportId in dataset will be retrieved. Type: string (or Expression with resultType string).
include_deleted_objects
<xref:JSON>

This property control whether query result contains Deleted objects. Default is false. 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 source type. Required.
source_retry_count
<xref:JSON>

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

Source 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 source 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).
query_timeout
<xref:JSON>

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

Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
soql_query
<xref:JSON>

Deprecating, please use 'query' property instead. Type: string (or Expression with resultType string).
query
<xref:JSON>

You can only use Salesforce Object Query Language (SOQL) query with limitations. For SOQL limitations, see this article: https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/queries.htm#SOQL%20Considerations. If query is not specified, all the data of the Salesforce object specified in ObjectApiName/reportId in dataset will be retrieved. Type: string (or Expression with resultType string).
include_deleted_objects
<xref:JSON>

This property control whether query result contains Deleted objects. Default is false. Type: boolean (or Expression with resultType boolean).