Package com.azure.resourcemanager.datafactory.models

Class ExcelDataset

java.lang.Object
com.azure.resourcemanager.datafactory.models.Dataset
com.azure.resourcemanager.datafactory.models.ExcelDataset
public final class ExcelDataset extends Dataset
Excel dataset.

  • Constructor Details

    • ExcelDataset

      public ExcelDataset()
      Creates an instance of ExcelDataset class.

  • Method Details

    • withDescription

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

    • withParameters

      public ExcelDataset withParameters(Map<String,ParameterSpecification> parameters)
      Set the parameters property: Parameters for dataset.
      Overrides:
      withParameters in class Dataset
      Parameters:
      parameters - the parameters value to set.
      Returns:
      the Dataset object itself.

    • withAnnotations

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

    • location

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

    • withLocation

      public ExcelDataset withLocation(DatasetLocation location)
      Set the location property: The location of the excel storage.
      Parameters:
      location - the location value to set.
      Returns:
      the ExcelDataset 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 ExcelDataset 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 ExcelDataset 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 ExcelDataset 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 ExcelDataset 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 ExcelDataset 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 ExcelDataset 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 ExcelDataset 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 ExcelDataset 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 ExcelDataset 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 ExcelDataset 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 ExcelDataset 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 ExcelDataset object itself.

    • validate

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