Package org.azd.test.iterations

Class IterationsRequestBuilder

java.lang.Object

org.azd.abstractions.BaseRequestBuilder

org.azd.test.iterations.IterationsRequestBuilder

public class IterationsRequestBuilder
extends BaseRequestBuilder

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

Method Summary

Modifier and Type	Method	Description
TestIterationDetailsModel	get(int iterationId, int runId, int testCaseResultId)	Get iteration for a result
TestIterationDetailsModel	get(int iterationId, int runId, int testCaseResultId, boolean includeActionResults)	Get iteration for a result
CompletableFuture<TestIterationDetailsModel>	getAsync(int iterationId, int runId, int testCaseResultId)	Get iteration for a result
CompletableFuture<TestIterationDetailsModel>	getAsync(int iterationId, int runId, int testCaseResultId, boolean includeActionResults)	Get iteration for a result
TestIterationDetailsModels	list(int runId, int testCaseResultId)	Get a list of iteration for a result
TestIterationDetailsModels	list(int runId, int testCaseResultId, boolean includeActionResults)	Get a list of iteration for a result
CompletableFuture<TestIterationDetailsModels>	listAsync(int runId, int testCaseResultId)	Get a list of iteration for a result
CompletableFuture<TestIterationDetailsModels>	listAsync(int runId, int testCaseResultId, boolean includeActionResults)	Get a list of iteration for a result

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

IterationsRequestBuilder

public IterationsRequestBuilder(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<TestIterationDetailsModel> getAsync(int iterationId,
 int runId,
 int testCaseResultId)
                                                      throws AzDException

Get iteration for a result

Parameters:

iterationId - Id of the test results Iteration.

runId - ID of the test run that contains the result.

testCaseResultId - ID of the test result that contains the iterations.

Returns:

TestIterationDetailsModel object TestIterationDetailsModel

Throws:

AzDException - Default Api exception handler.

getAsync

public CompletableFuture<TestIterationDetailsModel> getAsync(int iterationId,
 int runId,
 int testCaseResultId,
 boolean includeActionResults)
                                                      throws AzDException

Get iteration for a result

Parameters:

iterationId - Id of the test results Iteration.

runId - ID of the test run that contains the result.

testCaseResultId - ID of the test result that contains the iterations.

includeActionResults - Include result details for each action performed in the test iteration. ActionResults refer to outcome (pass/fail) of test steps that are executed as part of a running a manual test. Including the ActionResults flag gets the outcome of test steps in the actionResults section and test parameters in the parameters section for each test iteration.

Returns:

TestIterationDetailsModel object TestIterationDetailsModel

Throws:

AzDException - Default Api exception handler.

listAsync

public CompletableFuture<TestIterationDetailsModels> listAsync(int runId,
 int testCaseResultId)
                                                        throws AzDException

Get a list of iteration for a result

Parameters:

runId - ID of the test run that contains the result.

testCaseResultId - ID of the test result that contains the iterations.

Returns:

List of TestIterationDetailsModel object TestIterationDetailsModels

Throws:

AzDException - Default Api exception handler.

listAsync

public CompletableFuture<TestIterationDetailsModels> listAsync(int runId,
 int testCaseResultId,
 boolean includeActionResults)
                                                        throws AzDException

Get a list of iteration for a result

Parameters:

runId - ID of the test run that contains the result.

testCaseResultId - ID of the test result that contains the iterations.

includeActionResults - Include result details for each action performed in the test iteration. ActionResults refer to outcome (pass/fail) of test steps that are executed as part of a running a manual test. Including the ActionResults flag gets the outcome of test steps in the actionResults section and test parameters in the parameters section for each test iteration.

Returns:

List of TestIterationDetailsModel object TestIterationDetailsModels

Throws:

AzDException - Default Api exception handler.

get

public TestIterationDetailsModel get(int iterationId,
 int runId,
 int testCaseResultId)
                              throws AzDException

Get iteration for a result

Parameters:

iterationId - Id of the test results Iteration.

runId - ID of the test run that contains the result.

testCaseResultId - ID of the test result that contains the iterations.

Returns:

TestIterationDetailsModel object TestIterationDetailsModel

Throws:

AzDException - Default Api exception handler.

get

public TestIterationDetailsModel get(int iterationId,
 int runId,
 int testCaseResultId,
 boolean includeActionResults)
                              throws AzDException

Get iteration for a result

Parameters:

iterationId - Id of the test results Iteration.

runId - ID of the test run that contains the result.

testCaseResultId - ID of the test result that contains the iterations.

includeActionResults - Include result details for each action performed in the test iteration. ActionResults refer to outcome (pass/fail) of test steps that are executed as part of a running a manual test. Including the ActionResults flag gets the outcome of test steps in the actionResults section and test parameters in the parameters section for each test iteration.

Returns:

TestIterationDetailsModel object TestIterationDetailsModel

Throws:

AzDException - Default Api exception handler.

list

public TestIterationDetailsModels list(int runId,
 int testCaseResultId)
                                throws AzDException

Get a list of iteration for a result

Parameters:

runId - ID of the test run that contains the result.

testCaseResultId - ID of the test result that contains the iterations.

Returns:

List of TestIterationDetailsModel object TestIterationDetailsModels

Throws:

AzDException - Default Api exception handler.

list

public TestIterationDetailsModels list(int runId,
 int testCaseResultId,
 boolean includeActionResults)
                                throws AzDException

Get a list of iteration for a result

Parameters:

runId - ID of the test run that contains the result.

testCaseResultId - ID of the test result that contains the iterations.

includeActionResults - Include result details for each action performed in the test iteration. ActionResults refer to outcome (pass/fail) of test steps that are executed as part of a running a manual test. Including the ActionResults flag gets the outcome of test steps in the actionResults section and test parameters in the parameters section for each test iteration.

Returns:

List of TestIterationDetailsModel object TestIterationDetailsModels

Throws:

AzDException - Default Api exception handler.