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

Class TagsApi

java.lang.Object

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

public class TagsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
TagsApi()
TagsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)
TagListDTO	tagsGet(Integer limit, Integer offset, String xWSO2Tenant, String ifNoneMatch) Get all tags This operation can be used to retrieve a list of tags that are already added to APIs.
com.squareup.okhttp.Call	tagsGetAsync(Integer limit, Integer offset, String xWSO2Tenant, String ifNoneMatch, ApiCallback<TagListDTO> callback) Get all tags (asynchronously) This operation can be used to retrieve a list of tags that are already added to APIs.
com.squareup.okhttp.Call	tagsGetCall(Integer limit, Integer offset, String xWSO2Tenant, String ifNoneMatch, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for tagsGet
ApiResponse<TagListDTO>	tagsGetWithHttpInfo(Integer limit, Integer offset, String xWSO2Tenant, String ifNoneMatch) Get all tags This operation can be used to retrieve a list of tags that are already added to APIs.

Methods inherited from class java.lang.Object

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

Constructor Detail

TagsApi

public TagsApi()

TagsApi

public TagsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

tagsGetCall

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

Build call for tagsGet

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)

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

tagsGet

public TagListDTO tagsGet(Integer limit,
                          Integer offset,
                          String xWSO2Tenant,
                          String ifNoneMatch)
                   throws ApiException

Get all tags This operation can be used to retrieve a list of tags that are already added to APIs. `X-WSO2-Tenant` header can be used to retrive tags that belongs to a different tenant domain. If not specified super tenant will be used. If Authorization header is present in the request, the user's tenant associated with the access token will be used. **NOTE:** * This operation does not require an Authorization header by default. But in order to see a restricted API's tags, you need to provide Authorization header.

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)

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

Returns:

TagListDTO

Throws:

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

tagsGetWithHttpInfo

public ApiResponse<TagListDTO> tagsGetWithHttpInfo(Integer limit,
                                                   Integer offset,
                                                   String xWSO2Tenant,
                                                   String ifNoneMatch)
                                            throws ApiException

Get all tags This operation can be used to retrieve a list of tags that are already added to APIs. `X-WSO2-Tenant` header can be used to retrive tags that belongs to a different tenant domain. If not specified super tenant will be used. If Authorization header is present in the request, the user's tenant associated with the access token will be used. **NOTE:** * This operation does not require an Authorization header by default. But in order to see a restricted API's tags, you need to provide Authorization header.

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)

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

Returns:

ApiResponse<TagListDTO>

Throws:

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

tagsGetAsync

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

Get all tags (asynchronously) This operation can be used to retrieve a list of tags that are already added to APIs. `X-WSO2-Tenant` header can be used to retrive tags that belongs to a different tenant domain. If not specified super tenant will be used. If Authorization header is present in the request, the user's tenant associated with the access token will be used. **NOTE:** * This operation does not require an Authorization header by default. But in order to see a restricted API's tags, you need to provide Authorization header.

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)

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