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

Class DocumentsApi

java.lang.Object

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

public class DocumentsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
DocumentsApi()
DocumentsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
DocumentDTO	apisApiIdDocumentsDocumentIdGet(String apiId, String documentId, String xWSO2Tenant, String ifNoneMatch) Get a document of an API This operation can be used to retrieve a particular document's metadata associated with an API.
com.squareup.okhttp.Call	apisApiIdDocumentsDocumentIdGetAsync(String apiId, String documentId, String xWSO2Tenant, String ifNoneMatch, ApiCallback<DocumentDTO> callback) Get a document of an API (asynchronously) This operation can be used to retrieve a particular document's metadata associated with an API.
com.squareup.okhttp.Call	apisApiIdDocumentsDocumentIdGetCall(String apiId, String documentId, String xWSO2Tenant, String ifNoneMatch, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for apisApiIdDocumentsDocumentIdGet
ApiResponse<DocumentDTO>	apisApiIdDocumentsDocumentIdGetWithHttpInfo(String apiId, String documentId, String xWSO2Tenant, String ifNoneMatch) Get a document of an API This operation can be used to retrieve a particular document's metadata associated with an API.
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

DocumentsApi

public DocumentsApi()

DocumentsApi

public DocumentsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

apisApiIdDocumentsDocumentIdGetCall

public com.squareup.okhttp.Call apisApiIdDocumentsDocumentIdGetCall(String apiId,
                                                                    String documentId,
                                                                    String xWSO2Tenant,
                                                                    String ifNoneMatch,
                                                                    ProgressResponseBody.ProgressListener progressListener,
                                                                    ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                             throws ApiException

Build call for apisApiIdDocumentsDocumentIdGet

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

documentId - Document Identifier (required)

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

apisApiIdDocumentsDocumentIdGet

public DocumentDTO apisApiIdDocumentsDocumentIdGet(String apiId,
                                                   String documentId,
                                                   String xWSO2Tenant,
                                                   String ifNoneMatch)
                                            throws ApiException

Get a document of an API This operation can be used to retrieve a particular document's metadata associated with an API. `X-WSO2-Tenant` header can be used to retrive a document of an API 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 document, you need to provide Authorization header.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

documentId - Document Identifier (required)

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:

DocumentDTO

Throws:

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

apisApiIdDocumentsDocumentIdGetWithHttpInfo

public ApiResponse<DocumentDTO> apisApiIdDocumentsDocumentIdGetWithHttpInfo(String apiId,
                                                                            String documentId,
                                                                            String xWSO2Tenant,
                                                                            String ifNoneMatch)
                                                                     throws ApiException

Get a document of an API This operation can be used to retrieve a particular document's metadata associated with an API. `X-WSO2-Tenant` header can be used to retrive a document of an API 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 document, you need to provide Authorization header.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

documentId - Document Identifier (required)

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<DocumentDTO>

Throws:

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

apisApiIdDocumentsDocumentIdGetAsync

public com.squareup.okhttp.Call apisApiIdDocumentsDocumentIdGetAsync(String apiId,
                                                                     String documentId,
                                                                     String xWSO2Tenant,
                                                                     String ifNoneMatch,
                                                                     ApiCallback<DocumentDTO> callback)
                                                              throws ApiException

Get a document of an API (asynchronously) This operation can be used to retrieve a particular document's metadata associated with an API. `X-WSO2-Tenant` header can be used to retrive a document of an API 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 document, you need to provide Authorization header.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

documentId - Document Identifier (required)

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