RestSink Class

A copy activity Rest service Sink.

Constructor

RestSink(*args: Any, **kwargs: Any)

Variables

Name Description
write_batch_size
any

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

write_batch_timeout
any

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

sink_retry_count
any

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

sink_retry_wait
any

Sink retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

max_concurrent_connections
any

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

disable_metrics_collection
any

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

request_method
any

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

additional_headers
any

The additional HTTP headers in the request to the RESTful API. Type: key value pairs (value should be string type).

http_request_timeout
any

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+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

request_interval
any

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

http_compression_type
any

Http Compression Type to Send data in compressed format with Optimal Compression Level, Default is None. And The Only Supported option is Gzip. Type: string (or Expression with resultType string).

type
str

Copy sink type. Required. Default value is "RestSink".

Attributes

additional_headers

key value pairs (value should be string type).

additional_headers: Any | None

http_compression_type

Http Compression Type to Send data in compressed format with Optimal Compression Level, Default is None. And The Only Supported option is Gzip. Type: string (or Expression with resultType string).

http_compression_type: Any | None

http_request_timeout

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+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).

http_request_timeout: Any | None

request_interval

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

request_interval: Any | None

request_method

string (or Expression with resultType string).

request_method: Any | None

type

Copy sink type. Required. Default value is "RestSink".

type: Literal['RestSink']