io.nem.sdk.openapi.okhttp_gson.api

Class MetadataRoutesApi

java.lang.Object

io.nem.sdk.openapi.okhttp_gson.api.MetadataRoutesApi

public class MetadataRoutesApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
MetadataRoutesApi()
MetadataRoutesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
MetadataEntriesDTO	getAccountMetadata(java.lang.String accountId, java.lang.Integer pageSize, java.lang.String id, java.lang.String ordering) Get account metadata Returns the account metadata given an account id.
okhttp3.Call	getAccountMetadataAsync(java.lang.String accountId, java.lang.Integer pageSize, java.lang.String id, java.lang.String ordering, ApiCallback<MetadataEntriesDTO> _callback) Get account metadata (asynchronously) Returns the account metadata given an account id.
MetadataEntriesDTO	getAccountMetadataByKey(java.lang.String accountId, java.lang.String key) Get account metadata Returns the account metadata given an account id and a key.
MetadataDTO	getAccountMetadataByKeyAndSender(java.lang.String accountId, java.lang.String key, java.lang.String publicKey) Get account metadata Returns the account metadata given an account id, a key, and a sender.
okhttp3.Call	getAccountMetadataByKeyAndSenderAsync(java.lang.String accountId, java.lang.String key, java.lang.String publicKey, ApiCallback<MetadataDTO> _callback) Get account metadata (asynchronously) Returns the account metadata given an account id, a key, and a sender.
okhttp3.Call	getAccountMetadataByKeyAndSenderCall(java.lang.String accountId, java.lang.String key, java.lang.String publicKey, ApiCallback _callback) Build call for getAccountMetadataByKeyAndSender
ApiResponse<MetadataDTO>	getAccountMetadataByKeyAndSenderWithHttpInfo(java.lang.String accountId, java.lang.String key, java.lang.String publicKey) Get account metadata Returns the account metadata given an account id, a key, and a sender.
okhttp3.Call	getAccountMetadataByKeyAsync(java.lang.String accountId, java.lang.String key, ApiCallback<MetadataEntriesDTO> _callback) Get account metadata (asynchronously) Returns the account metadata given an account id and a key.
okhttp3.Call	getAccountMetadataByKeyCall(java.lang.String accountId, java.lang.String key, ApiCallback _callback) Build call for getAccountMetadataByKey
ApiResponse<MetadataEntriesDTO>	getAccountMetadataByKeyWithHttpInfo(java.lang.String accountId, java.lang.String key) Get account metadata Returns the account metadata given an account id and a key.
okhttp3.Call	getAccountMetadataCall(java.lang.String accountId, java.lang.Integer pageSize, java.lang.String id, java.lang.String ordering, ApiCallback _callback) Build call for getAccountMetadata
ApiResponse<MetadataEntriesDTO>	getAccountMetadataWithHttpInfo(java.lang.String accountId, java.lang.Integer pageSize, java.lang.String id, java.lang.String ordering) Get account metadata Returns the account metadata given an account id.
ApiClient	getApiClient()
MetadataEntriesDTO	getMosaicMetadata(java.lang.String mosaicId, java.lang.Integer pageSize, java.lang.String id, java.lang.String ordering) Get mosaic metadata Returns the mosaic metadata given a mosaic id.
okhttp3.Call	getMosaicMetadataAsync(java.lang.String mosaicId, java.lang.Integer pageSize, java.lang.String id, java.lang.String ordering, ApiCallback<MetadataEntriesDTO> _callback) Get mosaic metadata (asynchronously) Returns the mosaic metadata given a mosaic id.
MetadataEntriesDTO	getMosaicMetadataByKey(java.lang.String mosaicId, java.lang.String key) Get mosaic metadata Returns the mosaic metadata given a mosaic id and a key.
MetadataDTO	getMosaicMetadataByKeyAndSender(java.lang.String mosaicId, java.lang.String key, java.lang.String publicKey) Get mosaic metadata Returns the mosaic metadata given a mosaic id, a key, and a sender.
okhttp3.Call	getMosaicMetadataByKeyAndSenderAsync(java.lang.String mosaicId, java.lang.String key, java.lang.String publicKey, ApiCallback<MetadataDTO> _callback) Get mosaic metadata (asynchronously) Returns the mosaic metadata given a mosaic id, a key, and a sender.
okhttp3.Call	getMosaicMetadataByKeyAndSenderCall(java.lang.String mosaicId, java.lang.String key, java.lang.String publicKey, ApiCallback _callback) Build call for getMosaicMetadataByKeyAndSender
ApiResponse<MetadataDTO>	getMosaicMetadataByKeyAndSenderWithHttpInfo(java.lang.String mosaicId, java.lang.String key, java.lang.String publicKey) Get mosaic metadata Returns the mosaic metadata given a mosaic id, a key, and a sender.
okhttp3.Call	getMosaicMetadataByKeyAsync(java.lang.String mosaicId, java.lang.String key, ApiCallback<MetadataEntriesDTO> _callback) Get mosaic metadata (asynchronously) Returns the mosaic metadata given a mosaic id and a key.
okhttp3.Call	getMosaicMetadataByKeyCall(java.lang.String mosaicId, java.lang.String key, ApiCallback _callback) Build call for getMosaicMetadataByKey
ApiResponse<MetadataEntriesDTO>	getMosaicMetadataByKeyWithHttpInfo(java.lang.String mosaicId, java.lang.String key) Get mosaic metadata Returns the mosaic metadata given a mosaic id and a key.
okhttp3.Call	getMosaicMetadataCall(java.lang.String mosaicId, java.lang.Integer pageSize, java.lang.String id, java.lang.String ordering, ApiCallback _callback) Build call for getMosaicMetadata
ApiResponse<MetadataEntriesDTO>	getMosaicMetadataWithHttpInfo(java.lang.String mosaicId, java.lang.Integer pageSize, java.lang.String id, java.lang.String ordering) Get mosaic metadata Returns the mosaic metadata given a mosaic id.
MetadataEntriesDTO	getNamespaceMetadata(java.lang.String namespaceId, java.lang.Integer pageSize, java.lang.String id, java.lang.String ordering) Get namespace metadata Returns the namespace metadata given a namespace id.
okhttp3.Call	getNamespaceMetadataAsync(java.lang.String namespaceId, java.lang.Integer pageSize, java.lang.String id, java.lang.String ordering, ApiCallback<MetadataEntriesDTO> _callback) Get namespace metadata (asynchronously) Returns the namespace metadata given a namespace id.
MetadataEntriesDTO	getNamespaceMetadataByKey(java.lang.String namespaceId, java.lang.String key) Get namespace metadata Returns the namespace metadata given a namespace id and a key.
MetadataDTO	getNamespaceMetadataByKeyAndSender(java.lang.String namespaceId, java.lang.String key, java.lang.String publicKey) Get namespace metadata Returns the namespace metadata given a namespace id, a key, and a sender.
okhttp3.Call	getNamespaceMetadataByKeyAndSenderAsync(java.lang.String namespaceId, java.lang.String key, java.lang.String publicKey, ApiCallback<MetadataDTO> _callback) Get namespace metadata (asynchronously) Returns the namespace metadata given a namespace id, a key, and a sender.
okhttp3.Call	getNamespaceMetadataByKeyAndSenderCall(java.lang.String namespaceId, java.lang.String key, java.lang.String publicKey, ApiCallback _callback) Build call for getNamespaceMetadataByKeyAndSender
ApiResponse<MetadataDTO>	getNamespaceMetadataByKeyAndSenderWithHttpInfo(java.lang.String namespaceId, java.lang.String key, java.lang.String publicKey) Get namespace metadata Returns the namespace metadata given a namespace id, a key, and a sender.
okhttp3.Call	getNamespaceMetadataByKeyAsync(java.lang.String namespaceId, java.lang.String key, ApiCallback<MetadataEntriesDTO> _callback) Get namespace metadata (asynchronously) Returns the namespace metadata given a namespace id and a key.
okhttp3.Call	getNamespaceMetadataByKeyCall(java.lang.String namespaceId, java.lang.String key, ApiCallback _callback) Build call for getNamespaceMetadataByKey
ApiResponse<MetadataEntriesDTO>	getNamespaceMetadataByKeyWithHttpInfo(java.lang.String namespaceId, java.lang.String key) Get namespace metadata Returns the namespace metadata given a namespace id and a key.
okhttp3.Call	getNamespaceMetadataCall(java.lang.String namespaceId, java.lang.Integer pageSize, java.lang.String id, java.lang.String ordering, ApiCallback _callback) Build call for getNamespaceMetadata
ApiResponse<MetadataEntriesDTO>	getNamespaceMetadataWithHttpInfo(java.lang.String namespaceId, java.lang.Integer pageSize, java.lang.String id, java.lang.String ordering) Get namespace metadata Returns the namespace metadata given a namespace id.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

MetadataRoutesApi

public MetadataRoutesApi()

MetadataRoutesApi

public MetadataRoutesApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getAccountMetadataCall

public okhttp3.Call getAccountMetadataCall(java.lang.String accountId,
                                           java.lang.Integer pageSize,
                                           java.lang.String id,
                                           java.lang.String ordering,
                                           ApiCallback _callback)
                                    throws ApiException

Build call for getAccountMetadata

Parameters:

accountId - Account public key or address enconded using a 32-character set. (required)

pageSize - Number of transactions to return for each request. (optional, default to 10)

id - Metadata identifier up to which metadata are returned. (optional)

ordering - Ordering criteria: * -id - Descending order by id. * id - Ascending order by id. (optional, default to "-id")

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
200	success	-
404	ResourceNotFound	-
409	InvalidArgument	-

getAccountMetadata

public MetadataEntriesDTO getAccountMetadata(java.lang.String accountId,
                                             java.lang.Integer pageSize,
                                             java.lang.String id,
                                             java.lang.String ordering)
                                      throws ApiException

Get account metadata Returns the account metadata given an account id.

Parameters:

accountId - Account public key or address enconded using a 32-character set. (required)

pageSize - Number of transactions to return for each request. (optional, default to 10)

id - Metadata identifier up to which metadata are returned. (optional)

ordering - Ordering criteria: * -id - Descending order by id. * id - Ascending order by id. (optional, default to "-id")

Returns:

MetadataEntriesDTO

Throws:

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

Http Response Details

Status Code	Description	Response Headers
200	success	-
404	ResourceNotFound	-
409	InvalidArgument	-

getAccountMetadataWithHttpInfo

public ApiResponse<MetadataEntriesDTO> getAccountMetadataWithHttpInfo(java.lang.String accountId,
                                                                      java.lang.Integer pageSize,
                                                                      java.lang.String id,
                                                                      java.lang.String ordering)
                                                               throws ApiException

Get account metadata Returns the account metadata given an account id.

Parameters:

accountId - Account public key or address enconded using a 32-character set. (required)

pageSize - Number of transactions to return for each request. (optional, default to 10)

id - Metadata identifier up to which metadata are returned. (optional)

ordering - Ordering criteria: * -id - Descending order by id. * id - Ascending order by id. (optional, default to "-id")

Returns:

ApiResponse<MetadataEntriesDTO>

Throws:

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

Http Response Details

Status Code	Description	Response Headers
200	success	-
404	ResourceNotFound	-
409	InvalidArgument	-

getAccountMetadataAsync

public okhttp3.Call getAccountMetadataAsync(java.lang.String accountId,
                                            java.lang.Integer pageSize,
                                            java.lang.String id,
                                            java.lang.String ordering,
                                            ApiCallback<MetadataEntriesDTO> _callback)
                                     throws ApiException

Get account metadata (asynchronously) Returns the account metadata given an account id.

Parameters:

accountId - Account public key or address enconded using a 32-character set. (required)

pageSize - Number of transactions to return for each request. (optional, default to 10)

id - Metadata identifier up to which metadata are returned. (optional)

ordering - Ordering criteria: * -id - Descending order by id. * id - Ascending order by id. (optional, default to "-id")

_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

Http Response Details

Status Code	Description	Response Headers
200	success	-
404	ResourceNotFound	-
409	InvalidArgument	-

getAccountMetadataByKeyCall

public okhttp3.Call getAccountMetadataByKeyCall(java.lang.String accountId,
                                                java.lang.String key,
                                                ApiCallback _callback)
                                         throws ApiException

Build call for getAccountMetadataByKey

Parameters:

accountId - Account public key or address enconded using a 32-character set. (required)

key - Metadata key. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
200	success	-
404	ResourceNotFound	-
409	InvalidArgument	-

getAccountMetadataByKey

public MetadataEntriesDTO getAccountMetadataByKey(java.lang.String accountId,
                                                  java.lang.String key)
                                           throws ApiException

Get account metadata Returns the account metadata given an account id and a key.

Parameters:

accountId - Account public key or address enconded using a 32-character set. (required)

key - Metadata key. (required)

Returns:

MetadataEntriesDTO

Throws:

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

Http Response Details

Status Code	Description	Response Headers
200	success	-
404	ResourceNotFound	-
409	InvalidArgument	-

getAccountMetadataByKeyWithHttpInfo

public ApiResponse<MetadataEntriesDTO> getAccountMetadataByKeyWithHttpInfo(java.lang.String accountId,
                                                                           java.lang.String key)
                                                                    throws ApiException

Get account metadata Returns the account metadata given an account id and a key.

Parameters:

accountId - Account public key or address enconded using a 32-character set. (required)

key - Metadata key. (required)

Returns:

ApiResponse<MetadataEntriesDTO>

Throws:

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

Http Response Details

Status Code	Description	Response Headers
200	success	-
404	ResourceNotFound	-
409	InvalidArgument	-

getAccountMetadataByKeyAsync

public okhttp3.Call getAccountMetadataByKeyAsync(java.lang.String accountId,
                                                 java.lang.String key,
                                                 ApiCallback<MetadataEntriesDTO> _callback)
                                          throws ApiException

Get account metadata (asynchronously) Returns the account metadata given an account id and a key.

Parameters:

accountId - Account public key or address enconded using a 32-character set. (required)

key - Metadata key. (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

Http Response Details

Status Code	Description	Response Headers
200	success	-
404	ResourceNotFound	-
409	InvalidArgument	-

getAccountMetadataByKeyAndSenderCall

public okhttp3.Call getAccountMetadataByKeyAndSenderCall(java.lang.String accountId,
                                                         java.lang.String key,
                                                         java.lang.String publicKey,
                                                         ApiCallback _callback)
                                                  throws ApiException

Build call for getAccountMetadataByKeyAndSender

Parameters:

accountId - Account public key or address enconded using a 32-character set. (required)

key - Metadata key. (required)

publicKey - Account public key. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
200	success	-
404	ResourceNotFound	-
409	InvalidArgument	-

getAccountMetadataByKeyAndSender

public MetadataDTO getAccountMetadataByKeyAndSender(java.lang.String accountId,
                                                    java.lang.String key,
                                                    java.lang.String publicKey)
                                             throws ApiException

Get account metadata Returns the account metadata given an account id, a key, and a sender.

Parameters:

accountId - Account public key or address enconded using a 32-character set. (required)

key - Metadata key. (required)

publicKey - Account public key. (required)

Returns:

MetadataDTO

Throws:

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

Http Response Details

Status Code	Description	Response Headers
200	success	-
404	ResourceNotFound	-
409	InvalidArgument	-

getAccountMetadataByKeyAndSenderWithHttpInfo

public ApiResponse<MetadataDTO> getAccountMetadataByKeyAndSenderWithHttpInfo(java.lang.String accountId,
                                                                             java.lang.String key,
                                                                             java.lang.String publicKey)
                                                                      throws ApiException

Get account metadata Returns the account metadata given an account id, a key, and a sender.

Parameters:

accountId - Account public key or address enconded using a 32-character set. (required)

key - Metadata key. (required)

publicKey - Account public key. (required)

Returns:

ApiResponse<MetadataDTO>

Throws:

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

Http Response Details

Status Code	Description	Response Headers
200	success	-
404	ResourceNotFound	-
409	InvalidArgument	-

getAccountMetadataByKeyAndSenderAsync

public okhttp3.Call getAccountMetadataByKeyAndSenderAsync(java.lang.String accountId,
                                                          java.lang.String key,
                                                          java.lang.String publicKey,
                                                          ApiCallback<MetadataDTO> _callback)
                                                   throws ApiException

Get account metadata (asynchronously) Returns the account metadata given an account id, a key, and a sender.

Parameters:

accountId - Account public key or address enconded using a 32-character set. (required)

key - Metadata key. (required)

publicKey - Account public key. (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

Http Response Details

Status Code	Description	Response Headers
200	success	-
404	ResourceNotFound	-
409	InvalidArgument	-

getMosaicMetadataCall

public okhttp3.Call getMosaicMetadataCall(java.lang.String mosaicId,
                                          java.lang.Integer pageSize,
                                          java.lang.String id,
                                          java.lang.String ordering,
                                          ApiCallback _callback)
                                   throws ApiException

Build call for getMosaicMetadata

Parameters:

mosaicId - Mosaic identifier. (required)

pageSize - Number of transactions to return for each request. (optional, default to 10)

id - Metadata identifier up to which metadata are returned. (optional)

ordering - Ordering criteria: * -id - Descending order by id. * id - Ascending order by id. (optional, default to "-id")

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
200	success	-
404	ResourceNotFound	-
409	InvalidArgument	-

getMosaicMetadata

public MetadataEntriesDTO getMosaicMetadata(java.lang.String mosaicId,
                                            java.lang.Integer pageSize,
                                            java.lang.String id,
                                            java.lang.String ordering)
                                     throws ApiException

Get mosaic metadata Returns the mosaic metadata given a mosaic id.

Parameters:

mosaicId - Mosaic identifier. (required)

pageSize - Number of transactions to return for each request. (optional, default to 10)

id - Metadata identifier up to which metadata are returned. (optional)

ordering - Ordering criteria: * -id - Descending order by id. * id - Ascending order by id. (optional, default to "-id")

Returns:

MetadataEntriesDTO

Throws:

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

Http Response Details

Status Code	Description	Response Headers
200	success	-
404	ResourceNotFound	-
409	InvalidArgument	-

getMosaicMetadataWithHttpInfo

public ApiResponse<MetadataEntriesDTO> getMosaicMetadataWithHttpInfo(java.lang.String mosaicId,
                                                                     java.lang.Integer pageSize,
                                                                     java.lang.String id,
                                                                     java.lang.String ordering)
                                                              throws ApiException

Get mosaic metadata Returns the mosaic metadata given a mosaic id.

Parameters:

mosaicId - Mosaic identifier. (required)

pageSize - Number of transactions to return for each request. (optional, default to 10)

id - Metadata identifier up to which metadata are returned. (optional)

ordering - Ordering criteria: * -id - Descending order by id. * id - Ascending order by id. (optional, default to "-id")

Returns:

ApiResponse<MetadataEntriesDTO>

Throws:

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

Http Response Details

Status Code	Description	Response Headers
200	success	-
404	ResourceNotFound	-
409	InvalidArgument	-

getMosaicMetadataAsync

public okhttp3.Call getMosaicMetadataAsync(java.lang.String mosaicId,
                                           java.lang.Integer pageSize,
                                           java.lang.String id,
                                           java.lang.String ordering,
                                           ApiCallback<MetadataEntriesDTO> _callback)
                                    throws ApiException

Get mosaic metadata (asynchronously) Returns the mosaic metadata given a mosaic id.

Parameters:

mosaicId - Mosaic identifier. (required)

pageSize - Number of transactions to return for each request. (optional, default to 10)

id - Metadata identifier up to which metadata are returned. (optional)

ordering - Ordering criteria: * -id - Descending order by id. * id - Ascending order by id. (optional, default to "-id")

_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

Http Response Details

Status Code	Description	Response Headers
200	success	-
404	ResourceNotFound	-
409	InvalidArgument	-

getMosaicMetadataByKeyCall

public okhttp3.Call getMosaicMetadataByKeyCall(java.lang.String mosaicId,
                                               java.lang.String key,
                                               ApiCallback _callback)
                                        throws ApiException

Build call for getMosaicMetadataByKey

Parameters:

mosaicId - Mosaic identifier. (required)

key - Metadata key. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
200	success	-
404	ResourceNotFound	-
409	InvalidArgument	-

getMosaicMetadataByKey

public MetadataEntriesDTO getMosaicMetadataByKey(java.lang.String mosaicId,
                                                 java.lang.String key)
                                          throws ApiException

Get mosaic metadata Returns the mosaic metadata given a mosaic id and a key.

Parameters:

mosaicId - Mosaic identifier. (required)

key - Metadata key. (required)

Returns:

MetadataEntriesDTO

Throws:

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

Http Response Details

Status Code	Description	Response Headers
200	success	-
404	ResourceNotFound	-
409	InvalidArgument	-

getMosaicMetadataByKeyWithHttpInfo

public ApiResponse<MetadataEntriesDTO> getMosaicMetadataByKeyWithHttpInfo(java.lang.String mosaicId,
                                                                          java.lang.String key)
                                                                   throws ApiException

Get mosaic metadata Returns the mosaic metadata given a mosaic id and a key.

Parameters:

mosaicId - Mosaic identifier. (required)

key - Metadata key. (required)

Returns:

ApiResponse<MetadataEntriesDTO>

Throws:

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

Http Response Details

Status Code	Description	Response Headers
200	success	-
404	ResourceNotFound	-
409	InvalidArgument	-

getMosaicMetadataByKeyAsync

public okhttp3.Call getMosaicMetadataByKeyAsync(java.lang.String mosaicId,
                                                java.lang.String key,
                                                ApiCallback<MetadataEntriesDTO> _callback)
                                         throws ApiException

Get mosaic metadata (asynchronously) Returns the mosaic metadata given a mosaic id and a key.

Parameters:

mosaicId - Mosaic identifier. (required)

key - Metadata key. (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

Http Response Details

Status Code	Description	Response Headers
200	success	-
404	ResourceNotFound	-
409	InvalidArgument	-

getMosaicMetadataByKeyAndSenderCall

public okhttp3.Call getMosaicMetadataByKeyAndSenderCall(java.lang.String mosaicId,
                                                        java.lang.String key,
                                                        java.lang.String publicKey,
                                                        ApiCallback _callback)
                                                 throws ApiException

Build call for getMosaicMetadataByKeyAndSender

Parameters:

mosaicId - Mosaic identifier. (required)

key - Metadata key. (required)

publicKey - Account public key. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
200	success	-
404	ResourceNotFound	-
409	InvalidArgument	-

getMosaicMetadataByKeyAndSender

public MetadataDTO getMosaicMetadataByKeyAndSender(java.lang.String mosaicId,
                                                   java.lang.String key,
                                                   java.lang.String publicKey)
                                            throws ApiException

Get mosaic metadata Returns the mosaic metadata given a mosaic id, a key, and a sender.

Parameters:

mosaicId - Mosaic identifier. (required)

key - Metadata key. (required)

publicKey - Account public key. (required)

Returns:

MetadataDTO

Throws:

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

Http Response Details

Status Code	Description	Response Headers
200	success	-
404	ResourceNotFound	-
409	InvalidArgument	-

getMosaicMetadataByKeyAndSenderWithHttpInfo

public ApiResponse<MetadataDTO> getMosaicMetadataByKeyAndSenderWithHttpInfo(java.lang.String mosaicId,
                                                                            java.lang.String key,
                                                                            java.lang.String publicKey)
                                                                     throws ApiException

Get mosaic metadata Returns the mosaic metadata given a mosaic id, a key, and a sender.

Parameters:

mosaicId - Mosaic identifier. (required)

key - Metadata key. (required)

publicKey - Account public key. (required)

Returns:

ApiResponse<MetadataDTO>

Throws:

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

Http Response Details

Status Code	Description	Response Headers
200	success	-
404	ResourceNotFound	-
409	InvalidArgument	-

getMosaicMetadataByKeyAndSenderAsync

public okhttp3.Call getMosaicMetadataByKeyAndSenderAsync(java.lang.String mosaicId,
                                                         java.lang.String key,
                                                         java.lang.String publicKey,
                                                         ApiCallback<MetadataDTO> _callback)
                                                  throws ApiException

Get mosaic metadata (asynchronously) Returns the mosaic metadata given a mosaic id, a key, and a sender.

Parameters:

mosaicId - Mosaic identifier. (required)

key - Metadata key. (required)

publicKey - Account public key. (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

Http Response Details

Status Code	Description	Response Headers
200	success	-
404	ResourceNotFound	-
409	InvalidArgument	-

getNamespaceMetadataCall

public okhttp3.Call getNamespaceMetadataCall(java.lang.String namespaceId,
                                             java.lang.Integer pageSize,
                                             java.lang.String id,
                                             java.lang.String ordering,
                                             ApiCallback _callback)
                                      throws ApiException

Build call for getNamespaceMetadata

Parameters:

namespaceId - Namespace identifier. (required)

pageSize - Number of transactions to return for each request. (optional, default to 10)

id - Metadata identifier up to which metadata are returned. (optional)

ordering - Ordering criteria: * -id - Descending order by id. * id - Ascending order by id. (optional, default to "-id")

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
200	success	-
404	ResourceNotFound	-
409	InvalidArgument	-

getNamespaceMetadata

public MetadataEntriesDTO getNamespaceMetadata(java.lang.String namespaceId,
                                               java.lang.Integer pageSize,
                                               java.lang.String id,
                                               java.lang.String ordering)
                                        throws ApiException

Get namespace metadata Returns the namespace metadata given a namespace id.

Parameters:

namespaceId - Namespace identifier. (required)

pageSize - Number of transactions to return for each request. (optional, default to 10)

id - Metadata identifier up to which metadata are returned. (optional)

ordering - Ordering criteria: * -id - Descending order by id. * id - Ascending order by id. (optional, default to "-id")

Returns:

MetadataEntriesDTO

Throws:

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

Http Response Details

Status Code	Description	Response Headers
200	success	-
404	ResourceNotFound	-
409	InvalidArgument	-

getNamespaceMetadataWithHttpInfo

public ApiResponse<MetadataEntriesDTO> getNamespaceMetadataWithHttpInfo(java.lang.String namespaceId,
                                                                        java.lang.Integer pageSize,
                                                                        java.lang.String id,
                                                                        java.lang.String ordering)
                                                                 throws ApiException

Get namespace metadata Returns the namespace metadata given a namespace id.

Parameters:

namespaceId - Namespace identifier. (required)

pageSize - Number of transactions to return for each request. (optional, default to 10)

id - Metadata identifier up to which metadata are returned. (optional)

ordering - Ordering criteria: * -id - Descending order by id. * id - Ascending order by id. (optional, default to "-id")

Returns:

ApiResponse<MetadataEntriesDTO>

Throws:

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

Http Response Details

Status Code	Description	Response Headers
200	success	-
404	ResourceNotFound	-
409	InvalidArgument	-

getNamespaceMetadataAsync

public okhttp3.Call getNamespaceMetadataAsync(java.lang.String namespaceId,
                                              java.lang.Integer pageSize,
                                              java.lang.String id,
                                              java.lang.String ordering,
                                              ApiCallback<MetadataEntriesDTO> _callback)
                                       throws ApiException

Get namespace metadata (asynchronously) Returns the namespace metadata given a namespace id.

Parameters:

namespaceId - Namespace identifier. (required)

pageSize - Number of transactions to return for each request. (optional, default to 10)

id - Metadata identifier up to which metadata are returned. (optional)

ordering - Ordering criteria: * -id - Descending order by id. * id - Ascending order by id. (optional, default to "-id")

_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

Http Response Details

Status Code	Description	Response Headers
200	success	-
404	ResourceNotFound	-
409	InvalidArgument	-

getNamespaceMetadataByKeyCall

public okhttp3.Call getNamespaceMetadataByKeyCall(java.lang.String namespaceId,
                                                  java.lang.String key,
                                                  ApiCallback _callback)
                                           throws ApiException

Build call for getNamespaceMetadataByKey

Parameters:

namespaceId - Namespace identifier. (required)

key - Metadata key. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
200	success	-
404	ResourceNotFound	-
409	InvalidArgument	-

getNamespaceMetadataByKey

public MetadataEntriesDTO getNamespaceMetadataByKey(java.lang.String namespaceId,
                                                    java.lang.String key)
                                             throws ApiException

Get namespace metadata Returns the namespace metadata given a namespace id and a key.

Parameters:

namespaceId - Namespace identifier. (required)

key - Metadata key. (required)

Returns:

MetadataEntriesDTO

Throws:

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

Http Response Details

Status Code	Description	Response Headers
200	success	-
404	ResourceNotFound	-
409	InvalidArgument	-

getNamespaceMetadataByKeyWithHttpInfo

public ApiResponse<MetadataEntriesDTO> getNamespaceMetadataByKeyWithHttpInfo(java.lang.String namespaceId,
                                                                             java.lang.String key)
                                                                      throws ApiException

Get namespace metadata Returns the namespace metadata given a namespace id and a key.

Parameters:

namespaceId - Namespace identifier. (required)

key - Metadata key. (required)

Returns:

ApiResponse<MetadataEntriesDTO>

Throws:

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

Http Response Details

Status Code	Description	Response Headers
200	success	-
404	ResourceNotFound	-
409	InvalidArgument	-

getNamespaceMetadataByKeyAsync

public okhttp3.Call getNamespaceMetadataByKeyAsync(java.lang.String namespaceId,
                                                   java.lang.String key,
                                                   ApiCallback<MetadataEntriesDTO> _callback)
                                            throws ApiException

Get namespace metadata (asynchronously) Returns the namespace metadata given a namespace id and a key.

Parameters:

namespaceId - Namespace identifier. (required)

key - Metadata key. (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

Http Response Details

Status Code	Description	Response Headers
200	success	-
404	ResourceNotFound	-
409	InvalidArgument	-

getNamespaceMetadataByKeyAndSenderCall

public okhttp3.Call getNamespaceMetadataByKeyAndSenderCall(java.lang.String namespaceId,
                                                           java.lang.String key,
                                                           java.lang.String publicKey,
                                                           ApiCallback _callback)
                                                    throws ApiException

Build call for getNamespaceMetadataByKeyAndSender

Parameters:

namespaceId - Namespace identifier. (required)

key - Metadata key. (required)

publicKey - Account public key. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
200	success	-
404	ResourceNotFound	-
409	InvalidArgument	-

getNamespaceMetadataByKeyAndSender

public MetadataDTO getNamespaceMetadataByKeyAndSender(java.lang.String namespaceId,
                                                      java.lang.String key,
                                                      java.lang.String publicKey)
                                               throws ApiException

Get namespace metadata Returns the namespace metadata given a namespace id, a key, and a sender.

Parameters:

namespaceId - Namespace identifier. (required)

key - Metadata key. (required)

publicKey - Account public key. (required)

Returns:

MetadataDTO

Throws:

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

Http Response Details

Status Code	Description	Response Headers
200	success	-
404	ResourceNotFound	-
409	InvalidArgument	-

getNamespaceMetadataByKeyAndSenderWithHttpInfo

public ApiResponse<MetadataDTO> getNamespaceMetadataByKeyAndSenderWithHttpInfo(java.lang.String namespaceId,
                                                                               java.lang.String key,
                                                                               java.lang.String publicKey)
                                                                        throws ApiException

Get namespace metadata Returns the namespace metadata given a namespace id, a key, and a sender.

Parameters:

namespaceId - Namespace identifier. (required)

key - Metadata key. (required)

publicKey - Account public key. (required)

Returns:

ApiResponse<MetadataDTO>

Throws:

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

Http Response Details

Status Code	Description	Response Headers
200	success	-
404	ResourceNotFound	-
409	InvalidArgument	-

getNamespaceMetadataByKeyAndSenderAsync

public okhttp3.Call getNamespaceMetadataByKeyAndSenderAsync(java.lang.String namespaceId,
                                                            java.lang.String key,
                                                            java.lang.String publicKey,
                                                            ApiCallback<MetadataDTO> _callback)
                                                     throws ApiException

Get namespace metadata (asynchronously) Returns the namespace metadata given a namespace id, a key, and a sender.

Parameters:

namespaceId - Namespace identifier. (required)

key - Metadata key. (required)

publicKey - Account public key. (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

Http Response Details

Status Code	Description	Response Headers
200	success	-
404	ResourceNotFound	-
409	InvalidArgument	-