CosmosDBMongoDBApiSource Class

Definition

Namespace:

Azure.ResourceManager.DataFactory.Models

Assembly:

Azure.ResourceManager.DataFactory.dll

Package:

Azure.ResourceManager.DataFactory v1.6.0

Source:

CosmosDBMongoDBApiSource.cs

A copy activity source for a CosmosDB (MongoDB API) database.

public class CosmosDBMongoDBApiSource : Azure.ResourceManager.DataFactory.Models.CopyActivitySource, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.DataFactory.Models.CosmosDBMongoDBApiSource>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.DataFactory.Models.CosmosDBMongoDBApiSource>

type CosmosDBMongoDBApiSource = class
    inherit CopyActivitySource
    interface IJsonModel<CosmosDBMongoDBApiSource>
    interface IPersistableModel<CosmosDBMongoDBApiSource>

Public Class CosmosDBMongoDBApiSource
Inherits CopyActivitySource
Implements IJsonModel(Of CosmosDBMongoDBApiSource), IPersistableModel(Of CosmosDBMongoDBApiSource)

Inheritance

Object

CopyActivitySource

CosmosDBMongoDBApiSource

Implements

IJsonModel<CosmosDBMongoDBApiSource> IPersistableModel<CosmosDBMongoDBApiSource> IPersistableModel<T>

Constructors

CosmosDBMongoDBApiSource()

Initializes a new instance of CosmosDBMongoDBApiSource.

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" }.
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)
BatchSize	Specifies the number of documents to return in each batch of the response from MongoDB instance. In most cases, modifying the batch size will not affect the user or the application. This property's main purpose is to avoid hit the limitation of response size. Type: integer (or Expression with resultType integer).
CursorMethods	Cursor methods for Mongodb query.
DisableMetricsCollection	If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). (Inherited from CopyActivitySource)
Filter	Specifies selection filter using query operators. To return all documents in a collection, omit this parameter or pass an empty document ({}). Type: string (or Expression with resultType string).
MaxConcurrentConnections	The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). (Inherited from CopyActivitySource)
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). (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)

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<CosmosDBMongoDBApiSource>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<CosmosDBMongoDBApiSource>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
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<CosmosDBMongoDBApiSource>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<CosmosDBMongoDBApiSource>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<CosmosDBMongoDBApiSource>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.