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

Class TenantsApi

java.lang.Object

org.wso2.am.integration.clients.publisher.api.v1.TenantsApi

public class TenantsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
TenantsApi()
TenantsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
void	getTenantExistence(String tenantDomain) Check whether the given tenant already exists Using this operation, user can check whether a given tenant exists or not.
com.squareup.okhttp.Call	getTenantExistenceAsync(String tenantDomain, ApiCallback<Void> callback) Check whether the given tenant already exists (asynchronously) Using this operation, user can check whether a given tenant exists or not.
com.squareup.okhttp.Call	getTenantExistenceCall(String tenantDomain, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getTenantExistence
ApiResponse<Void>	getTenantExistenceWithHttpInfo(String tenantDomain) Check whether the given tenant already exists Using this operation, user can check whether a given tenant exists or not.
TenantListDTO	getTenantsByState(String state, Integer limit, Integer offset) Get get tenants by state This operation is to get tenants by state
com.squareup.okhttp.Call	getTenantsByStateAsync(String state, Integer limit, Integer offset, ApiCallback<TenantListDTO> callback) Get get tenants by state (asynchronously) This operation is to get tenants by state
com.squareup.okhttp.Call	getTenantsByStateCall(String state, Integer limit, Integer offset, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getTenantsByState
ApiResponse<TenantListDTO>	getTenantsByStateWithHttpInfo(String state, Integer limit, Integer offset) Get get tenants by state This operation is to get tenants by state
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

TenantsApi

public TenantsApi()

TenantsApi

public TenantsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getTenantExistenceCall

public com.squareup.okhttp.Call getTenantExistenceCall(String tenantDomain,
                                                       ProgressResponseBody.ProgressListener progressListener,
                                                       ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                throws ApiException

Build call for getTenantExistence

Parameters:

tenantDomain - The domain of a specific tenant (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getTenantExistence

public void getTenantExistence(String tenantDomain)
                        throws ApiException

Check whether the given tenant already exists Using this operation, user can check whether a given tenant exists or not.

Parameters:

tenantDomain - The domain of a specific tenant (required)

Throws:

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

getTenantExistenceWithHttpInfo

public ApiResponse<Void> getTenantExistenceWithHttpInfo(String tenantDomain)
                                                 throws ApiException

Check whether the given tenant already exists Using this operation, user can check whether a given tenant exists or not.

Parameters:

tenantDomain - The domain of a specific tenant (required)

Returns:

ApiResponse<Void>

Throws:

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

getTenantExistenceAsync

public com.squareup.okhttp.Call getTenantExistenceAsync(String tenantDomain,
                                                        ApiCallback<Void> callback)
                                                 throws ApiException

Check whether the given tenant already exists (asynchronously) Using this operation, user can check whether a given tenant exists or not.

Parameters:

tenantDomain - The domain of a specific tenant (required)

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

getTenantsByStateCall

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

Build call for getTenantsByState

Parameters:

state - The state represents the current state of the tenant Supported states are [ active, inactive] (optional, default to active)

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)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getTenantsByState

public TenantListDTO getTenantsByState(String state,
                                       Integer limit,
                                       Integer offset)
                                throws ApiException

Get get tenants by state This operation is to get tenants by state

Parameters:

state - The state represents the current state of the tenant Supported states are [ active, inactive] (optional, default to active)

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)

Returns:

TenantListDTO

Throws:

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

getTenantsByStateWithHttpInfo

public ApiResponse<TenantListDTO> getTenantsByStateWithHttpInfo(String state,
                                                                Integer limit,
                                                                Integer offset)
                                                         throws ApiException

Get get tenants by state This operation is to get tenants by state

Parameters:

state - The state represents the current state of the tenant Supported states are [ active, inactive] (optional, default to active)

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)

Returns:

ApiResponse<TenantListDTO>

Throws:

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

getTenantsByStateAsync

public com.squareup.okhttp.Call getTenantsByStateAsync(String state,
                                                       Integer limit,
                                                       Integer offset,
                                                       ApiCallback<TenantListDTO> callback)
                                                throws ApiException

Get get tenants by state (asynchronously) This operation is to get tenants by state

Parameters:

state - The state represents the current state of the tenant Supported states are [ active, inactive] (optional, default to active)

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)

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