PipelineAsyncClient Class

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.PipelineAsyncClient

public final class PipelineAsyncClient

Initializes a new instance of the asynchronous ArtifactsClient type.

Method Summary

Modifier and Type	Method and Description
Mono<PipelineResource>	createOrUpdatePipeline(String pipelineName, PipelineResource pipeline) Creates or updates a pipeline.
Mono<PipelineResource>	createOrUpdatePipeline(String pipelineName, PipelineResource pipeline, String ifMatch) Creates or updates a pipeline.
Mono<Response<PipelineResource>>	createOrUpdatePipelineWithResponse(String pipelineName, PipelineResource pipeline, String ifMatch) Creates or updates a pipeline.
Mono<CreateRunResponse>	createPipelineRun(String pipelineName) Creates a run of a pipeline.
Mono<CreateRunResponse>	createPipelineRun(String pipelineName, String referencePipelineRunId, Boolean isRecovery, String startActivityName, Map<String,Object> parameters) Creates a run of a pipeline.
Mono<Response<CreateRunResponse>>	createPipelineRunWithResponse(String pipelineName, String referencePipelineRunId, Boolean isRecovery, String startActivityName, Map<String,Object> parameters) Creates a run of a pipeline.
Mono<Void>	deletePipeline(String pipelineName) Deletes a pipeline.
Mono<Response<Void>>	deletePipelineWithResponse(String pipelineName) Deletes a pipeline.
Mono<PipelineResource>	getPipeline(String pipelineName) Gets a pipeline.
Mono<PipelineResource>	getPipeline(String pipelineName, String ifNoneMatch) Gets a pipeline.
Mono<Response<PipelineResource>>	getPipelineWithResponse(String pipelineName, String ifNoneMatch) Gets a pipeline.
PagedFlux<PipelineResource>	getPipelinesByWorkspace() Lists pipelines.
Mono<Void>	renamePipeline(String pipelineName, ArtifactRenameRequest request) Renames a pipeline.
Mono<Response<Void>>	renamePipelineWithResponse(String pipelineName, ArtifactRenameRequest request) Renames a pipeline.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

createOrUpdatePipeline

public Mono createOrUpdatePipeline(String pipelineName, PipelineResource pipeline)

Creates or updates a pipeline.

Parameters:

pipelineName - The pipeline name.

pipeline - Pipeline resource definition.

Returns:

pipeline resource type on successful completion of Mono.

createOrUpdatePipeline

public Mono createOrUpdatePipeline(String pipelineName, PipelineResource pipeline, String ifMatch)

Creates or updates a pipeline.

Parameters:

pipelineName - The pipeline name.

pipeline - Pipeline resource definition.

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

Returns:

pipeline resource type on successful completion of Mono.

createOrUpdatePipelineWithResponse

public Mono<>> createOrUpdatePipelineWithResponse(String pipelineName, PipelineResource pipeline, String ifMatch)

Creates or updates a pipeline.

Parameters:

pipelineName - The pipeline name.

pipeline - Pipeline resource definition.

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

Returns:

pipeline resource type along with Response<T> on successful completion of Mono.

createPipelineRun

public Mono createPipelineRun(String pipelineName)

Creates a run of a pipeline.

Parameters:

pipelineName - The pipeline name.

Returns:

response body with a run identifier on successful completion of Mono.

createPipelineRun

public Mono createPipelineRun(String pipelineName, String referencePipelineRunId, Boolean isRecovery, String startActivityName, Map parameters)

Creates a run of a pipeline.

Parameters:

pipelineName - The pipeline name.

referencePipelineRunId - The pipeline run identifier. If run ID is specified the parameters of the specified run will be used to create a new run.

isRecovery - Recovery mode flag. If recovery mode is set to true, the specified referenced pipeline run and the new run will be grouped under the same groupId.

startActivityName - In recovery mode, the rerun will start from this activity. If not specified, all activities will run.

parameters - Parameters of the pipeline run. These parameters will be used only if the runId is not specified.

Returns:

response body with a run identifier on successful completion of Mono.

createPipelineRunWithResponse

public Mono<>> createPipelineRunWithResponse(String pipelineName, String referencePipelineRunId, Boolean isRecovery, String startActivityName, Map parameters)

Creates a run of a pipeline.

Parameters:

pipelineName - The pipeline name.

referencePipelineRunId - The pipeline run identifier. If run ID is specified the parameters of the specified run will be used to create a new run.

isRecovery - Recovery mode flag. If recovery mode is set to true, the specified referenced pipeline run and the new run will be grouped under the same groupId.

startActivityName - In recovery mode, the rerun will start from this activity. If not specified, all activities will run.

parameters - Parameters of the pipeline run. These parameters will be used only if the runId is not specified.

Returns:

response body with a run identifier along with Response<T> on successful completion of Mono.

deletePipeline

public Mono deletePipeline(String pipelineName)

Deletes a pipeline.

Parameters:

pipelineName - The pipeline name.

Returns:

A Mono that completes when a successful response is received.

deletePipelineWithResponse

public Mono<>> deletePipelineWithResponse(String pipelineName)

Deletes a pipeline.

Parameters:

pipelineName - The pipeline name.

Returns:

the Response<T> on successful completion of Mono.

getPipeline

public Mono getPipeline(String pipelineName)

Gets a pipeline.

Parameters:

pipelineName - The pipeline name.

Returns:

a pipeline on successful completion of Mono.

getPipeline

public Mono getPipeline(String pipelineName, String ifNoneMatch)

Gets a pipeline.

Parameters:

pipelineName - The pipeline name.

ifNoneMatch - ETag of the pipeline 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 pipeline on successful completion of Mono.

getPipelineWithResponse

public Mono<>> getPipelineWithResponse(String pipelineName, String ifNoneMatch)

Gets a pipeline.

Parameters:

pipelineName - The pipeline name.

ifNoneMatch - ETag of the pipeline 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 pipeline along with Response<T> on successful completion of Mono.

getPipelinesByWorkspace

public PagedFlux getPipelinesByWorkspace()

Lists pipelines.

Returns:

a list of pipeline resources as paginated response with PagedFlux<T>.

renamePipeline

public Mono renamePipeline(String pipelineName, ArtifactRenameRequest request)

Renames a pipeline.

Parameters:

pipelineName - The pipeline name.

request - proposed new name.

Returns:

A Mono that completes when a successful response is received.

renamePipelineWithResponse

public Mono<>> renamePipelineWithResponse(String pipelineName, ArtifactRenameRequest request)

Renames a pipeline.

Parameters:

pipelineName - The pipeline name.

request - proposed new name.

Returns:

the Response<T> on successful completion of Mono.