Class PipelineRunAsyncClient
java.lang.Object
com.azure.analytics.synapse.artifacts.PipelineRunAsyncClient
Initializes a new instance of the asynchronous ArtifactsClient type.
-
Method Summary
Modifier and TypeMethodDescriptioncancelPipelineRun
(String runId) Cancel a pipeline run by its run ID.cancelPipelineRun
(String runId, Boolean isRecursive) Cancel a pipeline run by its run ID.cancelPipelineRunWithResponse
(String runId, Boolean isRecursive) Cancel a pipeline run by its run ID.getPipelineRun
(String runId) Get a pipeline run by its run ID.getPipelineRunWithResponse
(String runId) Get a pipeline run by its run ID.queryActivityRuns
(String pipelineName, String runId, RunFilterParameters filterParameters) Query activity runs based on input filter conditions.queryActivityRunsWithResponse
(String pipelineName, String runId, RunFilterParameters filterParameters) Query activity runs based on input filter conditions.queryPipelineRunsByWorkspace
(RunFilterParameters filterParameters) Query pipeline runs in the workspace based on input filter conditions.queryPipelineRunsByWorkspaceWithResponse
(RunFilterParameters filterParameters) Query pipeline runs in the workspace based on input filter conditions.
-
Method Details
-
queryPipelineRunsByWorkspaceWithResponse
public Mono<Response<PipelineRunsQueryResponse>> queryPipelineRunsByWorkspaceWithResponse(RunFilterParameters filterParameters) Query pipeline runs in the workspace based on input filter conditions.- Parameters:
filterParameters
- Parameters to filter the pipeline run.- Returns:
- a list pipeline runs along with
Response
on successful completion ofMono
. - 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.
-
queryPipelineRunsByWorkspace
public Mono<PipelineRunsQueryResponse> queryPipelineRunsByWorkspace(RunFilterParameters filterParameters) Query pipeline runs in the workspace based on input filter conditions.- Parameters:
filterParameters
- Parameters to filter the pipeline run.- Returns:
- a list pipeline runs 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.
-
getPipelineRunWithResponse
Get a pipeline run by its run ID.- Parameters:
runId
- The pipeline run identifier.- Returns:
- a pipeline run by its run ID along with
Response
on successful completion ofMono
. - 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.
-
getPipelineRun
Get a pipeline run by its run ID.- Parameters:
runId
- The pipeline run identifier.- Returns:
- a pipeline run by its run ID 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.
-
queryActivityRunsWithResponse
public Mono<Response<ActivityRunsQueryResponse>> queryActivityRunsWithResponse(String pipelineName, String runId, RunFilterParameters filterParameters) Query activity runs based on input filter conditions.- Parameters:
pipelineName
- The pipeline name.runId
- The pipeline run identifier.filterParameters
- Parameters to filter the activity runs.- Returns:
- a list activity runs along with
Response
on successful completion ofMono
. - 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.
-
queryActivityRuns
public Mono<ActivityRunsQueryResponse> queryActivityRuns(String pipelineName, String runId, RunFilterParameters filterParameters) Query activity runs based on input filter conditions.- Parameters:
pipelineName
- The pipeline name.runId
- The pipeline run identifier.filterParameters
- Parameters to filter the activity runs.- Returns:
- a list activity runs 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.
-
cancelPipelineRunWithResponse
Cancel a pipeline run by its run ID.- Parameters:
runId
- The pipeline run identifier.isRecursive
- If true, cancel all the Child pipelines that are triggered by the current pipeline.- Returns:
- the
Response
on successful completion ofMono
. - 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.
-
cancelPipelineRun
Cancel a pipeline run by its run ID.- Parameters:
runId
- The pipeline run identifier.isRecursive
- If true, cancel all the Child pipelines that are triggered by the current pipeline.- 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.
-
cancelPipelineRun
Cancel a pipeline run by its run ID.- Parameters:
runId
- The pipeline run identifier.- 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.
-