Share via

SalesforceV2Source interface

  • Reference
Package:
@azure/arm-datafactory

A copy activity Salesforce V2 source.

Extends
TabularSource

Properties

includeDeletedObjects

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

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).
soqlQuery

Deprecating, please use 'query' property instead. Type: string (or Expression with resultType string).
type

Polymorphic discriminator, which specifies the different types this object can be

Inherited Properties

additionalColumns

Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
disableMetricsCollection

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

The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
queryTimeout

Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).
sourceRetryCount

Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait

Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

Property Details

includeDeletedObjects

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

includeDeletedObjects?: any

Property Value

any

query

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).

query?: any

Property Value

any

soqlQuery

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

soqlQuery?: any

Property Value

any

type

Polymorphic discriminator, which specifies the different types this object can be

type: "SalesforceV2Source"

Property Value

"SalesforceV2Source"

Inherited Property Details

additionalColumns

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

additionalColumns?: any

Property Value

any

Inherited From TabularSource.additionalColumns

disableMetricsCollection

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

disableMetricsCollection?: any

Property Value

any

Inherited From TabularSource.disableMetricsCollection

maxConcurrentConnections

The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

maxConcurrentConnections?: any

Property Value

any

Inherited From TabularSource.maxConcurrentConnections

queryTimeout

Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

queryTimeout?: any

Property Value

any

Inherited From TabularSource.queryTimeout

sourceRetryCount

Source retry count. Type: integer (or Expression with resultType integer).

sourceRetryCount?: any

Property Value

any

Inherited From TabularSource.sourceRetryCount

sourceRetryWait

Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

sourceRetryWait?: any

Property Value

any

Inherited From TabularSource.sourceRetryWait