Package org.azd.pipelines.preview

Class PreviewRequestBuilder

java.lang.Object

org.azd.abstractions.BaseRequestBuilder

org.azd.pipelines.preview.PreviewRequestBuilder

public class PreviewRequestBuilder
extends BaseRequestBuilder

Provides functionality to work with Pipelines preview 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
PreviewRequestBuilder(String organizationUrl, AccessTokenCredential accessTokenCredential)	Instantiates a new RequestBuilder instance and sets the default values.

Method Summary

Modifier and Type	Method	Description
PreviewRun	preview(int pipelineId, RunPipelineParameters runPipelineParameters)	Queues a dry run of the pipeline and returns an object containing the final yaml.
PreviewRun	preview(int pipelineId, RunPipelineParameters runPipelineParameters, int pipelineVersion)	Queues a dry run of the pipeline and returns an object containing the final yaml.
CompletableFuture<PreviewRun>	previewAsync(int pipelineId, RunPipelineParameters runPipelineParameters)	Queues a dry run of the pipeline and returns an object containing the final yaml.
CompletableFuture<PreviewRun>	previewAsync(int pipelineId, RunPipelineParameters runPipelineParameters, int pipelineVersion)	Queues a dry run of the pipeline and returns an object containing the final yaml.

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

PreviewRequestBuilder

public PreviewRequestBuilder(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

previewAsync

public CompletableFuture<PreviewRun> previewAsync(int pipelineId,
 RunPipelineParameters runPipelineParameters)
                                           throws AzDException

Queues a dry run of the pipeline and returns an object containing the final yaml.

Parameters:

pipelineId - ID of the pipeline.

runPipelineParameters - Run parameters to queue dry run.

Returns:

Preview run object PreviewRun

Throws:

AzDException - Default Api exception handler.

previewAsync

public CompletableFuture<PreviewRun> previewAsync(int pipelineId,
 RunPipelineParameters runPipelineParameters,
 int pipelineVersion)
                                           throws AzDException

Queues a dry run of the pipeline and returns an object containing the final yaml.

Parameters:

pipelineId - ID of the pipeline.

runPipelineParameters - Run parameters to queue dry run.

pipelineVersion - The pipeline version

Returns:

Preview run object PreviewRun

Throws:

AzDException - Default Api exception handler.

preview

public PreviewRun preview(int pipelineId,
 RunPipelineParameters runPipelineParameters)
                   throws AzDException

Queues a dry run of the pipeline and returns an object containing the final yaml.

Parameters:

pipelineId - ID of the pipeline.

runPipelineParameters - Run parameters to queue dry run.

Returns:

Preview run object PreviewRun

Throws:

AzDException - Default Api exception handler.

preview

public PreviewRun preview(int pipelineId,
 RunPipelineParameters runPipelineParameters,
 int pipelineVersion)
                   throws AzDException

Queues a dry run of the pipeline and returns an object containing the final yaml.

Parameters:

pipelineId - ID of the pipeline.

runPipelineParameters - Run parameters to queue dry run.

pipelineVersion - The pipeline version

Returns:

Preview run object PreviewRun

Throws:

AzDException - Default Api exception handler.