io.qase.client.api

Class SharedStepsApi

java.lang.Object

io.qase.client.api.SharedStepsApi

public class SharedStepsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
SharedStepsApi()
SharedStepsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
HashResponse	createSharedStep(String code, SharedStepCreate sharedStepCreate) Create a new shared step.
okhttp3.Call	createSharedStepAsync(String code, SharedStepCreate sharedStepCreate, ApiCallback<HashResponse> _callback) Create a new shared step.
okhttp3.Call	createSharedStepCall(String code, SharedStepCreate sharedStepCreate, ApiCallback _callback) Build call for createSharedStep
ApiResponse<HashResponse>	createSharedStepWithHttpInfo(String code, SharedStepCreate sharedStepCreate) Create a new shared step.
HashResponse	deleteSharedStep(String code, String hash) Delete shared step.
okhttp3.Call	deleteSharedStepAsync(String code, String hash, ApiCallback<HashResponse> _callback) Delete shared step.
okhttp3.Call	deleteSharedStepCall(String code, String hash, ApiCallback _callback) Build call for deleteSharedStep
ApiResponse<HashResponse>	deleteSharedStepWithHttpInfo(String code, String hash) Delete shared step.
ApiClient	getApiClient()
String	getCustomBaseUrl()
int	getHostIndex()
SharedStepResponse	getSharedStep(String code, String hash) Get a specific shared step.
okhttp3.Call	getSharedStepAsync(String code, String hash, ApiCallback<SharedStepResponse> _callback) Get a specific shared step.
okhttp3.Call	getSharedStepCall(String code, String hash, ApiCallback _callback) Build call for getSharedStep
SharedStepListResponse	getSharedSteps(String code, GetMilestonesFiltersParameter filters, Integer limit, Integer offset) Get all shared steps.
okhttp3.Call	getSharedStepsAsync(String code, GetMilestonesFiltersParameter filters, Integer limit, Integer offset, ApiCallback<SharedStepListResponse> _callback) Get all shared steps.
okhttp3.Call	getSharedStepsCall(String code, GetMilestonesFiltersParameter filters, Integer limit, Integer offset, ApiCallback _callback) Build call for getSharedSteps
ApiResponse<SharedStepListResponse>	getSharedStepsWithHttpInfo(String code, GetMilestonesFiltersParameter filters, Integer limit, Integer offset) Get all shared steps.
ApiResponse<SharedStepResponse>	getSharedStepWithHttpInfo(String code, String hash) Get a specific shared step.
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)
HashResponse	updateSharedStep(String code, String hash, SharedStepUpdate sharedStepUpdate) Update shared step.
okhttp3.Call	updateSharedStepAsync(String code, String hash, SharedStepUpdate sharedStepUpdate, ApiCallback<HashResponse> _callback) Update shared step.
okhttp3.Call	updateSharedStepCall(String code, String hash, SharedStepUpdate sharedStepUpdate, ApiCallback _callback) Build call for updateSharedStep
ApiResponse<HashResponse>	updateSharedStepWithHttpInfo(String code, String hash, SharedStepUpdate sharedStepUpdate) Update shared step.

Methods inherited from class java.lang.Object

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

Constructor Detail

SharedStepsApi

public SharedStepsApi()

SharedStepsApi

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

createSharedStepCall

public okhttp3.Call createSharedStepCall(String code,
                                         SharedStepCreate sharedStepCreate,
                                         ApiCallback _callback)
                                  throws QaseException

Build call for createSharedStep

Parameters:

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

sharedStepCreate - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

QaseException - If fail to serialize the request body object

createSharedStep

public HashResponse createSharedStep(String code,
                                     SharedStepCreate sharedStepCreate)
                              throws QaseException

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

Parameters:

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

sharedStepCreate - (required)

Returns:

HashResponse

Throws:

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

createSharedStepWithHttpInfo

public ApiResponse<HashResponse> createSharedStepWithHttpInfo(String code,
                                                              SharedStepCreate sharedStepCreate)
                                                       throws QaseException

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

Parameters:

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

sharedStepCreate - (required)

Returns:

ApiResponse<HashResponse>

Throws:

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

createSharedStepAsync

public okhttp3.Call createSharedStepAsync(String code,
                                          SharedStepCreate sharedStepCreate,
                                          ApiCallback<HashResponse> _callback)
                                   throws QaseException

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

Parameters:

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

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

deleteSharedStepCall

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

Build call for deleteSharedStep

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

deleteSharedStep

public HashResponse deleteSharedStep(String code,
                                     String hash)
                              throws QaseException

Delete shared step. This method completely deletes a shared step from repository.

Parameters:

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

hash - Hash. (required)

Returns:

HashResponse

Throws:

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

deleteSharedStepWithHttpInfo

public ApiResponse<HashResponse> deleteSharedStepWithHttpInfo(String code,
                                                              String hash)
                                                       throws QaseException

Delete shared step. This method completely deletes a shared step from repository.

Parameters:

code - Code of project, where to search entities. (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

deleteSharedStepAsync

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

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

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

getSharedStepCall

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

Build call for getSharedStep

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

getSharedStep

public SharedStepResponse getSharedStep(String code,
                                        String hash)
                                 throws QaseException

Get a specific shared step. This method allows to retrieve a specific shared step.

Parameters:

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

hash - Hash. (required)

Returns:

SharedStepResponse

Throws:

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

getSharedStepWithHttpInfo

public ApiResponse<SharedStepResponse> getSharedStepWithHttpInfo(String code,
                                                                 String hash)
                                                          throws QaseException

Get a specific shared step. This method allows to retrieve a specific shared step.

Parameters:

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

hash - Hash. (required)

Returns:

ApiResponse<SharedStepResponse>

Throws:

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

getSharedStepAsync

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

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

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

getSharedStepsCall

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

Build call for getSharedSteps

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

getSharedSteps

public SharedStepListResponse getSharedSteps(String code,
                                             GetMilestonesFiltersParameter filters,
                                             Integer limit,
                                             Integer offset)
                                      throws QaseException

Get all shared steps. This method allows to retrieve all shared steps 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:

SharedStepListResponse

Throws:

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

getSharedStepsWithHttpInfo

public ApiResponse<SharedStepListResponse> getSharedStepsWithHttpInfo(String code,
                                                                      GetMilestonesFiltersParameter filters,
                                                                      Integer limit,
                                                                      Integer offset)
                                                               throws QaseException

Get all shared steps. This method allows to retrieve all shared steps 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<SharedStepListResponse>

Throws:

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

getSharedStepsAsync

public okhttp3.Call getSharedStepsAsync(String code,
                                        GetMilestonesFiltersParameter filters,
                                        Integer limit,
                                        Integer offset,
                                        ApiCallback<SharedStepListResponse> _callback)
                                 throws QaseException

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

updateSharedStepCall

public okhttp3.Call updateSharedStepCall(String code,
                                         String hash,
                                         SharedStepUpdate sharedStepUpdate,
                                         ApiCallback _callback)
                                  throws QaseException

Build call for updateSharedStep

Parameters:

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

hash - Hash. (required)

sharedStepUpdate - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

QaseException - If fail to serialize the request body object

updateSharedStep

public HashResponse updateSharedStep(String code,
                                     String hash,
                                     SharedStepUpdate sharedStepUpdate)
                              throws QaseException

Update shared step. This method updates a shared step.

Parameters:

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

hash - Hash. (required)

sharedStepUpdate - (required)

Returns:

HashResponse

Throws:

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

updateSharedStepWithHttpInfo

public ApiResponse<HashResponse> updateSharedStepWithHttpInfo(String code,
                                                              String hash,
                                                              SharedStepUpdate sharedStepUpdate)
                                                       throws QaseException

Update shared step. This method updates a shared step.

Parameters:

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

hash - Hash. (required)

sharedStepUpdate - (required)

Returns:

ApiResponse<HashResponse>

Throws:

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

updateSharedStepAsync

public okhttp3.Call updateSharedStepAsync(String code,
                                          String hash,
                                          SharedStepUpdate sharedStepUpdate,
                                          ApiCallback<HashResponse> _callback)
                                   throws QaseException

Update shared step. (asynchronously) This method updates a shared step.

Parameters:

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

hash - Hash. (required)

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