org.wso2.am.integration.clients.gateway.api.v2

Class GetApiArtifactsApi

java.lang.Object

org.wso2.am.integration.clients.gateway.api.v2.GetApiArtifactsApi

public class GetApiArtifactsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
GetApiArtifactsApi()
GetApiArtifactsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
APIArtifactDTO	apiArtifactGet(String apiName, String version, String tenantDomain) Get API artifact from the storage This operation is used to get the local entries, sequences and endpoints from the storage.
com.squareup.okhttp.Call	apiArtifactGetAsync(String apiName, String version, String tenantDomain, ApiCallback<APIArtifactDTO> callback) Get API artifact from the storage (asynchronously) This operation is used to get the local entries, sequences and endpoints from the storage.
com.squareup.okhttp.Call	apiArtifactGetCall(String apiName, String version, String tenantDomain, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for apiArtifactGet
ApiResponse<APIArtifactDTO>	apiArtifactGetWithHttpInfo(String apiName, String version, String tenantDomain) Get API artifact from the storage This operation is used to get the local entries, sequences and endpoints from the storage.
EndpointsDTO	endPointsGet(String apiName, String version, String tenantDomain) Get end-points from the storage for the API This operation is used to get the end-points from the storage.
com.squareup.okhttp.Call	endPointsGetAsync(String apiName, String version, String tenantDomain, ApiCallback<EndpointsDTO> callback) Get end-points from the storage for the API (asynchronously) This operation is used to get the end-points from the storage.
com.squareup.okhttp.Call	endPointsGetCall(String apiName, String version, String tenantDomain, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for endPointsGet
ApiResponse<EndpointsDTO>	endPointsGetWithHttpInfo(String apiName, String version, String tenantDomain) Get end-points from the storage for the API This operation is used to get the end-points from the storage.
ApiClient	getApiClient()
LocalEntryDTO	localEntryGet(String apiName, String version, String tenantDomain) Get Local Entry from the storage This operation is used to get local entry from the storage.If the Tenant domain is not provided carbon.super will be picked as the Tenant domain.
com.squareup.okhttp.Call	localEntryGetAsync(String apiName, String version, String tenantDomain, ApiCallback<LocalEntryDTO> callback) Get Local Entry from the storage (asynchronously) This operation is used to get local entry from the storage.If the Tenant domain is not provided carbon.super will be picked as the Tenant domain.
com.squareup.okhttp.Call	localEntryGetCall(String apiName, String version, String tenantDomain, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for localEntryGet
ApiResponse<LocalEntryDTO>	localEntryGetWithHttpInfo(String apiName, String version, String tenantDomain) Get Local Entry from the storage This operation is used to get local entry from the storage.If the Tenant domain is not provided carbon.super will be picked as the Tenant domain.
SequencesDTO	sequenceGet(String apiName, String version, String tenantDomain) Get sequences from the storage This operation is used to get the API sequence from the storage.
com.squareup.okhttp.Call	sequenceGetAsync(String apiName, String version, String tenantDomain, ApiCallback<SequencesDTO> callback) Get sequences from the storage (asynchronously) This operation is used to get the API sequence from the storage.
com.squareup.okhttp.Call	sequenceGetCall(String apiName, String version, String tenantDomain, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for sequenceGet
ApiResponse<SequencesDTO>	sequenceGetWithHttpInfo(String apiName, String version, String tenantDomain) Get sequences from the storage This operation is used to get the API sequence from the storage.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

GetApiArtifactsApi

public GetApiArtifactsApi()

GetApiArtifactsApi

public GetApiArtifactsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

apiArtifactGetCall

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

Build call for apiArtifactGet

Parameters:

apiName - Name of the API (required)

version - version of the API (required)

tenantDomain - Tenant Domain of the API (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

apiArtifactGet

public APIArtifactDTO apiArtifactGet(String apiName,
                                     String version,
                                     String tenantDomain)
                              throws ApiException

Get API artifact from the storage This operation is used to get the local entries, sequences and endpoints from the storage. If the Tenant domain is not provided carbon.super will be picked as the Tenant domain.

Parameters:

apiName - Name of the API (required)

version - version of the API (required)

tenantDomain - Tenant Domain of the API (optional)

Returns:

APIArtifactDTO

Throws:

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

apiArtifactGetWithHttpInfo

public ApiResponse<APIArtifactDTO> apiArtifactGetWithHttpInfo(String apiName,
                                                              String version,
                                                              String tenantDomain)
                                                       throws ApiException

Get API artifact from the storage This operation is used to get the local entries, sequences and endpoints from the storage. If the Tenant domain is not provided carbon.super will be picked as the Tenant domain.

Parameters:

apiName - Name of the API (required)

version - version of the API (required)

tenantDomain - Tenant Domain of the API (optional)

Returns:

ApiResponse<APIArtifactDTO>

Throws:

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

apiArtifactGetAsync

public com.squareup.okhttp.Call apiArtifactGetAsync(String apiName,
                                                    String version,
                                                    String tenantDomain,
                                                    ApiCallback<APIArtifactDTO> callback)
                                             throws ApiException

Get API artifact from the storage (asynchronously) This operation is used to get the local entries, sequences and endpoints from the storage. If the Tenant domain is not provided carbon.super will be picked as the Tenant domain.

Parameters:

apiName - Name of the API (required)

version - version of the API (required)

tenantDomain - Tenant Domain of the API (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

endPointsGetCall

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

Build call for endPointsGet

Parameters:

apiName - Name of the API (required)

version - version of the API (required)

tenantDomain - Tenant Domain of the API (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

endPointsGet

public EndpointsDTO endPointsGet(String apiName,
                                 String version,
                                 String tenantDomain)
                          throws ApiException

Get end-points from the storage for the API This operation is used to get the end-points from the storage. If the Tenant domain is not provided carbon.super will be picked as the Tenant domain.

Parameters:

apiName - Name of the API (required)

version - version of the API (required)

tenantDomain - Tenant Domain of the API (optional)

Returns:

EndpointsDTO

Throws:

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

endPointsGetWithHttpInfo

public ApiResponse<EndpointsDTO> endPointsGetWithHttpInfo(String apiName,
                                                          String version,
                                                          String tenantDomain)
                                                   throws ApiException

Get end-points from the storage for the API This operation is used to get the end-points from the storage. If the Tenant domain is not provided carbon.super will be picked as the Tenant domain.

Parameters:

apiName - Name of the API (required)

version - version of the API (required)

tenantDomain - Tenant Domain of the API (optional)

Returns:

ApiResponse<EndpointsDTO>

Throws:

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

endPointsGetAsync

public com.squareup.okhttp.Call endPointsGetAsync(String apiName,
                                                  String version,
                                                  String tenantDomain,
                                                  ApiCallback<EndpointsDTO> callback)
                                           throws ApiException

Get end-points from the storage for the API (asynchronously) This operation is used to get the end-points from the storage. If the Tenant domain is not provided carbon.super will be picked as the Tenant domain.

Parameters:

apiName - Name of the API (required)

version - version of the API (required)

tenantDomain - Tenant Domain of the API (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

localEntryGetCall

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

Build call for localEntryGet

Parameters:

apiName - Name of the API (required)

version - version of the API (required)

tenantDomain - Tenant Domain of the API (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

localEntryGet

public LocalEntryDTO localEntryGet(String apiName,
                                   String version,
                                   String tenantDomain)
                            throws ApiException

Get Local Entry from the storage This operation is used to get local entry from the storage.If the Tenant domain is not provided carbon.super will be picked as the Tenant domain.

Parameters:

apiName - Name of the API (required)

version - version of the API (required)

tenantDomain - Tenant Domain of the API (optional)

Returns:

LocalEntryDTO

Throws:

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

localEntryGetWithHttpInfo

public ApiResponse<LocalEntryDTO> localEntryGetWithHttpInfo(String apiName,
                                                            String version,
                                                            String tenantDomain)
                                                     throws ApiException

Get Local Entry from the storage This operation is used to get local entry from the storage.If the Tenant domain is not provided carbon.super will be picked as the Tenant domain.

Parameters:

apiName - Name of the API (required)

version - version of the API (required)

tenantDomain - Tenant Domain of the API (optional)

Returns:

ApiResponse<LocalEntryDTO>

Throws:

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

localEntryGetAsync

public com.squareup.okhttp.Call localEntryGetAsync(String apiName,
                                                   String version,
                                                   String tenantDomain,
                                                   ApiCallback<LocalEntryDTO> callback)
                                            throws ApiException

Get Local Entry from the storage (asynchronously) This operation is used to get local entry from the storage.If the Tenant domain is not provided carbon.super will be picked as the Tenant domain.

Parameters:

apiName - Name of the API (required)

version - version of the API (required)

tenantDomain - Tenant Domain of the API (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

sequenceGetCall

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

Build call for sequenceGet

Parameters:

apiName - Name of the API (required)

version - version of the API (required)

tenantDomain - Tenant Domain of the API (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

sequenceGet

public SequencesDTO sequenceGet(String apiName,
                                String version,
                                String tenantDomain)
                         throws ApiException

Get sequences from the storage This operation is used to get the API sequence from the storage. If the Tenant domain is not provided carbon.super will be picked as the Tenant domain.

Parameters:

apiName - Name of the API (required)

version - version of the API (required)

tenantDomain - Tenant Domain of the API (optional)

Returns:

SequencesDTO

Throws:

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

sequenceGetWithHttpInfo

public ApiResponse<SequencesDTO> sequenceGetWithHttpInfo(String apiName,
                                                         String version,
                                                         String tenantDomain)
                                                  throws ApiException

Get sequences from the storage This operation is used to get the API sequence from the storage. If the Tenant domain is not provided carbon.super will be picked as the Tenant domain.

Parameters:

apiName - Name of the API (required)

version - version of the API (required)

tenantDomain - Tenant Domain of the API (optional)

Returns:

ApiResponse<SequencesDTO>

Throws:

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

sequenceGetAsync

public com.squareup.okhttp.Call sequenceGetAsync(String apiName,
                                                 String version,
                                                 String tenantDomain,
                                                 ApiCallback<SequencesDTO> callback)
                                          throws ApiException

Get sequences from the storage (asynchronously) This operation is used to get the API sequence from the storage. If the Tenant domain is not provided carbon.super will be picked as the Tenant domain.

Parameters:

apiName - Name of the API (required)

version - version of the API (required)

tenantDomain - Tenant Domain of the API (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