Dataset Class

Package:

com.azure.analytics.synapse.artifacts.models

Maven Artifact:

com.azure:azure-analytics-synapse-artifacts:1.0.0-beta.17

• java.lang.Object
• • com.azure.analytics.synapse.artifacts.models.Dataset

Implements

JsonSerializable<Dataset>

public class Dataset
implements JsonSerializable<Dataset>

The Azure Data Factory nested object which identifies data within different data stores, such as tables, files, folders, and documents.

Constructor Summary

Constructor	Description
Dataset()	Creates an instance of Dataset class.

Method Summary

Modifier and Type	Method and Description
static Dataset	fromJson(JsonReader jsonReader) Reads an instance of Dataset from the JsonReader.
Map<String,Object>	getAdditionalProperties() Get the additionalProperties property: The Azure Data Factory nested object which identifies data within different data stores, such as tables, files, folders, and documents.
List<Object>	getAnnotations() Get the annotations property: List of tags that can be used for describing the Dataset.
String	getDescription() Get the description property: Dataset description.
DatasetFolder	getFolder() Get the folder property: The folder that this Dataset is in.
LinkedServiceReference	getLinkedServiceName() Get the linkedServiceName property: Linked service reference.
Map<String,ParameterSpecification>	getParameters() Get the parameters property: Parameters for dataset.
Object	getSchema() Get the schema property: Columns that define the physical type schema of the dataset.
Object	getStructure() Get the structure property: Columns that define the structure of the dataset.
String	getType() Get the type property: Type of dataset.
Dataset	setAdditionalProperties(Map<String,Object> additionalProperties) Set the additionalProperties property: The Azure Data Factory nested object which identifies data within different data stores, such as tables, files, folders, and documents.
Dataset	setAnnotations(List<Object> annotations) Set the annotations property: List of tags that can be used for describing the Dataset.
Dataset	setDescription(String description) Set the description property: Dataset description.
Dataset	setFolder(DatasetFolder folder) Set the folder property: The folder that this Dataset is in.
Dataset	setLinkedServiceName(LinkedServiceReference linkedServiceName) Set the linkedServiceName property: Linked service reference.
Dataset	setParameters(Map<String,ParameterSpecification> parameters) Set the parameters property: Parameters for dataset.
Dataset	setSchema(Object schema) Set the schema property: Columns that define the physical type schema of the dataset.
Dataset	setStructure(Object structure) Set the structure property: Columns that define the structure of the dataset.
JsonWriter	toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

Dataset

public Dataset()

Creates an instance of Dataset class.

Method Details

fromJson

public static Dataset fromJson(JsonReader jsonReader)

Reads an instance of Dataset from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of Dataset if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

Get the additionalProperties property: The Azure Data Factory nested object which identifies data within different data stores, such as tables, files, folders, and documents.

Returns:

the additionalProperties value.

getAnnotations

public List<Object> getAnnotations()

Get the annotations property: List of tags that can be used for describing the Dataset.

Returns:

the annotations value.

getDescription

public String getDescription()

Get the description property: Dataset description.

Returns:

the description value.

getFolder

public DatasetFolder getFolder()

Get the folder property: The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

Returns:

the folder value.

getLinkedServiceName

public LinkedServiceReference getLinkedServiceName()

Get the linkedServiceName property: Linked service reference.

Returns:

the linkedServiceName value.

getParameters

public Map<String,ParameterSpecification> getParameters()

Get the parameters property: Parameters for dataset.

Returns:

the parameters value.

getSchema

public Object getSchema()

Get the schema property: Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

Returns:

the schema value.

getStructure

public Object getStructure()

Get the structure property: Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

Returns:

the structure value.

getType

public String getType()

Get the type property: Type of dataset.

Returns:

the type value.

setAdditionalProperties

public Dataset setAdditionalProperties(Map<String,Object> additionalProperties)

Set the additionalProperties property: The Azure Data Factory nested object which identifies data within different data stores, such as tables, files, folders, and documents.

Parameters:

additionalProperties - the additionalProperties value to set.

Returns:

the Dataset object itself.

setAnnotations

public Dataset setAnnotations(List<Object> annotations)

Set the annotations property: List of tags that can be used for describing the Dataset.

Parameters:

annotations - the annotations value to set.

Returns:

the Dataset object itself.

setDescription

public Dataset setDescription(String description)

Set the description property: Dataset description.

Parameters:

description - the description value to set.

Returns:

the Dataset object itself.

setFolder

public Dataset setFolder(DatasetFolder folder)

Set the folder property: The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

Parameters:

folder - the folder value to set.

Returns:

the Dataset object itself.

setLinkedServiceName

public Dataset setLinkedServiceName(LinkedServiceReference linkedServiceName)

Set the linkedServiceName property: Linked service reference.

Parameters:

linkedServiceName - the linkedServiceName value to set.

Returns:

the Dataset object itself.

setParameters

public Dataset setParameters(Map<String,ParameterSpecification> parameters)

Set the parameters property: Parameters for dataset.

Parameters:

parameters - the parameters value to set.

Returns:

the Dataset object itself.

setSchema

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

Parameters:

schema - the schema value to set.

Returns:

the Dataset object itself.

setStructure

public Dataset setStructure(Object structure)

Set the structure property: Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

Parameters:

structure - the structure value to set.

Returns:

the Dataset object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException