Class FileShareDataset

public class FileShareDataset : Azure.ResourceManager.DataFactory.Models.DataFactoryDatasetProperties, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.DataFactory.Models.FileShareDataset>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.DataFactory.Models.FileShareDataset>

Constructors

FileShareDataset(DataFactoryLinkedServiceReference)

Initializes a new instance of FileShareDataset.

Declaration

public FileShareDataset (Azure.Core.Expressions.DataFactory.DataFactoryLinkedServiceReference linkedServiceName);

Parameters

Azure.Core.Expressions.DataFactory.DataFactoryLinkedServiceReference linkedServiceName

Linked service reference.

Exceptions

System.ArgumentNullException

linkedServiceName is null.

Properties

FileFilter

Specify a filter to be used to select a subset of files in the folderPath rather than all files. Type: string (or Expression with resultType string).

Declaration

public Azure.Core.Expressions.DataFactory.DataFactoryElement<string> FileFilter { get; set; }

Property Value

Azure.Core.Expressions.DataFactory.DataFactoryElement<System.String>

FileName

The name of the on-premises file system. 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

The path of the on-premises file system. 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>

The format of the 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

ModifiedDatetimeEnd

The end of file's modified datetime. Type: string (or Expression with resultType string).

Declaration

public Azure.Core.Expressions.DataFactory.DataFactoryElement<string> ModifiedDatetimeEnd { get; set; }

Property Value

Azure.Core.Expressions.DataFactory.DataFactoryElement<System.String>

ModifiedDatetimeStart

The start of file's modified datetime. Type: string (or Expression with resultType string).

Declaration

public Azure.Core.Expressions.DataFactory.DataFactoryElement<string> ModifiedDatetimeStart { 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<FileShareDataset>.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.FileShareDataset IJsonModel<FileShareDataset>.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

FileShareDataset

A T representation of the JSON value.

Exceptions

System.FormatException

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

IJsonModel<FileShareDataset>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

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

Declaration

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

Converts the provided System.BinaryData into a model.

Declaration

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

FileShareDataset

A T representation of the data.

Exceptions

System.FormatException

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

IPersistableModel<FileShareDataset>.GetFormatFromOptions(ModelReaderWriterOptions)

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

Declaration

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

Writes the model into a System.BinaryData.

Declaration

BinaryData IPersistableModel<FileShareDataset>.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.