Package org.azd.workitemtracking.workitems

Class WorkItemsRequestBuilder

java.lang.Object

org.azd.abstractions.BaseRequestBuilder

org.azd.workitemtracking.workitems.WorkItemsRequestBuilder

public class WorkItemsRequestBuilder
extends BaseRequestBuilder

Provides functionality to work with work items Api.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WorkItemsRequestBuilder.CreateQueryParameters	Represents the query parameters.
static class	WorkItemsRequestBuilder.CreateRequestConfiguration	Request configuration object for the query parameters.
static class	WorkItemsRequestBuilder.GetQueryParameters	Represents the query parameters.
static class	WorkItemsRequestBuilder.GetRequestConfiguration	Request configuration object for the query parameters.
static class	WorkItemsRequestBuilder.ListQueryParameters	Represents the query parameters.
static class	WorkItemsRequestBuilder.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
WorkItemsRequestBuilder(String organizationUrl, AccessTokenCredential accessTokenCredential)	Instantiates a new RequestBuilder instance and sets the default values.

Method Summary

Modifier and Type	Method	Description
WorkItem	create(String type, List<JsonPatchDocument> jsonPatchDocuments)	Creates a single work item.
WorkItem	create(String type, List<JsonPatchDocument> jsonPatchDocuments, Consumer<WorkItemsRequestBuilder.CreateRequestConfiguration> requestConfiguration)	Creates a single work item.
CompletableFuture<WorkItem>	createAsync(String type, List<JsonPatchDocument> jsonPatchDocuments)	Creates a single work item.
CompletableFuture<WorkItem>	createAsync(String type, List<JsonPatchDocument> jsonPatchDocuments, Consumer<WorkItemsRequestBuilder.CreateRequestConfiguration> requestConfiguration)	Creates a single work item.
WorkItemDelete	delete(int id)	Deletes the specified work item and sends it to the Recycle Bin, so that it can be restored back, if required.
WorkItemDelete	delete(int id, boolean destroy)	Deletes the specified work item permanently if the destroy parameter has been set to true, WARNING: If the destroy parameter is set to true, work items deleted by this command will NOT go to recycle-bin and there is no way to restore/recover them after deletion.
WorkItemDeleteBatch	delete(WorkItemDeleteBatchRequest workItemDeleteBatchRequest)	Deletes specified work items and sends them to the Recycle Bin, so that it can be restored back, if required.
CompletableFuture<WorkItemDelete>	deleteAsync(int id)	Deletes the specified work item and sends it to the Recycle Bin, so that it can be restored back, if required.
CompletableFuture<WorkItemDelete>	deleteAsync(int id, boolean destroy)	Deletes the specified work item permanently if the destroy parameter has been set to true, WARNING: If the destroy parameter is set to true, work items deleted by this command will NOT go to recycle-bin and there is no way to restore/recover them after deletion.
CompletableFuture<WorkItemDeleteBatch>	deleteAsync(WorkItemDeleteBatchRequest workItemDeleteBatchRequest)	Deletes specified work items and sends them to the Recycle Bin, so that it can be restored back, if required.
WorkItem	get(int id)	Returns a single work item.
WorkItem	get(int id, Consumer<WorkItemsRequestBuilder.GetRequestConfiguration> requestConfiguration)	Returns a single work item.
CompletableFuture<WorkItem>	getAsync(int id)	Returns a single work item.
CompletableFuture<WorkItem>	getAsync(int id, Consumer<WorkItemsRequestBuilder.GetRequestConfiguration> requestConfiguration)	Returns a single work item.
WorkItemList	getBatch(WorkItemBatchGetRequest workItemBatchGetRequest)	Gets work items for a list of work item ids (Maximum 200)
CompletableFuture<WorkItemList>	getBatchAsync(WorkItemBatchGetRequest workItemBatchGetRequest)	Gets work items for a list of work item ids (Maximum 200)
WorkItem	getTemplate(String type)	Returns a single work item from a template.
WorkItem	getTemplate(String type, Consumer<WorkItemsRequestBuilder.GetRequestConfiguration> requestConfiguration)	Returns a single work item from a template.
CompletableFuture<WorkItem>	getTemplateAsync(String type)	Returns a single work item from a template.
CompletableFuture<WorkItem>	getTemplateAsync(String type, Consumer<WorkItemsRequestBuilder.GetRequestConfiguration> requestConfiguration)	Returns a single work item from a template.
WorkItemList	list(int... ids)	Returns a list of work items (Maximum 200)
WorkItemList	list(Consumer<WorkItemsRequestBuilder.RequestConfiguration> requestConfiguration)	Returns a list of work items (Maximum 200)
CompletableFuture<WorkItemList>	listAsync(Consumer<WorkItemsRequestBuilder.RequestConfiguration> requestConfiguration)	Returns a list of work items (Maximum 200)
WorkItem	update(int id, List<JsonPatchDocument> jsonPatchDocuments)	Updates a single work item.
WorkItem	update(int id, List<JsonPatchDocument> jsonPatchDocuments, Consumer<WorkItemsRequestBuilder.CreateRequestConfiguration> requestConfiguration)	Updates a single work item.
CompletableFuture<WorkItem>	updateAsync(int id, List<JsonPatchDocument> jsonPatchDocuments)	Updates a single work item.
CompletableFuture<WorkItem>	updateAsync(int id, List<JsonPatchDocument> jsonPatchDocuments, Consumer<WorkItemsRequestBuilder.CreateRequestConfiguration> requestConfiguration)	Updates a single work item.

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

WorkItemsRequestBuilder

public WorkItemsRequestBuilder(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<WorkItem> createAsync(String type,
 List<JsonPatchDocument> jsonPatchDocuments)
                                        throws AzDException

Creates a single work item.

Parameters:

type - The work item type of the work item to create.

jsonPatchDocuments - Request body to create the work item.

Returns:

Work item object. WorkItem

Throws:

AzDException - Default Api exception handler.

createAsync

public CompletableFuture<WorkItem> createAsync(String type,
 List<JsonPatchDocument> jsonPatchDocuments,
 Consumer<WorkItemsRequestBuilder.CreateRequestConfiguration> requestConfiguration)
                                        throws AzDException

Creates a single work item.

Parameters:

type - The work item type of the work item to create.

jsonPatchDocuments - Request body to create the work item.

requestConfiguration - Represents the query parameters.

Returns:

Work item object. WorkItem

Throws:

AzDException - Default Api exception handler.

deleteAsync

public CompletableFuture<WorkItemDelete> deleteAsync(int id)
                                              throws AzDException

Deletes the specified work item and sends it to the Recycle Bin, so that it can be restored back, if required.

Parameters:

id - ID of the work item to be deleted

Returns:

Work item delete object. WorkItemDelete

Throws:

AzDException - Default Api Exception handler.

deleteAsync

public CompletableFuture<WorkItemDelete> deleteAsync(int id,
 boolean destroy)
                                              throws AzDException

Deletes the specified work item permanently if the destroy parameter has been set to true, WARNING: If the destroy parameter is set to true, work items deleted by this command will NOT go to recycle-bin and there is no way to restore/recover them after deletion. It is recommended NOT to use this parameter. If you do, please use this parameter with extreme caution.

Parameters:

id - ID of the work item to be deleted

destroy - Optional parameter, if set to true, the work item is deleted permanently. Please note: the destroy action is PERMANENT and cannot be undone.

Returns:

Describes response to delete a set of work items. WorkItemDeleteBatch

Throws:

AzDException - Default Api Exception handler.

deleteAsync

public CompletableFuture<WorkItemDeleteBatch> deleteAsync(WorkItemDeleteBatchRequest workItemDeleteBatchRequest)
                                                   throws AzDException

Deletes specified work items and sends them to the Recycle Bin, so that it can be restored back, if required. Optionally, if the destroy parameter has been set to true, it destroys the work item permanently. WARNING: If the destroy parameter is set to true, work items deleted by this command will NOT go to recycle-bin and there is no way to restore/recover them after deletion.

Parameters:

workItemDeleteBatchRequest - Describes a request to delete a set of work items

Returns:

Describes response to delete a set of work items. WorkItemDeleteBatch

Throws:

AzDException - Default Api Exception handler.

getAsync

public CompletableFuture<WorkItem> getAsync(int id)
                                     throws AzDException

Returns a single work item.

Parameters:

id - The work item id

Returns:

WorkItem WorkItem

Throws:

AzDException - Default Api Exception handler.

getAsync

public CompletableFuture<WorkItem> getAsync(int id,
 Consumer<WorkItemsRequestBuilder.GetRequestConfiguration> requestConfiguration)
                                     throws AzDException

Returns a single work item.

Parameters:

id - The work item id

requestConfiguration - Represents the query parameters.

Returns:

WorkItem WorkItem

Throws:

AzDException - Default Api Exception handler.

getTemplateAsync

public CompletableFuture<WorkItem> getTemplateAsync(String type)
                                             throws AzDException

Returns a single work item from a template.

Parameters:

type - The work item type name

Returns:

WorkItem object WorkItem

Throws:

AzDException - Default Api Exception handler.

getTemplateAsync

public CompletableFuture<WorkItem> getTemplateAsync(String type,
 Consumer<WorkItemsRequestBuilder.GetRequestConfiguration> requestConfiguration)
                                             throws AzDException

Returns a single work item from a template.

Parameters:

type - The work item type name

requestConfiguration - Represents the query parameters.

Returns:

WorkItem object WorkItem

Throws:

AzDException - Default Api Exception handler.

getBatchAsync

public CompletableFuture<WorkItemList> getBatchAsync(WorkItemBatchGetRequest workItemBatchGetRequest)
                                              throws AzDException

Gets work items for a list of work item ids (Maximum 200)

Parameters:

workItemBatchGetRequest - Describes a request to get a set of work items

Returns:

Array of work item WorkItemList

Throws:

AzDException - Default Api Exception handler.

listAsync

public CompletableFuture<WorkItemList> listAsync(Consumer<WorkItemsRequestBuilder.RequestConfiguration> requestConfiguration)
                                          throws AzDException

Returns a list of work items (Maximum 200)

Parameters:

requestConfiguration - Represents the query parameters.

Returns:

Collection of WorkItem object WorkItemList

Throws:

AzDException - Default Api Exception handler.

updateAsync

public CompletableFuture<WorkItem> updateAsync(int id,
 List<JsonPatchDocument> jsonPatchDocuments)
                                        throws AzDException

Updates a single work item.

Parameters:

id - The id of the work item to update

jsonPatchDocuments - Request body to update a work item

Returns:

WorkItem object WorkItem

Throws:

AzDException - Default Api Exception handler.

updateAsync

public CompletableFuture<WorkItem> updateAsync(int id,
 List<JsonPatchDocument> jsonPatchDocuments,
 Consumer<WorkItemsRequestBuilder.CreateRequestConfiguration> requestConfiguration)
                                        throws AzDException

Updates a single work item.

Parameters:

id - The id of the work item to update

jsonPatchDocuments - Request body to update a work item

requestConfiguration - Represents the query parameters.

Returns:

WorkItem object WorkItem

Throws:

AzDException - Default Api Exception handler.

create

public WorkItem create(String type,
 List<JsonPatchDocument> jsonPatchDocuments)
                throws AzDException

Creates a single work item.

Parameters:

type - The work item type of the work item to create.

jsonPatchDocuments - Request body to create the work item.

Returns:

Work item object. WorkItem

Throws:

AzDException - Default Api exception handler.

create

public WorkItem create(String type,
 List<JsonPatchDocument> jsonPatchDocuments,
 Consumer<WorkItemsRequestBuilder.CreateRequestConfiguration> requestConfiguration)
                throws AzDException

Creates a single work item.

Parameters:

type - The work item type of the work item to create.

jsonPatchDocuments - Request body to create the work item.

requestConfiguration - Represents the query parameters.

Returns:

Work item object. WorkItem

Throws:

AzDException - Default Api exception handler.

delete

public WorkItemDelete delete(int id)
                      throws AzDException

Deletes the specified work item and sends it to the Recycle Bin, so that it can be restored back, if required.

Parameters:

id - ID of the work item to be deleted

Returns:

Work item delete object. WorkItemDelete

Throws:

AzDException - Default Api Exception handler.

delete

public WorkItemDelete delete(int id,
 boolean destroy)
                      throws AzDException

Deletes the specified work item permanently if the destroy parameter has been set to true, WARNING: If the destroy parameter is set to true, work items deleted by this command will NOT go to recycle-bin and there is no way to restore/recover them after deletion. It is recommended NOT to use this parameter. If you do, please use this parameter with extreme caution.

Parameters:

id - ID of the work item to be deleted

destroy - Optional parameter, if set to true, the work item is deleted permanently. Please note: the destroy action is PERMANENT and cannot be undone.

Returns:

Describes response to delete a set of work items. WorkItemDeleteBatch

Throws:

AzDException - Default Api Exception handler.

delete

public WorkItemDeleteBatch delete(WorkItemDeleteBatchRequest workItemDeleteBatchRequest)
                           throws AzDException

Deletes specified work items and sends them to the Recycle Bin, so that it can be restored back, if required. Optionally, if the destroy parameter has been set to true, it destroys the work item permanently. WARNING: If the destroy parameter is set to true, work items deleted by this command will NOT go to recycle-bin and there is no way to restore/recover them after deletion.

Parameters:

workItemDeleteBatchRequest - Describes a request to delete a set of work items

Returns:

Describes response to delete a set of work items. WorkItemDeleteBatch

Throws:

AzDException - Default Api Exception handler.

get

public WorkItem get(int id)
             throws AzDException

Returns a single work item.

Parameters:

id - The work item id

Returns:

WorkItem WorkItem

Throws:

AzDException - Default Api Exception handler.

get

public WorkItem get(int id,
 Consumer<WorkItemsRequestBuilder.GetRequestConfiguration> requestConfiguration)
             throws AzDException

Returns a single work item.

Parameters:

id - The work item id

requestConfiguration - Represents the query parameters.

Returns:

WorkItem WorkItem

Throws:

AzDException - Default Api Exception handler.

getTemplate

public WorkItem getTemplate(String type)
                     throws AzDException

Returns a single work item from a template.

Parameters:

type - The work item type name

Returns:

WorkItem object WorkItem

Throws:

AzDException - Default Api Exception handler.

getTemplate

public WorkItem getTemplate(String type,
 Consumer<WorkItemsRequestBuilder.GetRequestConfiguration> requestConfiguration)
                     throws AzDException

Returns a single work item from a template.

Parameters:

type - The work item type name

requestConfiguration - Represents the query parameters.

Returns:

WorkItem object WorkItem

Throws:

AzDException - Default Api Exception handler.

getBatch

public WorkItemList getBatch(WorkItemBatchGetRequest workItemBatchGetRequest)
                      throws AzDException

Gets work items for a list of work item ids (Maximum 200)

Parameters:

workItemBatchGetRequest - Describes a request to get a set of work items

Returns:

Array of work item WorkItemList

Throws:

AzDException - Default Api Exception handler.

list

public WorkItemList list(int... ids)
                  throws AzDException

Returns a list of work items (Maximum 200)

Parameters:

ids - Array of work item ids to list.

Returns:

Collection of WorkItem object WorkItemList

Throws:

AzDException - Default Api Exception handler.

list

public WorkItemList list(Consumer<WorkItemsRequestBuilder.RequestConfiguration> requestConfiguration)
                  throws AzDException

Returns a list of work items (Maximum 200)

Parameters:

requestConfiguration - Represents the query parameters.

Returns:

Collection of WorkItem object WorkItemList

Throws:

AzDException - Default Api Exception handler.

update

public WorkItem update(int id,
 List<JsonPatchDocument> jsonPatchDocuments)
                throws AzDException

Updates a single work item.

Parameters:

id - The id of the work item to update

jsonPatchDocuments - Request body to update a work item

Returns:

WorkItem object WorkItem

Throws:

AzDException - Default Api Exception handler.

update

public WorkItem update(int id,
 List<JsonPatchDocument> jsonPatchDocuments,
 Consumer<WorkItemsRequestBuilder.CreateRequestConfiguration> requestConfiguration)
                throws AzDException

Updates a single work item.

Parameters:

id - The id of the work item to update

jsonPatchDocuments - Request body to update a work item

requestConfiguration - Represents the query parameters.

Returns:

WorkItem object WorkItem

Throws:

AzDException - Default Api Exception handler.