HttpReadSettings interface

Http read settings.

Extends

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

requestBody

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

requestMethod

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

requestTimeout

Specifies the timeout for a HTTP client to get HTTP response from HTTP server. Type: string (or Expression with resultType string).

type

The read setting type.

Inherited Properties

additionalProperties

Additional properties

disableMetricsCollection

If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).

maxConcurrentConnections

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

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

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

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

requestTimeout

Specifies the timeout for a HTTP client to get HTTP response from HTTP server. Type: string (or Expression with resultType string).

requestTimeout?: any

Property Value

any

type

The read setting type.

type: "HttpReadSettings"

Property Value

"HttpReadSettings"

Inherited Property Details

additionalProperties

Additional properties

additionalProperties?: Record<string, any>

Property Value

Record<string, any>

Inherited From StoreReadSettings.additionalProperties

disableMetricsCollection

If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).

disableMetricsCollection?: any

Property Value

any

Inherited From StoreReadSettings.disableMetricsCollection

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 StoreReadSettings.maxConcurrentConnections