Share via


IcebergSink Class

Definition

A copy activity Iceberg sink.

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

Constructors

IcebergSink()

Initializes a new instance of IcebergSink.

Properties

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 CopySink)
DisableMetricsCollection

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

(Inherited from CopySink)
FormatSettings

Iceberg format settings.

MaxConcurrentConnections

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

(Inherited from CopySink)
SinkRetryCount

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

(Inherited from CopySink)
SinkRetryWait

Sink 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 CopySink)
StoreSettings

Iceberg store settings. Please note StoreWriteSettings 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 AzureBlobFSWriteSettings, AzureBlobStorageWriteSettings, AzureDataLakeStoreWriteSettings, AzureFileStorageWriteSettings, FileServerWriteSettings, LakeHouseWriteSettings and SftpWriteSettings.

WriteBatchSize

Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

(Inherited from CopySink)
WriteBatchTimeout

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

(Inherited from CopySink)

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

IJsonModel<CopySink>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

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

Writes the model to the provided Utf8JsonWriter.

(Inherited from CopySink)
IJsonModel<IcebergSink>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

IJsonModel<IcebergSink>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<CopySink>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

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

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

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

Writes the model into a BinaryData.

(Inherited from CopySink)
IPersistableModel<IcebergSink>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<IcebergSink>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<IcebergSink>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to