AzureBlobDataset Class

Package:

com.azure.analytics.synapse.artifacts.models

Maven Artifact:

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

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

public 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	getCompression() Get the compression property: The data compression method used for the blob storage.
Object	getFileName() Get the fileName property: The name of the Azure Blob.
Object	getFolderPath() Get the folderPath property: The path of the Azure Blob storage.
DatasetStorageFormat	getFormat() Get the format property: The format of the Azure Blob storage.
Object	getModifiedDatetimeEnd() Get the modifiedDatetimeEnd property: The end of Azure Blob's modified datetime.
Object	getModifiedDatetimeStart() Get the modifiedDatetimeStart property: The start of Azure Blob's modified datetime.
Object	getTableRootLocation() Get the tableRootLocation property: The root of blob path.
AzureBlobDataset	setAnnotations(List<Object> annotations) Set the annotations property: List of tags that can be used for describing the Dataset.
AzureBlobDataset	setCompression(DatasetCompression compression) Set the compression property: The data compression method used for the blob storage.
AzureBlobDataset	setDescription(String description) Set the description property: Dataset description.
AzureBlobDataset	setFileName(Object fileName) Set the fileName property: The name of the Azure Blob.
AzureBlobDataset	setFolder(DatasetFolder folder) Set the folder property: The folder that this Dataset is in.
AzureBlobDataset	setFolderPath(Object folderPath) Set the folderPath property: The path of the Azure Blob storage.
AzureBlobDataset	setFormat(DatasetStorageFormat format) Set the format property: The format of the Azure Blob storage.
AzureBlobDataset	setLinkedServiceName(LinkedServiceReference linkedServiceName) Set the linkedServiceName property: Linked service reference.
AzureBlobDataset	setModifiedDatetimeEnd(Object modifiedDatetimeEnd) Set the modifiedDatetimeEnd property: The end of Azure Blob's modified datetime.
AzureBlobDataset	setModifiedDatetimeStart(Object modifiedDatetimeStart) Set the modifiedDatetimeStart property: The start of Azure Blob's modified datetime.
AzureBlobDataset	setParameters(Map<String,ParameterSpecification> parameters) Set the parameters property: Parameters for dataset.
AzureBlobDataset	setSchema(Object schema) Set the schema property: Columns that define the physical type schema of the dataset.
AzureBlobDataset	setStructure(Object structure) Set the structure property: Columns that define the structure of the dataset.
AzureBlobDataset	setTableRootLocation(Object tableRootLocation) Set the tableRootLocation property: The root of blob path.

Methods inherited from Dataset

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

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

getCompression

public DatasetCompression getCompression()

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

Returns:

the compression value.

getFileName

public Object getFileName()

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

Returns:

the fileName value.

getFolderPath

public Object getFolderPath()

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

Returns:

the folderPath value.

getFormat

public DatasetStorageFormat getFormat()

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

Returns:

the format value.

getModifiedDatetimeEnd

public Object getModifiedDatetimeEnd()

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

Returns:

the modifiedDatetimeEnd value.

getModifiedDatetimeStart

public Object getModifiedDatetimeStart()

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

Returns:

the modifiedDatetimeStart value.

getTableRootLocation

public Object getTableRootLocation()

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

Returns:

the tableRootLocation value.

setAnnotations

public AzureBlobDataset setAnnotations(List

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

Overrides:

AzureBlobDataset.setAnnotations(List<Object> annotations)

Parameters:

annotations

setCompression

public AzureBlobDataset setCompression(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.

setDescription

public AzureBlobDataset setDescription(String description)

Set the description property: Dataset description.

Overrides:

AzureBlobDataset.setDescription(String description)

Parameters:

description

setFileName

public AzureBlobDataset setFileName(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.

setFolder

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

AzureBlobDataset.setFolder(DatasetFolder folder)

Parameters:

folder

setFolderPath

public AzureBlobDataset setFolderPath(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.

setFormat

public AzureBlobDataset setFormat(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.

setLinkedServiceName

public AzureBlobDataset setLinkedServiceName(LinkedServiceReference linkedServiceName)

Set the linkedServiceName property: Linked service reference.

Overrides:

AzureBlobDataset.setLinkedServiceName(LinkedServiceReference linkedServiceName)

Parameters:

linkedServiceName

setModifiedDatetimeEnd

public AzureBlobDataset setModifiedDatetimeEnd(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.

setModifiedDatetimeStart

public AzureBlobDataset setModifiedDatetimeStart(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.

setParameters

public AzureBlobDataset setParameters(Map parameters)

Set the parameters property: Parameters for dataset.

Overrides:

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

Parameters:

parameters

setSchema

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

AzureBlobDataset.setSchema(Object schema)

Parameters:

schema

setStructure

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

AzureBlobDataset.setStructure(Object structure)

Parameters:

structure

setTableRootLocation

public AzureBlobDataset setTableRootLocation(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.