HttpReadSettings Class

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

public final class HttpReadSettings
extends StoreReadSettings

Http read settings.

Constructor Summary

Constructor Description
HttpReadSettings()

Creates an instance of HttpReadSettings class.

Method Summary

Modifier and Type Method and Description
static HttpReadSettings fromJson(JsonReader jsonReader)

Reads an instance of HttpReadSettings 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 getEnablePartitionDiscovery()

Get the enablePartitionDiscovery property: Indicates whether to enable partition discovery.
Object getPartitionRootPath()

Get the partitionRootPath property: Specify the root path where partition discovery starts from.
Object getRequestBody()

Get the requestBody property: The HTTP request body to the RESTful API if requestMethod is POST.
Object getRequestMethod()

Get the requestMethod property: The HTTP method used to call the RESTful API.
Object getRequestTimeout()

Get the requestTimeout property: Specifies the timeout for a HTTP client to get HTTP response from HTTP server.
String getType()

Get the type property: The read setting type.
HttpReadSettings setAdditionalColumns(Object additionalColumns)

Set the additionalColumns property: Specifies the additional columns to be added to source data.
HttpReadSettings setAdditionalHeaders(Object additionalHeaders)

Set the additionalHeaders property: The additional HTTP headers in the request to the RESTful API.
HttpReadSettings setEnablePartitionDiscovery(Object enablePartitionDiscovery)

Set the enablePartitionDiscovery property: Indicates whether to enable partition discovery.
HttpReadSettings setMaxConcurrentConnections(Object maxConcurrentConnections)

Set the maxConcurrentConnections property: The maximum concurrent connection count for the source data store.
HttpReadSettings setPartitionRootPath(Object partitionRootPath)

Set the partitionRootPath property: Specify the root path where partition discovery starts from.
HttpReadSettings setRequestBody(Object requestBody)

Set the requestBody property: The HTTP request body to the RESTful API if requestMethod is POST.
HttpReadSettings setRequestMethod(Object requestMethod)

Set the requestMethod property: The HTTP method used to call the RESTful API.
HttpReadSettings setRequestTimeout(Object requestTimeout)

Set the requestTimeout property: Specifies the timeout for a HTTP client to get HTTP response from HTTP server.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from StoreReadSettings

fromJson getAdditionalProperties getMaxConcurrentConnections getType setAdditionalProperties setMaxConcurrentConnections toJson

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

HttpReadSettings

public HttpReadSettings()

Creates an instance of HttpReadSettings class.

Method Details

fromJson

public static HttpReadSettings fromJson(JsonReader jsonReader)

Reads an instance of HttpReadSettings from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of HttpReadSettings 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 HttpReadSettings.

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.

getEnablePartitionDiscovery

public Object getEnablePartitionDiscovery()

Get the enablePartitionDiscovery property: Indicates whether to enable partition discovery. Type: boolean (or Expression with resultType boolean).

Returns:

the enablePartitionDiscovery value.

getPartitionRootPath

public Object getPartitionRootPath()

Get the partitionRootPath property: Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string).

Returns:

the partitionRootPath 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.

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.

getRequestTimeout

public Object getRequestTimeout()

Get the requestTimeout property: Specifies the timeout for a HTTP client to get HTTP response from HTTP server.

Returns:

the requestTimeout value.

getType

public String getType()

Get the type property: The read setting type.

Overrides:

HttpReadSettings.getType()

Returns:

the type value.

setAdditionalColumns

public HttpReadSettings 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 HttpReadSettings object itself.

setAdditionalHeaders

public HttpReadSettings 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 HttpReadSettings object itself.

setEnablePartitionDiscovery

public HttpReadSettings setEnablePartitionDiscovery(Object enablePartitionDiscovery)

Set the enablePartitionDiscovery property: Indicates whether to enable partition discovery. Type: boolean (or Expression with resultType boolean).

Parameters:

enablePartitionDiscovery - the enablePartitionDiscovery value to set.

Returns:

the HttpReadSettings object itself.

setMaxConcurrentConnections

public HttpReadSettings 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:

HttpReadSettings.setMaxConcurrentConnections(Object maxConcurrentConnections)

Parameters:

maxConcurrentConnections

setPartitionRootPath

public HttpReadSettings setPartitionRootPath(Object partitionRootPath)

Set the partitionRootPath property: Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string).

Parameters:

partitionRootPath - the partitionRootPath value to set.

Returns:

the HttpReadSettings object itself.

setRequestBody

public HttpReadSettings 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 HttpReadSettings object itself.

setRequestMethod

public HttpReadSettings 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 HttpReadSettings object itself.

setRequestTimeout

public HttpReadSettings setRequestTimeout(Object requestTimeout)

Set the requestTimeout property: Specifies the timeout for a HTTP client to get HTTP response from HTTP server.

Parameters:

requestTimeout - the requestTimeout value to set.

Returns:

the HttpReadSettings object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

HttpReadSettings.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to