Package org.azd.test.points

Class PointsRequestBuilder

java.lang.Object

org.azd.abstractions.BaseRequestBuilder

org.azd.test.points.PointsRequestBuilder

public class PointsRequestBuilder
extends BaseRequestBuilder

Provides functionality to work with Test points Api.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
TestPoint	get(int planId, int pointIds, int suiteId)	Get a test point.
TestPoint	get(int planId, int pointIds, int suiteId, String... witFields)	Get a test point.
CompletableFuture<TestPoint>	getAsync(int planId, int pointIds, int suiteId)	Get a test point.
CompletableFuture<TestPoint>	getAsync(int planId, int pointIds, int suiteId, String... witFields)	Get a test point.
TestPointsQuery	getByQuery(TestPointsQuery query)	Get test points using query.
TestPointsQuery	getByQuery(TestPointsQuery query, int skip, int top)	Get test points using query.
CompletableFuture<TestPointsQuery>	getByQueryAsync(TestPointsQuery query)	Get test points using query.
CompletableFuture<TestPointsQuery>	getByQueryAsync(TestPointsQuery query, int skip, int top)	Get test points using query.
TestPoints	list(int planId, int suiteId)	Get a list of test points.
TestPoints	list(int planId, int suiteId, Consumer<PointsRequestBuilder.RequestConfiguration> requestConfiguration)	Get a list of test points.
CompletableFuture<TestPoints>	listAsync(int planId, int suiteId)	Get a list of test points.
CompletableFuture<TestPoints>	listAsync(int planId, int suiteId, Consumer<PointsRequestBuilder.RequestConfiguration> requestConfiguration)	Get a list of test points.
TestPoints	update(PointUpdateModel updateModel, int planId, int suiteId, int... pointIds)	Update test points.
CompletableFuture<TestPoints>	updateAsync(PointUpdateModel updateModel, int planId, int suiteId, int... pointIds)	Update test points.

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

PointsRequestBuilder

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

getAsync

public CompletableFuture<TestPoint> getAsync(int planId,
 int pointIds,
 int suiteId)
                                      throws AzDException

Get a test point.

Parameters:

planId - ID of the test plan.

pointIds - ID of the test point to get.

suiteId - ID of the suite that contains the point.

Returns:

Test point object TestPoint

Throws:

AzDException - Default Api Exception handler.

getAsync

public CompletableFuture<TestPoint> getAsync(int planId,
 int pointIds,
 int suiteId,
 String... witFields)
                                      throws AzDException

Get a test point.

Parameters:

planId - ID of the test plan.

pointIds - ID of the test point to get.

suiteId - ID of the suite that contains the point.

witFields - list of work item field names.

Returns:

Test point object TestPoint

Throws:

AzDException - Default Api Exception handler.

getByQueryAsync

public CompletableFuture<TestPointsQuery> getByQueryAsync(TestPointsQuery query)
                                                   throws AzDException

Get test points using query.

Parameters:

query - Query object to get the test points.

Returns:

Test points query object TestPointsQuery

Throws:

AzDException - Default Api Exception handler.

getByQueryAsync

public CompletableFuture<TestPointsQuery> getByQueryAsync(TestPointsQuery query,
 int skip,
 int top)
                                                   throws AzDException

Get test points using query.

Parameters:

query - Query object to get the test points.

skip - Number of test points to skip.

top - Number of test points to return.

Returns:

Test points query object TestPointsQuery

Throws:

AzDException - Default Api Exception handler.

listAsync

public CompletableFuture<TestPoints> listAsync(int planId,
 int suiteId)
                                        throws AzDException

Get a list of test points.

Parameters:

planId - ID of the test plan.

suiteId - ID of the suite that contains the point.

Returns:

Collection of test points object TestPoints

Throws:

AzDException - Default Api Exception handler.

listAsync

public CompletableFuture<TestPoints> listAsync(int planId,
 int suiteId,
 Consumer<PointsRequestBuilder.RequestConfiguration> requestConfiguration)
                                        throws AzDException

Get a list of test points.

Parameters:

planId - ID of the test plan.

suiteId - ID of the suite that contains the point.

requestConfiguration - Represents the query parameters.

Returns:

Collection of test points object TestPoints

Throws:

AzDException - Default Api Exception handler.

updateAsync

public CompletableFuture<TestPoints> updateAsync(PointUpdateModel updateModel,
 int planId,
 int suiteId,
 int... pointIds)
                                          throws AzDException

Update test points.

Parameters:

updateModel - Request object to update.

planId - ID of the test plan.

suiteId - ID of the suite that contains the point.

pointIds - IDs of the test point to get.

Returns:

Collection of test points object TestPoints

Throws:

AzDException - Default Api Exception handler.

get

public TestPoint get(int planId,
 int pointIds,
 int suiteId)
              throws AzDException

Get a test point.

Parameters:

planId - ID of the test plan.

pointIds - ID of the test point to get.

suiteId - ID of the suite that contains the point.

Returns:

Test point object TestPoint

Throws:

AzDException - Default Api Exception handler.

get

public TestPoint get(int planId,
 int pointIds,
 int suiteId,
 String... witFields)
              throws AzDException

Get a test point.

Parameters:

planId - ID of the test plan.

pointIds - ID of the test point to get.

suiteId - ID of the suite that contains the point.

witFields - list of work item field names.

Returns:

Test point object TestPoint

Throws:

AzDException - Default Api Exception handler.

getByQuery

public TestPointsQuery getByQuery(TestPointsQuery query)
                           throws AzDException

Get test points using query.

Parameters:

query - Query object to get the test points.

Returns:

Test points query object TestPointsQuery

Throws:

AzDException - Default Api Exception handler.

getByQuery

public TestPointsQuery getByQuery(TestPointsQuery query,
 int skip,
 int top)
                           throws AzDException

Get test points using query.

Parameters:

query - Query object to get the test points.

skip - Number of test points to skip.

top - Number of test points to return.

Returns:

Test points query object TestPointsQuery

Throws:

AzDException - Default Api Exception handler.

list

public TestPoints list(int planId,
 int suiteId)
                throws AzDException

Get a list of test points.

Parameters:

planId - ID of the test plan.

suiteId - ID of the suite that contains the point.

Returns:

Collection of test points object TestPoints

Throws:

AzDException - Default Api Exception handler.

list

public TestPoints list(int planId,
 int suiteId,
 Consumer<PointsRequestBuilder.RequestConfiguration> requestConfiguration)
                throws AzDException

Get a list of test points.

Parameters:

planId - ID of the test plan.

suiteId - ID of the suite that contains the point.

requestConfiguration - Represents the query parameters.

Returns:

Collection of test points object TestPoints

Throws:

AzDException - Default Api Exception handler.

update

public TestPoints update(PointUpdateModel updateModel,
 int planId,
 int suiteId,
 int... pointIds)
                  throws AzDException

Update test points.

Parameters:

updateModel - Request object to update.

planId - ID of the test plan.

suiteId - ID of the suite that contains the point.

pointIds - IDs of the test point to get.

Returns:

Collection of test points object TestPoints

Throws:

AzDException - Default Api Exception handler.