FileShareDataset interface
An on-premises file system dataset.
- Extends
Properties
| compression | The data compression method used for the file system. |
| file |
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). |
| file |
The name of the on-premises file system. Type: string (or Expression with resultType string). |
| folder |
The path of the on-premises file system. Type: string (or Expression with resultType string). |
| format | The format of the files. |
| modified |
The end of file's modified datetime. Type: string (or Expression with resultType string). |
| modified |
The start of file's modified datetime. Type: string (or Expression with resultType string). |
| type | Polymorphic discriminator, which specifies the different types this object can be |
Inherited Properties
| annotations | List of tags that can be used for describing the Dataset. |
| description | Dataset description. |
| folder | The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
| linked |
Linked service reference. |
| parameters | Parameters for dataset. |
| schema | Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
| structure | Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
Property Details
compression
The data compression method used for the file system.
compression?: DatasetCompression
Property Value
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).
fileFilter?: any
Property Value
any
fileName
The name of the on-premises file system. Type: string (or Expression with resultType string).
fileName?: any
Property Value
any
folderPath
The path of the on-premises file system. Type: string (or Expression with resultType string).
folderPath?: any
Property Value
any
format
The format of the files.
format?: DatasetStorageFormatUnion
Property Value
modifiedDatetimeEnd
The end of file's modified datetime. Type: string (or Expression with resultType string).
modifiedDatetimeEnd?: any
Property Value
any
modifiedDatetimeStart
The start of file's modified datetime. Type: string (or Expression with resultType string).
modifiedDatetimeStart?: any
Property Value
any
type
Polymorphic discriminator, which specifies the different types this object can be
type: "FileShare"
Property Value
"FileShare"
Inherited Property Details
annotations
List of tags that can be used for describing the Dataset.
annotations?: any[]
Property Value
any[]
Inherited From Dataset.annotations
description
folder
The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
folder?: DatasetFolder
Property Value
Inherited From Dataset.folder
linkedServiceName
Linked service reference.
linkedServiceName: LinkedServiceReference
Property Value
Inherited From Dataset.linkedServiceName
parameters
Parameters for dataset.
parameters?: {[propertyName: string]: ParameterSpecification}
Property Value
{[propertyName: string]: ParameterSpecification}
Inherited From Dataset.parameters
schema
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
schema?: any
Property Value
any
Inherited From Dataset.schema
structure
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
structure?: any
Property Value
any
Inherited From Dataset.structure