Share via

HttpDataset Class

  • Reference

Definition

Namespace:
Azure.Analytics.Synapse.Artifacts.Models
Assembly:
Azure.Analytics.Synapse.Artifacts.dll
Package:
Azure.Analytics.Synapse.Artifacts v1.0.0-preview.20
Source:
HttpDataset.cs

A file in an HTTP web server.

[System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.HttpDataset+HttpDatasetConverter))]
public class HttpDataset : Azure.Analytics.Synapse.Artifacts.Models.Dataset
[<System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.HttpDataset+HttpDatasetConverter))>]
type HttpDataset = class
    inherit Dataset
Public Class HttpDataset
Inherits Dataset
Inheritance
Object
Dataset
HttpDataset
Attributes
JsonConverterAttribute

Constructors

HttpDataset(LinkedServiceReference)

Initializes a new instance of HttpDataset.

Properties

AdditionalHeaders

The headers for the HTTP Request. e.g. request-header-name-1:request-header-value-1 ... request-header-name-n:request-header-value-n Type: string (or Expression with resultType string).
AdditionalProperties

Additional Properties.

(Inherited from Dataset)
Annotations

List of tags that can be used for describing the Dataset.

(Inherited from Dataset)
Compression

The data compression method used on files.
Description

Dataset description.

(Inherited from Dataset)
Folder

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

(Inherited from Dataset)
Format

The format of files. Please note DatasetStorageFormat is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AvroFormat, JsonFormat, OrcFormat, ParquetFormat and TextFormat.
LinkedServiceName

Linked service reference.

(Inherited from Dataset)
Parameters

Parameters for dataset.

(Inherited from Dataset)
RelativeUrl

The relative URL based on the URL in the HttpLinkedService refers to an HTTP file Type: string (or Expression with resultType string).
RequestBody

The body for the HTTP request. Type: string (or Expression with resultType string).
RequestMethod

The HTTP method for the HTTP request. Type: string (or Expression with resultType string).
Schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

(Inherited from Dataset)
Structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

(Inherited from Dataset)

Applies to