AzureBlobDataset Class

Package:

com.azure.resourcemanager.datafactory.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-datafactory:1.3.0-beta.1

• java.lang.Object
• • com.azure.resourcemanager.datafactory.models.Dataset
  • • com.azure.resourcemanager.datafactory.models.AzureBlobDataset

public final class AzureBlobDataset
extends Dataset

The Azure Blob storage.

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
DatasetCompression	compression() Get the compression property: The data compression method used for the blob storage.
Object	fileName() Get the fileName property: The name of the Azure Blob.
Object	folderPath() Get the folderPath property: The path of the Azure Blob storage.
DatasetStorageFormat	format() Get the format property: The format of the Azure Blob storage.
static AzureBlobDataset	fromJson(JsonReader jsonReader) Reads an instance of AzureBlobDataset from the JsonReader.
Object	modifiedDatetimeEnd() Get the modifiedDatetimeEnd property: The end of Azure Blob's modified datetime.
Object	modifiedDatetimeStart() Get the modifiedDatetimeStart property: The start of Azure Blob's modified datetime.
Object	tableRootLocation() Get the tableRootLocation property: The root of blob path.
JsonWriter	toJson(JsonWriter jsonWriter)
String	type() Get the type property: Type of dataset.
AzureBlobDataset	withAnnotations(List<Object> annotations) Set the annotations property: List of tags that can be used for describing the Dataset.
AzureBlobDataset	withCompression(DatasetCompression compression) Set the compression property: The data compression method used for the blob storage.
AzureBlobDataset	withDescription(String description) Set the description property: Dataset description.
AzureBlobDataset	withFileName(Object fileName) Set the fileName property: The name of the Azure Blob.
AzureBlobDataset	withFolder(DatasetFolder folder) Set the folder property: The folder that this Dataset is in.
AzureBlobDataset	withFolderPath(Object folderPath) Set the folderPath property: The path of the Azure Blob storage.
AzureBlobDataset	withFormat(DatasetStorageFormat format) Set the format property: The format of the Azure Blob storage.
AzureBlobDataset	withLinkedServiceName(LinkedServiceReference linkedServiceName) Set the linkedServiceName property: Linked service reference.
AzureBlobDataset	withModifiedDatetimeEnd(Object modifiedDatetimeEnd) Set the modifiedDatetimeEnd property: The end of Azure Blob's modified datetime.
AzureBlobDataset	withModifiedDatetimeStart(Object modifiedDatetimeStart) Set the modifiedDatetimeStart property: The start of Azure Blob's modified datetime.
AzureBlobDataset	withParameters(Map<String,ParameterSpecification> parameters) Set the parameters property: Parameters for dataset.
AzureBlobDataset	withSchema(Object schema) Set the schema property: Columns that define the physical type schema of the dataset.
AzureBlobDataset	withStructure(Object structure) Set the structure property: Columns that define the structure of the dataset.
AzureBlobDataset	withTableRootLocation(Object tableRootLocation) Set the tableRootLocation property: The root of blob path.

Methods inherited from Dataset

additionalProperties annotations description folder fromJson linkedServiceName parameters schema structure toJson type withAdditionalProperties withAnnotations withDescription withFolder withLinkedServiceName withParameters withSchema withStructure

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

AzureBlobDataset

public AzureBlobDataset()

Creates an instance of AzureBlobDataset class.

Method Details

compression

public DatasetCompression compression()

Get the compression property: The data compression method used for the blob storage.

Returns:

the compression value.

fileName

public Object fileName()

Get the fileName property: The name of the Azure Blob. Type: string (or Expression with resultType string).

Returns:

the fileName value.

folderPath

public Object folderPath()

Get the folderPath property: The path of the Azure Blob storage. Type: string (or Expression with resultType string).

Returns:

the folderPath value.

format

public DatasetStorageFormat format()

Get the format property: The format of the Azure Blob storage.

Returns:

the format value.

fromJson

public static AzureBlobDataset fromJson(JsonReader jsonReader)

Reads an instance of AzureBlobDataset from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

modifiedDatetimeEnd

public Object modifiedDatetimeEnd()

Get the modifiedDatetimeEnd property: The end of Azure Blob's modified datetime. Type: string (or Expression with resultType string).

Returns:

the modifiedDatetimeEnd value.

modifiedDatetimeStart

public Object modifiedDatetimeStart()

Get the modifiedDatetimeStart property: The start of Azure Blob's modified datetime. Type: string (or Expression with resultType string).

Returns:

the modifiedDatetimeStart value.

tableRootLocation

public Object tableRootLocation()

Get the tableRootLocation property: The root of blob path. Type: string (or Expression with resultType string).

Returns:

the tableRootLocation value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

AzureBlobDataset.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

type

public String type()

Get the type property: Type of dataset.

Overrides:

AzureBlobDataset.type()

Returns:

the type value.

withAnnotations

public AzureBlobDataset withAnnotations(List<Object> annotations)

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

Overrides:

AzureBlobDataset.withAnnotations(List<Object> annotations)

Parameters:

annotations

withCompression

public AzureBlobDataset withCompression(DatasetCompression compression)

Set the compression property: The data compression method used for the blob storage.

Parameters:

compression - the compression value to set.

Returns:

the AzureBlobDataset object itself.

withDescription

public AzureBlobDataset withDescription(String description)

Set the description property: Dataset description.

Overrides:

AzureBlobDataset.withDescription(String description)

Parameters:

description

withFileName

public AzureBlobDataset withFileName(Object fileName)

Set the fileName property: The name of the Azure Blob. Type: string (or Expression with resultType string).

Parameters:

fileName - the fileName value to set.

Returns:

the AzureBlobDataset object itself.

withFolder

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

AzureBlobDataset.withFolder(DatasetFolder folder)

Parameters:

folder

withFolderPath

public AzureBlobDataset withFolderPath(Object folderPath)

Set the folderPath property: The path of the Azure Blob storage. Type: string (or Expression with resultType string).

Parameters:

folderPath - the folderPath value to set.

Returns:

the AzureBlobDataset object itself.

withFormat

public AzureBlobDataset withFormat(DatasetStorageFormat format)

Set the format property: The format of the Azure Blob storage.

Parameters:

format - the format value to set.

Returns:

the AzureBlobDataset object itself.

withLinkedServiceName

public AzureBlobDataset withLinkedServiceName(LinkedServiceReference linkedServiceName)

Set the linkedServiceName property: Linked service reference.

Overrides:

AzureBlobDataset.withLinkedServiceName(LinkedServiceReference linkedServiceName)

Parameters:

linkedServiceName

withModifiedDatetimeEnd

public AzureBlobDataset withModifiedDatetimeEnd(Object modifiedDatetimeEnd)

Set the modifiedDatetimeEnd property: The end of Azure Blob's modified datetime. Type: string (or Expression with resultType string).

Parameters:

modifiedDatetimeEnd - the modifiedDatetimeEnd value to set.

Returns:

the AzureBlobDataset object itself.

withModifiedDatetimeStart

public AzureBlobDataset withModifiedDatetimeStart(Object modifiedDatetimeStart)

Set the modifiedDatetimeStart property: The start of Azure Blob's modified datetime. Type: string (or Expression with resultType string).

Parameters:

modifiedDatetimeStart - the modifiedDatetimeStart value to set.

Returns:

the AzureBlobDataset object itself.

withParameters

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

Set the parameters property: Parameters for dataset.

Overrides:

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

Parameters:

parameters

withSchema

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

AzureBlobDataset.withSchema(Object schema)

Parameters:

schema

withStructure

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

AzureBlobDataset.withStructure(Object structure)

Parameters:

structure

withTableRootLocation

public AzureBlobDataset withTableRootLocation(Object tableRootLocation)

Set the tableRootLocation property: The root of blob path. Type: string (or Expression with resultType string).

Parameters:

tableRootLocation - the tableRootLocation value to set.

Returns:

the AzureBlobDataset object itself.