org.wso2.carbon.apimgt.samples.utils.store.rest.client.api

Class ApplicationCollectionApi

java.lang.Object

org.wso2.carbon.apimgt.samples.utils.store.rest.client.api.ApplicationCollectionApi

public class ApplicationCollectionApi
extends Object

Constructor Summary

Constructors

Constructor and Description
ApplicationCollectionApi()
ApplicationCollectionApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApplicationList	applicationsGet(String groupId, String query, Integer limit, Integer offset, String accept, String ifNoneMatch) Retrieve/Search applications This operation can be used to retrieve list of applications that is belonged to the user associated with the provided access token.
com.squareup.okhttp.Call	applicationsGetAsync(String groupId, String query, Integer limit, Integer offset, String accept, String ifNoneMatch, ApiCallback<ApplicationList> callback) Retrieve/Search applications (asynchronously) This operation can be used to retrieve list of applications that is belonged to the user associated with the provided access token.
ApiResponse<ApplicationList>	applicationsGetWithHttpInfo(String groupId, String query, Integer limit, Integer offset, String accept, String ifNoneMatch) Retrieve/Search applications This operation can be used to retrieve list of applications that is belonged to the user associated with the provided access token.
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

ApplicationCollectionApi

public ApplicationCollectionApi()

ApplicationCollectionApi

public ApplicationCollectionApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

applicationsGet

public ApplicationList applicationsGet(String groupId,
                                       String query,
                                       Integer limit,
                                       Integer offset,
                                       String accept,
                                       String ifNoneMatch)
                                throws ApiException

Retrieve/Search applications This operation can be used to retrieve list of applications that is belonged to the user associated with the provided access token.

Parameters:

groupId - Application Group Id (optional)

query - **Search condition**. You can search for an application by specifying the name as \"query\" attribute. Eg. \"app1\" will match an application if the name is exactly \"app1\". Currently this does not support wildcards. Given name must exactly match the application name. (optional)

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)

accept - Media types acceptable for the response. Default is application/json. (optional, default to application/json)

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

Returns:

ApplicationList

Throws:

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

applicationsGetWithHttpInfo

public ApiResponse<ApplicationList> applicationsGetWithHttpInfo(String groupId,
                                                                String query,
                                                                Integer limit,
                                                                Integer offset,
                                                                String accept,
                                                                String ifNoneMatch)
                                                         throws ApiException

Retrieve/Search applications This operation can be used to retrieve list of applications that is belonged to the user associated with the provided access token.

Parameters:

groupId - Application Group Id (optional)

query - **Search condition**. You can search for an application by specifying the name as \"query\" attribute. Eg. \"app1\" will match an application if the name is exactly \"app1\". Currently this does not support wildcards. Given name must exactly match the application name. (optional)

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)

accept - Media types acceptable for the response. Default is application/json. (optional, default to application/json)

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

Returns:

ApiResponse<ApplicationList>

Throws:

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

applicationsGetAsync

public com.squareup.okhttp.Call applicationsGetAsync(String groupId,
                                                     String query,
                                                     Integer limit,
                                                     Integer offset,
                                                     String accept,
                                                     String ifNoneMatch,
                                                     ApiCallback<ApplicationList> callback)
                                              throws ApiException

Retrieve/Search applications (asynchronously) This operation can be used to retrieve list of applications that is belonged to the user associated with the provided access token.

Parameters:

groupId - Application Group Id (optional)

query - **Search condition**. You can search for an application by specifying the name as \"query\" attribute. Eg. \"app1\" will match an application if the name is exactly \"app1\". Currently this does not support wildcards. Given name must exactly match the application name. (optional)

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)

accept - Media types acceptable for the response. Default is application/json. (optional, default to application/json)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (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