RestSource Class
A copy activity Rest service source.
All required parameters must be populated in order to send to server.
Constructor
RestSource(*, additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, source_retry_count: MutableMapping[str, Any] | None = None, source_retry_wait: MutableMapping[str, Any] | None = None, max_concurrent_connections: MutableMapping[str, Any] | None = None, disable_metrics_collection: MutableMapping[str, Any] | None = None, request_method: MutableMapping[str, Any] | None = None, request_body: MutableMapping[str, Any] | None = None, additional_headers: MutableMapping[str, Any] | None = None, pagination_rules: MutableMapping[str, Any] | None = None, http_request_timeout: MutableMapping[str, Any] | None = None, request_interval: MutableMapping[str, Any] | None = None, additional_columns: MutableMapping[str, Any] | None = None, **kwargs: Any)Keyword-Only Parameters
| Name | Description |
|---|---|
|
additional_properties
|
Unmatched properties from the message are deserialized to this collection. Default value: None
|
|
source_retry_count
|
<xref:JSON>
Source retry count. Type: integer (or Expression with resultType integer). Default value: None
|
|
source_retry_wait
|
<xref:JSON>
Source retry wait. Type: string (or Expression with resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])). Default value: None
|
|
max_concurrent_connections
|
<xref:JSON>
The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). Default value: None
|
|
disable_metrics_collection
|
<xref:JSON>
If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). Default value: None
|
|
request_method
|
<xref:JSON>
The HTTP method used to call the RESTful API. The default is GET. Type: string (or Expression with resultType string). Default value: None
|
|
request_body
|
<xref:JSON>
The HTTP request body to the RESTful API if requestMethod is POST. Type: string (or Expression with resultType string). Default value: None
|
|
additional_headers
|
<xref:JSON>
The additional HTTP headers in the request to the RESTful API. Type: string (or Expression with resultType string). Default value: None
|
|
pagination_rules
|
<xref:JSON>
The pagination rules to compose next page requests. Type: string (or Expression with resultType string). Default value: None
|
|
http_request_timeout
|
<xref:JSON>
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])). Default value: None
|
|
request_interval
|
<xref:JSON>
The time to await before sending next page request. Default value: None
|
|
additional_columns
|
<xref:JSON>
Specifies the additional columns to be added to source data. Type: key value pairs (value should be string type). Default value: None
|
Variables
| Name | Description |
|---|---|
|
additional_properties
|
Unmatched properties from the message are deserialized to this collection. |
|
type
|
Copy source type. Required. |
|
source_retry_count
|
<xref:JSON>
Source retry count. Type: integer (or Expression with resultType integer). |
|
source_retry_wait
|
<xref:JSON>
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
|
<xref:JSON>
The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). |
|
disable_metrics_collection
|
<xref:JSON>
If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). |
|
request_method
|
<xref:JSON>
The HTTP method used to call the RESTful API. The default is GET. Type: string (or Expression with resultType string). |
|
request_body
|
<xref:JSON>
The HTTP request body to the RESTful API if requestMethod is POST. Type: string (or Expression with resultType string). |
|
additional_headers
|
<xref:JSON>
The additional HTTP headers in the request to the RESTful API. Type: string (or Expression with resultType string). |
|
pagination_rules
|
<xref:JSON>
The pagination rules to compose next page requests. Type: string (or Expression with resultType string). |
|
http_request_timeout
|
<xref:JSON>
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
|
<xref:JSON>
The time to await before sending next page request. |
|
additional_columns
|
<xref:JSON>
Specifies the additional columns to be added to source data. Type: key value pairs (value should be string type). |
