FileShareDataset Class

An on-premises file system dataset.

All required parameters must be populated in order to send to Azure.

Inheritance

azure.mgmt.datafactory.models._models_py3.Dataset

FileShareDataset

Constructor

FileShareDataset(*, linked_service_name: _models.LinkedServiceReference, additional_properties: Optional[Dict[str, Any]] = None, description: Optional[str] = None, structure: Optional[Any] = None, schema: Optional[Any] = None, parameters: Optional[Dict[str, _models.ParameterSpecification]] = None, annotations: Optional[List[Any]] = None, folder: Optional[_models.DatasetFolder] = None, folder_path: Optional[Any] = None, file_name: Optional[Any] = None, modified_datetime_start: Optional[Any] = None, modified_datetime_end: Optional[Any] = None, format: Optional[_models.DatasetStorageFormat] = None, file_filter: Optional[Any] = None, compression: Optional[_models.DatasetCompression] = None, **kwargs)

Variables

additional_properties

dict[str, any]

Unmatched properties from the message are deserialized to this collection.

type

str

Required. Type of dataset.Constant filled by server.

description

str

Dataset description.

structure

any

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

schema

any

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

linked_service_name

LinkedServiceReference

Required. Linked service reference.

parameters

dict[str, ParameterSpecification]

Parameters for dataset.

annotations

list[any]

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

folder

DatasetFolder

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

folder_path

any

The path of the on-premises file system. Type: string (or Expression with resultType string).

file_name

any

The name of the on-premises file system. Type: string (or Expression with resultType string).

modified_datetime_start

any

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

modified_datetime_end

any

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

format

DatasetStorageFormat

The format of the files.

file_filter

any

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

compression

DatasetCompression

The data compression method used for the file system.