Package com.azure.analytics.synapse.artifacts

Class PipelineRunClient

java.lang.Object

com.azure.analytics.synapse.artifacts.PipelineRunClient

public final class PipelineRunClient
extends Object

Initializes a new instance of the synchronous ArtifactsClient type.

Method Summary

Modifier and Type	Method	Description
void	cancelPipelineRun(String runId)	Cancel a pipeline run by its run ID.
void	cancelPipelineRun(String runId, Boolean isRecursive)	Cancel a pipeline run by its run ID.
com.azure.core.http.rest.Response<Void>	cancelPipelineRunWithResponse(String runId, Boolean isRecursive, com.azure.core.util.Context context)	Cancel a pipeline run by its run ID.
PipelineRun	getPipelineRun(String runId)	Get a pipeline run by its run ID.
com.azure.core.http.rest.Response<PipelineRun>	getPipelineRunWithResponse(String runId, com.azure.core.util.Context context)	Get a pipeline run by its run ID.
ActivityRunsQueryResponse	queryActivityRuns(String pipelineName, String runId, RunFilterParameters filterParameters)	Query activity runs based on input filter conditions.
com.azure.core.http.rest.Response<ActivityRunsQueryResponse>	queryActivityRunsWithResponse(String pipelineName, String runId, RunFilterParameters filterParameters, com.azure.core.util.Context context)	Query activity runs based on input filter conditions.
PipelineRunsQueryResponse	queryPipelineRunsByWorkspace(RunFilterParameters filterParameters)	Query pipeline runs in the workspace based on input filter conditions.
com.azure.core.http.rest.Response<PipelineRunsQueryResponse>	queryPipelineRunsByWorkspaceWithResponse(RunFilterParameters filterParameters, com.azure.core.util.Context context)	Query pipeline runs in the workspace based on input filter conditions.

Methods inherited from class java.lang.Object

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

Method Detail

queryPipelineRunsByWorkspace

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

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.

queryPipelineRunsByWorkspaceWithResponse

public com.azure.core.http.rest.Response<PipelineRunsQueryResponse> queryPipelineRunsByWorkspaceWithResponse(RunFilterParameters filterParameters,
                                                                                                             com.azure.core.util.Context context)

Query pipeline runs in the workspace based on input filter conditions.

Parameters:

filterParameters - Parameters to filter the pipeline run.

context - The context to associate with this operation.

Returns:

a list pipeline runs along with Response.

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

public PipelineRun getPipelineRun(String runId)

Get a pipeline run by its run ID.

Parameters:

runId - The pipeline run identifier.

Returns:

a pipeline run by its run ID.

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

public com.azure.core.http.rest.Response<PipelineRun> getPipelineRunWithResponse(String runId,
                                                                                 com.azure.core.util.Context context)

Get a pipeline run by its run ID.

Parameters:

runId - The pipeline run identifier.

context - The context to associate with this operation.

Returns:

a pipeline run by its run ID along with Response.

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

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 com.azure.core.http.rest.Response<ActivityRunsQueryResponse> queryActivityRunsWithResponse(String pipelineName,
                                                                                                  String runId,
                                                                                                  RunFilterParameters filterParameters,
                                                                                                  com.azure.core.util.Context context)

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.

context - The context to associate with this operation.

Returns:

a list activity runs along with Response.

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

public void cancelPipelineRun(String runId,
                              Boolean isRecursive)

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.

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

public void cancelPipelineRun(String runId)

Cancel a pipeline run by its run ID.

Parameters:

runId - The pipeline run identifier.

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

public com.azure.core.http.rest.Response<Void> cancelPipelineRunWithResponse(String runId,
                                                                             Boolean isRecursive,
                                                                             com.azure.core.util.Context context)

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.

context - The context to associate with this operation.

Returns:

the Response.

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.