BinaryDataset Class

Package:
com.azure.analytics.synapse.artifacts.models
Maven Artifact:
com.azure:azure-analytics-synapse-artifacts:1.0.0-beta.17

public class BinaryDataset
extends Dataset

Binary dataset.

Constructor Summary

Constructor Description
BinaryDataset()

Creates an instance of BinaryDataset class.

Method Summary

Modifier and Type Method and Description
static BinaryDataset fromJson(JsonReader jsonReader)

Reads an instance of BinaryDataset from the JsonReader.
DatasetCompression getCompression()

Get the compression property: The data compression method used for the binary dataset.
DatasetLocation getLocation()

Get the location property: The location of the Binary storage.
String getType()

Get the type property: Type of dataset.
BinaryDataset setAnnotations(List<Object> annotations)

Set the annotations property: List of tags that can be used for describing the Dataset.
BinaryDataset setCompression(DatasetCompression compression)

Set the compression property: The data compression method used for the binary dataset.
BinaryDataset setDescription(String description)

Set the description property: Dataset description.
BinaryDataset setFolder(DatasetFolder folder)

Set the folder property: The folder that this Dataset is in.
BinaryDataset setLinkedServiceName(LinkedServiceReference linkedServiceName)

Set the linkedServiceName property: Linked service reference.
BinaryDataset setLocation(DatasetLocation location)

Set the location property: The location of the Binary storage.
BinaryDataset setParameters(Map<String,ParameterSpecification> parameters)

Set the parameters property: Parameters for dataset.
BinaryDataset setSchema(Object schema)

Set the schema property: Columns that define the physical type schema of the dataset.
BinaryDataset setStructure(Object structure)

Set the structure property: Columns that define the structure of the dataset.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from Dataset

fromJson getAdditionalProperties getAnnotations getDescription getFolder getLinkedServiceName getParameters getSchema getStructure getType setAdditionalProperties setAnnotations setDescription setFolder setLinkedServiceName setParameters setSchema setStructure toJson

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

BinaryDataset

public BinaryDataset()

Creates an instance of BinaryDataset class.

Method Details

fromJson

public static BinaryDataset fromJson(JsonReader jsonReader)

Reads an instance of BinaryDataset from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of BinaryDataset 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.

getCompression

public DatasetCompression getCompression()

Get the compression property: The data compression method used for the binary dataset.

Returns:

the compression value.

getLocation

public DatasetLocation getLocation()

Get the location property: The location of the Binary storage.

Returns:

the location value.

getType

public String getType()

Get the type property: Type of dataset.

Overrides:

BinaryDataset.getType()

Returns:

the type value.

setAnnotations

public BinaryDataset setAnnotations(List<Object> annotations)

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

Overrides:

BinaryDataset.setAnnotations(List<Object> annotations)

Parameters:

annotations

setCompression

public BinaryDataset setCompression(DatasetCompression compression)

Set the compression property: The data compression method used for the binary dataset.

Parameters:

compression - the compression value to set.

Returns:

the BinaryDataset object itself.

setDescription

public BinaryDataset setDescription(String description)

Set the description property: Dataset description.

Overrides:

BinaryDataset.setDescription(String description)

Parameters:

description

setFolder

public BinaryDataset 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:

BinaryDataset.setFolder(DatasetFolder folder)

Parameters:

folder

setLinkedServiceName

public BinaryDataset setLinkedServiceName(LinkedServiceReference linkedServiceName)

Set the linkedServiceName property: Linked service reference.

Overrides:

BinaryDataset.setLinkedServiceName(LinkedServiceReference linkedServiceName)

Parameters:

linkedServiceName

setLocation

public BinaryDataset setLocation(DatasetLocation location)

Set the location property: The location of the Binary storage.

Parameters:

location - the location value to set.

Returns:

the BinaryDataset object itself.

setParameters

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

Set the parameters property: Parameters for dataset.

Overrides:

BinaryDataset.setParameters(Map<String,ParameterSpecification> parameters)

Parameters:

parameters

setSchema

public BinaryDataset 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:

BinaryDataset.setSchema(Object schema)

Parameters:

schema

setStructure

public BinaryDataset 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:

BinaryDataset.setStructure(Object structure)

Parameters:

structure

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

BinaryDataset.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to