Share via

DatasetClient Class

  • Reference
Package:
com.azure.analytics.synapse.artifacts
Maven Artifact:
com.azure:azure-analytics-synapse-artifacts:1.0.0-beta.14
  • java.lang.Object
    • com.azure.analytics.synapse.artifacts.DatasetClient

public final class DatasetClient

Initializes a new instance of the synchronous ArtifactsClient type.

Method Summary

Modifier and Type Method and Description
DatasetResource createOrUpdateDataset(String datasetName, DatasetResource dataset)

Creates or updates a dataset.
DatasetResource createOrUpdateDataset(String datasetName, DatasetResource dataset, String ifMatch)

Creates or updates a dataset.
Response<DatasetResource> createOrUpdateDatasetWithResponse(String datasetName, DatasetResource dataset, String ifMatch, Context context)

Creates or updates a dataset.
void deleteDataset(String datasetName)

Deletes a dataset.
Response<Void> deleteDatasetWithResponse(String datasetName, Context context)

Deletes a dataset.
DatasetResource getDataset(String datasetName)

Gets a dataset.
DatasetResource getDataset(String datasetName, String ifNoneMatch)

Gets a dataset.
Response<DatasetResource> getDatasetWithResponse(String datasetName, String ifNoneMatch, Context context)

Gets a dataset.
PagedIterable<DatasetResource> getDatasetsByWorkspace()

Lists datasets.
PagedIterable<DatasetResource> getDatasetsByWorkspace(Context context)

Lists datasets.
void renameDataset(String datasetName, ArtifactRenameRequest request)

Renames a dataset.
Response<Void> renameDatasetWithResponse(String datasetName, ArtifactRenameRequest request, Context context)

Renames a dataset.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

createOrUpdateDataset

public DatasetResource createOrUpdateDataset(String datasetName, DatasetResource dataset)

Creates or updates a dataset.

Parameters:

datasetName - The dataset name.
dataset - Dataset resource definition.

Returns:

dataset resource type.

createOrUpdateDataset

public DatasetResource createOrUpdateDataset(String datasetName, DatasetResource dataset, String ifMatch)

Creates or updates a dataset.

Parameters:

datasetName - The dataset name.
dataset - Dataset resource definition.
ifMatch - ETag of the dataset entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update.

Returns:

dataset resource type.

createOrUpdateDatasetWithResponse

public Response createOrUpdateDatasetWithResponse(String datasetName, DatasetResource dataset, String ifMatch, Context context)

Creates or updates a dataset.

Parameters:

datasetName - The dataset name.
dataset - Dataset resource definition.
ifMatch - ETag of the dataset entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update.
context - The context to associate with this operation.

Returns:

dataset resource type along with Response<T>.

deleteDataset

public void deleteDataset(String datasetName)

Deletes a dataset.

Parameters:

datasetName - The dataset name.

deleteDatasetWithResponse

public Response deleteDatasetWithResponse(String datasetName, Context context)

Deletes a dataset.

Parameters:

datasetName - The dataset name.
context - The context to associate with this operation.

Returns:

getDataset

public DatasetResource getDataset(String datasetName)

Gets a dataset.

Parameters:

datasetName - The dataset name.

Returns:

a dataset.

getDataset

public DatasetResource getDataset(String datasetName, String ifNoneMatch)

Gets a dataset.

Parameters:

datasetName - The dataset name.
ifNoneMatch - ETag of the dataset entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned.

Returns:

a dataset.

getDatasetWithResponse

public Response getDatasetWithResponse(String datasetName, String ifNoneMatch, Context context)

Gets a dataset.

Parameters:

datasetName - The dataset name.
ifNoneMatch - ETag of the dataset entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned.
context - The context to associate with this operation.

Returns:

a dataset along with Response<T>.

getDatasetsByWorkspace

public PagedIterable getDatasetsByWorkspace()

Lists datasets.

Returns:

a list of dataset resources as paginated response with PagedIterable<T>.

getDatasetsByWorkspace

public PagedIterable getDatasetsByWorkspace(Context context)

Lists datasets.

Parameters:

context - The context to associate with this operation.

Returns:

a list of dataset resources as paginated response with PagedIterable<T>.

renameDataset

public void renameDataset(String datasetName, ArtifactRenameRequest request)

Renames a dataset.

Parameters:

datasetName - The dataset name.
request - proposed new name.

renameDatasetWithResponse

public Response renameDatasetWithResponse(String datasetName, ArtifactRenameRequest request, Context context)

Renames a dataset.

Parameters:

datasetName - The dataset name.
request - proposed new name.
context - The context to associate with this operation.

Returns:

Applies to