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="2021-01-14T22:22:10.865Z[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
ApiClient	getApiClient()
MetadataInfoDTO	getMetadata(java.lang.String compositeHash) Get metadata information Gets the metadata for a given composite hash.
MerkleStateInfoDTO	getMetadataMerkle(java.lang.String compositeHash) Get metadata merkle information Gets the metadata merkle for a given composite hash.
ApiResponse<MerkleStateInfoDTO>	getMetadataMerkleWithHttpInfo(java.lang.String compositeHash) Get metadata merkle information Gets the metadata merkle for a given composite hash.
ApiResponse<MetadataInfoDTO>	getMetadataWithHttpInfo(java.lang.String compositeHash) Get metadata information Gets the metadata for a given composite hash.
MetadataPage	searchMetadataEntries(java.lang.String sourceAddress, java.lang.String targetAddress, java.lang.String scopedMetadataKey, java.lang.String targetId, MetadataTypeEnum metadataType, java.lang.Integer pageSize, java.lang.Integer pageNumber, java.lang.String offset, Order order) Search metadata entries Returns an array of metadata.
ApiResponse<MetadataPage>	searchMetadataEntriesWithHttpInfo(java.lang.String sourceAddress, java.lang.String targetAddress, java.lang.String scopedMetadataKey, java.lang.String targetId, MetadataTypeEnum metadataType, java.lang.Integer pageSize, java.lang.Integer pageNumber, java.lang.String offset, Order order) Search metadata entries Returns an array of metadata.
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)

getMetadata

public MetadataInfoDTO getMetadata(java.lang.String compositeHash)
                            throws ApiException

Get metadata information Gets the metadata for a given composite hash.

Parameters:

compositeHash - Filter by composite hash. (required)

Returns:

MetadataInfoDTO

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-
409	InvalidArgument	-

getMetadataWithHttpInfo

public ApiResponse<MetadataInfoDTO> getMetadataWithHttpInfo(java.lang.String compositeHash)
                                                     throws ApiException

Get metadata information Gets the metadata for a given composite hash.

Parameters:

compositeHash - Filter by composite hash. (required)

Returns:

ApiResponse<MetadataInfoDTO>

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-
409	InvalidArgument	-

getMetadataMerkle

public MerkleStateInfoDTO getMetadataMerkle(java.lang.String compositeHash)
                                     throws ApiException

Get metadata merkle information Gets the metadata merkle for a given composite hash.

Parameters:

compositeHash - Filter by composite hash. (required)

Returns:

MerkleStateInfoDTO

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-
409	InvalidArgument	-

getMetadataMerkleWithHttpInfo

public ApiResponse<MerkleStateInfoDTO> getMetadataMerkleWithHttpInfo(java.lang.String compositeHash)
                                                              throws ApiException

Get metadata merkle information Gets the metadata merkle for a given composite hash.

Parameters:

compositeHash - Filter by composite hash. (required)

Returns:

ApiResponse<MerkleStateInfoDTO>

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-
409	InvalidArgument	-

searchMetadataEntries

public MetadataPage searchMetadataEntries(java.lang.String sourceAddress,
                                          java.lang.String targetAddress,
                                          java.lang.String scopedMetadataKey,
                                          java.lang.String targetId,
                                          MetadataTypeEnum metadataType,
                                          java.lang.Integer pageSize,
                                          java.lang.Integer pageNumber,
                                          java.lang.String offset,
                                          Order order)
                                   throws ApiException

Search metadata entries Returns an array of metadata.

Parameters:

sourceAddress - Filter by address sending the metadata entry. (optional)

targetAddress - Filter by target address. (optional)

scopedMetadataKey - Filter by metadata key. (optional)

targetId - Filter by namespace or mosaic id. (optional)

metadataType - Filter by metadata type. (optional)

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

pageNumber - Filter by page number. (optional, default to 1)

offset - 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:

MetadataPage

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-
409	InvalidArgument	-

searchMetadataEntriesWithHttpInfo

public ApiResponse<MetadataPage> searchMetadataEntriesWithHttpInfo(java.lang.String sourceAddress,
                                                                   java.lang.String targetAddress,
                                                                   java.lang.String scopedMetadataKey,
                                                                   java.lang.String targetId,
                                                                   MetadataTypeEnum metadataType,
                                                                   java.lang.Integer pageSize,
                                                                   java.lang.Integer pageNumber,
                                                                   java.lang.String offset,
                                                                   Order order)
                                                            throws ApiException

Search metadata entries Returns an array of metadata.

Parameters:

sourceAddress - Filter by address sending the metadata entry. (optional)

targetAddress - Filter by target address. (optional)

scopedMetadataKey - Filter by metadata key. (optional)

targetId - Filter by namespace or mosaic id. (optional)

metadataType - Filter by metadata type. (optional)

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

pageNumber - Filter by page number. (optional, default to 1)

offset - 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<MetadataPage>

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-
409	InvalidArgument	-