Package org.azd.workitemtracking.recyclebin

Class RecycleBinRequestBuilder

java.lang.Object

org.azd.abstractions.BaseRequestBuilder

org.azd.workitemtracking.recyclebin.RecycleBinRequestBuilder

public class RecycleBinRequestBuilder
extends BaseRequestBuilder

Provides functionality to work with Work item recycle bin Api.

Nested Class Summary

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
RecycleBinRequestBuilder(String organizationUrl, AccessTokenCredential accessTokenCredential)	Instantiates a new RequestBuilder instance and sets the default values.

Method Summary

Modifier and Type	Method	Description
Void	destroy(int id)	Destroys the specified work item permanently from the Recycle Bin.
CompletableFuture<Void>	destroyAsync(int id)	Destroys the specified work item permanently from the Recycle Bin.
WorkItemDelete	get(int id)	Gets a deleted work item from Recycle Bin.
CompletableFuture<WorkItemDelete>	getAsync(int id)	Gets a deleted work item from Recycle Bin.
WorkItemDeleteShallowReferences	list()	Gets a list of the IDs and the URLs of the deleted the work items in the Recycle Bin.
WorkItemDeleteReferences	list(int... ids)	Gets the work items from the recycle bin, whose IDs have been specified in the parameters
CompletableFuture<WorkItemDeleteShallowReferences>	listAsync()	Gets a list of the IDs and the URLs of the deleted the work items in the Recycle Bin.
CompletableFuture<WorkItemDeleteReferences>	listAsync(int... ids)	Gets the work items from the recycle bin, whose IDs have been specified in the parameters
WorkItemDelete	restore(int id, boolean isDeleted)	Restores the deleted work item from Recycle Bin.
CompletableFuture<WorkItemDelete>	restoreAsync(int id, boolean isDeleted)	Restores the deleted work item from Recycle Bin.

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

RecycleBinRequestBuilder

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

destroyAsync

public CompletableFuture<Void> destroyAsync(int id)
                                     throws AzDException

Destroys the specified work item permanently from the Recycle Bin. This action can not be undone.

Parameters:

id - ID of the work item to be destroyed permanently

Throws:

AzDException - Default Api exception handler.

getAsync

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

Gets a deleted work item from Recycle Bin.

Parameters:

id - ID of the work item to be returned

Returns:

Work item delete object WorkItemDelete

Throws:

AzDException - Default Api exception handler.

listAsync

public CompletableFuture<WorkItemDeleteShallowReferences> listAsync()
                                                             throws AzDException

Gets a list of the IDs and the URLs of the deleted the work items in the Recycle Bin.

Returns:

Collection of WorkItemDeleteShallowReference WorkItemDeleteShallowReferences

Throws:

AzDException - Default Api exception handler.

listAsync

public CompletableFuture<WorkItemDeleteReferences> listAsync(int... ids)
                                                      throws AzDException

Gets the work items from the recycle bin, whose IDs have been specified in the parameters

Parameters:

ids - Array of IDs of the deleted work items to be returned

Returns:

Collection of WorkItemDeleteReference WorkItemDeleteReferences

Throws:

AzDException - Default Api exception handler.

restoreAsync

public CompletableFuture<WorkItemDelete> restoreAsync(int id,
 boolean isDeleted)
                                               throws AzDException

Restores the deleted work item from Recycle Bin.

Parameters:

id - ID of the work item to be restored

isDeleted - Sets a value indicating whether this work item is deleted.

Returns:

Work item delete object WorkItemDelete

Throws:

AzDException - Default Api exception handler.

destroy

public Void destroy(int id)
             throws AzDException

Destroys the specified work item permanently from the Recycle Bin. This action can not be undone.

Parameters:

id - ID of the work item to be destroyed permanently

Throws:

AzDException - Default Api exception handler.

get

public WorkItemDelete get(int id)
                   throws AzDException

Gets a deleted work item from Recycle Bin.

Parameters:

id - ID of the work item to be returned

Returns:

Work item delete object WorkItemDelete

Throws:

AzDException - Default Api exception handler.

list

public WorkItemDeleteShallowReferences list()
                                     throws AzDException

Gets a list of the IDs and the URLs of the deleted the work items in the Recycle Bin.

Returns:

Collection of WorkItemDeleteShallowReference WorkItemDeleteShallowReferences

Throws:

AzDException - Default Api exception handler.

list

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

Gets the work items from the recycle bin, whose IDs have been specified in the parameters

Parameters:

ids - Array of IDs of the deleted work items to be returned

Returns:

Collection of WorkItemDeleteReference WorkItemDeleteReferences

Throws:

AzDException - Default Api exception handler.

restore

public WorkItemDelete restore(int id,
 boolean isDeleted)
                       throws AzDException

Restores the deleted work item from Recycle Bin.

Parameters:

id - ID of the work item to be restored

isDeleted - Sets a value indicating whether this work item is deleted.

Returns:

Work item delete object WorkItemDelete

Throws:

AzDException - Default Api exception handler.