Show / Hide Table of Contents

Class DataFactoryHttpDataset

A file in an HTTP web server.

Inheritance
System.Object
DataFactoryDatasetProperties
DataFactoryHttpDataset
Inherited Members
DataFactoryDatasetProperties.AdditionalProperties
DataFactoryDatasetProperties.Annotations
DataFactoryDatasetProperties.Description
DataFactoryDatasetProperties.FolderName
DataFactoryDatasetProperties.LinkedServiceName
DataFactoryDatasetProperties.Parameters
DataFactoryDatasetProperties.Schema
DataFactoryDatasetProperties.Structure
DataFactoryDatasetProperties.IJsonModel<DataFactoryDatasetProperties>.Create(Utf8JsonReader, ModelReaderWriterOptions)
DataFactoryDatasetProperties.IJsonModel<DataFactoryDatasetProperties>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
DataFactoryDatasetProperties.IPersistableModel<DataFactoryDatasetProperties>.Create(BinaryData, ModelReaderWriterOptions)
DataFactoryDatasetProperties.IPersistableModel<DataFactoryDatasetProperties>.GetFormatFromOptions(ModelReaderWriterOptions)
DataFactoryDatasetProperties.IPersistableModel<DataFactoryDatasetProperties>.Write(ModelReaderWriterOptions)
Namespace: System.Dynamic.ExpandoObject
Assembly: Azure.ResourceManager.DataFactory.dll
Syntax
public class DataFactoryHttpDataset : Azure.ResourceManager.DataFactory.Models.DataFactoryDatasetProperties, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.DataFactory.Models.DataFactoryHttpDataset>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.DataFactory.Models.DataFactoryHttpDataset>

Constructors

DataFactoryHttpDataset(DataFactoryLinkedServiceReference)

Initializes a new instance of DataFactoryHttpDataset.

Declaration
public DataFactoryHttpDataset (Azure.Core.Expressions.DataFactory.DataFactoryLinkedServiceReference linkedServiceName);
Parameters
Azure.Core.Expressions.DataFactory.DataFactoryLinkedServiceReference linkedServiceName

Linked service reference.

Exceptions
System.ArgumentNullException

linkedServiceName is null.

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

Declaration
public Azure.Core.Expressions.DataFactory.DataFactoryElement<string> AdditionalHeaders { get; set; }
Property Value
Azure.Core.Expressions.DataFactory.DataFactoryElement<System.String>

Compression

The data compression method used on files.

Declaration
public Azure.ResourceManager.DataFactory.Models.DatasetCompression Compression { get; set; }
Property Value
DatasetCompression

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 DatasetAvroFormat, DatasetJsonFormat, DatasetOrcFormat, DatasetParquetFormat and DatasetTextFormat.

Declaration
public Azure.ResourceManager.DataFactory.Models.DatasetStorageFormat Format { get; set; }
Property Value
DatasetStorageFormat

RelativeUri

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

Declaration
public Azure.Core.Expressions.DataFactory.DataFactoryElement<string> RelativeUri { get; set; }
Property Value
Azure.Core.Expressions.DataFactory.DataFactoryElement<System.String>

RequestBody

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

Declaration
public Azure.Core.Expressions.DataFactory.DataFactoryElement<string> RequestBody { get; set; }
Property Value
Azure.Core.Expressions.DataFactory.DataFactoryElement<System.String>

RequestMethod

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

Declaration
public Azure.Core.Expressions.DataFactory.DataFactoryElement<string> RequestMethod { get; set; }
Property Value
Azure.Core.Expressions.DataFactory.DataFactoryElement<System.String>

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Declaration
protected override void JsonModelWriteCore (System.Text.Json.Utf8JsonWriter writer, System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.Text.Json.Utf8JsonWriter writer

The JSON writer.

System.ClientModel.Primitives.ModelReaderWriterOptions options

The client options for reading and writing models.

Explicit Interface Implementations

IJsonModel<DataFactoryHttpDataset>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

Declaration
Azure.ResourceManager.DataFactory.Models.DataFactoryHttpDataset IJsonModel<DataFactoryHttpDataset>.Create (ref System.Text.Json.Utf8JsonReader reader, System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.Text.Json.Utf8JsonReader reader

The System.Text.Json.Utf8JsonReader to read.

System.ClientModel.Primitives.ModelReaderWriterOptions options

The System.ClientModel.Primitives.ModelReaderWriterOptions to use.

Returns
DataFactoryHttpDataset

A T representation of the JSON value.

Exceptions
System.FormatException

If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.

IJsonModel<DataFactoryHttpDataset>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided System.Text.Json.Utf8JsonWriter.

Declaration
void IJsonModel<DataFactoryHttpDataset>.Write (System.Text.Json.Utf8JsonWriter writer, System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.Text.Json.Utf8JsonWriter writer

The System.Text.Json.Utf8JsonWriter to write into.

System.ClientModel.Primitives.ModelReaderWriterOptions options

The System.ClientModel.Primitives.ModelReaderWriterOptions to use.

Exceptions
System.FormatException

If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.

IPersistableModel<DataFactoryHttpDataset>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided System.BinaryData into a model.

Declaration
Azure.ResourceManager.DataFactory.Models.DataFactoryHttpDataset IPersistableModel<DataFactoryHttpDataset>.Create (BinaryData data, System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.BinaryData data

The System.BinaryData to parse.

System.ClientModel.Primitives.ModelReaderWriterOptions options

The System.ClientModel.Primitives.ModelReaderWriterOptions to use.

Returns
DataFactoryHttpDataset

A T representation of the data.

Exceptions
System.FormatException

If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.

IPersistableModel<DataFactoryHttpDataset>.GetFormatFromOptions(ModelReaderWriterOptions)

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

Declaration
string IPersistableModel<DataFactoryHttpDataset>.GetFormatFromOptions (System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.ClientModel.Primitives.ModelReaderWriterOptions options

The System.ClientModel.Primitives.ModelReaderWriterOptions to consider when serializing and deserializing the model.

Returns
System.String

The format that the model uses when communicating with the service.

IPersistableModel<DataFactoryHttpDataset>.Write(ModelReaderWriterOptions)

Writes the model into a System.BinaryData.

Declaration
BinaryData IPersistableModel<DataFactoryHttpDataset>.Write (System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.ClientModel.Primitives.ModelReaderWriterOptions options

The System.ClientModel.Primitives.ModelReaderWriterOptions to use.

Returns
System.BinaryData

A binary representation of the written model.

Exceptions
System.FormatException

If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.

Back to top Azure SDK for .NET