FileShareDataset Class

Definition

Namespace:

Azure.Analytics.Synapse.Artifacts.Models

Assembly:

Azure.Analytics.Synapse.Artifacts.dll

Package:

Azure.Analytics.Synapse.Artifacts v1.0.0-preview.20

Source:

FileShareDataset.cs

An on-premises file system dataset.

[System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.FileShareDataset+FileShareDatasetConverter))]
public class FileShareDataset : Azure.Analytics.Synapse.Artifacts.Models.Dataset

[<System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.FileShareDataset+FileShareDatasetConverter))>]
type FileShareDataset = class
    inherit Dataset

Public Class FileShareDataset
Inherits Dataset

Inheritance

Object

Dataset

FileShareDataset

Attributes

JsonConverterAttribute

Constructors

FileShareDataset(LinkedServiceReference)

Initializes a new instance of FileShareDataset.

Properties

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 for the file system.
Description	Dataset description. (Inherited from Dataset)
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).
FileName	The name of the on-premises file system. Type: string (or Expression with resultType string).
Folder	The folder that this Dataset is in. If not specified, Dataset will appear at the root level. (Inherited from Dataset)
FolderPath	The path of the on-premises file system. Type: string (or Expression with resultType string).
Format	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 AvroFormat, JsonFormat, OrcFormat, ParquetFormat and TextFormat.
LinkedServiceName	Linked service reference. (Inherited from Dataset)
ModifiedDatetimeEnd	The end of file's modified datetime. Type: string (or Expression with resultType string).
ModifiedDatetimeStart	The start of file's modified datetime. Type: string (or Expression with resultType string).
Parameters	Parameters for dataset. (Inherited from Dataset)
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)