Package com.azure.analytics.synapse.artifacts

Class DatasetAsyncClient

java.lang.Object

com.azure.analytics.synapse.artifacts.DatasetAsyncClient

public final class DatasetAsyncClient
extends Object

Initializes a new instance of the asynchronous ArtifactsClient type.

Method Summary

Modifier and Type	Method	Description
Mono<DatasetResource>	createOrUpdateDataset(String datasetName, DatasetResource dataset)	Creates or updates a dataset.
Mono<DatasetResource>	createOrUpdateDataset(String datasetName, DatasetResource dataset, String ifMatch)	Creates or updates a dataset.
Mono<com.azure.core.http.rest.Response<DatasetResource>>	createOrUpdateDatasetWithResponse(String datasetName, DatasetResource dataset, String ifMatch)	Creates or updates a dataset.
Mono<Void>	deleteDataset(String datasetName)	Deletes a dataset.
Mono<com.azure.core.http.rest.Response<Void>>	deleteDatasetWithResponse(String datasetName)	Deletes a dataset.
Mono<DatasetResource>	getDataset(String datasetName)	Gets a dataset.
Mono<DatasetResource>	getDataset(String datasetName, String ifNoneMatch)	Gets a dataset.
com.azure.core.http.rest.PagedFlux<DatasetResource>	getDatasetsByWorkspace()	Lists datasets.
Mono<com.azure.core.http.rest.Response<DatasetResource>>	getDatasetWithResponse(String datasetName, String ifNoneMatch)	Gets a dataset.
Mono<Void>	renameDataset(String datasetName, ArtifactRenameRequest request)	Renames a dataset.
Mono<com.azure.core.http.rest.Response<Void>>	renameDatasetWithResponse(String datasetName, ArtifactRenameRequest request)	Renames a dataset.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getDatasetsByWorkspace

public com.azure.core.http.rest.PagedFlux<DatasetResource> getDatasetsByWorkspace()

Lists datasets.

Returns:

a list of dataset resources as paginated response with PagedFlux.

Throws:

CloudErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

createOrUpdateDatasetWithResponse

public Mono<com.azure.core.http.rest.Response<DatasetResource>> createOrUpdateDatasetWithResponse(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 along with Response on successful completion of Mono.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

CloudErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

createOrUpdateDataset

public Mono<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 on successful completion of Mono.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

CloudErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

createOrUpdateDataset

public Mono<DatasetResource> createOrUpdateDataset(String datasetName,
                                                   DatasetResource dataset)

Creates or updates a dataset.

Parameters:

datasetName - The dataset name.

dataset - Dataset resource definition.

Returns:

dataset resource type on successful completion of Mono.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

CloudErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getDatasetWithResponse

public Mono<com.azure.core.http.rest.Response<DatasetResource>> getDatasetWithResponse(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 along with Response on successful completion of Mono.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

CloudErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getDataset

public Mono<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 on successful completion of Mono.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

CloudErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getDataset

public Mono<DatasetResource> getDataset(String datasetName)

Gets a dataset.

Parameters:

datasetName - The dataset name.

Returns:

a dataset on successful completion of Mono.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

CloudErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

deleteDatasetWithResponse

public Mono<com.azure.core.http.rest.Response<Void>> deleteDatasetWithResponse(String datasetName)

Deletes a dataset.

Parameters:

datasetName - The dataset name.

Returns:

the Response on successful completion of Mono.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

CloudErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

deleteDataset

public Mono<Void> deleteDataset(String datasetName)

Deletes a dataset.

Parameters:

datasetName - The dataset name.

Returns:

A Mono that completes when a successful response is received.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

CloudErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

renameDatasetWithResponse

public Mono<com.azure.core.http.rest.Response<Void>> renameDatasetWithResponse(String datasetName,
                                                                               ArtifactRenameRequest request)

Renames a dataset.

Parameters:

datasetName - The dataset name.

request - proposed new name.

Returns:

the Response on successful completion of Mono.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

CloudErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

renameDataset

public Mono<Void> renameDataset(String datasetName,
                                ArtifactRenameRequest request)

Renames a dataset.

Parameters:

datasetName - The dataset name.

request - proposed new name.

Returns:

A Mono that completes when a successful response is received.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

CloudErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.