io.qase.client.api

Class SearchApi

java.lang.Object

io.qase.client.api.SearchApi

public class SearchApi
extends Object

Constructor Summary

Constructors

Constructor and Description
SearchApi()
SearchApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
String	getCustomBaseUrl()
int	getHostIndex()
SearchResponse	search(String query, Integer limit, Integer offset) Search entities by Qase Query Language (QQL).
okhttp3.Call	searchAsync(String query, Integer limit, Integer offset, ApiCallback<SearchResponse> _callback) Search entities by Qase Query Language (QQL).
okhttp3.Call	searchCall(String query, Integer limit, Integer offset, ApiCallback _callback) Build call for search
ApiResponse<SearchResponse>	searchWithHttpInfo(String query, Integer limit, Integer offset) Search entities by Qase Query Language (QQL).
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchApi

public SearchApi()

SearchApi

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

searchCall

public okhttp3.Call searchCall(String query,
                               Integer limit,
                               Integer offset,
                               ApiCallback _callback)
                        throws QaseException

Build call for search

Parameters:

query - Expression in Qase Query Language. (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

See Also:

Search entities by Qase Query Language (QQL). Documentation

search

public SearchResponse search(String query,
                             Integer limit,
                             Integer offset)
                      throws QaseException

Search entities by Qase Query Language (QQL). This method allows to retrieve data sets for various entities using expressions with conditions.

Parameters:

query - Expression in Qase Query Language. (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:

SearchResponse

Throws:

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

See Also:

Search entities by Qase Query Language (QQL). Documentation

searchWithHttpInfo

public ApiResponse<SearchResponse> searchWithHttpInfo(String query,
                                                      Integer limit,
                                                      Integer offset)
                                               throws QaseException

Search entities by Qase Query Language (QQL). This method allows to retrieve data sets for various entities using expressions with conditions.

Parameters:

query - Expression in Qase Query Language. (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<SearchResponse>

Throws:

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

See Also:

Search entities by Qase Query Language (QQL). Documentation

searchAsync

public okhttp3.Call searchAsync(String query,
                                Integer limit,
                                Integer offset,
                                ApiCallback<SearchResponse> _callback)
                         throws QaseException

Search entities by Qase Query Language (QQL). (asynchronously) This method allows to retrieve data sets for various entities using expressions with conditions.

Parameters:

query - Expression in Qase Query Language. (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

See Also:

Search entities by Qase Query Language (QQL). Documentation