Package org.azd.test.testsuites

Class TestSuitesRequestBuilder

java.lang.Object

org.azd.abstractions.BaseRequestBuilder

org.azd.test.testsuites.TestSuitesRequestBuilder

public class TestSuitesRequestBuilder
extends BaseRequestBuilder

Provides functionality to work with Test suites 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
TestSuitesRequestBuilder(String organizationUrl, AccessTokenCredential accessTokenCredential)	Instantiates a new RequestBuilder instance and sets the default values.

Method Summary

Modifier and Type	Method	Description
SuiteTestCases	create(int planId, int suiteId, String... testCaseIds)	Add test cases to suite.
CompletableFuture<SuiteTestCases>	createAsync(int planId, int suiteId, String... testCaseIds)	Add test cases to suite.
SuiteTestCase	get(int planId, int suiteId, int testCaseIds)	Get a specific test case in a test suite with test case id.
CompletableFuture<SuiteTestCase>	getAsync(int planId, int suiteId, int testCaseIds)	Get a specific test case in a test suite with test case id.
SuiteTestCases	list(int planId, int suiteId)	Get all test cases in a suite.
CompletableFuture<SuiteTestCases>	listAsync(int planId, int suiteId)	Get all test cases in a suite.
Void	removeTestCasesFromSiteUrl(int planId, int suiteId, String... testCaseIds)	The test points associated with the test cases are removed from the test suite.
CompletableFuture<Void>	removeTestCasesFromSiteUrlAsync(int planId, int suiteId, String... testCaseIds)	The test points associated with the test cases are removed from the test suite.
SuiteTestCases	update(List<ShallowReference> configurations, int planId, int suiteId, String... testCaseIds)	Add test cases to suite.
CompletableFuture<SuiteTestCases>	updateAsync(List<ShallowReference> configurations, int planId, int suiteId, String... testCaseIds)	Add test cases to suite.

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

TestSuitesRequestBuilder

public TestSuitesRequestBuilder(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<SuiteTestCases> createAsync(int planId,
 int suiteId,
 String... testCaseIds)
                                              throws AzDException

Add test cases to suite.

Parameters:

planId - ID of the test plan that contains the suite.

suiteId - ID of the test suite to which the test cases must be added.

testCaseIds - IDs of the test cases to add to the suite.

Returns:

Collection of test case suites. SuiteTestCases

Throws:

AzDException - Default Api Exception handler.

getAsync

public CompletableFuture<SuiteTestCase> getAsync(int planId,
 int suiteId,
 int testCaseIds)
                                          throws AzDException

Get a specific test case in a test suite with test case id.

Parameters:

planId - ID of the test plan that contains the suite.

suiteId - ID of the test suite to which the test cases must be added.

testCaseIds - ID of the test cases to add to the suite.

Returns:

Test case suite object. SuiteTestCase

Throws:

AzDException - Default Api Exception handler.

listAsync

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

Get all test cases in a suite.

Parameters:

planId - ID of the test plan that contains the suite.

suiteId - ID of the test suite to which the test cases must be added.

Returns:

Collection of test case suites. SuiteTestCases

Throws:

AzDException - Default Api Exception handler.

removeTestCasesFromSiteUrlAsync

public CompletableFuture<Void> removeTestCasesFromSiteUrlAsync(int planId,
 int suiteId,
 String... testCaseIds)
                                                        throws AzDException

The test points associated with the test cases are removed from the test suite. The test case work item is not deleted from the system. See test cases resource to delete a test case permanently.

Parameters:

planId - ID of the test plan that contains the suite.

suiteId - ID of the test suite to which the test cases must be added.

testCaseIds - IDs of the test cases to add to the suite.

Returns:

Success response.

Throws:

AzDException - Default Api Exception handler.

updateAsync

public CompletableFuture<SuiteTestCases> updateAsync(List<ShallowReference> configurations,
 int planId,
 int suiteId,
 String... testCaseIds)
                                              throws AzDException

Add test cases to suite.

Parameters:

planId - ID of the test plan that contains the suite.

suiteId - ID of the test suite to which the test cases must be added.

testCaseIds - IDs of the test cases to add to the suite.

Returns:

Collection of test case suites. SuiteTestCases

Throws:

AzDException - Default Api Exception handler.

create

public SuiteTestCases create(int planId,
 int suiteId,
 String... testCaseIds)
                      throws AzDException

Add test cases to suite.

Parameters:

planId - ID of the test plan that contains the suite.

suiteId - ID of the test suite to which the test cases must be added.

testCaseIds - IDs of the test cases to add to the suite.

Returns:

Collection of test case suites. SuiteTestCases

Throws:

AzDException - Default Api Exception handler.

get

public SuiteTestCase get(int planId,
 int suiteId,
 int testCaseIds)
                  throws AzDException

Get a specific test case in a test suite with test case id.

Parameters:

planId - ID of the test plan that contains the suite.

suiteId - ID of the test suite to which the test cases must be added.

testCaseIds - ID of the test cases to add to the suite.

Returns:

Test case suite object. SuiteTestCase

Throws:

AzDException - Default Api Exception handler.

list

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

Get all test cases in a suite.

Parameters:

planId - ID of the test plan that contains the suite.

suiteId - ID of the test suite to which the test cases must be added.

Returns:

Collection of test case suites. SuiteTestCases

Throws:

AzDException - Default Api Exception handler.

removeTestCasesFromSiteUrl

public Void removeTestCasesFromSiteUrl(int planId,
 int suiteId,
 String... testCaseIds)
                                throws AzDException

The test points associated with the test cases are removed from the test suite. The test case work item is not deleted from the system. See test cases resource to delete a test case permanently.

Parameters:

planId - ID of the test plan that contains the suite.

suiteId - ID of the test suite to which the test cases must be added.

testCaseIds - IDs of the test cases to add to the suite.

Returns:

Success response.

Throws:

AzDException - Default Api Exception handler.

update

public SuiteTestCases update(List<ShallowReference> configurations,
 int planId,
 int suiteId,
 String... testCaseIds)
                      throws AzDException

Add test cases to suite.

Parameters:

planId - ID of the test plan that contains the suite.

suiteId - ID of the test suite to which the test cases must be added.

testCaseIds - IDs of the test cases to add to the suite.

Returns:

Collection of test case suites. SuiteTestCases

Throws:

AzDException - Default Api Exception handler.