Class FileShareDataset


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

      • FileShareDataset

        public FileShareDataset()
    • Method Detail

      • withDescription

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

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

        public FileShareDataset withSchema​(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:
        withSchema in class Dataset
        Parameters:
        schema - the schema value to set.
        Returns:
        the Dataset object itself.
      • withLinkedServiceName

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

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

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

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

        public FileShareDataset withFolderPath​(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.
      • fileName

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

        public FileShareDataset withFileName​(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.
      • modifiedDatetimeStart

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

        public FileShareDataset withModifiedDatetimeStart​(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.
      • modifiedDatetimeEnd

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

        public FileShareDataset withModifiedDatetimeEnd​(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.
      • format

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

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

        public Object fileFilter()
        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.
      • withFileFilter

        public FileShareDataset withFileFilter​(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.
      • compression

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

        public FileShareDataset withCompression​(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.