Package com.azure.analytics.synapse.artifacts

Class DataFlowAsyncClient

java.lang.Object

com.azure.analytics.synapse.artifacts.DataFlowAsyncClient

public final class DataFlowAsyncClient
extends Object

Initializes a new instance of the asynchronous ArtifactsClient type.

Method Summary

Modifier and Type	Method	Description
Mono<DataFlowResource>	createOrUpdateDataFlow(String dataFlowName, DataFlowResource dataFlow)	Creates or updates a data flow.
Mono<DataFlowResource>	createOrUpdateDataFlow(String dataFlowName, DataFlowResource dataFlow, String ifMatch)	Creates or updates a data flow.
Mono<com.azure.core.http.rest.Response<DataFlowResource>>	createOrUpdateDataFlowWithResponse(String dataFlowName, DataFlowResource dataFlow, String ifMatch)	Creates or updates a data flow.
Mono<Void>	deleteDataFlow(String dataFlowName)	Deletes a data flow.
Mono<com.azure.core.http.rest.Response<Void>>	deleteDataFlowWithResponse(String dataFlowName)	Deletes a data flow.
Mono<DataFlowResource>	getDataFlow(String dataFlowName)	Gets a data flow.
Mono<DataFlowResource>	getDataFlow(String dataFlowName, String ifNoneMatch)	Gets a data flow.
com.azure.core.http.rest.PagedFlux<DataFlowResource>	getDataFlowsByWorkspace()	Lists data flows.
Mono<com.azure.core.http.rest.Response<DataFlowResource>>	getDataFlowWithResponse(String dataFlowName, String ifNoneMatch)	Gets a data flow.
Mono<Void>	renameDataFlow(String dataFlowName, ArtifactRenameRequest request)	Renames a dataflow.
Mono<com.azure.core.http.rest.Response<Void>>	renameDataFlowWithResponse(String dataFlowName, ArtifactRenameRequest request)	Renames a dataflow.

Methods inherited from class java.lang.Object

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

Method Detail

createOrUpdateDataFlowWithResponse

public Mono<com.azure.core.http.rest.Response<DataFlowResource>> createOrUpdateDataFlowWithResponse(String dataFlowName,
                                                                                                    DataFlowResource dataFlow,
                                                                                                    String ifMatch)

Creates or updates a data flow.

Parameters:

dataFlowName - The data flow name.

dataFlow - Data flow resource definition.

ifMatch - ETag of the data flow entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update.

Returns:

data flow 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.

createOrUpdateDataFlow

public Mono<DataFlowResource> createOrUpdateDataFlow(String dataFlowName,
                                                     DataFlowResource dataFlow,
                                                     String ifMatch)

Creates or updates a data flow.

Parameters:

dataFlowName - The data flow name.

dataFlow - Data flow resource definition.

ifMatch - ETag of the data flow entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update.

Returns:

data flow 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.

createOrUpdateDataFlow

public Mono<DataFlowResource> createOrUpdateDataFlow(String dataFlowName,
                                                     DataFlowResource dataFlow)

Creates or updates a data flow.

Parameters:

dataFlowName - The data flow name.

dataFlow - Data flow resource definition.

Returns:

data flow 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.

getDataFlowWithResponse

public Mono<com.azure.core.http.rest.Response<DataFlowResource>> getDataFlowWithResponse(String dataFlowName,
                                                                                         String ifNoneMatch)

Gets a data flow.

Parameters:

dataFlowName - The data flow name.

ifNoneMatch - ETag of the data flow 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 data flow 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.

getDataFlow

public Mono<DataFlowResource> getDataFlow(String dataFlowName,
                                          String ifNoneMatch)

Gets a data flow.

Parameters:

dataFlowName - The data flow name.

ifNoneMatch - ETag of the data flow 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 data flow 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.

getDataFlow

public Mono<DataFlowResource> getDataFlow(String dataFlowName)

Gets a data flow.

Parameters:

dataFlowName - The data flow name.

Returns:

a data flow 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.

deleteDataFlowWithResponse

public Mono<com.azure.core.http.rest.Response<Void>> deleteDataFlowWithResponse(String dataFlowName)

Deletes a data flow.

Parameters:

dataFlowName - The data flow 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.

deleteDataFlow

public Mono<Void> deleteDataFlow(String dataFlowName)

Deletes a data flow.

Parameters:

dataFlowName - The data flow 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.

renameDataFlowWithResponse

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

Renames a dataflow.

Parameters:

dataFlowName - The data flow 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.

renameDataFlow

public Mono<Void> renameDataFlow(String dataFlowName,
                                 ArtifactRenameRequest request)

Renames a dataflow.

Parameters:

dataFlowName - The data flow 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.

getDataFlowsByWorkspace

public com.azure.core.http.rest.PagedFlux<DataFlowResource> getDataFlowsByWorkspace()

Lists data flows.

Returns:

a list of data flow 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.