public final class PipelineRunClient extends Object
Modifier and Type | Method and 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.
|
public PipelineRunsQueryResponse queryPipelineRunsByWorkspace(RunFilterParameters filterParameters)
filterParameters
- Parameters to filter the pipeline run.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.public com.azure.core.http.rest.Response<PipelineRunsQueryResponse> queryPipelineRunsByWorkspaceWithResponse(RunFilterParameters filterParameters, com.azure.core.util.Context context)
filterParameters
- Parameters to filter the pipeline run.context
- The context to associate with this operation.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.public PipelineRun getPipelineRun(String runId)
runId
- The pipeline run identifier.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.public com.azure.core.http.rest.Response<PipelineRun> getPipelineRunWithResponse(String runId, com.azure.core.util.Context context)
runId
- The pipeline run identifier.context
- The context to associate with this operation.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.public ActivityRunsQueryResponse queryActivityRuns(String pipelineName, String runId, RunFilterParameters filterParameters)
pipelineName
- The pipeline name.runId
- The pipeline run identifier.filterParameters
- Parameters to filter the activity runs.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.public com.azure.core.http.rest.Response<ActivityRunsQueryResponse> queryActivityRunsWithResponse(String pipelineName, String runId, RunFilterParameters filterParameters, com.azure.core.util.Context context)
pipelineName
- The pipeline name.runId
- The pipeline run identifier.filterParameters
- Parameters to filter the activity runs.context
- The context to associate with this operation.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.public void cancelPipelineRun(String runId, Boolean isRecursive)
runId
- The pipeline run identifier.isRecursive
- If true, cancel all the Child pipelines that are triggered by the current pipeline.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.public void cancelPipelineRun(String runId)
runId
- The pipeline run identifier.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.public com.azure.core.http.rest.Response<Void> cancelPipelineRunWithResponse(String runId, Boolean isRecursive, com.azure.core.util.Context context)
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.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.Copyright © 2021 Microsoft Corporation. All rights reserved.