Package 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	Description
GetApiArtifactsApi()
GetApiArtifactsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
APIArtifactDTO	getAPIArtifacts(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	getAPIArtifactsAsync(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	getAPIArtifactsCall(String apiName, String version, String tenantDomain, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for getAPIArtifacts
ApiResponse<APIArtifactDTO>	getAPIArtifactsWithHttpInfo(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.
ApiClient	getApiClient()
EndpointsDTO	getEndpoints(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	getEndpointsAsync(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	getEndpointsCall(String apiName, String version, String tenantDomain, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for getEndpoints
ApiResponse<EndpointsDTO>	getEndpointsWithHttpInfo(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.
LocalEntryDTO	getLocalEntries(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	getLocalEntriesAsync(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	getLocalEntriesCall(String apiName, String version, String tenantDomain, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for getLocalEntries
ApiResponse<LocalEntryDTO>	getLocalEntriesWithHttpInfo(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	getSequences(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	getSequencesAsync(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	getSequencesCall(String apiName, String version, String tenantDomain, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for getSequences
ApiResponse<SequencesDTO>	getSequencesWithHttpInfo(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)

getAPIArtifactsCall

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

Build call for getAPIArtifacts

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

getAPIArtifacts

public APIArtifactDTO getAPIArtifacts(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

getAPIArtifactsWithHttpInfo

public ApiResponse<APIArtifactDTO> getAPIArtifactsWithHttpInfo(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

getAPIArtifactsAsync

public com.squareup.okhttp.Call getAPIArtifactsAsync(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

getEndpointsCall

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

Build call for getEndpoints

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

getEndpoints

public EndpointsDTO getEndpoints(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

getEndpointsWithHttpInfo

public ApiResponse<EndpointsDTO> getEndpointsWithHttpInfo(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

getEndpointsAsync

public com.squareup.okhttp.Call getEndpointsAsync(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

getLocalEntriesCall

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

Build call for getLocalEntries

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

getLocalEntries

public LocalEntryDTO getLocalEntries(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

getLocalEntriesWithHttpInfo

public ApiResponse<LocalEntryDTO> getLocalEntriesWithHttpInfo(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

getLocalEntriesAsync

public com.squareup.okhttp.Call getLocalEntriesAsync(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

getSequencesCall

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

Build call for getSequences

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

getSequences

public SequencesDTO getSequences(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

getSequencesWithHttpInfo

public ApiResponse<SequencesDTO> getSequencesWithHttpInfo(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

getSequencesAsync

public com.squareup.okhttp.Call getSequencesAsync(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