SalesforceV2Source Class

Definition

A copy activity Salesforce V2 source.

public class SalesforceV2Source : Azure.ResourceManager.DataFactory.Models.TabularSource, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.DataFactory.Models.SalesforceV2Source>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.DataFactory.Models.SalesforceV2Source>
public class SalesforceV2Source : Azure.ResourceManager.DataFactory.Models.TabularSource
type SalesforceV2Source = class
    inherit TabularSource
    interface IJsonModel<SalesforceV2Source>
    interface IPersistableModel<SalesforceV2Source>
type SalesforceV2Source = class
    inherit TabularSource
Public Class SalesforceV2Source
Inherits TabularSource
Implements IJsonModel(Of SalesforceV2Source), IPersistableModel(Of SalesforceV2Source)
Public Class SalesforceV2Source
Inherits TabularSource
Inheritance
Implements

Constructors

SalesforceV2Source()

Initializes a new instance of SalesforceV2Source.

Properties

AdditionalColumns

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

To assign an object to this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""): Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.

(Inherited from TabularSource)
AdditionalProperties

Additional Properties

To assign an object to the value of this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""): Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.

(Inherited from CopyActivitySource)
DisableMetricsCollection

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

(Inherited from CopyActivitySource)
IncludeDeletedObjects

This property control whether query result contains Deleted objects. 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).

(Inherited from CopyActivitySource)
PageSize

Page size for each http request, too large pageSize will caused timeout, default 300,000. Type: integer (or Expression with resultType integer).

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

QueryTimeout

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

(Inherited from TabularSource)
SoqlQuery

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

SourceRetryCount

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

(Inherited from CopyActivitySource)
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])).

(Inherited from CopyActivitySource)

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from TabularSource)

Explicit Interface Implementations

IJsonModel<CopyActivitySource>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

(Inherited from CopyActivitySource)
IJsonModel<CopyActivitySource>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

(Inherited from CopyActivitySource)
IJsonModel<SalesforceV2Source>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<SalesforceV2Source>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IJsonModel<TabularSource>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

(Inherited from TabularSource)
IJsonModel<TabularSource>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

(Inherited from TabularSource)
IPersistableModel<CopyActivitySource>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

(Inherited from CopyActivitySource)
IPersistableModel<CopyActivitySource>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

(Inherited from CopyActivitySource)
IPersistableModel<CopyActivitySource>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

(Inherited from CopyActivitySource)
IPersistableModel<SalesforceV2Source>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<SalesforceV2Source>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<SalesforceV2Source>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

IPersistableModel<TabularSource>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

(Inherited from TabularSource)
IPersistableModel<TabularSource>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

(Inherited from TabularSource)
IPersistableModel<TabularSource>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

(Inherited from TabularSource)

Applies to