Package org.azd.workitemtracking.classificationnodes

Class ClassificationNodesRequestBuilder

java.lang.Object

org.azd.abstractions.BaseRequestBuilder

org.azd.workitemtracking.classificationnodes.ClassificationNodesRequestBuilder

public class ClassificationNodesRequestBuilder
extends BaseRequestBuilder

Provides functionality to work with Work item tracking classification nodes Api.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
WorkItemClassificationNode	createOrUpdate(TreeStructureGroup structureGroup, String path, WorkItemClassificationNode workItemClassificationNode)	Create new or update an existing classification node.
WorkItemClassificationNode	createOrUpdate(TreeStructureGroup structureGroup, WorkItemClassificationNode workItemClassificationNode)	Create new or update an existing classification node.
CompletableFuture<WorkItemClassificationNode>	createOrUpdateAsync(TreeStructureGroup structureGroup, String path, WorkItemClassificationNode workItemClassificationNode)	Create new or update an existing classification node.
CompletableFuture<WorkItemClassificationNode>	createOrUpdateAsync(TreeStructureGroup structureGroup, WorkItemClassificationNode workItemClassificationNode)	Create new or update an existing classification node.
Void	delete(TreeStructureGroup structureGroup, String path)	Delete an existing classification node.
Void	delete(TreeStructureGroup structureGroup, String path, int reclassifyId)	Delete an existing classification node.
CompletableFuture<Void>	deleteAsync(TreeStructureGroup structureGroup, String path)	Delete an existing classification node.
CompletableFuture<Void>	deleteAsync(TreeStructureGroup structureGroup, String path, int reclassifyId)	Delete an existing classification node.
WorkItemClassificationNode	get(TreeStructureGroup structureGroup, String path)	Gets the classification node for a given node path.
WorkItemClassificationNode	get(TreeStructureGroup structureGroup, String path, int depth)	Gets the classification node for a given node path.
CompletableFuture<WorkItemClassificationNode>	getAsync(TreeStructureGroup structureGroup, String path)	Gets the classification node for a given node path.
CompletableFuture<WorkItemClassificationNode>	getAsync(TreeStructureGroup structureGroup, String path, int depth)	Gets the classification node for a given node path.
WorkItemClassificationNodes	list(Consumer<ClassificationNodesRequestBuilder.RequestConfiguration> requestConfiguration)	Gets root classification nodes or list of classification nodes for a given list of nodes ids, for a given project.
CompletableFuture<WorkItemClassificationNodes>	listAsync(Consumer<ClassificationNodesRequestBuilder.RequestConfiguration> requestConfiguration)	Gets root classification nodes or list of classification nodes for a given list of nodes ids, for a given project.
WorkItemClassificationNodes	listRoot()	Gets root classification nodes under the project.
WorkItemClassificationNodes	listRoot(int depth)	Gets root classification nodes under the project.
CompletableFuture<WorkItemClassificationNodes>	listRootAsync()	Gets root classification nodes under the project.
CompletableFuture<WorkItemClassificationNodes>	listRootAsync(int depth)	Gets root classification nodes under the project.
WorkItemClassificationNode	update(TreeStructureGroup structureGroup, String path, WorkItemClassificationNode workItemClassificationNode)	Update an existing classification node.
CompletableFuture<WorkItemClassificationNode>	updateAsync(TreeStructureGroup structureGroup, String path, WorkItemClassificationNode workItemClassificationNode)	Update an existing classification node.

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

ClassificationNodesRequestBuilder

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

createOrUpdateAsync

public CompletableFuture<WorkItemClassificationNode> createOrUpdateAsync(TreeStructureGroup structureGroup,
 WorkItemClassificationNode workItemClassificationNode)
                                                                  throws AzDException

Create new or update an existing classification node.

Parameters:

structureGroup - Structure group of the classification node, area or iteration.

workItemClassificationNode - Defines a classification node for work item tracking.

Returns:

Defines a classification node for work item tracking. WorkItemClassificationNode

Throws:

AzDException - Default Api exception handler.

createOrUpdateAsync

public CompletableFuture<WorkItemClassificationNode> createOrUpdateAsync(TreeStructureGroup structureGroup,
 String path,
 WorkItemClassificationNode workItemClassificationNode)
                                                                  throws AzDException

Create new or update an existing classification node.

Parameters:

structureGroup - Structure group of the classification node, area or iteration.

path - Path of the classification node.

workItemClassificationNode - Defines a classification node for work item tracking.

Returns:

Defines a classification node for work item tracking. WorkItemClassificationNode

Throws:

AzDException - Default Api exception handler.

deleteAsync

public CompletableFuture<Void> deleteAsync(TreeStructureGroup structureGroup,
 String path)
                                    throws AzDException

Delete an existing classification node.

Parameters:

structureGroup - Structure group of the classification node, area or iteration.

path - Path of the classification node.

Throws:

AzDException - Default Api exception handler.

deleteAsync

public CompletableFuture<Void> deleteAsync(TreeStructureGroup structureGroup,
 String path,
 int reclassifyId)
                                    throws AzDException

Delete an existing classification node.

Parameters:

structureGroup - Structure group of the classification node, area or iteration.

path - Path of the classification node.

reclassifyId - Id of the target classification node for reclassification.

Throws:

AzDException - Default Api exception handler.

getAsync

public CompletableFuture<WorkItemClassificationNode> getAsync(TreeStructureGroup structureGroup,
 String path)
                                                       throws AzDException

Gets the classification node for a given node path.

Parameters:

structureGroup - Structure group of the classification node, area or iteration.

path - Path of the classification node.

Returns:

Defines a classification node for work item tracking. WorkItemClassificationNode

Throws:

AzDException - Default Api exception handler.

getAsync

public CompletableFuture<WorkItemClassificationNode> getAsync(TreeStructureGroup structureGroup,
 String path,
 int depth)
                                                       throws AzDException

Gets the classification node for a given node path.

Parameters:

structureGroup - Structure group of the classification node, area or iteration.

path - Path of the classification node.

depth - Depth of children to fetch.

Returns:

Defines a classification node for work item tracking. WorkItemClassificationNode

Throws:

AzDException - Default Api exception handler.

listAsync

public CompletableFuture<WorkItemClassificationNodes> listAsync(Consumer<ClassificationNodesRequestBuilder.RequestConfiguration> requestConfiguration)
                                                         throws AzDException

Gets root classification nodes or list of classification nodes for a given list of nodes ids, for a given project. In case ids parameter is supplied you will get list of classification nodes for those ids. Otherwise you will get root classification nodes for this project.

Parameters:

requestConfiguration - Represents the query parameters.

Returns:

Collection of WorkItemClassificationNode object WorkItemClassificationNodes

Throws:

AzDException - Default Api exception handler.

listRootAsync

public CompletableFuture<WorkItemClassificationNodes> listRootAsync()
                                                             throws AzDException

Gets root classification nodes under the project.

Returns:

Collection of WorkItemClassificationNode object WorkItemClassificationNodes

Throws:

AzDException - Default Api exception handler.

listRootAsync

public CompletableFuture<WorkItemClassificationNodes> listRootAsync(int depth)
                                                             throws AzDException

Gets root classification nodes under the project.

Parameters:

depth - Depth of children to fetch.

Returns:

Collection of WorkItemClassificationNode object WorkItemClassificationNodes

Throws:

AzDException - Default Api exception handler.

updateAsync

public CompletableFuture<WorkItemClassificationNode> updateAsync(TreeStructureGroup structureGroup,
 String path,
 WorkItemClassificationNode workItemClassificationNode)
                                                          throws AzDException

Update an existing classification node.

Parameters:

structureGroup - Structure group of the classification node, area or iteration.

path - Path of the classification node.

workItemClassificationNode - Defines a classification node for work item tracking.

Returns:

Defines a classification node for work item tracking. WorkItemClassificationNode

Throws:

AzDException - Default Api exception handler.

createOrUpdate

public WorkItemClassificationNode createOrUpdate(TreeStructureGroup structureGroup,
 WorkItemClassificationNode workItemClassificationNode)
                                          throws AzDException

Create new or update an existing classification node.

Parameters:

structureGroup - Structure group of the classification node, area or iteration.

workItemClassificationNode - Defines a classification node for work item tracking.

Returns:

Defines a classification node for work item tracking. WorkItemClassificationNode

Throws:

AzDException - Default Api exception handler.

createOrUpdate

public WorkItemClassificationNode createOrUpdate(TreeStructureGroup structureGroup,
 String path,
 WorkItemClassificationNode workItemClassificationNode)
                                          throws AzDException

Create new or update an existing classification node.

Parameters:

structureGroup - Structure group of the classification node, area or iteration.

path - Path of the classification node.

workItemClassificationNode - Defines a classification node for work item tracking.

Returns:

Defines a classification node for work item tracking. WorkItemClassificationNode

Throws:

AzDException - Default Api exception handler.

delete

public Void delete(TreeStructureGroup structureGroup,
 String path)
            throws AzDException

Delete an existing classification node.

Parameters:

structureGroup - Structure group of the classification node, area or iteration.

path - Path of the classification node.

Throws:

AzDException - Default Api exception handler.

delete

public Void delete(TreeStructureGroup structureGroup,
 String path,
 int reclassifyId)
            throws AzDException

Delete an existing classification node.

Parameters:

structureGroup - Structure group of the classification node, area or iteration.

path - Path of the classification node.

reclassifyId - Id of the target classification node for reclassification.

Throws:

AzDException - Default Api exception handler.

get

public WorkItemClassificationNode get(TreeStructureGroup structureGroup,
 String path)
                               throws AzDException

Gets the classification node for a given node path.

Parameters:

structureGroup - Structure group of the classification node, area or iteration.

path - Path of the classification node.

Returns:

Defines a classification node for work item tracking. WorkItemClassificationNode

Throws:

AzDException - Default Api exception handler.

get

public WorkItemClassificationNode get(TreeStructureGroup structureGroup,
 String path,
 int depth)
                               throws AzDException

Gets the classification node for a given node path.

Parameters:

structureGroup - Structure group of the classification node, area or iteration.

path - Path of the classification node.

depth - Depth of children to fetch.

Returns:

Defines a classification node for work item tracking. WorkItemClassificationNode

Throws:

AzDException - Default Api exception handler.

list

public WorkItemClassificationNodes list(Consumer<ClassificationNodesRequestBuilder.RequestConfiguration> requestConfiguration)
                                 throws AzDException

Gets root classification nodes or list of classification nodes for a given list of nodes ids, for a given project. In case ids parameter is supplied you will get list of classification nodes for those ids. Otherwise you will get root classification nodes for this project.

Parameters:

requestConfiguration - Represents the query parameters.

Returns:

Collection of WorkItemClassificationNode object WorkItemClassificationNodes

Throws:

AzDException - Default Api exception handler.

listRoot

public WorkItemClassificationNodes listRoot()
                                     throws AzDException

Gets root classification nodes under the project.

Returns:

Collection of WorkItemClassificationNode object WorkItemClassificationNodes

Throws:

AzDException - Default Api exception handler.

listRoot

public WorkItemClassificationNodes listRoot(int depth)
                                     throws AzDException

Gets root classification nodes under the project.

Parameters:

depth - Depth of children to fetch.

Returns:

Collection of WorkItemClassificationNode object WorkItemClassificationNodes

Throws:

AzDException - Default Api exception handler.

update

public WorkItemClassificationNode update(TreeStructureGroup structureGroup,
 String path,
 WorkItemClassificationNode workItemClassificationNode)
                                  throws AzDException

Update an existing classification node.

Parameters:

structureGroup - Structure group of the classification node, area or iteration.

path - Path of the classification node.

workItemClassificationNode - Defines a classification node for work item tracking.

Returns:

Defines a classification node for work item tracking. WorkItemClassificationNode

Throws:

AzDException - Default Api exception handler.