RestSource Class

A copy activity Rest service source.

Constructor

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

Variables

Name Description
source_retry_count
any

Source retry count. Type: integer (or Expression with resultType integer).
source_retry_wait
any

Source 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 source 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 GET. Type: string (or Expression with resultType string).
request_body
any

The HTTP request body to the RESTful API if requestMethod is POST. Type: string (or Expression with resultType string).
additional_headers
any

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

The pagination rules to compose next page requests. Type: string (or Expression with resultType string).
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 page request.
additional_columns
any

Specifies the additional columns to be added to source data. Type: key value pairs (value should be string type).
type
str

Copy source type. Required. Default value is "RestSource".

Attributes

additional_columns

key value pairs (value should be string type).

additional_columns: Any | None

additional_headers

string (or Expression with resultType string).

additional_headers: 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

pagination_rules

string (or Expression with resultType string).

pagination_rules: Any | None

request_body

string (or Expression with resultType string).

request_body: Any | None

request_interval

The time to await before sending next page request.

request_interval: Any | None

request_method

string (or Expression with resultType string).

request_method: Any | None

type

Copy source type. Required. Default value is "RestSource".

type: Literal['RestSource']