Package org.azd.build.builds

Class BuildsRequestBuilder

java.lang.Object

org.azd.abstractions.BaseRequestBuilder

org.azd.build.builds.BuildsRequestBuilder

public class BuildsRequestBuilder
extends BaseRequestBuilder

Provides the functionality to manage Builds Api.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BuildsRequestBuilder.GetQueryParameters	Represents the query parameters.
static class	BuildsRequestBuilder.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
BuildsRequestBuilder(String organizationUrl, AccessTokenCredential accessTokenCredential)	Instantiates a new RequestBuilder instance and sets the default values.

Method Summary

Modifier and Type	Method	Description
BuildChangesRequestBuilder	changes()	Provides functionality to Build changes Api.
Void	delete(int buildId)	Deletes a build hronously.
CompletableFuture<Void>	deleteAsync(int buildId)	Deletes a build asynchronously.
Build	get(int buildId)	Gets a build
Build	get(int buildId, String propertyFilters)	Gets a build
CompletableFuture<Build>	getAsync(int buildId)	Gets a build
CompletableFuture<Build>	getAsync(int buildId, String propertyFilters)	Gets a build
RetentionLeases	getRetentionLeases(int buildId)	Gets all retention leases that apply to a specific build.
CompletableFuture<RetentionLeases>	getRetentionLeasesAsync(int buildId)	Gets all retention leases that apply to a specific build.
Builds	list()	Gets a list of builds.
Builds	list(Consumer<BuildsRequestBuilder.RequestConfiguration> requestConfiguration)	Gets a list of builds.
CompletableFuture<Builds>	listAsync()	Gets a list of builds.
CompletableFuture<Builds>	listAsync(Consumer<BuildsRequestBuilder.RequestConfiguration> requestConfiguration)	Gets a list of builds.
BuildLogsRequestBuilder	logs()	Provides functionality to manage Build logs Api.
Build	queue(int definitionId)	Queues a build
Build	queue(Build build)	Queues a build
CompletableFuture<Build>	queueAsync(int definitionId)	Queues a build
CompletableFuture<Build>	queueAsync(Build build)	Queues a build
Build	update(int buildId, boolean retry, Build build)	Updates a build.
Builds	update(Builds builds)	Updates multiple builds.
CompletableFuture<Build>	updateAsync(int buildId, boolean retry, Build build)	Updates a build.
CompletableFuture<Builds>	updateAsync(Builds builds)	Updates multiple builds.
BuildWorkItemsRequestBuilder	workItems()	Provides functionality to manage Build work items Api.

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

BuildsRequestBuilder

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

changes

public BuildChangesRequestBuilder changes()

Provides functionality to Build changes Api.

Returns:

BuildChangesRequestBuilder BuildChangesRequestBuilder

logs

public BuildLogsRequestBuilder logs()

Provides functionality to manage Build logs Api.

Returns:

BuildLogsRequestBuilder BuildLogsRequestBuilder

workItems

public BuildWorkItemsRequestBuilder workItems()

Provides functionality to manage Build work items Api.

Returns:

BuildWorkItemsRequestBuilder BuildWorkItemsRequestBuilder

deleteAsync

public CompletableFuture<Void> deleteAsync(int buildId)
                                    throws AzDException

Deletes a build asynchronously.

Parameters:

buildId - pass the build id to delete

Throws:

AzDException - Default Api Exception handler.

getAsync

public CompletableFuture<Build> getAsync(int buildId)
                                  throws AzDException

Gets a build

Parameters:

buildId - pass the build id

Returns:

Future build object Build

Throws:

AzDException - Default Api Exception handler.

getAsync

public CompletableFuture<Build> getAsync(int buildId,
 String propertyFilters)
                                  throws AzDException

Gets a build

Parameters:

buildId - pass the build id

propertyFilters - Property filters.

Returns:

Future build object Build

Throws:

AzDException - Default Api Exception handler.

getRetentionLeasesAsync

public CompletableFuture<RetentionLeases> getRetentionLeasesAsync(int buildId)
                                                           throws AzDException

Gets all retention leases that apply to a specific build.

Parameters:

buildId - pass the build id

Returns:

Future Retention leases object RetentionLeases

Throws:

AzDException - Default Api Exception handler.

listAsync

public CompletableFuture<Builds> listAsync()
                                    throws AzDException

Gets a list of builds.

Returns:

Future Builds object Builds

Throws:

AzDException - Default Api Exception handler.

listAsync

public CompletableFuture<Builds> listAsync(Consumer<BuildsRequestBuilder.RequestConfiguration> requestConfiguration)
                                    throws AzDException

Gets a list of builds.

Returns:

Future Builds object Builds

Throws:

AzDException - Default Api Exception handler.

queueAsync

public CompletableFuture<Build> queueAsync(int definitionId)
                                    throws AzDException

Queues a build

Parameters:

definitionId - pass the pipeline id to queue the build

Returns:

a build object Build

Throws:

AzDException - Default Api Exception handler.

queueAsync

public CompletableFuture<Build> queueAsync(Build build)
                                    throws AzDException

Queues a build

Parameters:

build - Build object to queue the build.

Returns:

a build object Build

Throws:

AzDException - Default Api Exception handler.

updateAsync

public CompletableFuture<Build> updateAsync(int buildId,
 boolean retry,
 Build build)
                                     throws AzDException

Updates a build.

Parameters:

buildId - The ID of the build.

retry - None

build - pass the Build object to update. Build

Returns:

Build Object Build

Throws:

AzDException - Default Api Exception handler.

updateAsync

public CompletableFuture<Builds> updateAsync(Builds builds)
                                      throws AzDException

Updates multiple builds.

Parameters:

builds - List of build to update. Builds

Returns:

Build Object Builds

Throws:

AzDException - Default Api Exception handler.

delete

public Void delete(int buildId)
            throws AzDException

Deletes a build hronously.

Parameters:

buildId - pass the build id to delete

Throws:

AzDException - Default Api Exception handler.

get

public Build get(int buildId)
          throws AzDException

Gets a build

Parameters:

buildId - pass the build id

Returns:

Future build object Build

Throws:

AzDException - Default Api Exception handler.

get

public Build get(int buildId,
 String propertyFilters)
          throws AzDException

Gets a build

Parameters:

buildId - pass the build id

propertyFilters - Property filters.

Returns:

Future build object Build

Throws:

AzDException - Default Api Exception handler.

getRetentionLeases

public RetentionLeases getRetentionLeases(int buildId)
                                   throws AzDException

Gets all retention leases that apply to a specific build.

Parameters:

buildId - pass the build id

Returns:

Future Retention leases object RetentionLeases

Throws:

AzDException - Default Api Exception handler.

list

public Builds list()
            throws AzDException

Gets a list of builds.

Returns:

Future Builds object Builds

Throws:

AzDException - Default Api Exception handler.

list

public Builds list(Consumer<BuildsRequestBuilder.RequestConfiguration> requestConfiguration)
            throws AzDException

Gets a list of builds.

Returns:

Future Builds object Builds

Throws:

AzDException - Default Api Exception handler.

queue

public Build queue(int definitionId)
            throws AzDException

Queues a build

Parameters:

definitionId - pass the pipeline id to queue the build

Returns:

a build object Build

Throws:

AzDException - Default Api Exception handler.

queue

public Build queue(Build build)
            throws AzDException

Queues a build

Parameters:

build - Build object to queue the build.

Returns:

a build object Build

Throws:

AzDException - Default Api Exception handler.

update

public Build update(int buildId,
 boolean retry,
 Build build)
             throws AzDException

Updates a build.

Parameters:

buildId - The ID of the build.

retry - None

build - pass the Build object to update. Build

Returns:

Build Object Build

Throws:

AzDException - Default Api Exception handler.

update

public Builds update(Builds builds)
              throws AzDException

Updates multiple builds.

Parameters:

builds - List of build to update. Builds

Returns:

Build Object Builds

Throws:

AzDException - Default Api Exception handler.