io.qase.client.api

Class EnvironmentsApi

java.lang.Object

io.qase.client.api.EnvironmentsApi

public class EnvironmentsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
EnvironmentsApi()
EnvironmentsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
IdResponse	createEnvironment(String code, EnvironmentCreate environmentCreate) Create a new environment.
okhttp3.Call	createEnvironmentAsync(String code, EnvironmentCreate environmentCreate, ApiCallback<IdResponse> _callback) Create a new environment.
okhttp3.Call	createEnvironmentCall(String code, EnvironmentCreate environmentCreate, ApiCallback _callback) Build call for createEnvironment
ApiResponse<IdResponse>	createEnvironmentWithHttpInfo(String code, EnvironmentCreate environmentCreate) Create a new environment.
IdResponse	deleteEnvironment(String code, Integer id) Delete environment.
okhttp3.Call	deleteEnvironmentAsync(String code, Integer id, ApiCallback<IdResponse> _callback) Delete environment.
okhttp3.Call	deleteEnvironmentCall(String code, Integer id, ApiCallback _callback) Build call for deleteEnvironment
ApiResponse<IdResponse>	deleteEnvironmentWithHttpInfo(String code, Integer id) Delete environment.
ApiClient	getApiClient()
String	getCustomBaseUrl()
EnvironmentResponse	getEnvironment(String code, Integer id) Get a specific environment.
okhttp3.Call	getEnvironmentAsync(String code, Integer id, ApiCallback<EnvironmentResponse> _callback) Get a specific environment.
okhttp3.Call	getEnvironmentCall(String code, Integer id, ApiCallback _callback) Build call for getEnvironment
EnvironmentListResponse	getEnvironments(String code, Integer limit, Integer offset) Get all environments.
okhttp3.Call	getEnvironmentsAsync(String code, Integer limit, Integer offset, ApiCallback<EnvironmentListResponse> _callback) Get all environments.
okhttp3.Call	getEnvironmentsCall(String code, Integer limit, Integer offset, ApiCallback _callback) Build call for getEnvironments
ApiResponse<EnvironmentListResponse>	getEnvironmentsWithHttpInfo(String code, Integer limit, Integer offset) Get all environments.
ApiResponse<EnvironmentResponse>	getEnvironmentWithHttpInfo(String code, Integer id) Get a specific environment.
int	getHostIndex()
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)
IdResponse	updateEnvironment(String code, Integer id, EnvironmentUpdate environmentUpdate) Update environment.
okhttp3.Call	updateEnvironmentAsync(String code, Integer id, EnvironmentUpdate environmentUpdate, ApiCallback<IdResponse> _callback) Update environment.
okhttp3.Call	updateEnvironmentCall(String code, Integer id, EnvironmentUpdate environmentUpdate, ApiCallback _callback) Build call for updateEnvironment
ApiResponse<IdResponse>	updateEnvironmentWithHttpInfo(String code, Integer id, EnvironmentUpdate environmentUpdate) Update environment.

Methods inherited from class java.lang.Object

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

Constructor Detail

EnvironmentsApi

public EnvironmentsApi()

EnvironmentsApi

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

createEnvironmentCall

public okhttp3.Call createEnvironmentCall(String code,
                                          EnvironmentCreate environmentCreate,
                                          ApiCallback _callback)
                                   throws QaseException

Build call for createEnvironment

Parameters:

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

environmentCreate - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

QaseException - If fail to serialize the request body object

createEnvironment

public IdResponse createEnvironment(String code,
                                    EnvironmentCreate environmentCreate)
                             throws QaseException

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

Parameters:

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

environmentCreate - (required)

Returns:

IdResponse

Throws:

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

createEnvironmentWithHttpInfo

public ApiResponse<IdResponse> createEnvironmentWithHttpInfo(String code,
                                                             EnvironmentCreate environmentCreate)
                                                      throws QaseException

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

Parameters:

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

environmentCreate - (required)

Returns:

ApiResponse<IdResponse>

Throws:

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

createEnvironmentAsync

public okhttp3.Call createEnvironmentAsync(String code,
                                           EnvironmentCreate environmentCreate,
                                           ApiCallback<IdResponse> _callback)
                                    throws QaseException

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

Parameters:

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

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

deleteEnvironmentCall

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

Build call for deleteEnvironment

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

deleteEnvironment

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

Delete environment. This method completely deletes an environment 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

deleteEnvironmentWithHttpInfo

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

Delete environment. This method completely deletes an environment 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

deleteEnvironmentAsync

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

Delete environment. (asynchronously) This method completely deletes an environment 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

getEnvironmentCall

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

Build call for getEnvironment

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

getEnvironment

public EnvironmentResponse getEnvironment(String code,
                                          Integer id)
                                   throws QaseException

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

Parameters:

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

id - Identifier. (required)

Returns:

EnvironmentResponse

Throws:

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

getEnvironmentWithHttpInfo

public ApiResponse<EnvironmentResponse> getEnvironmentWithHttpInfo(String code,
                                                                   Integer id)
                                                            throws QaseException

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

Parameters:

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

id - Identifier. (required)

Returns:

ApiResponse<EnvironmentResponse>

Throws:

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

getEnvironmentAsync

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

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

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

getEnvironmentsCall

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

Build call for getEnvironments

Parameters:

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

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

getEnvironments

public EnvironmentListResponse getEnvironments(String code,
                                               Integer limit,
                                               Integer offset)
                                        throws QaseException

Get all environments. This method allows to retrieve all environments stored in selected project.

Parameters:

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

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

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

Returns:

EnvironmentListResponse

Throws:

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

getEnvironmentsWithHttpInfo

public ApiResponse<EnvironmentListResponse> getEnvironmentsWithHttpInfo(String code,
                                                                        Integer limit,
                                                                        Integer offset)
                                                                 throws QaseException

Get all environments. This method allows to retrieve all environments stored in selected project.

Parameters:

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

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<EnvironmentListResponse>

Throws:

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

getEnvironmentsAsync

public okhttp3.Call getEnvironmentsAsync(String code,
                                         Integer limit,
                                         Integer offset,
                                         ApiCallback<EnvironmentListResponse> _callback)
                                  throws QaseException

Get all environments. (asynchronously) This method allows to retrieve all environments stored in selected project.

Parameters:

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

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

updateEnvironmentCall

public okhttp3.Call updateEnvironmentCall(String code,
                                          Integer id,
                                          EnvironmentUpdate environmentUpdate,
                                          ApiCallback _callback)
                                   throws QaseException

Build call for updateEnvironment

Parameters:

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

id - Identifier. (required)

environmentUpdate - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

QaseException - If fail to serialize the request body object

updateEnvironment

public IdResponse updateEnvironment(String code,
                                    Integer id,
                                    EnvironmentUpdate environmentUpdate)
                             throws QaseException

Update environment. This method updates an environment.

Parameters:

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

id - Identifier. (required)

environmentUpdate - (required)

Returns:

IdResponse

Throws:

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

updateEnvironmentWithHttpInfo

public ApiResponse<IdResponse> updateEnvironmentWithHttpInfo(String code,
                                                             Integer id,
                                                             EnvironmentUpdate environmentUpdate)
                                                      throws QaseException

Update environment. This method updates an environment.

Parameters:

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

id - Identifier. (required)

environmentUpdate - (required)

Returns:

ApiResponse<IdResponse>

Throws:

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

updateEnvironmentAsync

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

Update environment. (asynchronously) This method updates an environment.

Parameters:

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

id - Identifier. (required)

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