io.nem.symbol.sdk.openapi.jersey2.api

Class MetadataRoutesApi

java.lang.Object

io.nem.symbol.sdk.openapi.jersey2.api.MetadataRoutesApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2020-06-26T18:32:22.702Z[UTC]")
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 address, java.lang.Integer pageSize, Order order, java.lang.String id) Get account metadata Returns the account metadata given an account id.
MetadataEntriesDTO	getAccountMetadataByKey(java.lang.String address, java.lang.String key) Get account metadata Returns the account metadata given an account id and a key.
MetadataDTO	getAccountMetadataByKeyAndSender(java.lang.String address, java.lang.String key, java.lang.String sourceAddress) Get account metadata Returns the account metadata given an account id, a key, and a sender.
ApiResponse<MetadataDTO>	getAccountMetadataByKeyAndSenderWithHttpInfo(java.lang.String address, java.lang.String key, java.lang.String sourceAddress) Get account metadata Returns the account metadata given an account id, a key, and a sender.
ApiResponse<MetadataEntriesDTO>	getAccountMetadataByKeyWithHttpInfo(java.lang.String address, java.lang.String key) Get account metadata Returns the account metadata given an account id and a key.
ApiResponse<MetadataEntriesDTO>	getAccountMetadataWithHttpInfo(java.lang.String address, java.lang.Integer pageSize, Order order, java.lang.String id) 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, Order order) Get mosaic metadata 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 sourceAddress) Get mosaic metadata Returns the mosaic metadata given a mosaic id, a key, and a sender.
ApiResponse<MetadataDTO>	getMosaicMetadataByKeyAndSenderWithHttpInfo(java.lang.String mosaicId, java.lang.String key, java.lang.String sourceAddress) Get mosaic metadata Returns the mosaic metadata given a mosaic id, a key, and a sender.
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.
ApiResponse<MetadataEntriesDTO>	getMosaicMetadataWithHttpInfo(java.lang.String mosaicId, java.lang.Integer pageSize, java.lang.String id, Order order) 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, Order order) Get namespace metadata 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 sourceAddress) Get namespace metadata Returns the namespace metadata given a namespace id, a key, and a sender.
ApiResponse<MetadataDTO>	getNamespaceMetadataByKeyAndSenderWithHttpInfo(java.lang.String namespaceId, java.lang.String key, java.lang.String sourceAddress) Get namespace metadata Returns the namespace metadata given a namespace id, a key, and a sender.
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.
ApiResponse<MetadataEntriesDTO>	getNamespaceMetadataWithHttpInfo(java.lang.String namespaceId, java.lang.Integer pageSize, java.lang.String id, Order order) 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)

getAccountMetadata

public MetadataEntriesDTO getAccountMetadata(java.lang.String address,
                                             java.lang.Integer pageSize,
                                             Order order,
                                             java.lang.String id)
                                      throws ApiException

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

Parameters:

address - Account address. (required)

pageSize - Select the number of entries to return. (optional, default to 10)

order - Sort responses in ascending or descending order based on the collection property set on the param ``orderBy``. If the request does not specify ``orderBy``, REST returns the collection ordered by id. (optional, default to desc)

id - Entry id at which to start pagination. If the ordering parameter is set to -id, the elements returned precede the identifier. Otherwise, newer elements with respect to the id are returned. (optional)

Returns:

MetadataEntriesDTO

Throws:

ApiException - if fails to make API call

Http Response Details

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

getAccountMetadataWithHttpInfo

public ApiResponse<MetadataEntriesDTO> getAccountMetadataWithHttpInfo(java.lang.String address,
                                                                      java.lang.Integer pageSize,
                                                                      Order order,
                                                                      java.lang.String id)
                                                               throws ApiException

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

Parameters:

address - Account address. (required)

pageSize - Select the number of entries to return. (optional, default to 10)

order - Sort responses in ascending or descending order based on the collection property set on the param ``orderBy``. If the request does not specify ``orderBy``, REST returns the collection ordered by id. (optional, default to desc)

id - Entry id at which to start pagination. If the ordering parameter is set to -id, the elements returned precede the identifier. Otherwise, newer elements with respect to the id are returned. (optional)

Returns:

ApiResponse<MetadataEntriesDTO>

Throws:

ApiException - if fails to make API call

Http Response Details

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

getAccountMetadataByKey

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

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

Parameters:

address - Account address. (required)

key - Metadata key. (required)

Returns:

MetadataEntriesDTO

Throws:

ApiException - if fails to make API call

Http Response Details

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

getAccountMetadataByKeyWithHttpInfo

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

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

Parameters:

address - Account address. (required)

key - Metadata key. (required)

Returns:

ApiResponse<MetadataEntriesDTO>

Throws:

ApiException - if fails to make API call

Http Response Details

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

getAccountMetadataByKeyAndSender

public MetadataDTO getAccountMetadataByKeyAndSender(java.lang.String address,
                                                    java.lang.String key,
                                                    java.lang.String sourceAddress)
                                             throws ApiException

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

Parameters:

address - Account address. (required)

key - Metadata key. (required)

sourceAddress - Account address. (required)

Returns:

MetadataDTO

Throws:

ApiException - if fails to make API call

Http Response Details

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

getAccountMetadataByKeyAndSenderWithHttpInfo

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

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

Parameters:

address - Account address. (required)

key - Metadata key. (required)

sourceAddress - Account address. (required)

Returns:

ApiResponse<MetadataDTO>

Throws:

ApiException - if fails to make API call

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,
                                            Order order)
                                     throws ApiException

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

Parameters:

mosaicId - Mosaic identifier. (required)

pageSize - Select the number of entries to return. (optional, default to 10)

id - Entry id at which to start pagination. If the ordering parameter is set to -id, the elements returned precede the identifier. Otherwise, newer elements with respect to the id are returned. (optional)

order - Sort responses in ascending or descending order based on the collection property set on the param ``orderBy``. If the request does not specify ``orderBy``, REST returns the collection ordered by id. (optional, default to desc)

Returns:

MetadataEntriesDTO

Throws:

ApiException - if fails to make API call

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,
                                                                     Order order)
                                                              throws ApiException

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

Parameters:

mosaicId - Mosaic identifier. (required)

pageSize - Select the number of entries to return. (optional, default to 10)

id - Entry id at which to start pagination. If the ordering parameter is set to -id, the elements returned precede the identifier. Otherwise, newer elements with respect to the id are returned. (optional)

order - Sort responses in ascending or descending order based on the collection property set on the param ``orderBy``. If the request does not specify ``orderBy``, REST returns the collection ordered by id. (optional, default to desc)

Returns:

ApiResponse<MetadataEntriesDTO>

Throws:

ApiException - if fails to make API call

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 fails to make API call

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 fails to make API call

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 sourceAddress)
                                            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)

sourceAddress - Account address. (required)

Returns:

MetadataDTO

Throws:

ApiException - if fails to make API call

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 sourceAddress)
                                                                     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)

sourceAddress - Account address. (required)

Returns:

ApiResponse<MetadataDTO>

Throws:

ApiException - if fails to make API call

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,
                                               Order order)
                                        throws ApiException

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

Parameters:

namespaceId - Namespace identifier. (required)

pageSize - Select the number of entries to return. (optional, default to 10)

id - Entry id at which to start pagination. If the ordering parameter is set to -id, the elements returned precede the identifier. Otherwise, newer elements with respect to the id are returned. (optional)

order - Sort responses in ascending or descending order based on the collection property set on the param ``orderBy``. If the request does not specify ``orderBy``, REST returns the collection ordered by id. (optional, default to desc)

Returns:

MetadataEntriesDTO

Throws:

ApiException - if fails to make API call

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,
                                                                        Order order)
                                                                 throws ApiException

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

Parameters:

namespaceId - Namespace identifier. (required)

pageSize - Select the number of entries to return. (optional, default to 10)

id - Entry id at which to start pagination. If the ordering parameter is set to -id, the elements returned precede the identifier. Otherwise, newer elements with respect to the id are returned. (optional)

order - Sort responses in ascending or descending order based on the collection property set on the param ``orderBy``. If the request does not specify ``orderBy``, REST returns the collection ordered by id. (optional, default to desc)

Returns:

ApiResponse<MetadataEntriesDTO>

Throws:

ApiException - if fails to make API call

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 fails to make API call

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 fails to make API call

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 sourceAddress)
                                               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)

sourceAddress - Account address. (required)

Returns:

MetadataDTO

Throws:

ApiException - if fails to make API call

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 sourceAddress)
                                                                        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)

sourceAddress - Account address. (required)

Returns:

ApiResponse<MetadataDTO>

Throws:

ApiException - if fails to make API call

Http Response Details

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