Package org.azd.test.runs

Class RunsRequestBuilder

java.lang.Object

org.azd.abstractions.BaseRequestBuilder

org.azd.test.runs.RunsRequestBuilder

public class RunsRequestBuilder
extends BaseRequestBuilder

Provides functionality to work with Test runs Api.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
TestRun	create(RunCreateModel runCreateModel)	Create new test run.
CompletableFuture<TestRun>	createAsync(RunCreateModel runCreateModel)	Create new test run.
Void	delete(int runId)	Delete a test run by its ID.
CompletableFuture<Void>	deleteAsync(int runId)	Delete a test run by its ID.
TestRun	get(int runId)	Get a test run by its ID.
TestRun	get(int runId, boolean includeDetails)	Get a test run by its ID.
CompletableFuture<TestRun>	getAsync(int runId)	Get a test run by its ID.
CompletableFuture<TestRun>	getAsync(int runId, boolean includeDetails)	Get a test run by its ID.
TestRunStatistic	getStatistics(int runId)	Get test run statistics , used when we want to get summary of a run by outcome.
CompletableFuture<TestRunStatistic>	getStatisticsAsync(int runId)	Get test run statistics , used when we want to get summary of a run by outcome.
TestRuns	list()	Get a list of test runs.
TestRuns	list(Consumer<RunsRequestBuilder.RequestConfiguration> requestConfiguration)	Get a list of test runs.
CompletableFuture<TestRuns>	listAsync()	Get a list of test runs.
CompletableFuture<TestRuns>	listAsync(Consumer<RunsRequestBuilder.RequestConfiguration> requestConfiguration)	Get a list of test runs.
TestRuns	query(Consumer<RunsRequestBuilder.QueryRequestConfiguration> requestConfiguration)	Query Test Runs based on filters.
CompletableFuture<TestRuns>	queryAsync(Consumer<RunsRequestBuilder.QueryRequestConfiguration> requestConfiguration)	Query Test Runs based on filters.
TestRun	update(int runId, TestRun testRun)	Update test run by its ID.
CompletableFuture<TestRun>	updateAsync(int runId, TestRun testRun)	Update test run by its 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

RunsRequestBuilder

public RunsRequestBuilder(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<TestRun> createAsync(RunCreateModel runCreateModel)
                                       throws AzDException

Create new test run.

Parameters:

runCreateModel - Run create model object to create a test run.

Returns:

TestRun Object TestRun

Throws:

AzDException - Default Api Exception handler.

deleteAsync

public CompletableFuture<Void> deleteAsync(int runId)
                                    throws AzDException

Delete a test run by its ID.

Parameters:

runId - ID of the run to delete.

Throws:

AzDException - Default Api Exception handler.

getAsync

public CompletableFuture<TestRun> getAsync(int runId)
                                    throws AzDException

Get a test run by its ID.

Parameters:

runId - ID of the run to get.

Returns:

TestRun Object TestRun

Throws:

AzDException - Default Api Exception handler.

getAsync

public CompletableFuture<TestRun> getAsync(int runId,
 boolean includeDetails)
                                    throws AzDException

Get a test run by its ID.

Parameters:

runId - ID of the run to get.

includeDetails - Default value is true. It includes details like run statistics, release, build, test environment, post process state, and more.

Returns:

TestRun Object TestRun

Throws:

AzDException - Default Api Exception handler.

getStatisticsAsync

public CompletableFuture<TestRunStatistic> getStatisticsAsync(int runId)
                                                       throws AzDException

Get test run statistics , used when we want to get summary of a run by outcome.

Parameters:

runId - ID of the run to get.

Returns:

TestRunStatistic Object TestRunStatistic

Throws:

AzDException - Default Api Exception handler.

listAsync

public CompletableFuture<TestRuns> listAsync()
                                      throws AzDException

Get a list of test runs.

Returns:

Collection of TestRun Object TestRuns

Throws:

AzDException - Default Api Exception handler.

listAsync

public CompletableFuture<TestRuns> listAsync(Consumer<RunsRequestBuilder.RequestConfiguration> requestConfiguration)
                                      throws AzDException

Get a list of test runs.

Parameters:

requestConfiguration - Represents the query parameters.

Returns:

Collection of TestRun Object TestRuns

Throws:

AzDException - Default Api Exception handler.

queryAsync

public CompletableFuture<TestRuns> queryAsync(Consumer<RunsRequestBuilder.QueryRequestConfiguration> requestConfiguration)
                                       throws AzDException

Query Test Runs based on filters. Mandatory fields are minLastUpdatedDate and maxLastUpdatedDate.

Parameters:

requestConfiguration - Represents the query parameters.

Returns:

Collection of TestRun Object TestRuns

Throws:

AzDException - Default Api Exception handler.

updateAsync

public CompletableFuture<TestRun> updateAsync(int runId,
 TestRun testRun)
                                       throws AzDException

Update test run by its ID.

Parameters:

runId - ID of the run to update.

testRun - Test run object to update.

Returns:

Test run objet TestRun

Throws:

AzDException - Default Api Exception handler.

create

public TestRun create(RunCreateModel runCreateModel)
               throws AzDException

Create new test run.

Parameters:

runCreateModel - Run create model object to create a test run.

Returns:

TestRun Object TestRun

Throws:

AzDException - Default Api Exception handler.

delete

public Void delete(int runId)
            throws AzDException

Delete a test run by its ID.

Parameters:

runId - ID of the run to delete.

Throws:

AzDException - Default Api Exception handler.

get

public TestRun get(int runId)
            throws AzDException

Get a test run by its ID.

Parameters:

runId - ID of the run to get.

Returns:

TestRun Object TestRun

Throws:

AzDException - Default Api Exception handler.

get

public TestRun get(int runId,
 boolean includeDetails)
            throws AzDException

Get a test run by its ID.

Parameters:

runId - ID of the run to get.

includeDetails - Default value is true. It includes details like run statistics, release, build, test environment, post process state, and more.

Returns:

TestRun Object TestRun

Throws:

AzDException - Default Api Exception handler.

getStatistics

public TestRunStatistic getStatistics(int runId)
                               throws AzDException

Get test run statistics , used when we want to get summary of a run by outcome.

Parameters:

runId - ID of the run to get.

Returns:

TestRunStatistic Object TestRunStatistic

Throws:

AzDException - Default Api Exception handler.

list

public TestRuns list()
              throws AzDException

Get a list of test runs.

Returns:

Collection of TestRun Object TestRuns

Throws:

AzDException - Default Api Exception handler.

list

public TestRuns list(Consumer<RunsRequestBuilder.RequestConfiguration> requestConfiguration)
              throws AzDException

Get a list of test runs.

Parameters:

requestConfiguration - Represents the query parameters.

Returns:

Collection of TestRun Object TestRuns

Throws:

AzDException - Default Api Exception handler.

query

public TestRuns query(Consumer<RunsRequestBuilder.QueryRequestConfiguration> requestConfiguration)
               throws AzDException

Query Test Runs based on filters. Mandatory fields are minLastUpdatedDate and maxLastUpdatedDate.

Parameters:

requestConfiguration - Represents the query parameters.

Returns:

Collection of TestRun Object TestRuns

Throws:

AzDException - Default Api Exception handler.

update

public TestRun update(int runId,
 TestRun testRun)
               throws AzDException

Update test run by its ID.

Parameters:

runId - ID of the run to update.

testRun - Test run object to update.

Returns:

Test run objet TestRun

Throws:

AzDException - Default Api Exception handler.