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

Class NodeRoutesApi

java.lang.Object

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

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2021-01-14T22:22:10.865Z[UTC]")
public class NodeRoutesApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
NodeRoutesApi()
NodeRoutesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
NodeHealthInfoDTO	getNodeHealth() Get the node health information Supplies information regarding the connection and services status.
ApiResponse<NodeHealthInfoDTO>	getNodeHealthWithHttpInfo() Get the node health information Supplies information regarding the connection and services status.
NodeInfoDTO	getNodeInfo() Get the node information Supplies additional information about the application running on a node.
ApiResponse<NodeInfoDTO>	getNodeInfoWithHttpInfo() Get the node information Supplies additional information about the application running on a node.
java.util.List<NodeInfoDTO>	getNodePeers() Get peers information Gets the list of peers visible by the node.
ApiResponse<java.util.List<NodeInfoDTO>>	getNodePeersWithHttpInfo() Get peers information Gets the list of peers visible by the node.
StorageInfoDTO	getNodeStorage() Get the storage information of the node Returns storage information about the node.
ApiResponse<StorageInfoDTO>	getNodeStorageWithHttpInfo() Get the storage information of the node Returns storage information about the node.
NodeTimeDTO	getNodeTime() Get the node time Gets the node time at the moment the reply was sent and received.
ApiResponse<NodeTimeDTO>	getNodeTimeWithHttpInfo() Get the node time Gets the node time at the moment the reply was sent and received.
ServerInfoDTO	getServerInfo() Get the version of the running REST component Returns the version of the running catapult-rest component.
ApiResponse<ServerInfoDTO>	getServerInfoWithHttpInfo() Get the version of the running REST component Returns the version of the running catapult-rest component.
UnlockedAccountDTO	getUnlockedAccount() Get the unlocked harvesting account public keys.
ApiResponse<UnlockedAccountDTO>	getUnlockedAccountWithHttpInfo() Get the unlocked harvesting account public keys.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

NodeRoutesApi

public NodeRoutesApi()

NodeRoutesApi

public NodeRoutesApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getNodeHealth

public NodeHealthInfoDTO getNodeHealth()
                                throws ApiException

Get the node health information Supplies information regarding the connection and services status.

Returns:

NodeHealthInfoDTO

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	Both API node and database services are reachable from REST server.	-
503	Either API node or database service is unavailable or unreachable from REST server.	-

getNodeHealthWithHttpInfo

public ApiResponse<NodeHealthInfoDTO> getNodeHealthWithHttpInfo()
                                                         throws ApiException

Get the node health information Supplies information regarding the connection and services status.

Returns:

ApiResponse<NodeHealthInfoDTO>

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	Both API node and database services are reachable from REST server.	-
503	Either API node or database service is unavailable or unreachable from REST server.	-

getNodeInfo

public NodeInfoDTO getNodeInfo()
                        throws ApiException

Get the node information Supplies additional information about the application running on a node.

Returns:

NodeInfoDTO

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-

getNodeInfoWithHttpInfo

public ApiResponse<NodeInfoDTO> getNodeInfoWithHttpInfo()
                                                 throws ApiException

Get the node information Supplies additional information about the application running on a node.

Returns:

ApiResponse<NodeInfoDTO>

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-

getNodePeers

public java.util.List<NodeInfoDTO> getNodePeers()
                                         throws ApiException

Get peers information Gets the list of peers visible by the node.

Returns:

List<NodeInfoDTO>

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-

getNodePeersWithHttpInfo

public ApiResponse<java.util.List<NodeInfoDTO>> getNodePeersWithHttpInfo()
                                                                  throws ApiException

Get peers information Gets the list of peers visible by the node.

Returns:

ApiResponse<List<NodeInfoDTO>>

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-

getNodeStorage

public StorageInfoDTO getNodeStorage()
                              throws ApiException

Get the storage information of the node Returns storage information about the node.

Returns:

StorageInfoDTO

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-

getNodeStorageWithHttpInfo

public ApiResponse<StorageInfoDTO> getNodeStorageWithHttpInfo()
                                                       throws ApiException

Get the storage information of the node Returns storage information about the node.

Returns:

ApiResponse<StorageInfoDTO>

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-

getNodeTime

public NodeTimeDTO getNodeTime()
                        throws ApiException

Get the node time Gets the node time at the moment the reply was sent and received.

Returns:

NodeTimeDTO

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-

getNodeTimeWithHttpInfo

public ApiResponse<NodeTimeDTO> getNodeTimeWithHttpInfo()
                                                 throws ApiException

Get the node time Gets the node time at the moment the reply was sent and received.

Returns:

ApiResponse<NodeTimeDTO>

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-

getServerInfo

public ServerInfoDTO getServerInfo()
                            throws ApiException

Get the version of the running REST component Returns the version of the running catapult-rest component.

Returns:

ServerInfoDTO

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-

getServerInfoWithHttpInfo

public ApiResponse<ServerInfoDTO> getServerInfoWithHttpInfo()
                                                     throws ApiException

Get the version of the running REST component Returns the version of the running catapult-rest component.

Returns:

ApiResponse<ServerInfoDTO>

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-

getUnlockedAccount

public UnlockedAccountDTO getUnlockedAccount()
                                      throws ApiException

Get the unlocked harvesting account public keys. Returns array of unlocked account public keys.

Returns:

UnlockedAccountDTO

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-

getUnlockedAccountWithHttpInfo

public ApiResponse<UnlockedAccountDTO> getUnlockedAccountWithHttpInfo()
                                                               throws ApiException

Get the unlocked harvesting account public keys. Returns array of unlocked account public keys.

Returns:

ApiResponse<UnlockedAccountDTO>

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	success	-