RestSource interface

Package:

@azure/synapse-artifacts

A copy activity Rest service source.

Extends

CopySource

Properties

additionalColumns	Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
additionalHeaders	The additional HTTP headers in the request to the RESTful API. Type: string (or Expression with resultType string).
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])).
paginationRules	The pagination rules to compose next page requests. Type: string (or Expression with resultType string).
requestBody	The HTTP request body to the RESTful API if requestMethod is POST. Type: string (or Expression with resultType string).
requestInterval	The time to await before sending next page request.
requestMethod	The HTTP method used to call the RESTful API. The default is GET. Type: string (or Expression with resultType string).
type	Polymorphic discriminator, which specifies the different types this object can be

Inherited Properties

maxConcurrentConnections	The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
sourceRetryCount	Source retry count. Type: integer (or Expression with resultType integer).
sourceRetryWait	Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

Property Details

additionalColumns

Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

additionalColumns?: any

Property Value

any

additionalHeaders

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

additionalHeaders?: any

Property Value

any

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

httpRequestTimeout?: any

Property Value

any

paginationRules

The pagination rules to compose next page requests. Type: string (or Expression with resultType string).

paginationRules?: any

Property Value

any

requestBody

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

requestBody?: any

Property Value

any

requestInterval

The time to await before sending next page request.

requestInterval?: any

Property Value

any

requestMethod

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

requestMethod?: any

Property Value

any

type

Polymorphic discriminator, which specifies the different types this object can be

type: "RestSource"

Property Value

"RestSource"

Inherited Property Details

maxConcurrentConnections

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

maxConcurrentConnections?: any

Property Value

any

Inherited From CopySource.maxConcurrentConnections

sourceRetryCount

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

sourceRetryCount?: any

Property Value

any

Inherited From CopySource.sourceRetryCount

sourceRetryWait

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

sourceRetryWait?: any

Property Value

any

Inherited From CopySource.sourceRetryWait