Share via


RestSink Class

Definition

A copy activity Rest service Sink.

[System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.RestSink+RestSinkConverter))]
public class RestSink : Azure.Analytics.Synapse.Artifacts.Models.CopySink
[<System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.RestSink+RestSinkConverter))>]
type RestSink = class
    inherit CopySink
Public Class RestSink
Inherits CopySink
Inheritance
RestSink
Attributes

Constructors

RestSink()

Initializes a new instance of RestSink.

Properties

AdditionalHeaders

The additional HTTP headers in the request to the RESTful API. Type: string (or Expression with resultType string).

AdditionalProperties

Additional Properties.

(Inherited from CopySink)
HttpCompressionType

Http Compression Type to Send data in compressed format with Optimal Compression Level, Default is None. And The Only Supported option is Gzip.

HttpRequestTimeout

The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:01:40. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

MaxConcurrentConnections

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

(Inherited from CopySink)
RequestInterval

The time to await before sending next request, in milliseconds.

RequestMethod

The HTTP method used to call the RESTful API. The default is POST. Type: string (or Expression with resultType string).

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

Applies to