RestSource Class

Package:: com.azure.analytics.synapse.artifacts.models

Maven Artifact:: com.azure:azure-analytics-synapse-artifacts:1.0.0-beta.17

java.lang.Object
- com.azure.analytics.synapse.artifacts.models.CopySource
- - com.azure.analytics.synapse.artifacts.models.RestSource

public final class RestSource
extends CopySource

A copy activity Rest service source.

Constructor Summary

Constructor	Description
RestSource()	Creates an instance of RestSource class.

Method Summary

Modifier and Type	Method and Description
static RestSource	fromJson(JsonReader jsonReader) Reads an instance of RestSource from the JsonReader.
Object	getAdditionalColumns() Get the additionalColumns property: Specifies the additional columns to be added to source data.
Object	getAdditionalHeaders() Get the additionalHeaders property: The additional HTTP headers in the request to the RESTful API.
Object	getHttpRequestTimeout() Get the httpRequestTimeout property: The timeout (TimeSpan) to get an HTTP response.
Object	getPaginationRules() Get the paginationRules property: The pagination rules to compose next page requests.
Object	getRequestBody() Get the requestBody property: The HTTP request body to the RESTful API if requestMethod is POST.
Object	getRequestInterval() Get the requestInterval property: The time to await before sending next page request.
Object	getRequestMethod() Get the requestMethod property: The HTTP method used to call the RESTful API.
String	getType() Get the type property: Copy source type.
RestSource	setAdditionalColumns(Object additionalColumns) Set the additionalColumns property: Specifies the additional columns to be added to source data.
RestSource	setAdditionalHeaders(Object additionalHeaders) Set the additionalHeaders property: The additional HTTP headers in the request to the RESTful API.
RestSource	setHttpRequestTimeout(Object httpRequestTimeout) Set the httpRequestTimeout property: The timeout (TimeSpan) to get an HTTP response.
RestSource	setMaxConcurrentConnections(Object maxConcurrentConnections) Set the maxConcurrentConnections property: The maximum concurrent connection count for the source data store.
RestSource	setPaginationRules(Object paginationRules) Set the paginationRules property: The pagination rules to compose next page requests.
RestSource	setRequestBody(Object requestBody) Set the requestBody property: The HTTP request body to the RESTful API if requestMethod is POST.
RestSource	setRequestInterval(Object requestInterval) Set the requestInterval property: The time to await before sending next page request.
RestSource	setRequestMethod(Object requestMethod) Set the requestMethod property: The HTTP method used to call the RESTful API.
RestSource	setSourceRetryCount(Object sourceRetryCount) Set the sourceRetryCount property: Source retry count.
RestSource	setSourceRetryWait(Object sourceRetryWait) Set the sourceRetryWait property: Source retry wait.
JsonWriter	toJson(JsonWriter jsonWriter)

Methods inherited from CopySource

fromJson getAdditionalProperties getMaxConcurrentConnections getSourceRetryCount getSourceRetryWait getType setAdditionalProperties setMaxConcurrentConnections setSourceRetryCount setSourceRetryWait toJson

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

RestSource

public RestSource()

Creates an instance of RestSource class.

Method Details

fromJson

public static RestSource fromJson(JsonReader jsonReader)

Reads an instance of RestSource from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of RestSource if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If an error occurs while reading the RestSource.

getAdditionalColumns

public Object getAdditionalColumns()

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

Returns:

the additionalColumns value.

getAdditionalHeaders

public Object getAdditionalHeaders()

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

Returns:

the additionalHeaders value.

getHttpRequestTimeout

public Object getHttpRequestTimeout()

Get the httpRequestTimeout property: 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])).

Returns:

the httpRequestTimeout value.

getPaginationRules

public Object getPaginationRules()

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

Returns:

the paginationRules value.

getRequestBody

public Object getRequestBody()

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

Returns:

the requestBody value.

getRequestInterval

public Object getRequestInterval()

Get the requestInterval property: The time to await before sending next page request.

Returns:

the requestInterval value.

getRequestMethod

public Object getRequestMethod()

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

Returns:

the requestMethod value.

getType

public String getType()

Get the type property: Copy source type.

Overrides:

RestSource.getType()

Returns:

the type value.

setAdditionalColumns

public RestSource setAdditionalColumns(Object additionalColumns)

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

Parameters:

additionalColumns - the additionalColumns value to set.

Returns:

the RestSource object itself.

setAdditionalHeaders

public RestSource setAdditionalHeaders(Object additionalHeaders)

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

Parameters:

additionalHeaders - the additionalHeaders value to set.

Returns:

the RestSource object itself.

setHttpRequestTimeout

public RestSource setHttpRequestTimeout(Object httpRequestTimeout)

Set the httpRequestTimeout property: 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])).

Parameters:

httpRequestTimeout - the httpRequestTimeout value to set.

Returns:

the RestSource object itself.

setMaxConcurrentConnections

public RestSource setMaxConcurrentConnections(Object maxConcurrentConnections)

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

Overrides:

RestSource.setMaxConcurrentConnections(Object maxConcurrentConnections)

Parameters:

maxConcurrentConnections

setPaginationRules

public RestSource setPaginationRules(Object paginationRules)

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

Parameters:

paginationRules - the paginationRules value to set.

Returns:

the RestSource object itself.

setRequestBody

public RestSource setRequestBody(Object requestBody)

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

Parameters:

requestBody - the requestBody value to set.

Returns:

the RestSource object itself.

setRequestInterval

public RestSource setRequestInterval(Object requestInterval)

Set the requestInterval property: The time to await before sending next page request.

Parameters:

requestInterval - the requestInterval value to set.

Returns:

the RestSource object itself.

setRequestMethod

public RestSource setRequestMethod(Object requestMethod)

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

Parameters:

requestMethod - the requestMethod value to set.

Returns:

the RestSource object itself.

setSourceRetryCount

public RestSource setSourceRetryCount(Object sourceRetryCount)

Set the sourceRetryCount property: Source retry count. Type: integer (or Expression with resultType integer).

Overrides:

RestSource.setSourceRetryCount(Object sourceRetryCount)

Parameters:

sourceRetryCount

setSourceRetryWait

public RestSource setSourceRetryWait(Object sourceRetryWait)

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

Overrides:

RestSource.setSourceRetryWait(Object sourceRetryWait)

Parameters:

sourceRetryWait

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

RestSource.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

Applies to

Feedback

Was this page helpful?