BinaryDataset Class

public final 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
DatasetCompression compression()

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

static BinaryDataset fromJson(JsonReader jsonReader)

Reads an instance of BinaryDataset from the JsonReader.

DatasetLocation location()

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

JsonWriter toJson(JsonWriter jsonWriter)
String type()

Get the type property: Type of dataset.

void validate()

Validates the instance.

BinaryDataset withAnnotations(List<Object> annotations)

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

BinaryDataset withCompression(DatasetCompression compression)

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

BinaryDataset withDescription(String description)

Set the description property: Dataset description.

BinaryDataset withFolder(DatasetFolder folder)

Set the folder property: The folder that this Dataset is in.

BinaryDataset withLinkedServiceName(LinkedServiceReference linkedServiceName)

Set the linkedServiceName property: Linked service reference.

BinaryDataset withLocation(DatasetLocation location)

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

BinaryDataset withParameters(Map<String,ParameterSpecification> parameters)

Set the parameters property: Parameters for dataset.

BinaryDataset withSchema(Object schema)

Set the schema property: Columns that define the physical type schema of the dataset.

BinaryDataset withStructure(Object structure)

Set the structure property: Columns that define the structure of the dataset.

Methods inherited from Dataset

Methods inherited from java.lang.Object

Constructor Details

BinaryDataset

public BinaryDataset()

Creates an instance of BinaryDataset class.

Method Details

compression

public DatasetCompression compression()

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

Returns:

the compression value.

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.

location

public DatasetLocation location()

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

Returns:

the location value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

BinaryDataset.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

type

public String type()

Get the type property: Type of dataset.

Overrides:

BinaryDataset.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

Overrides:

BinaryDataset.validate()

withAnnotations

public BinaryDataset withAnnotations(List<Object> annotations)

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

Overrides:

BinaryDataset.withAnnotations(List<Object> annotations)

Parameters:

annotations

withCompression

public BinaryDataset withCompression(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.

withDescription

public BinaryDataset withDescription(String description)

Set the description property: Dataset description.

Overrides:

BinaryDataset.withDescription(String description)

Parameters:

description

withFolder

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

BinaryDataset.withFolder(DatasetFolder folder)

Parameters:

folder

withLinkedServiceName

public BinaryDataset withLinkedServiceName(LinkedServiceReference linkedServiceName)

Set the linkedServiceName property: Linked service reference.

Overrides:

BinaryDataset.withLinkedServiceName(LinkedServiceReference linkedServiceName)

Parameters:

linkedServiceName

withLocation

public BinaryDataset withLocation(DatasetLocation location)

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

Parameters:

location - the location value to set.

Returns:

the BinaryDataset object itself.

withParameters

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

Set the parameters property: Parameters for dataset.

Overrides:

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

Parameters:

parameters

withSchema

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

BinaryDataset.withSchema(Object schema)

Parameters:

schema

withStructure

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

BinaryDataset.withStructure(Object structure)

Parameters:

structure

Applies to