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

Class ExcelDataset

  • public class ExcelDataset
extends Dataset
    Excel dataset.

    • Constructor Detail

      • ExcelDataset

        public ExcelDataset()

    • Method Detail

      • getLocation

        public DatasetLocation getLocation()
        Get the location property: The location of the excel storage.
        Returns:
        the location value.

      • setLocation

        public ExcelDataset setLocation​(DatasetLocation location)
        Set the location property: The location of the excel storage.
        Parameters:
        location - the location value to set.
        Returns:
        the ExcelDataset object itself.

      • getSheetName

        public Object getSheetName()
        Get the sheetName property: The sheet of excel file. Type: string (or Expression with resultType string).
        Returns:
        the sheetName value.

      • setSheetName

        public ExcelDataset setSheetName​(Object sheetName)
        Set the sheetName property: The sheet of excel file. Type: string (or Expression with resultType string).
        Parameters:
        sheetName - the sheetName value to set.
        Returns:
        the ExcelDataset object itself.

      • getRange

        public Object getRange()
        Get the range property: The partial data of one sheet. Type: string (or Expression with resultType string).
        Returns:
        the range value.

      • setRange

        public ExcelDataset setRange​(Object range)
        Set the range property: The partial data of one sheet. Type: string (or Expression with resultType string).
        Parameters:
        range - the range value to set.
        Returns:
        the ExcelDataset object itself.

      • getFirstRowAsHeader

        public Object getFirstRowAsHeader()
        Get the firstRowAsHeader property: When used as input, treat the first row of data as headers. When used as output,write the headers into the output as the first row of data. The default value is false. Type: boolean (or Expression with resultType boolean).
        Returns:
        the firstRowAsHeader value.

      • setFirstRowAsHeader

        public ExcelDataset setFirstRowAsHeader​(Object firstRowAsHeader)
        Set the firstRowAsHeader property: When used as input, treat the first row of data as headers. When used as output,write the headers into the output as the first row of data. The default value is false. Type: boolean (or Expression with resultType boolean).
        Parameters:
        firstRowAsHeader - the firstRowAsHeader value to set.
        Returns:
        the ExcelDataset object itself.

      • getCompression

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

      • setCompression

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

      • getNullValue

        public Object getNullValue()
        Get the nullValue property: The null value string. Type: string (or Expression with resultType string).
        Returns:
        the nullValue value.

      • setNullValue

        public ExcelDataset setNullValue​(Object nullValue)
        Set the nullValue property: The null value string. Type: string (or Expression with resultType string).
        Parameters:
        nullValue - the nullValue value to set.
        Returns:
        the ExcelDataset object itself.

      • setDescription

        public ExcelDataset 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 ExcelDataset 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 ExcelDataset 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 ExcelDataset 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 ExcelDataset 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 ExcelDataset 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.