Class ExcelDataset
java.lang.Object
com.azure.analytics.synapse.artifacts.models.Dataset
com.azure.analytics.synapse.artifacts.models.ExcelDataset
Excel dataset.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGet the compression property: The data compression method used for the json dataset.Get the firstRowAsHeader property: When used as input, treat the first row of data as headers.Get the location property: The location of the excel storage.Get the nullValue property: The null value string.getRange()
Get the range property: The partial data of one sheet.Get the sheetIndex property: The sheet index of excel file and default value is 0.Get the sheetName property: The sheet name of excel file.setAnnotations
(List<Object> annotations) Set the annotations property: List of tags that can be used for describing the Dataset.setCompression
(DatasetCompression compression) Set the compression property: The data compression method used for the json dataset.setDescription
(String description) Set the description property: Dataset description.setFirstRowAsHeader
(Object firstRowAsHeader) Set the firstRowAsHeader property: When used as input, treat the first row of data as headers.setFolder
(DatasetFolder folder) Set the folder property: The folder that this Dataset is in.setLinkedServiceName
(LinkedServiceReference linkedServiceName) Set the linkedServiceName property: Linked service reference.setLocation
(DatasetLocation location) Set the location property: The location of the excel storage.setNullValue
(Object nullValue) Set the nullValue property: The null value string.setParameters
(Map<String, ParameterSpecification> parameters) Set the parameters property: Parameters for dataset.Set the range property: The partial data of one sheet.Set the schema property: Columns that define the physical type schema of the dataset.setSheetIndex
(Object sheetIndex) Set the sheetIndex property: The sheet index of excel file and default value is 0.setSheetName
(Object sheetName) Set the sheetName property: The sheet name of excel file.setStructure
(Object structure) Set the structure property: Columns that define the structure of the dataset.Methods inherited from class com.azure.analytics.synapse.artifacts.models.Dataset
getAdditionalProperties, getAnnotations, getDescription, getFolder, getLinkedServiceName, getParameters, getSchema, getStructure, setAdditionalProperties
-
Constructor Details
-
ExcelDataset
public ExcelDataset()Creates an instance of ExcelDataset class.
-
-
Method Details
-
getLocation
Get the location property: The location of the excel storage.- Returns:
- the location value.
-
setLocation
Set the location property: The location of the excel storage.- Parameters:
location
- the location value to set.- Returns:
- the ExcelDataset object itself.
-
getSheetName
Get the sheetName property: The sheet name of excel file. Type: string (or Expression with resultType string).- Returns:
- the sheetName value.
-
setSheetName
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.
-
getSheetIndex
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.
-
setSheetIndex
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.
-
getRange
Get the range property: The partial data of one sheet. Type: string (or Expression with resultType string).- Returns:
- the range value.
-
setRange
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
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
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
Get the compression property: The data compression method used for the json dataset.- Returns:
- the compression value.
-
setCompression
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
Get the nullValue property: The null value string. Type: string (or Expression with resultType string).- Returns:
- the nullValue value.
-
setNullValue
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
Set the description property: Dataset description.- Overrides:
setDescription
in classDataset
- Parameters:
description
- the description value to set.- Returns:
- the Dataset object itself.
-
setStructure
Set the structure property: Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.- Overrides:
setStructure
in classDataset
- Parameters:
structure
- the structure value to set.- Returns:
- the Dataset object itself.
-
setSchema
Set the schema property: Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. -
setLinkedServiceName
Set the linkedServiceName property: Linked service reference.- Overrides:
setLinkedServiceName
in classDataset
- Parameters:
linkedServiceName
- the linkedServiceName value to set.- Returns:
- the Dataset object itself.
-
setParameters
Set the parameters property: Parameters for dataset.- Overrides:
setParameters
in classDataset
- Parameters:
parameters
- the parameters value to set.- Returns:
- the Dataset object itself.
-
setAnnotations
Set the annotations property: List of tags that can be used for describing the Dataset.- Overrides:
setAnnotations
in classDataset
- Parameters:
annotations
- the annotations value to set.- Returns:
- the Dataset object itself.
-
setFolder
Set the folder property: The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
-