io.qase.client.api

Class RunsApi

java.lang.Object

io.qase.client.api.RunsApi

public class RunsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
RunsApi()
RunsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
Response	completeRun(String code, Integer id) Complete a specific run.
okhttp3.Call	completeRunAsync(String code, Integer id, ApiCallback<Response> _callback) Complete a specific run.
okhttp3.Call	completeRunCall(String code, Integer id, ApiCallback _callback) Build call for completeRun
ApiResponse<Response>	completeRunWithHttpInfo(String code, Integer id) Complete a specific run.
IdResponse	createRun(String code, RunCreate runCreate) Create a new run.
okhttp3.Call	createRunAsync(String code, RunCreate runCreate, ApiCallback<IdResponse> _callback) Create a new run.
okhttp3.Call	createRunCall(String code, RunCreate runCreate, ApiCallback _callback) Build call for createRun
ApiResponse<IdResponse>	createRunWithHttpInfo(String code, RunCreate runCreate) Create a new run.
IdResponse	deleteRun(String code, Integer id) Delete run.
okhttp3.Call	deleteRunAsync(String code, Integer id, ApiCallback<IdResponse> _callback) Delete run.
okhttp3.Call	deleteRunCall(String code, Integer id, ApiCallback _callback) Build call for deleteRun
ApiResponse<IdResponse>	deleteRunWithHttpInfo(String code, Integer id) Delete run.
ApiClient	getApiClient()
String	getCustomBaseUrl()
int	getHostIndex()
RunResponse	getRun(String code, Integer id, String include) Get a specific run.
okhttp3.Call	getRunAsync(String code, Integer id, String include, ApiCallback<RunResponse> _callback) Get a specific run.
okhttp3.Call	getRunCall(String code, Integer id, String include, ApiCallback _callback) Build call for getRun
RunListResponse	getRuns(String code, GetRunsFiltersParameter filters, Integer limit, Integer offset, String include) Get all runs.
okhttp3.Call	getRunsAsync(String code, GetRunsFiltersParameter filters, Integer limit, Integer offset, String include, ApiCallback<RunListResponse> _callback) Get all runs.
okhttp3.Call	getRunsCall(String code, GetRunsFiltersParameter filters, Integer limit, Integer offset, String include, ApiCallback _callback) Build call for getRuns
ApiResponse<RunListResponse>	getRunsWithHttpInfo(String code, GetRunsFiltersParameter filters, Integer limit, Integer offset, String include) Get all runs.
ApiResponse<RunResponse>	getRunWithHttpInfo(String code, Integer id, String include) Get a specific run.
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)
RunPublicResponse	updateRunPublicity(String code, Integer id, RunPublic runPublic) Update publicity of a specific run.
okhttp3.Call	updateRunPublicityAsync(String code, Integer id, RunPublic runPublic, ApiCallback<RunPublicResponse> _callback) Update publicity of a specific run.
okhttp3.Call	updateRunPublicityCall(String code, Integer id, RunPublic runPublic, ApiCallback _callback) Build call for updateRunPublicity
ApiResponse<RunPublicResponse>	updateRunPublicityWithHttpInfo(String code, Integer id, RunPublic runPublic) Update publicity of a specific run.

Methods inherited from class java.lang.Object

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

Constructor Detail

RunsApi

public RunsApi()

RunsApi

public RunsApi(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)

completeRunCall

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

Build call for completeRun

Parameters:

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

id - Identifier. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

QaseException - If fail to serialize the request body object

completeRun

public Response completeRun(String code,
                            Integer id)
                     throws QaseException

Complete a specific run. This method allows to complete a specific run.

Parameters:

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

id - Identifier. (required)

Returns:

Response

Throws:

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

completeRunWithHttpInfo

public ApiResponse<Response> completeRunWithHttpInfo(String code,
                                                     Integer id)
                                              throws QaseException

Complete a specific run. This method allows to complete a specific run.

Parameters:

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

id - Identifier. (required)

Returns:

ApiResponse<Response>

Throws:

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

completeRunAsync

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

Complete a specific run. (asynchronously) This method allows to complete a specific run.

Parameters:

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

id - Identifier. (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

createRunCall

public okhttp3.Call createRunCall(String code,
                                  RunCreate runCreate,
                                  ApiCallback _callback)
                           throws QaseException

Build call for createRun

Parameters:

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

runCreate - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

QaseException - If fail to serialize the request body object

createRun

public IdResponse createRun(String code,
                            RunCreate runCreate)
                     throws QaseException

Create a new run. This method allows to create a run in selected project.

Parameters:

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

runCreate - (required)

Returns:

IdResponse

Throws:

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

createRunWithHttpInfo

public ApiResponse<IdResponse> createRunWithHttpInfo(String code,
                                                     RunCreate runCreate)
                                              throws QaseException

Create a new run. This method allows to create a run in selected project.

Parameters:

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

runCreate - (required)

Returns:

ApiResponse<IdResponse>

Throws:

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

createRunAsync

public okhttp3.Call createRunAsync(String code,
                                   RunCreate runCreate,
                                   ApiCallback<IdResponse> _callback)
                            throws QaseException

Create a new run. (asynchronously) This method allows to create a run in selected project.

Parameters:

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

runCreate - (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

deleteRunCall

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

Build call for deleteRun

Parameters:

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

id - Identifier. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

QaseException - If fail to serialize the request body object

deleteRun

public IdResponse deleteRun(String code,
                            Integer id)
                     throws QaseException

Delete run. This method completely deletes a run from repository.

Parameters:

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

id - Identifier. (required)

Returns:

IdResponse

Throws:

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

deleteRunWithHttpInfo

public ApiResponse<IdResponse> deleteRunWithHttpInfo(String code,
                                                     Integer id)
                                              throws QaseException

Delete run. This method completely deletes a run from repository.

Parameters:

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

id - Identifier. (required)

Returns:

ApiResponse<IdResponse>

Throws:

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

deleteRunAsync

public okhttp3.Call deleteRunAsync(String code,
                                   Integer id,
                                   ApiCallback<IdResponse> _callback)
                            throws QaseException

Delete run. (asynchronously) This method completely deletes a run from repository.

Parameters:

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

id - Identifier. (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

getRunCall

public okhttp3.Call getRunCall(String code,
                               Integer id,
                               String include,
                               ApiCallback _callback)
                        throws QaseException

Build call for getRun

Parameters:

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

id - Identifier. (required)

include - Include a list of related entities IDs into response. Should be separated by comma. Possible values: cases, defects (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

QaseException - If fail to serialize the request body object

getRun

public RunResponse getRun(String code,
                          Integer id,
                          String include)
                   throws QaseException

Get a specific run. This method allows to retrieve a specific run.

Parameters:

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

id - Identifier. (required)

include - Include a list of related entities IDs into response. Should be separated by comma. Possible values: cases, defects (optional)

Returns:

RunResponse

Throws:

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

getRunWithHttpInfo

public ApiResponse<RunResponse> getRunWithHttpInfo(String code,
                                                   Integer id,
                                                   String include)
                                            throws QaseException

Get a specific run. This method allows to retrieve a specific run.

Parameters:

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

id - Identifier. (required)

include - Include a list of related entities IDs into response. Should be separated by comma. Possible values: cases, defects (optional)

Returns:

ApiResponse<RunResponse>

Throws:

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

getRunAsync

public okhttp3.Call getRunAsync(String code,
                                Integer id,
                                String include,
                                ApiCallback<RunResponse> _callback)
                         throws QaseException

Get a specific run. (asynchronously) This method allows to retrieve a specific run.

Parameters:

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

id - Identifier. (required)

include - Include a list of related entities IDs into response. Should be separated by comma. Possible values: cases, defects (optional)

_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

getRunsCall

public okhttp3.Call getRunsCall(String code,
                                GetRunsFiltersParameter filters,
                                Integer limit,
                                Integer offset,
                                String include,
                                ApiCallback _callback)
                         throws QaseException

Build call for getRuns

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)

include - Include a list of related entities IDs into response. Should be separated by comma. Possible values: cases, defects (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

QaseException - If fail to serialize the request body object

getRuns

public RunListResponse getRuns(String code,
                               GetRunsFiltersParameter filters,
                               Integer limit,
                               Integer offset,
                               String include)
                        throws QaseException

Get all runs. This method allows to retrieve all runs 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)

include - Include a list of related entities IDs into response. Should be separated by comma. Possible values: cases, defects (optional)

Returns:

RunListResponse

Throws:

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

getRunsWithHttpInfo

public ApiResponse<RunListResponse> getRunsWithHttpInfo(String code,
                                                        GetRunsFiltersParameter filters,
                                                        Integer limit,
                                                        Integer offset,
                                                        String include)
                                                 throws QaseException

Get all runs. This method allows to retrieve all runs 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)

include - Include a list of related entities IDs into response. Should be separated by comma. Possible values: cases, defects (optional)

Returns:

ApiResponse<RunListResponse>

Throws:

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

getRunsAsync

public okhttp3.Call getRunsAsync(String code,
                                 GetRunsFiltersParameter filters,
                                 Integer limit,
                                 Integer offset,
                                 String include,
                                 ApiCallback<RunListResponse> _callback)
                          throws QaseException

Get all runs. (asynchronously) This method allows to retrieve all runs 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)

include - Include a list of related entities IDs into response. Should be separated by comma. Possible values: cases, defects (optional)

_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

updateRunPublicityCall

public okhttp3.Call updateRunPublicityCall(String code,
                                           Integer id,
                                           RunPublic runPublic,
                                           ApiCallback _callback)
                                    throws QaseException

Build call for updateRunPublicity

Parameters:

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

id - Identifier. (required)

runPublic - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

QaseException - If fail to serialize the request body object

updateRunPublicity

public RunPublicResponse updateRunPublicity(String code,
                                            Integer id,
                                            RunPublic runPublic)
                                     throws QaseException

Update publicity of a specific run. This method allows to update a publicity of specific run.

Parameters:

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

id - Identifier. (required)

runPublic - (required)

Returns:

RunPublicResponse

Throws:

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

updateRunPublicityWithHttpInfo

public ApiResponse<RunPublicResponse> updateRunPublicityWithHttpInfo(String code,
                                                                     Integer id,
                                                                     RunPublic runPublic)
                                                              throws QaseException

Update publicity of a specific run. This method allows to update a publicity of specific run.

Parameters:

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

id - Identifier. (required)

runPublic - (required)

Returns:

ApiResponse<RunPublicResponse>

Throws:

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

updateRunPublicityAsync

public okhttp3.Call updateRunPublicityAsync(String code,
                                            Integer id,
                                            RunPublic runPublic,
                                            ApiCallback<RunPublicResponse> _callback)
                                     throws QaseException

Update publicity of a specific run. (asynchronously) This method allows to update a publicity of specific run.

Parameters:

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

id - Identifier. (required)

runPublic - (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