io.qase.client.api

Class ResultsApi

java.lang.Object

io.qase.client.api.ResultsApi

public class ResultsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
ResultsApi()
ResultsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
CreateResult200Response	createResult(String code, Integer id, ResultCreate resultCreate) Create test run result.
okhttp3.Call	createResultAsync(String code, Integer id, ResultCreate resultCreate, ApiCallback<CreateResult200Response> _callback) Create test run result.
Response	createResultBulk(String code, Integer id, ResultCreateBulk resultCreateBulk) Bulk create test run result.
okhttp3.Call	createResultBulkAsync(String code, Integer id, ResultCreateBulk resultCreateBulk, ApiCallback<Response> _callback) Bulk create test run result.
okhttp3.Call	createResultBulkCall(String code, Integer id, ResultCreateBulk resultCreateBulk, ApiCallback _callback) Build call for createResultBulk
ApiResponse<Response>	createResultBulkWithHttpInfo(String code, Integer id, ResultCreateBulk resultCreateBulk) Bulk create test run result.
okhttp3.Call	createResultCall(String code, Integer id, ResultCreate resultCreate, ApiCallback _callback) Build call for createResult
ApiResponse<CreateResult200Response>	createResultWithHttpInfo(String code, Integer id, ResultCreate resultCreate) Create test run result.
HashResponse	deleteResult(String code, Integer id, String hash) Delete test run result.
okhttp3.Call	deleteResultAsync(String code, Integer id, String hash, ApiCallback<HashResponse> _callback) Delete test run result.
okhttp3.Call	deleteResultCall(String code, Integer id, String hash, ApiCallback _callback) Build call for deleteResult
ApiResponse<HashResponse>	deleteResultWithHttpInfo(String code, Integer id, String hash) Delete test run result.
ApiClient	getApiClient()
String	getCustomBaseUrl()
int	getHostIndex()
ResultResponse	getResult(String code, String hash) Get test run result by code.
okhttp3.Call	getResultAsync(String code, String hash, ApiCallback<ResultResponse> _callback) Get test run result by code.
okhttp3.Call	getResultCall(String code, String hash, ApiCallback _callback) Build call for getResult
ResultListResponse	getResults(String code, GetResultsFiltersParameter filters, Integer limit, Integer offset) Get all test run results.
okhttp3.Call	getResultsAsync(String code, GetResultsFiltersParameter filters, Integer limit, Integer offset, ApiCallback<ResultListResponse> _callback) Get all test run results.
okhttp3.Call	getResultsCall(String code, GetResultsFiltersParameter filters, Integer limit, Integer offset, ApiCallback _callback) Build call for getResults
ApiResponse<ResultListResponse>	getResultsWithHttpInfo(String code, GetResultsFiltersParameter filters, Integer limit, Integer offset) Get all test run results.
ApiResponse<ResultResponse>	getResultWithHttpInfo(String code, String hash) Get test run result by code.
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)
HashResponse	updateResult(String code, Integer id, String hash, ResultUpdate resultUpdate) Update test run result.
okhttp3.Call	updateResultAsync(String code, Integer id, String hash, ResultUpdate resultUpdate, ApiCallback<HashResponse> _callback) Update test run result.
okhttp3.Call	updateResultCall(String code, Integer id, String hash, ResultUpdate resultUpdate, ApiCallback _callback) Build call for updateResult
ApiResponse<HashResponse>	updateResultWithHttpInfo(String code, Integer id, String hash, ResultUpdate resultUpdate) Update test run result.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ResultsApi

public ResultsApi()

ResultsApi

public ResultsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getHostIndex

public int getHostIndex()

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl

public String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(String customBaseUrl)

createResultCall

public okhttp3.Call createResultCall(String code,
                                     Integer id,
                                     ResultCreate resultCreate,
                                     ApiCallback _callback)
                              throws QaseException

Build call for createResult

Parameters:

code - Code of project, where to search entities. (required)

id - Identifier. (required)

resultCreate - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

QaseException - If fail to serialize the request body object

createResult

public CreateResult200Response createResult(String code,
                                            Integer id,
                                            ResultCreate resultCreate)
                                     throws QaseException

Create test run result. This method allows to create test run result by Run Id.

Parameters:

code - Code of project, where to search entities. (required)

id - Identifier. (required)

resultCreate - (required)

Returns:

CreateResult200Response

Throws:

QaseException - If fail to call the API, e.g. server error or cannot deserialize the response body

createResultWithHttpInfo

public ApiResponse<CreateResult200Response> createResultWithHttpInfo(String code,
                                                                     Integer id,
                                                                     ResultCreate resultCreate)
                                                              throws QaseException

Create test run result. This method allows to create test run result by Run Id.

Parameters:

code - Code of project, where to search entities. (required)

id - Identifier. (required)

resultCreate - (required)

Returns:

ApiResponse<CreateResult200Response>

Throws:

QaseException - If fail to call the API, e.g. server error or cannot deserialize the response body

createResultAsync

public okhttp3.Call createResultAsync(String code,
                                      Integer id,
                                      ResultCreate resultCreate,
                                      ApiCallback<CreateResult200Response> _callback)
                               throws QaseException

Create test run result. (asynchronously) This method allows to create test run result by Run Id.

Parameters:

code - Code of project, where to search entities. (required)

id - Identifier. (required)

resultCreate - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

QaseException - If fail to process the API call, e.g. serializing the request body object

createResultBulkCall

public okhttp3.Call createResultBulkCall(String code,
                                         Integer id,
                                         ResultCreateBulk resultCreateBulk,
                                         ApiCallback _callback)
                                  throws QaseException

Build call for createResultBulk

Parameters:

code - Code of project, where to search entities. (required)

id - Identifier. (required)

resultCreateBulk - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

QaseException - If fail to serialize the request body object

createResultBulk

public Response createResultBulk(String code,
                                 Integer id,
                                 ResultCreateBulk resultCreateBulk)
                          throws QaseException

Bulk create test run result. This method allows to create a lot of test run result at once. If you try to send more than 2,000 results in a single bulk request, you will receive an error with code 413 - Payload Too Large. If there is no free space left in your team account, when attempting to upload an attachment, e.g., through reporters, you will receive an error with code 507 - Insufficient Storage.

Parameters:

code - Code of project, where to search entities. (required)

id - Identifier. (required)

resultCreateBulk - (required)

Returns:

Response

Throws:

QaseException - If fail to call the API, e.g. server error or cannot deserialize the response body

createResultBulkWithHttpInfo

public ApiResponse<Response> createResultBulkWithHttpInfo(String code,
                                                          Integer id,
                                                          ResultCreateBulk resultCreateBulk)
                                                   throws QaseException

Bulk create test run result. This method allows to create a lot of test run result at once. If you try to send more than 2,000 results in a single bulk request, you will receive an error with code 413 - Payload Too Large. If there is no free space left in your team account, when attempting to upload an attachment, e.g., through reporters, you will receive an error with code 507 - Insufficient Storage.

Parameters:

code - Code of project, where to search entities. (required)

id - Identifier. (required)

resultCreateBulk - (required)

Returns:

ApiResponse<Response>

Throws:

QaseException - If fail to call the API, e.g. server error or cannot deserialize the response body

createResultBulkAsync

public okhttp3.Call createResultBulkAsync(String code,
                                          Integer id,
                                          ResultCreateBulk resultCreateBulk,
                                          ApiCallback<Response> _callback)
                                   throws QaseException

Bulk create test run result. (asynchronously) This method allows to create a lot of test run result at once. If you try to send more than 2,000 results in a single bulk request, you will receive an error with code 413 - Payload Too Large. If there is no free space left in your team account, when attempting to upload an attachment, e.g., through reporters, you will receive an error with code 507 - Insufficient Storage.

Parameters:

code - Code of project, where to search entities. (required)

id - Identifier. (required)

resultCreateBulk - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

QaseException - If fail to process the API call, e.g. serializing the request body object

deleteResultCall

public okhttp3.Call deleteResultCall(String code,
                                     Integer id,
                                     String hash,
                                     ApiCallback _callback)
                              throws QaseException

Build call for deleteResult

Parameters:

code - Code of project, where to search entities. (required)

id - Identifier. (required)

hash - Hash. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

QaseException - If fail to serialize the request body object

deleteResult

public HashResponse deleteResult(String code,
                                 Integer id,
                                 String hash)
                          throws QaseException

Delete test run result. This method allows to delete test run result.

Parameters:

code - Code of project, where to search entities. (required)

id - Identifier. (required)

hash - Hash. (required)

Returns:

HashResponse

Throws:

QaseException - If fail to call the API, e.g. server error or cannot deserialize the response body

deleteResultWithHttpInfo

public ApiResponse<HashResponse> deleteResultWithHttpInfo(String code,
                                                          Integer id,
                                                          String hash)
                                                   throws QaseException

Delete test run result. This method allows to delete test run result.

Parameters:

code - Code of project, where to search entities. (required)

id - Identifier. (required)

hash - Hash. (required)

Returns:

ApiResponse<HashResponse>

Throws:

QaseException - If fail to call the API, e.g. server error or cannot deserialize the response body

deleteResultAsync

public okhttp3.Call deleteResultAsync(String code,
                                      Integer id,
                                      String hash,
                                      ApiCallback<HashResponse> _callback)
                               throws QaseException

Delete test run result. (asynchronously) This method allows to delete test run result.

Parameters:

code - Code of project, where to search entities. (required)

id - Identifier. (required)

hash - Hash. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

QaseException - If fail to process the API call, e.g. serializing the request body object

getResultCall

public okhttp3.Call getResultCall(String code,
                                  String hash,
                                  ApiCallback _callback)
                           throws QaseException

Build call for getResult

Parameters:

code - Code of project, where to search entities. (required)

hash - Hash. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

QaseException - If fail to serialize the request body object

getResult

public ResultResponse getResult(String code,
                                String hash)
                         throws QaseException

Get test run result by code. This method allows to retrieve a specific test run result by Hash.

Parameters:

code - Code of project, where to search entities. (required)

hash - Hash. (required)

Returns:

ResultResponse

Throws:

QaseException - If fail to call the API, e.g. server error or cannot deserialize the response body

getResultWithHttpInfo

public ApiResponse<ResultResponse> getResultWithHttpInfo(String code,
                                                         String hash)
                                                  throws QaseException

Get test run result by code. This method allows to retrieve a specific test run result by Hash.

Parameters:

code - Code of project, where to search entities. (required)

hash - Hash. (required)

Returns:

ApiResponse<ResultResponse>

Throws:

QaseException - If fail to call the API, e.g. server error or cannot deserialize the response body

getResultAsync

public okhttp3.Call getResultAsync(String code,
                                   String hash,
                                   ApiCallback<ResultResponse> _callback)
                            throws QaseException

Get test run result by code. (asynchronously) This method allows to retrieve a specific test run result by Hash.

Parameters:

code - Code of project, where to search entities. (required)

hash - Hash. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

QaseException - If fail to process the API call, e.g. serializing the request body object

getResultsCall

public okhttp3.Call getResultsCall(String code,
                                   GetResultsFiltersParameter filters,
                                   Integer limit,
                                   Integer offset,
                                   ApiCallback _callback)
                            throws QaseException

Build call for getResults

Parameters:

code - Code of project, where to search entities. (required)

filters - (optional)

limit - A number of entities in result set. (optional, default to 10)

offset - How many entities should be skipped. (optional, default to 0)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

QaseException - If fail to serialize the request body object

getResults

public ResultListResponse getResults(String code,
                                     GetResultsFiltersParameter filters,
                                     Integer limit,
                                     Integer offset)
                              throws QaseException

Get all test run results. This method allows to retrieve all test run results stored in selected project.

Parameters:

code - Code of project, where to search entities. (required)

filters - (optional)

limit - A number of entities in result set. (optional, default to 10)

offset - How many entities should be skipped. (optional, default to 0)

Returns:

ResultListResponse

Throws:

QaseException - If fail to call the API, e.g. server error or cannot deserialize the response body

getResultsWithHttpInfo

public ApiResponse<ResultListResponse> getResultsWithHttpInfo(String code,
                                                              GetResultsFiltersParameter filters,
                                                              Integer limit,
                                                              Integer offset)
                                                       throws QaseException

Get all test run results. This method allows to retrieve all test run results stored in selected project.

Parameters:

code - Code of project, where to search entities. (required)

filters - (optional)

limit - A number of entities in result set. (optional, default to 10)

offset - How many entities should be skipped. (optional, default to 0)

Returns:

ApiResponse<ResultListResponse>

Throws:

QaseException - If fail to call the API, e.g. server error or cannot deserialize the response body

getResultsAsync

public okhttp3.Call getResultsAsync(String code,
                                    GetResultsFiltersParameter filters,
                                    Integer limit,
                                    Integer offset,
                                    ApiCallback<ResultListResponse> _callback)
                             throws QaseException

Get all test run results. (asynchronously) This method allows to retrieve all test run results stored in selected project.

Parameters:

code - Code of project, where to search entities. (required)

filters - (optional)

limit - A number of entities in result set. (optional, default to 10)

offset - How many entities should be skipped. (optional, default to 0)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

QaseException - If fail to process the API call, e.g. serializing the request body object

updateResultCall

public okhttp3.Call updateResultCall(String code,
                                     Integer id,
                                     String hash,
                                     ResultUpdate resultUpdate,
                                     ApiCallback _callback)
                              throws QaseException

Build call for updateResult

Parameters:

code - Code of project, where to search entities. (required)

id - Identifier. (required)

hash - Hash. (required)

resultUpdate - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

QaseException - If fail to serialize the request body object

updateResult

public HashResponse updateResult(String code,
                                 Integer id,
                                 String hash,
                                 ResultUpdate resultUpdate)
                          throws QaseException

Update test run result. This method allows to update test run result.

Parameters:

code - Code of project, where to search entities. (required)

id - Identifier. (required)

hash - Hash. (required)

resultUpdate - (required)

Returns:

HashResponse

Throws:

QaseException - If fail to call the API, e.g. server error or cannot deserialize the response body

updateResultWithHttpInfo

public ApiResponse<HashResponse> updateResultWithHttpInfo(String code,
                                                          Integer id,
                                                          String hash,
                                                          ResultUpdate resultUpdate)
                                                   throws QaseException

Update test run result. This method allows to update test run result.

Parameters:

code - Code of project, where to search entities. (required)

id - Identifier. (required)

hash - Hash. (required)

resultUpdate - (required)

Returns:

ApiResponse<HashResponse>

Throws:

QaseException - If fail to call the API, e.g. server error or cannot deserialize the response body

updateResultAsync

public okhttp3.Call updateResultAsync(String code,
                                      Integer id,
                                      String hash,
                                      ResultUpdate resultUpdate,
                                      ApiCallback<HashResponse> _callback)
                               throws QaseException

Update test run result. (asynchronously) This method allows to update test run result.

Parameters:

code - Code of project, where to search entities. (required)

id - Identifier. (required)

hash - Hash. (required)

resultUpdate - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

QaseException - If fail to process the API call, e.g. serializing the request body object