org.wso2.am.integration.clients.store.api.v1

Class UnifiedSearchApi

java.lang.Object

org.wso2.am.integration.clients.store.api.v1.UnifiedSearchApi

public class UnifiedSearchApi
extends Object

Constructor Summary

Constructors

Constructor and Description
UnifiedSearchApi()
UnifiedSearchApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
SearchResultListDTO	searchGet(Integer limit, Integer offset, String xWSO2Tenant, String query, String ifNoneMatch) Retrieve/Search APIs and API Documents by content This operation provides you a list of available APIs and API Documents qualifying the given keyword match.
com.squareup.okhttp.Call	searchGetAsync(Integer limit, Integer offset, String xWSO2Tenant, String query, String ifNoneMatch, ApiCallback<SearchResultListDTO> callback) Retrieve/Search APIs and API Documents by content (asynchronously) This operation provides you a list of available APIs and API Documents qualifying the given keyword match.
com.squareup.okhttp.Call	searchGetCall(Integer limit, Integer offset, String xWSO2Tenant, String query, String ifNoneMatch, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for searchGet
ApiResponse<SearchResultListDTO>	searchGetWithHttpInfo(Integer limit, Integer offset, String xWSO2Tenant, String query, String ifNoneMatch) Retrieve/Search APIs and API Documents by content This operation provides you a list of available APIs and API Documents qualifying the given keyword match.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

UnifiedSearchApi

public UnifiedSearchApi()

UnifiedSearchApi

public UnifiedSearchApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

searchGetCall

public com.squareup.okhttp.Call searchGetCall(Integer limit,
                                              Integer offset,
                                              String xWSO2Tenant,
                                              String query,
                                              String ifNoneMatch,
                                              ProgressResponseBody.ProgressListener progressListener,
                                              ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                       throws ApiException

Build call for searchGet

Parameters:

limit - Maximum size of resource array to return. (optional, default to 25)

offset - Starting point within the complete list of items qualified. (optional, default to 0)

xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retirieved from. (optional)

query - **Search**. You can search by using providing the search term in the query parameters. (optional)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

searchGet

public SearchResultListDTO searchGet(Integer limit,
                                     Integer offset,
                                     String xWSO2Tenant,
                                     String query,
                                     String ifNoneMatch)
                              throws ApiException

Retrieve/Search APIs and API Documents by content This operation provides you a list of available APIs and API Documents qualifying the given keyword match.

Parameters:

limit - Maximum size of resource array to return. (optional, default to 25)

offset - Starting point within the complete list of items qualified. (optional, default to 0)

xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retirieved from. (optional)

query - **Search**. You can search by using providing the search term in the query parameters. (optional)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)

Returns:

SearchResultListDTO

Throws:

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

searchGetWithHttpInfo

public ApiResponse<SearchResultListDTO> searchGetWithHttpInfo(Integer limit,
                                                              Integer offset,
                                                              String xWSO2Tenant,
                                                              String query,
                                                              String ifNoneMatch)
                                                       throws ApiException

Retrieve/Search APIs and API Documents by content This operation provides you a list of available APIs and API Documents qualifying the given keyword match.

Parameters:

limit - Maximum size of resource array to return. (optional, default to 25)

offset - Starting point within the complete list of items qualified. (optional, default to 0)

xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retirieved from. (optional)

query - **Search**. You can search by using providing the search term in the query parameters. (optional)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)

Returns:

ApiResponse<SearchResultListDTO>

Throws:

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

searchGetAsync

public com.squareup.okhttp.Call searchGetAsync(Integer limit,
                                               Integer offset,
                                               String xWSO2Tenant,
                                               String query,
                                               String ifNoneMatch,
                                               ApiCallback<SearchResultListDTO> callback)
                                        throws ApiException

Retrieve/Search APIs and API Documents by content (asynchronously) This operation provides you a list of available APIs and API Documents qualifying the given keyword match.

Parameters:

limit - Maximum size of resource array to return. (optional, default to 25)

offset - Starting point within the complete list of items qualified. (optional, default to 0)

xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retirieved from. (optional)

query - **Search**. You can search by using providing the search term in the query parameters. (optional)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)

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

Returns:

The request call

Throws:

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