Package org.azd.build.builds

Class BuildWorkItemsRequestBuilder

java.lang.Object

org.azd.abstractions.BaseRequestBuilder

org.azd.build.builds.BuildWorkItemsRequestBuilder

public class BuildWorkItemsRequestBuilder
extends BaseRequestBuilder

Provides functionality to manage Build work items Api.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
BuildWorkItems	get(int buildId)	Gets the work items associated with a build.
BuildWorkItems	get(int buildId, int top)	Gets the work items associated with a build.
BuildWorkItems	get(Consumer<BuildWorkItemsRequestBuilder.RequestConfiguration> requestConfiguration)	Gets all the work items between two builds.
CompletableFuture<BuildWorkItems>	getAsync(int buildId)	Gets the work items associated with a build.
CompletableFuture<BuildWorkItems>	getAsync(int buildId, int top)	Gets the work items associated with a build.
CompletableFuture<BuildWorkItems>	getAsync(Consumer<BuildWorkItemsRequestBuilder.RequestConfiguration> requestConfiguration)	Gets all the work items between two builds.
BuildWorkItems	getFromCommits(int buildId, List<String> commitId, int top)	Gets the work items associated with a build, filtered to specific commits.
CompletableFuture<BuildWorkItems>	getFromCommitsAsync(int buildId, List<String> commitId, int top)	Gets the work items associated with a build, filtered to specific commits.

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

BuildWorkItemsRequestBuilder

public BuildWorkItemsRequestBuilder(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<BuildWorkItems> getAsync(int buildId)
                                           throws AzDException

Gets the work items associated with a build. Only work items in the same project are returned.

Parameters:

buildId - ID of the build.

Returns:

Future object of BuildWorkItems BuildWorkItems

Throws:

AzDException - Default Api exception handler.

getAsync

public CompletableFuture<BuildWorkItems> getAsync(int buildId,
 int top)
                                           throws AzDException

Gets the work items associated with a build. Only work items in the same project are returned.

Parameters:

buildId - ID of the build.

top - The maximum number of work items to return.

Returns:

Future object of BuildWorkItems BuildWorkItems

Throws:

AzDException - Default Api exception handler.

getFromCommitsAsync

public CompletableFuture<BuildWorkItems> getFromCommitsAsync(int buildId,
 List<String> commitId,
 int top)
                                                      throws AzDException

Gets the work items associated with a build, filtered to specific commits.

Parameters:

buildId - ID of the build.

commitId - List of commit ids to get the work items.

top - The maximum number of work items to return, or the number of commits to consider if no commit IDs are specified.

Returns:

Future object of BuildWorkItems BuildWorkItems

Throws:

AzDException - Default Api exception handler.

getAsync

public CompletableFuture<BuildWorkItems> getAsync(Consumer<BuildWorkItemsRequestBuilder.RequestConfiguration> requestConfiguration)
                                           throws AzDException

Gets all the work items between two builds.

Parameters:

requestConfiguration - Consumer of Request configuration query parameters.

Returns:

Future object of BuildWorkItems BuildWorkItems

Throws:

AzDException - Default Api exception handler.

get

public BuildWorkItems get(int buildId)
                   throws AzDException

Gets the work items associated with a build. Only work items in the same project are returned.

Parameters:

buildId - ID of the build.

Returns:

Future object of BuildWorkItems BuildWorkItems

Throws:

AzDException - Default Api exception handler.

get

public BuildWorkItems get(int buildId,
 int top)
                   throws AzDException

Gets the work items associated with a build. Only work items in the same project are returned.

Parameters:

buildId - ID of the build.

top - The maximum number of work items to return.

Returns:

Future object of BuildWorkItems BuildWorkItems

Throws:

AzDException - Default Api exception handler.

getFromCommits

public BuildWorkItems getFromCommits(int buildId,
 List<String> commitId,
 int top)
                              throws AzDException

Gets the work items associated with a build, filtered to specific commits.

Parameters:

buildId - ID of the build.

commitId - List of commit ids to get the work items.

top - The maximum number of work items to return, or the number of commits to consider if no commit IDs are specified.

Returns:

Future object of BuildWorkItems BuildWorkItems

Throws:

AzDException - Default Api exception handler.

get

public BuildWorkItems get(Consumer<BuildWorkItemsRequestBuilder.RequestConfiguration> requestConfiguration)
                   throws AzDException

Gets all the work items between two builds.

Parameters:

requestConfiguration - Consumer of Request configuration query parameters.

Returns:

Future object of BuildWorkItems BuildWorkItems

Throws:

AzDException - Default Api exception handler.