Package org.azd.build.artifacts

Class ArtifactsRequestBuilder

java.lang.Object

org.azd.abstractions.BaseRequestBuilder

org.azd.build.artifacts.ArtifactsRequestBuilder

public class ArtifactsRequestBuilder
extends BaseRequestBuilder

Provides the functionality to manage Build 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
BuildArtifact	create(int buildId, BuildArtifact buildArtifact)	Associates an artifact with a build.
CompletableFuture<BuildArtifact>	createAsync(int buildId, BuildArtifact buildArtifact)	Associates an artifact with a build.
BuildArtifact	get(int buildId, String artifactName)	Gets a specific artifact for a build.
CompletableFuture<BuildArtifact>	getAsync(int buildId, String artifactName)	Gets a specific artifact for a build.
InputStream	getAsZip(int buildId, String artifactName)	Gets a specific artifact for a build as a zip file.
CompletableFuture<InputStream>	getAsZipAsync(int buildId, String artifactName)	Gets a specific artifact for a build as a zip file.
InputStream	getFile(int buildId, String artifactName, Consumer<ArtifactsRequestBuilder.RequestConfiguration> requestConfiguration)	Gets a file from the build.
CompletableFuture<InputStream>	getFileAsync(int buildId, String artifactName, Consumer<ArtifactsRequestBuilder.RequestConfiguration> requestConfiguration)	Gets a file from the build.
BuildArtifacts	list(int buildId)	Gets all artifacts for a build.
CompletableFuture<BuildArtifacts>	listAsync(int buildId)	Gets all artifacts for a build.

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

createAsync

public CompletableFuture<BuildArtifact> createAsync(int buildId,
 BuildArtifact buildArtifact)
                                             throws AzDException

Associates an artifact with a build.

Parameters:

buildId - The ID of the build.

buildArtifact - Build artifact to associate.

Returns:

BuildArtifact future Object BuildArtifact

Throws:

AzDException - Default Api Exception handler.

getAsync

public CompletableFuture<BuildArtifact> getAsync(int buildId,
 String artifactName)
                                          throws AzDException

Gets a specific artifact for a build.

Parameters:

buildId - The ID of the build.

artifactName - The name of the artifact.

Returns:

BuildArtifact future Object BuildArtifact

Throws:

AzDException - Default Api Exception handler.

getAsZipAsync

public CompletableFuture<InputStream> getAsZipAsync(int buildId,
 String artifactName)
                                             throws AzDException

Gets a specific artifact for a build as a zip file.

Parameters:

buildId - The ID of the build.

artifactName - The name of the artifact.

Returns:

Input stream future response of artifact

Throws:

AzDException - Default Api Exception handler.

getFileAsync

public CompletableFuture<InputStream> getFileAsync(int buildId,
 String artifactName,
 Consumer<ArtifactsRequestBuilder.RequestConfiguration> requestConfiguration)
                                            throws AzDException

Gets a file from the build. Returns the file contents as InputStream and StreamHelper can be used to download the file.

Parameters:

buildId - The ID of the build.

artifactName - The name of the artifact.

Returns:

Input stream future response of artifact

Throws:

AzDException - Default Api Exception handler.

listAsync

public CompletableFuture<BuildArtifacts> listAsync(int buildId)
                                            throws AzDException

Gets all artifacts for a build.

Parameters:

buildId - The ID of the build.

Returns:

BuildArtifacts future Object BuildArtifacts

Throws:

AzDException - Default Api Exception handler.

create

public BuildArtifact create(int buildId,
 BuildArtifact buildArtifact)
                     throws AzDException

Associates an artifact with a build.

Parameters:

buildId - The ID of the build.

buildArtifact - Build artifact to associate.

Returns:

BuildArtifact future Object BuildArtifact

Throws:

AzDException - Default Api Exception handler.

get

public BuildArtifact get(int buildId,
 String artifactName)
                  throws AzDException

Gets a specific artifact for a build.

Parameters:

buildId - The ID of the build.

artifactName - The name of the artifact.

Returns:

BuildArtifact future Object BuildArtifact

Throws:

AzDException - Default Api Exception handler.

getAsZip

public InputStream getAsZip(int buildId,
 String artifactName)
                     throws AzDException

Gets a specific artifact for a build as a zip file.

Parameters:

buildId - The ID of the build.

artifactName - The name of the artifact.

Returns:

Input stream future response of artifact

Throws:

AzDException - Default Api Exception handler.

getFile

public InputStream getFile(int buildId,
 String artifactName,
 Consumer<ArtifactsRequestBuilder.RequestConfiguration> requestConfiguration)
                    throws AzDException

Gets a file from the build. Returns the file contents as InputStream and StreamHelper can be used to download the file.

Parameters:

buildId - The ID of the build.

artifactName - The name of the artifact.

Returns:

Input stream future response of artifact

Throws:

AzDException - Default Api Exception handler.

list

public BuildArtifacts list(int buildId)
                    throws AzDException

Gets all artifacts for a build.

Parameters:

buildId - The ID of the build.

Returns:

BuildArtifacts future Object BuildArtifacts

Throws:

AzDException - Default Api Exception handler.