Package org.azd.workitemtracking.queries

Class QueriesRequestBuilder

java.lang.Object

org.azd.abstractions.BaseRequestBuilder

org.azd.workitemtracking.queries.QueriesRequestBuilder

public class QueriesRequestBuilder
extends BaseRequestBuilder

Provides functionality to work with Work item queries Api.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
QueryHierarchyItem	create(String query, boolean validateWiqlOnly, QueryHierarchyItem queryHierarchyItem)	Creates a query, or moves a query.
QueryHierarchyItem	create(String query, QueryHierarchyItem queryHierarchyItem)	Creates a query, or moves a query.
CompletableFuture<QueryHierarchyItem>	createAsync(String query, boolean validateWiqlOnly, QueryHierarchyItem queryHierarchyItem)	Creates a query, or moves a query.
CompletableFuture<QueryHierarchyItem>	createAsync(String query, QueryHierarchyItem queryHierarchyItem)	Creates a query, or moves a query.
Void	delete(String query)	Delete a query or a folder.
CompletableFuture<Void>	deleteAsync(String query)	Delete a query or a folder.
QueryHierarchyItem	get(String query)	Retrieves an individual query and its children
QueryHierarchyItem	get(String query, Consumer<QueriesRequestBuilder.RequestConfiguration> requestConfiguration)	Retrieves an individual query and its children
CompletableFuture<QueryHierarchyItem>	getAsync(String query)	Retrieves an individual query and its children
CompletableFuture<QueryHierarchyItem>	getAsync(String query, Consumer<QueriesRequestBuilder.RequestConfiguration> requestConfiguration)	Retrieves an individual query and its children
QueryHierarchyItems	getBatch(QueryBatchGetRequest queryBatchGetRequest)	Gets a list of queries by ids (Maximum 1000)
CompletableFuture<QueryHierarchyItems>	getBatchAsync(QueryBatchGetRequest queryBatchGetRequest)	Gets a list of queries by ids (Maximum 1000)
QueryHierarchyItems	list()	Gets the root queries and their children
QueryHierarchyItems	list(Consumer<QueriesRequestBuilder.RequestConfiguration> requestConfiguration)	Gets the root queries and their children
CompletableFuture<QueryHierarchyItems>	listAsync()	Gets the root queries and their children
CompletableFuture<QueryHierarchyItems>	listAsync(Consumer<QueriesRequestBuilder.RequestConfiguration> requestConfiguration)	Gets the root queries and their children
QueryHierarchyItemsResult	search(Consumer<QueriesRequestBuilder.SearchRequestConfiguration> requestConfiguration)	Searches all queries the user has access to in the current project
CompletableFuture<QueryHierarchyItemsResult>	searchAsync(Consumer<QueriesRequestBuilder.SearchRequestConfiguration> requestConfiguration)	Searches all queries the user has access to in the current project
QueryHierarchyItem	update(String query, boolean undeleteDescendants, QueryHierarchyItem queryHierarchyItem)	Update a query or a folder.
QueryHierarchyItem	update(String query, QueryHierarchyItem queryHierarchyItem)	Update a query or a folder.
CompletableFuture<QueryHierarchyItem>	updateAsync(String query, boolean undeleteDescendants, QueryHierarchyItem queryHierarchyItem)	Update a query or a folder.
CompletableFuture<QueryHierarchyItem>	updateAsync(String query, QueryHierarchyItem queryHierarchyItem)	Update a query or a folder.

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

QueriesRequestBuilder

public QueriesRequestBuilder(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<QueryHierarchyItem> createAsync(String query,
 QueryHierarchyItem queryHierarchyItem)
                                                  throws AzDException

Creates a query, or moves a query.

Parameters:

query - The parent id or path under which the query is to be created.

queryHierarchyItem - Query Hierarchy item object.

Returns:

QueryHierarchyItem Object QueryHierarchyItem

Throws:

AzDException - Default Api Exception handler.

createAsync

public CompletableFuture<QueryHierarchyItem> createAsync(String query,
 boolean validateWiqlOnly,
 QueryHierarchyItem queryHierarchyItem)
                                                  throws AzDException

Creates a query, or moves a query.

Parameters:

query - The parent id or path under which the query is to be created.

validateWiqlOnly - If you only want to validate your WIQL query without actually creating one, set it to true. Default is false.

queryHierarchyItem - Query Hierarchy item object.

Returns:

QueryHierarchyItem Object QueryHierarchyItem

Throws:

AzDException - Default Api Exception handler.

deleteAsync

public CompletableFuture<Void> deleteAsync(String query)
                                    throws AzDException

Delete a query or a folder. This deletes any permission change on the deleted query or folder and any of its descendants if it is a folder. It is important to note that the deleted permission changes cannot be recovered upon undeleting the query or folder.

Parameters:

query - The parent id or path under which the query is to be created.

Throws:

AzDException - Default Api Exception handler.

getAsync

public CompletableFuture<QueryHierarchyItem> getAsync(String query)
                                               throws AzDException

Retrieves an individual query and its children

Parameters:

query - The parent id or path under which the query is to be created.

Returns:

QueryHierarchyItem Object QueryHierarchyItem

Throws:

AzDException - Default Api Exception handler.

getAsync

public CompletableFuture<QueryHierarchyItem> getAsync(String query,
 Consumer<QueriesRequestBuilder.RequestConfiguration> requestConfiguration)
                                               throws AzDException

Retrieves an individual query and its children

Parameters:

query - The parent id or path under which the query is to be created.

requestConfiguration - Represents the query parameters.

Returns:

QueryHierarchyItem Object QueryHierarchyItem

Throws:

AzDException - Default Api Exception handler.

getBatchAsync

public CompletableFuture<QueryHierarchyItems> getBatchAsync(QueryBatchGetRequest queryBatchGetRequest)
                                                     throws AzDException

Gets a list of queries by ids (Maximum 1000)

Parameters:

queryBatchGetRequest - Describes a request to get a list of queries QueryBatchGetRequest

Returns:

Collection of query hierarchy item QueryHierarchyItems

Throws:

AzDException - Default Api Exception handler.

listAsync

public CompletableFuture<QueryHierarchyItems> listAsync()
                                                 throws AzDException

Gets the root queries and their children

Returns:

Collection of query hierarchy item QueryHierarchyItems

Throws:

AzDException - Default Api Exception handler.

listAsync

public CompletableFuture<QueryHierarchyItems> listAsync(Consumer<QueriesRequestBuilder.RequestConfiguration> requestConfiguration)
                                                 throws AzDException

Gets the root queries and their children

Parameters:

requestConfiguration - Represents the query parameters.

Returns:

Collection of query hierarchy item QueryHierarchyItems

Throws:

AzDException - Default Api Exception handler.

searchAsync

public CompletableFuture<QueryHierarchyItemsResult> searchAsync(Consumer<QueriesRequestBuilder.SearchRequestConfiguration> requestConfiguration)
                                                         throws AzDException

Searches all queries the user has access to in the current project

Parameters:

requestConfiguration - Represents the query parameters.

Returns:

Collection of query hierarchy item QueryHierarchyItemsResult

Throws:

AzDException - Default Api Exception handler.

updateAsync

public CompletableFuture<QueryHierarchyItem> updateAsync(String query,
 QueryHierarchyItem queryHierarchyItem)
                                                  throws AzDException

Update a query or a folder. This allows you to update, rename and move queries and folders.

Parameters:

query - The ID or path for the query to update.

queryHierarchyItem - Represents an item in the work item query hierarchy. This can be either a query or a folder.

Returns:

QueryHierarchyItem Object QueryHierarchyItem

Throws:

AzDException - Default Api Exception handler.

updateAsync

public CompletableFuture<QueryHierarchyItem> updateAsync(String query,
 boolean undeleteDescendants,
 QueryHierarchyItem queryHierarchyItem)
                                                  throws AzDException

Update a query or a folder. This allows you to update, rename and move queries and folders.

Parameters:

query - The ID or path for the query to update.

undeleteDescendants - Undelete the children of this folder. It is important to note that this will not bring back the permission changes that were previously applied to the descendants.

queryHierarchyItem - Represents an item in the work item query hierarchy. This can be either a query or a folder.

Returns:

QueryHierarchyItem Object QueryHierarchyItem

Throws:

AzDException - Default Api Exception handler.

create

public QueryHierarchyItem create(String query,
 QueryHierarchyItem queryHierarchyItem)
                          throws AzDException

Creates a query, or moves a query.

Parameters:

query - The parent id or path under which the query is to be created.

queryHierarchyItem - Query Hierarchy item object.

Returns:

QueryHierarchyItem Object QueryHierarchyItem

Throws:

AzDException - Default Api Exception handler.

create

public QueryHierarchyItem create(String query,
 boolean validateWiqlOnly,
 QueryHierarchyItem queryHierarchyItem)
                          throws AzDException

Creates a query, or moves a query.

Parameters:

query - The parent id or path under which the query is to be created.

validateWiqlOnly - If you only want to validate your WIQL query without actually creating one, set it to true. Default is false.

queryHierarchyItem - Query Hierarchy item object.

Returns:

QueryHierarchyItem Object QueryHierarchyItem

Throws:

AzDException - Default Api Exception handler.

delete

public Void delete(String query)
            throws AzDException

Delete a query or a folder. This deletes any permission change on the deleted query or folder and any of its descendants if it is a folder. It is important to note that the deleted permission changes cannot be recovered upon undeleting the query or folder.

Parameters:

query - The parent id or path under which the query is to be created.

Throws:

AzDException - Default Api Exception handler.

get

public QueryHierarchyItem get(String query)
                       throws AzDException

Retrieves an individual query and its children

Parameters:

query - The parent id or path under which the query is to be created.

Returns:

QueryHierarchyItem Object QueryHierarchyItem

Throws:

AzDException - Default Api Exception handler.

get

public QueryHierarchyItem get(String query,
 Consumer<QueriesRequestBuilder.RequestConfiguration> requestConfiguration)
                       throws AzDException

Retrieves an individual query and its children

Parameters:

query - The parent id or path under which the query is to be created.

requestConfiguration - Represents the query parameters.

Returns:

QueryHierarchyItem Object QueryHierarchyItem

Throws:

AzDException - Default Api Exception handler.

getBatch

public QueryHierarchyItems getBatch(QueryBatchGetRequest queryBatchGetRequest)
                             throws AzDException

Gets a list of queries by ids (Maximum 1000)

Parameters:

queryBatchGetRequest - Describes a request to get a list of queries QueryBatchGetRequest

Returns:

Collection of query hierarchy item QueryHierarchyItems

Throws:

AzDException - Default Api Exception handler.

list

public QueryHierarchyItems list()
                         throws AzDException

Gets the root queries and their children

Returns:

Collection of query hierarchy item QueryHierarchyItems

Throws:

AzDException - Default Api Exception handler.

list

public QueryHierarchyItems list(Consumer<QueriesRequestBuilder.RequestConfiguration> requestConfiguration)
                         throws AzDException

Gets the root queries and their children

Parameters:

requestConfiguration - Represents the query parameters.

Returns:

Collection of query hierarchy item QueryHierarchyItems

Throws:

AzDException - Default Api Exception handler.

search

public QueryHierarchyItemsResult search(Consumer<QueriesRequestBuilder.SearchRequestConfiguration> requestConfiguration)
                                 throws AzDException

Searches all queries the user has access to in the current project

Parameters:

requestConfiguration - Represents the query parameters.

Returns:

Collection of query hierarchy item QueryHierarchyItemsResult

Throws:

AzDException - Default Api Exception handler.

update

public QueryHierarchyItem update(String query,
 QueryHierarchyItem queryHierarchyItem)
                          throws AzDException

Update a query or a folder. This allows you to update, rename and move queries and folders.

Parameters:

query - The ID or path for the query to update.

queryHierarchyItem - Represents an item in the work item query hierarchy. This can be either a query or a folder.

Returns:

QueryHierarchyItem Object QueryHierarchyItem

Throws:

AzDException - Default Api Exception handler.

update

public QueryHierarchyItem update(String query,
 boolean undeleteDescendants,
 QueryHierarchyItem queryHierarchyItem)
                          throws AzDException

Update a query or a folder. This allows you to update, rename and move queries and folders.

Parameters:

query - The ID or path for the query to update.

undeleteDescendants - Undelete the children of this folder. It is important to note that this will not bring back the permission changes that were previously applied to the descendants.

queryHierarchyItem - Represents an item in the work item query hierarchy. This can be either a query or a folder.

Returns:

QueryHierarchyItem Object QueryHierarchyItem

Throws:

AzDException - Default Api Exception handler.