Package com.azure.analytics.synapse.artifacts.models

Class FileShareDataset

  • public class FileShareDataset
extends Dataset
    An on-premises file system dataset.

    • Constructor Detail

      • FileShareDataset

        public FileShareDataset()

    • Method Detail

      • getFolderPath

        public Object getFolderPath()
        Get the folderPath property: The path of the on-premises file system. Type: string (or Expression with resultType string).
        Returns:
        the folderPath value.

      • setFolderPath

        public FileShareDataset setFolderPath​(Object folderPath)
        Set the folderPath property: The path of the on-premises file system. Type: string (or Expression with resultType string).
        Parameters:
        folderPath - the folderPath value to set.
        Returns:
        the FileShareDataset object itself.

      • getFileName

        public Object getFileName()
        Get the fileName property: The name of the on-premises file system. Type: string (or Expression with resultType string).
        Returns:
        the fileName value.

      • setFileName

        public FileShareDataset setFileName​(Object fileName)
        Set the fileName property: The name of the on-premises file system. Type: string (or Expression with resultType string).
        Parameters:
        fileName - the fileName value to set.
        Returns:
        the FileShareDataset object itself.

      • getModifiedDatetimeStart

        public Object getModifiedDatetimeStart()
        Get the modifiedDatetimeStart property: The start of file's modified datetime. Type: string (or Expression with resultType string).
        Returns:
        the modifiedDatetimeStart value.

      • setModifiedDatetimeStart

        public FileShareDataset setModifiedDatetimeStart​(Object modifiedDatetimeStart)
        Set the modifiedDatetimeStart property: The start of file's modified datetime. Type: string (or Expression with resultType string).
        Parameters:
        modifiedDatetimeStart - the modifiedDatetimeStart value to set.
        Returns:
        the FileShareDataset object itself.

      • getModifiedDatetimeEnd

        public Object getModifiedDatetimeEnd()
        Get the modifiedDatetimeEnd property: The end of file's modified datetime. Type: string (or Expression with resultType string).
        Returns:
        the modifiedDatetimeEnd value.

      • setModifiedDatetimeEnd

        public FileShareDataset setModifiedDatetimeEnd​(Object modifiedDatetimeEnd)
        Set the modifiedDatetimeEnd property: The end of file's modified datetime. Type: string (or Expression with resultType string).
        Parameters:
        modifiedDatetimeEnd - the modifiedDatetimeEnd value to set.
        Returns:
        the FileShareDataset object itself.

      • getFormat

        public DatasetStorageFormat getFormat()
        Get the format property: The format of the files.
        Returns:
        the format value.

      • setFormat

        public FileShareDataset setFormat​(DatasetStorageFormat format)
        Set the format property: The format of the files.
        Parameters:
        format - the format value to set.
        Returns:
        the FileShareDataset object itself.

      • getFileFilter

        public Object getFileFilter()
        Get the fileFilter property: 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).
        Returns:
        the fileFilter value.

      • setFileFilter

        public FileShareDataset setFileFilter​(Object fileFilter)
        Set the fileFilter property: 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).
        Parameters:
        fileFilter - the fileFilter value to set.
        Returns:
        the FileShareDataset object itself.

      • getCompression

        public DatasetCompression getCompression()
        Get the compression property: The data compression method used for the file system.
        Returns:
        the compression value.

      • setCompression

        public FileShareDataset setCompression​(DatasetCompression compression)
        Set the compression property: The data compression method used for the file system.
        Parameters:
        compression - the compression value to set.
        Returns:
        the FileShareDataset object itself.

      • setDescription

        public FileShareDataset setDescription​(String description)
        Set the description property: Dataset description.
        Overrides:
        setDescription in class Dataset
        Parameters:
        description - the description value to set.
        Returns:
        the Dataset object itself.

      • setStructure

        public FileShareDataset setStructure​(Object structure)
        Set the structure property: Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
        Overrides:
        setStructure in class Dataset
        Parameters:
        structure - the structure value to set.
        Returns:
        the Dataset object itself.

      • setSchema

        public FileShareDataset setSchema​(Object schema)
        Set the schema property: Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
        Overrides:
        setSchema in class Dataset
        Parameters:
        schema - the schema value to set.
        Returns:
        the Dataset object itself.

      • setLinkedServiceName

        public FileShareDataset setLinkedServiceName​(LinkedServiceReference linkedServiceName)
        Set the linkedServiceName property: Linked service reference.
        Overrides:
        setLinkedServiceName in class Dataset
        Parameters:
        linkedServiceName - the linkedServiceName value to set.
        Returns:
        the Dataset object itself.

      • setAnnotations

        public FileShareDataset setAnnotations​(List<Object> annotations)
        Set the annotations property: List of tags that can be used for describing the Dataset.
        Overrides:
        setAnnotations in class Dataset
        Parameters:
        annotations - the annotations value to set.
        Returns:
        the Dataset object itself.

      • setFolder

        public FileShareDataset setFolder​(DatasetFolder folder)
        Set the folder property: The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
        Overrides:
        setFolder in class Dataset
        Parameters:
        folder - the folder value to set.
        Returns:
        the Dataset object itself.