Package org.azd.pipelines.runs

Class RunsRequestBuilder

java.lang.Object

org.azd.abstractions.BaseRequestBuilder

org.azd.pipelines.runs.RunsRequestBuilder

public class RunsRequestBuilder
extends BaseRequestBuilder

Provides functionality to work with Pipelines runs Api.

Nested Class Summary

Nested classes/interfaces inherited from class org.azd.abstractions.BaseRequestBuilder

BaseRequestBuilder.ProjectExcludeParameter

Field Summary

Fields inherited from class org.azd.abstractions.BaseRequestBuilder

accessTokenCredential, apiVersion, area, locationId, organizationUrl, serializer

Constructor Summary

Constructors

Constructor	Description
RunsRequestBuilder(String organizationUrl, AccessTokenCredential accessTokenCredential)	Instantiates a new RequestBuilder instance and sets the default values.

Method Summary

Modifier and Type	Method	Description
PipelineRun	get(int pipelineId, int runId)	Gets a run for a particular pipeline.
CompletableFuture<PipelineRun>	getAsync(int pipelineId, int runId)	Gets a run for a particular pipeline.
PipelineRuns	list(int pipelineId)	Gets top 10000 runs for a particular pipeline.
CompletableFuture<PipelineRuns>	listAsync(int pipelineId)	Gets top 10000 runs for a particular pipeline.
PipelineRun	run(int pipelineId, RunPipelineParameters runPipelineParameters)	Runs a pipeline.
PipelineRun	run(int pipelineId, RunPipelineParameters runPipelineParameters, int pipelineVersion)	Runs a pipeline.
CompletableFuture<PipelineRun>	runAsync(int pipelineId, RunPipelineParameters runPipelineParameters)	Runs a pipeline.
CompletableFuture<PipelineRun>	runAsync(int pipelineId, RunPipelineParameters runPipelineParameters, int pipelineVersion)	Runs a pipeline.

Methods inherited from class org.azd.abstractions.BaseRequestBuilder

builder

Methods inherited from class java.lang.Object

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

Constructor Details

RunsRequestBuilder

public RunsRequestBuilder(String organizationUrl,
 AccessTokenCredential accessTokenCredential)

Instantiates a new RequestBuilder instance and sets the default values.

Parameters:

organizationUrl - Represents organization location request url.

accessTokenCredential - Access token credential object.

Method Details

getAsync

public CompletableFuture<PipelineRun> getAsync(int pipelineId,
 int runId)
                                        throws AzDException

Gets a run for a particular pipeline.

Parameters:

pipelineId - The pipeline id

runId - The run id

Returns:

Pipeline run object PipelineRun

Throws:

AzDException - Default Api Exception handler.

listAsync

public CompletableFuture<PipelineRuns> listAsync(int pipelineId)
                                          throws AzDException

Gets top 10000 runs for a particular pipeline.

Parameters:

pipelineId - The pipeline id

Returns:

a list of pipeline run object PipelineRuns

Throws:

AzDException - Default Api Exception handler.

runAsync

public CompletableFuture<PipelineRun> runAsync(int pipelineId,
 RunPipelineParameters runPipelineParameters)
                                        throws AzDException

Runs a pipeline.

Parameters:

pipelineId - The pipeline id

runPipelineParameters - Request parameters to run pipeline.

Returns:

a pipeline run object PipelineRun

Throws:

AzDException - Default Api Exception handler.

runAsync

public CompletableFuture<PipelineRun> runAsync(int pipelineId,
 RunPipelineParameters runPipelineParameters,
 int pipelineVersion)
                                        throws AzDException

Runs a pipeline.

Parameters:

pipelineId - The pipeline id

runPipelineParameters - Request parameters to run pipeline.

pipelineVersion - The pipeline version.

Returns:

a pipeline run object PipelineRun

Throws:

AzDException - Default Api Exception handler.

get

public PipelineRun get(int pipelineId,
 int runId)
                throws AzDException

Gets a run for a particular pipeline.

Parameters:

pipelineId - The pipeline id

runId - The run id

Returns:

Pipeline run object PipelineRun

Throws:

AzDException - Default Api Exception handler.

list

public PipelineRuns list(int pipelineId)
                  throws AzDException

Gets top 10000 runs for a particular pipeline.

Parameters:

pipelineId - The pipeline id

Returns:

a list of pipeline run object PipelineRuns

Throws:

AzDException - Default Api Exception handler.

run

public PipelineRun run(int pipelineId,
 RunPipelineParameters runPipelineParameters)
                throws AzDException

Runs a pipeline.

Parameters:

pipelineId - The pipeline id

runPipelineParameters - Request parameters to run pipeline.

Returns:

a pipeline run object PipelineRun

Throws:

AzDException - Default Api Exception handler.

run

public PipelineRun run(int pipelineId,
 RunPipelineParameters runPipelineParameters,
 int pipelineVersion)
                throws AzDException

Runs a pipeline.

Parameters:

pipelineId - The pipeline id

runPipelineParameters - Request parameters to run pipeline.

pipelineVersion - The pipeline version.

Returns:

a pipeline run object PipelineRun

Throws:

AzDException - Default Api Exception handler.