Class ExcelDatasetTypeProperties


  • public final class ExcelDatasetTypeProperties
    extends Object
    Excel dataset properties.
    • Constructor Detail

      • ExcelDatasetTypeProperties

        public ExcelDatasetTypeProperties()
    • Method Detail

      • location

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

        public ExcelDatasetTypeProperties withLocation​(DatasetLocation location)
        Set the location property: The location of the excel storage.
        Parameters:
        location - the location value to set.
        Returns:
        the ExcelDatasetTypeProperties object itself.
      • sheetName

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

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

        public Object sheetIndex()
        Get the sheetIndex property: The sheet index of excel file and default value is 0. Type: integer (or Expression with resultType integer).
        Returns:
        the sheetIndex value.
      • withSheetIndex

        public ExcelDatasetTypeProperties withSheetIndex​(Object sheetIndex)
        Set the sheetIndex property: The sheet index of excel file and default value is 0. Type: integer (or Expression with resultType integer).
        Parameters:
        sheetIndex - the sheetIndex value to set.
        Returns:
        the ExcelDatasetTypeProperties object itself.
      • range

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

        public ExcelDatasetTypeProperties withRange​(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 ExcelDatasetTypeProperties object itself.
      • firstRowAsHeader

        public Object firstRowAsHeader()
        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.
      • withFirstRowAsHeader

        public ExcelDatasetTypeProperties withFirstRowAsHeader​(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 ExcelDatasetTypeProperties object itself.
      • compression

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

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

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

        public ExcelDatasetTypeProperties withNullValue​(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 ExcelDatasetTypeProperties object itself.
      • validate

        public void validate()
        Validates the instance.
        Throws:
        IllegalArgumentException - thrown if the instance is not valid.