Partilhar via


HttpReadSettings Class

Definition

Http read settings.

public class HttpReadSettings : Azure.ResourceManager.DataFactory.Models.StoreReadSettings, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.DataFactory.Models.HttpReadSettings>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.DataFactory.Models.HttpReadSettings>
public class HttpReadSettings : Azure.ResourceManager.DataFactory.Models.StoreReadSettings
type HttpReadSettings = class
    inherit StoreReadSettings
    interface IJsonModel<HttpReadSettings>
    interface IPersistableModel<HttpReadSettings>
type HttpReadSettings = class
    inherit StoreReadSettings
Public Class HttpReadSettings
Inherits StoreReadSettings
Implements IJsonModel(Of HttpReadSettings), IPersistableModel(Of HttpReadSettings)
Public Class HttpReadSettings
Inherits StoreReadSettings
Inheritance
HttpReadSettings
Implements

Constructors

HttpReadSettings()

Initializes a new instance of HttpReadSettings.

Properties

AdditionalColumns

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

To assign an object to this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""): Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.

AdditionalHeaders

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

AdditionalProperties

Additional Properties

To assign an object to the value of this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""): Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.

(Inherited from StoreReadSettings)
DisableMetricsCollection

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

(Inherited from StoreReadSettings)
MaxConcurrentConnections

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

(Inherited from StoreReadSettings)
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).

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from StoreReadSettings)

Explicit Interface Implementations

IJsonModel<HttpReadSettings>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<HttpReadSettings>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IJsonModel<StoreReadSettings>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

(Inherited from StoreReadSettings)
IJsonModel<StoreReadSettings>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

(Inherited from StoreReadSettings)
IPersistableModel<HttpReadSettings>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<HttpReadSettings>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<HttpReadSettings>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

IPersistableModel<StoreReadSettings>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

(Inherited from StoreReadSettings)
IPersistableModel<StoreReadSettings>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

(Inherited from StoreReadSettings)
IPersistableModel<StoreReadSettings>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

(Inherited from StoreReadSettings)

Applies to