DataTransferJobProperties Class

Definition

The properties of a DataTransfer Job.

public class DataTransferJobProperties : System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.CosmosDB.Models.DataTransferJobProperties>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.CosmosDB.Models.DataTransferJobProperties>
type DataTransferJobProperties = class
    interface IJsonModel<DataTransferJobProperties>
    interface IPersistableModel<DataTransferJobProperties>
Public Class DataTransferJobProperties
Implements IJsonModel(Of DataTransferJobProperties), IPersistableModel(Of DataTransferJobProperties)
Inheritance
DataTransferJobProperties
Implements

Constructors

DataTransferJobProperties(DataTransferDataSourceSink, DataTransferDataSourceSink)

Initializes a new instance of DataTransferJobProperties.

Properties

Destination

Destination DataStore details Please note DataTransferDataSourceSink is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AzureBlobDataTransferDataSourceSink, BaseCosmosDataTransferDataSourceSink, CosmosCassandraDataTransferDataSourceSink, CosmosMongoDataTransferDataSourceSink, CosmosMongoVCoreDataTransferDataSourceSink and CosmosSqlDataTransferDataSourceSink.

Duration

Total Duration of Job.

Error

Error response for Faulted job.

JobName

Job Name.

LastUpdatedUtcOn

Last Updated Time (ISO-8601 format).

Mode

Mode of job execution.

ProcessedCount

Processed Count.

Source

Source DataStore details Please note DataTransferDataSourceSink is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AzureBlobDataTransferDataSourceSink, BaseCosmosDataTransferDataSourceSink, CosmosCassandraDataTransferDataSourceSink, CosmosMongoDataTransferDataSourceSink, CosmosMongoVCoreDataTransferDataSourceSink and CosmosSqlDataTransferDataSourceSink.

Status

Job Status.

TotalCount

Total Count.

WorkerCount

Worker count.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

IJsonModel<DataTransferJobProperties>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

IJsonModel<DataTransferJobProperties>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<DataTransferJobProperties>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<DataTransferJobProperties>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<DataTransferJobProperties>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to