Package org.azd.workitemtracking.revisions

Class WorkItemRevisionsRequestBuilder

java.lang.Object

org.azd.abstractions.BaseRequestBuilder

org.azd.workitemtracking.revisions.WorkItemRevisionsRequestBuilder

public class WorkItemRevisionsRequestBuilder
extends BaseRequestBuilder

Provides functionality to work with Work item revisions Api.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
WorkItem	get(int id, int revisionNumber)	Returns a fully hydrated work item for the requested revision
WorkItem	get(int id, int revisionNumber, WorkItemExpand expand)	Returns a fully hydrated work item for the requested revision
CompletableFuture<WorkItem>	getAsync(int id, int revisionNumber)	Returns a fully hydrated work item for the requested revision
CompletableFuture<WorkItem>	getAsync(int id, int revisionNumber, WorkItemExpand expand)	Returns a fully hydrated work item for the requested revision
WorkItemList	list(int id)	Returns the list of fully hydrated work item revisions, paged.
WorkItemList	list(int id, Consumer<WorkItemRevisionsRequestBuilder.RequestConfiguration> requestConfiguration)	Returns the list of fully hydrated work item revisions, paged.
CompletableFuture<WorkItemList>	listAsync(int id)	Returns the list of fully hydrated work item revisions, paged.
CompletableFuture<WorkItemList>	listAsync(int id, Consumer<WorkItemRevisionsRequestBuilder.RequestConfiguration> requestConfiguration)	Returns the list of fully hydrated work item revisions, paged.

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

WorkItemRevisionsRequestBuilder

public WorkItemRevisionsRequestBuilder(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<WorkItem> getAsync(int id,
 int revisionNumber)
                                     throws AzDException

Returns a fully hydrated work item for the requested revision

Parameters:

id - ID of the work item.

revisionNumber - Revision number of work item to retrieve.

Returns:

WorkItem object WorkItem

Throws:

AzDException - Default Api exception handler.

getAsync

public CompletableFuture<WorkItem> getAsync(int id,
 int revisionNumber,
 WorkItemExpand expand)
                                     throws AzDException

Returns a fully hydrated work item for the requested revision

Parameters:

id - ID of the work item.

revisionNumber - Revision number of work item to retrieve.

expand - Expands the work item fields.

Returns:

WorkItem object WorkItem

Throws:

AzDException - Default Api exception handler.

listAsync

public CompletableFuture<WorkItemList> listAsync(int id)
                                          throws AzDException

Returns the list of fully hydrated work item revisions, paged.

Parameters:

id - ID of the work item.

Returns:

Collection of work item WorkItemList

Throws:

AzDException - Default Api exception handler.

listAsync

public CompletableFuture<WorkItemList> listAsync(int id,
 Consumer<WorkItemRevisionsRequestBuilder.RequestConfiguration> requestConfiguration)
                                          throws AzDException

Returns the list of fully hydrated work item revisions, paged.

Parameters:

id - ID of the work item.

requestConfiguration - Represents the query parameters.

Returns:

Collection of work item WorkItemList

Throws:

AzDException - Default Api exception handler.

get

public WorkItem get(int id,
 int revisionNumber)
             throws AzDException

Returns a fully hydrated work item for the requested revision

Parameters:

id - ID of the work item.

revisionNumber - Revision number of work item to retrieve.

Returns:

WorkItem object WorkItem

Throws:

AzDException - Default Api exception handler.

get

public WorkItem get(int id,
 int revisionNumber,
 WorkItemExpand expand)
             throws AzDException

Returns a fully hydrated work item for the requested revision

Parameters:

id - ID of the work item.

revisionNumber - Revision number of work item to retrieve.

expand - Expands the work item fields.

Returns:

WorkItem object WorkItem

Throws:

AzDException - Default Api exception handler.

list

public WorkItemList list(int id)
                  throws AzDException

Returns the list of fully hydrated work item revisions, paged.

Parameters:

id - ID of the work item.

Returns:

Collection of work item WorkItemList

Throws:

AzDException - Default Api exception handler.

list

public WorkItemList list(int id,
 Consumer<WorkItemRevisionsRequestBuilder.RequestConfiguration> requestConfiguration)
                  throws AzDException

Returns the list of fully hydrated work item revisions, paged.

Parameters:

id - ID of the work item.

requestConfiguration - Represents the query parameters.

Returns:

Collection of work item WorkItemList

Throws:

AzDException - Default Api exception handler.