Package org.azd.pipelines.artifacts

Class ArtifactsRequestBuilder

java.lang.Object

org.azd.abstractions.BaseRequestBuilder

org.azd.pipelines.artifacts.ArtifactsRequestBuilder

public class ArtifactsRequestBuilder
extends BaseRequestBuilder

Provides functionality to work with Pipelines artifacts Api.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ArtifactsRequestBuilder.GetQueryParameters	Represents the query parameters.
static class	ArtifactsRequestBuilder.RequestConfiguration	Request configuration object for the query parameters.

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
ArtifactsRequestBuilder(String organizationUrl, AccessTokenCredential accessTokenCredential)	Instantiates a new RequestBuilder instance and sets the default values.

Method Summary

Modifier and Type	Method	Description
PipelinesArtifact	get(int pipelineId, int runId, Consumer<ArtifactsRequestBuilder.RequestConfiguration> requestConfiguration)	Get a specific artifact from a pipeline run
CompletableFuture<PipelinesArtifact>	getAsync(int pipelineId, int runId, Consumer<ArtifactsRequestBuilder.RequestConfiguration> requestConfiguration)	Get a specific artifact from a pipeline run

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

ArtifactsRequestBuilder

public ArtifactsRequestBuilder(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<PipelinesArtifact> getAsync(int pipelineId,
 int runId,
 Consumer<ArtifactsRequestBuilder.RequestConfiguration> requestConfiguration)
                                              throws AzDException

Get a specific artifact from a pipeline run

Parameters:

pipelineId - ID of the pipeline.

runId - ID of the run of that pipeline.

requestConfiguration - Represents query parameters.

Returns:

Pipelines artifact object PipelinesArtifact

Throws:

AzDException - Default Api exception handler.

get

public PipelinesArtifact get(int pipelineId,
 int runId,
 Consumer<ArtifactsRequestBuilder.RequestConfiguration> requestConfiguration)
                      throws AzDException

Get a specific artifact from a pipeline run

Parameters:

pipelineId - ID of the pipeline.

runId - ID of the run of that pipeline.

requestConfiguration - Represents query parameters.

Returns:

Pipelines artifact object PipelinesArtifact

Throws:

AzDException - Default Api exception handler.