Package com.groupdocs.cloud.metadata.api

Class MetadataApi

java.lang.Object

com.groupdocs.cloud.metadata.api.MetadataApi

public class MetadataApi
extends Object

Constructor Summary

Constructors

Constructor	Description
MetadataApi(Configuration configuration)	Initializes new instance of MetadataApi
MetadataApi(String appSid, String appKey)	Initializes new instance of MetadataApi

Method Summary

Modifier and Type	Method	Description
AddResult	add(AddRequest request)	Add new metadata fields to a file.
com.squareup.okhttp.Call	addAsync(AddRequest request, ApiCallback<AddResult> callback)	Add new metadata fields to a file.
com.squareup.okhttp.Call	addCall(AddRequest request, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for add
ApiResponse<AddResult>	addWithHttpInfo(AddRequest request)	Add new metadata fields to a file.
ExtractResult	extract(ExtractRequest request)	Retrieve document metadata.
com.squareup.okhttp.Call	extractAsync(ExtractRequest request, ApiCallback<ExtractResult> callback)	Retrieve document metadata.
com.squareup.okhttp.Call	extractCall(ExtractRequest request, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for extract
ApiResponse<ExtractResult>	extractWithHttpInfo(ExtractRequest request)	Retrieve document metadata.
ApiClient	getApiClient()	Gets ApiClient
RemoveResult	remove(RemoveRequest request)	Remove metadata from document using search criteria.
com.squareup.okhttp.Call	removeAsync(RemoveRequest request, ApiCallback<RemoveResult> callback)	Remove metadata from document using search criteria.
com.squareup.okhttp.Call	removeCall(RemoveRequest request, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for remove
ApiResponse<RemoveResult>	removeWithHttpInfo(RemoveRequest request)	Remove metadata from document using search criteria.
SetResult	set(SetRequest request)	Set existing metadata fields with new values.
void	setApiClient(ApiClient apiClient)	Sets ApiClient
com.squareup.okhttp.Call	setAsync(SetRequest request, ApiCallback<SetResult> callback)	Set existing metadata fields with new values.
com.squareup.okhttp.Call	setCall(SetRequest request, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for set
ApiResponse<SetResult>	setWithHttpInfo(SetRequest request)	Set existing metadata fields with new values.

Methods inherited from class java.lang.Object

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

Constructor Detail

MetadataApi

public MetadataApi(String appSid,
                   String appKey)

Initializes new instance of MetadataApi

Parameters:

appSid - Application identifier (App SID)

appKey - Application private key (App Key)

MetadataApi

public MetadataApi(Configuration configuration)

Initializes new instance of MetadataApi

Parameters:

configuration - Configuration The configuration

Method Detail

getApiClient

public ApiClient getApiClient()

Gets ApiClient

Returns:

ApiClient The Api client

setApiClient

public void setApiClient(ApiClient apiClient)

Sets ApiClient

Parameters:

apiClient - The Api client

addCall

public com.squareup.okhttp.Call addCall(AddRequest request,
                                        ProgressResponseBody.ProgressListener progressListener,
                                        ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                 throws ApiException

Build call for add

Parameters:

request - The request model

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

add

public AddResult add(AddRequest request)
              throws ApiException

Add new metadata fields to a file.

Parameters:

request - The request model

Returns:

AddResult

Throws:

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

addWithHttpInfo

public ApiResponse<AddResult> addWithHttpInfo(AddRequest request)
                                       throws ApiException

Add new metadata fields to a file.

Parameters:

request - The request model

Returns:

ApiResponse<AddResult>

Throws:

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

addAsync

public com.squareup.okhttp.Call addAsync(AddRequest request,
                                         ApiCallback<AddResult> callback)
                                  throws ApiException

Add new metadata fields to a file. (asynchronously)

Parameters:

request - The request model

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

extractCall

public com.squareup.okhttp.Call extractCall(ExtractRequest request,
                                            ProgressResponseBody.ProgressListener progressListener,
                                            ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                     throws ApiException

Build call for extract

Parameters:

request - The request model

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

extract

public ExtractResult extract(ExtractRequest request)
                      throws ApiException

Retrieve document metadata.

Parameters:

request - The request model

Returns:

ExtractResult

Throws:

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

extractWithHttpInfo

public ApiResponse<ExtractResult> extractWithHttpInfo(ExtractRequest request)
                                               throws ApiException

Retrieve document metadata.

Parameters:

request - The request model

Returns:

ApiResponse<ExtractResult>

Throws:

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

extractAsync

public com.squareup.okhttp.Call extractAsync(ExtractRequest request,
                                             ApiCallback<ExtractResult> callback)
                                      throws ApiException

Retrieve document metadata. (asynchronously)

Parameters:

request - The request model

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

removeCall

public com.squareup.okhttp.Call removeCall(RemoveRequest request,
                                           ProgressResponseBody.ProgressListener progressListener,
                                           ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                    throws ApiException

Build call for remove

Parameters:

request - The request model

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

remove

public RemoveResult remove(RemoveRequest request)
                    throws ApiException

Remove metadata from document using search criteria.

Parameters:

request - The request model

Returns:

RemoveResult

Throws:

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

removeWithHttpInfo

public ApiResponse<RemoveResult> removeWithHttpInfo(RemoveRequest request)
                                             throws ApiException

Remove metadata from document using search criteria.

Parameters:

request - The request model

Returns:

ApiResponse<RemoveResult>

Throws:

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

removeAsync

public com.squareup.okhttp.Call removeAsync(RemoveRequest request,
                                            ApiCallback<RemoveResult> callback)
                                     throws ApiException

Remove metadata from document using search criteria. (asynchronously)

Parameters:

request - The request model

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

setCall

public com.squareup.okhttp.Call setCall(SetRequest request,
                                        ProgressResponseBody.ProgressListener progressListener,
                                        ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                 throws ApiException

Build call for set

Parameters:

request - The request model

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

set

public SetResult set(SetRequest request)
              throws ApiException

Set existing metadata fields with new values.

Parameters:

request - The request model

Returns:

SetResult

Throws:

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

setWithHttpInfo

public ApiResponse<SetResult> setWithHttpInfo(SetRequest request)
                                       throws ApiException

Set existing metadata fields with new values.

Parameters:

request - The request model

Returns:

ApiResponse<SetResult>

Throws:

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

setAsync

public com.squareup.okhttp.Call setAsync(SetRequest request,
                                         ApiCallback<SetResult> callback)
                                  throws ApiException

Set existing metadata fields with new values. (asynchronously)

Parameters:

request - The request model

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