Show / Hide Table of Contents

Class AzureDataLakeStoreDataset

Azure Data Lake Store dataset.

Inheritance
System.Object
DataFactoryDatasetProperties
AzureDataLakeStoreDataset
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 AzureDataLakeStoreDataset : Azure.ResourceManager.DataFactory.Models.DataFactoryDatasetProperties, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.DataFactory.Models.AzureDataLakeStoreDataset>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.DataFactory.Models.AzureDataLakeStoreDataset>

Constructors

AzureDataLakeStoreDataset(DataFactoryLinkedServiceReference)

Initializes a new instance of AzureDataLakeStoreDataset.

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

Linked service reference.

Exceptions
System.ArgumentNullException

linkedServiceName is null.

Properties

Compression

The data compression method used for the item(s) in the Azure Data Lake Store.

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

FileName

The name of the file in the Azure Data Lake Store. Type: string (or Expression with resultType string).

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

FolderPath

Path to the folder in the Azure Data Lake Store. Type: string (or Expression with resultType string).

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

Format

The format of the Data Lake Store. 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

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<AzureDataLakeStoreDataset>.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.AzureDataLakeStoreDataset IJsonModel<AzureDataLakeStoreDataset>.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
AzureDataLakeStoreDataset

A T representation of the JSON value.

Exceptions
System.FormatException

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

IJsonModel<AzureDataLakeStoreDataset>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

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

Declaration
void IJsonModel<AzureDataLakeStoreDataset>.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<AzureDataLakeStoreDataset>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided System.BinaryData into a model.

Declaration
Azure.ResourceManager.DataFactory.Models.AzureDataLakeStoreDataset IPersistableModel<AzureDataLakeStoreDataset>.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
AzureDataLakeStoreDataset

A T representation of the data.

Exceptions
System.FormatException

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

IPersistableModel<AzureDataLakeStoreDataset>.GetFormatFromOptions(ModelReaderWriterOptions)

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

Declaration
string IPersistableModel<AzureDataLakeStoreDataset>.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<AzureDataLakeStoreDataset>.Write(ModelReaderWriterOptions)

Writes the model into a System.BinaryData.

Declaration
BinaryData IPersistableModel<AzureDataLakeStoreDataset>.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