Package org.azd.workitemtracking.wiql

Class WiqlRequestBuilder

java.lang.Object

org.azd.abstractions.BaseRequestBuilder

org.azd.workitemtracking.wiql.WiqlRequestBuilder

public class WiqlRequestBuilder
extends BaseRequestBuilder

Provides functionality to work with Work item tracking Wiql Api.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
WorkItemQueryResult	query(String team, String query)	Gets the results of the query given its WIQL.
WorkItemQueryResult	query(String team, String query, Consumer<WiqlRequestBuilder.RequestConfiguration> requestConfiguration)	Gets the results of the query given its WIQL.
CompletableFuture<WorkItemQueryResult>	queryAsync(String team, String query)	Gets the results of the query given its WIQL.
CompletableFuture<WorkItemQueryResult>	queryAsync(String team, String query, Consumer<WiqlRequestBuilder.RequestConfiguration> requestConfiguration)	Gets the results of the query given its WIQL.
WorkItemQueryResult	queryById(String id, String team)	Gets the results of the query given the query ID.
WorkItemQueryResult	queryById(String id, String team, Consumer<WiqlRequestBuilder.RequestConfiguration> requestConfiguration)	Gets the results of the query given the query ID.
CompletableFuture<WorkItemQueryResult>	queryByIdAsync(String id, String team)	Gets the results of the query given the query ID.
CompletableFuture<WorkItemQueryResult>	queryByIdAsync(String id, String team, Consumer<WiqlRequestBuilder.RequestConfiguration> requestConfiguration)	Gets the results of the query given the query ID.

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

WiqlRequestBuilder

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

queryByIdAsync

public CompletableFuture<WorkItemQueryResult> queryByIdAsync(String id,
 String team)
                                                      throws AzDException

Gets the results of the query given the query ID.

Parameters:

id - The query ID.

team - Team ID or team name

Returns:

The result of a work item query. WorkItemQueryResult

Throws:

AzDException - Default Api exception handler.

queryByIdAsync

public CompletableFuture<WorkItemQueryResult> queryByIdAsync(String id,
 String team,
 Consumer<WiqlRequestBuilder.RequestConfiguration> requestConfiguration)
                                                      throws AzDException

Gets the results of the query given the query ID.

Parameters:

id - The query ID.

team - Team ID or team name

requestConfiguration - Represents the query parameters.

Returns:

The result of a work item query. WorkItemQueryResult

Throws:

AzDException - Default Api exception handler.

queryAsync

public CompletableFuture<WorkItemQueryResult> queryAsync(String team,
 String query)
                                                  throws AzDException

Gets the results of the query given its WIQL.

Parameters:

team - Team ID or team name

Returns:

The result of a work item query. WorkItemQueryResult

Throws:

AzDException - Default Api exception handler.

queryAsync

public CompletableFuture<WorkItemQueryResult> queryAsync(String team,
 String query,
 Consumer<WiqlRequestBuilder.RequestConfiguration> requestConfiguration)
                                                  throws AzDException

Gets the results of the query given its WIQL.

Parameters:

team - Team ID or team name

requestConfiguration - Represents the query parameters.

Returns:

The result of a work item query. WorkItemQueryResult

Throws:

AzDException - Default Api exception handler.

queryById

public WorkItemQueryResult queryById(String id,
 String team)
                              throws AzDException

Gets the results of the query given the query ID.

Parameters:

id - The query ID.

team - Team ID or team name

Returns:

The result of a work item query. WorkItemQueryResult

Throws:

AzDException - Default Api exception handler.

queryById

public WorkItemQueryResult queryById(String id,
 String team,
 Consumer<WiqlRequestBuilder.RequestConfiguration> requestConfiguration)
                              throws AzDException

Gets the results of the query given the query ID.

Parameters:

id - The query ID.

team - Team ID or team name

requestConfiguration - Represents the query parameters.

Returns:

The result of a work item query. WorkItemQueryResult

Throws:

AzDException - Default Api exception handler.

query

public WorkItemQueryResult query(String team,
 String query)
                          throws AzDException

Gets the results of the query given its WIQL.

Parameters:

team - Team ID or team name

Returns:

The result of a work item query. WorkItemQueryResult

Throws:

AzDException - Default Api exception handler.

query

public WorkItemQueryResult query(String team,
 String query,
 Consumer<WiqlRequestBuilder.RequestConfiguration> requestConfiguration)
                          throws AzDException

Gets the results of the query given its WIQL.

Parameters:

team - Team ID or team name

requestConfiguration - Represents the query parameters.

Returns:

The result of a work item query. WorkItemQueryResult

Throws:

AzDException - Default Api exception handler.