io.nem.sdk.openapi.okhttp_gson.api

Class NodeRoutesApi

java.lang.Object

io.nem.sdk.openapi.okhttp_gson.api.NodeRoutesApi

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.
okhttp3.Call	getNodeHealthAsync(ApiCallback<NodeHealthInfoDTO> _callback) Get the node health information (asynchronously) Supplies information regarding the connection and services status.
okhttp3.Call	getNodeHealthCall(ApiCallback _callback) Build call for getNodeHealth
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.
okhttp3.Call	getNodeInfoAsync(ApiCallback<NodeInfoDTO> _callback) Get the node information (asynchronously) Supplies additional information about the application running on a node.
okhttp3.Call	getNodeInfoCall(ApiCallback _callback) Build call for getNodeInfo
ApiResponse<NodeInfoDTO>	getNodeInfoWithHttpInfo() Get the node information Supplies additional information about the application running on a node.
StorageInfoDTO	getNodeStorage() Get the storage information of the node Returns storage information about the node.
okhttp3.Call	getNodeStorageAsync(ApiCallback<StorageInfoDTO> _callback) Get the storage information of the node (asynchronously) Returns storage information about the node.
okhttp3.Call	getNodeStorageCall(ApiCallback _callback) Build call for getNodeStorage
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.
okhttp3.Call	getNodeTimeAsync(ApiCallback<NodeTimeDTO> _callback) Get the node time (asynchronously) Gets the node time at the moment the reply was sent and received.
okhttp3.Call	getNodeTimeCall(ApiCallback _callback) Build call for getNodeTime
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.
okhttp3.Call	getServerInfoAsync(ApiCallback<ServerInfoDTO> _callback) Get the version of the running REST component (asynchronously) Returns the version of the running catapult-rest component.
okhttp3.Call	getServerInfoCall(ApiCallback _callback) Build call for getServerInfo
ApiResponse<ServerInfoDTO>	getServerInfoWithHttpInfo() Get the version of the running REST component Returns the version of the running catapult-rest component.
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)

getNodeHealthCall

public okhttp3.Call getNodeHealthCall(ApiCallback _callback)
                               throws ApiException

Build call for getNodeHealth

Parameters:

_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	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.	-

getNodeHealth

public NodeHealthInfoDTO getNodeHealth()
                                throws ApiException

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

Returns:

NodeHealthInfoDTO

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	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 fail to call the API, e.g. server error or cannot deserialize the response body

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.	-

getNodeHealthAsync

public okhttp3.Call getNodeHealthAsync(ApiCallback<NodeHealthInfoDTO> _callback)
                                throws ApiException

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

Parameters:

_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	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.	-

getNodeInfoCall

public okhttp3.Call getNodeInfoCall(ApiCallback _callback)
                             throws ApiException

Build call for getNodeInfo

Parameters:

_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	-

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

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

getNodeInfoAsync

public okhttp3.Call getNodeInfoAsync(ApiCallback<NodeInfoDTO> _callback)
                              throws ApiException

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

Parameters:

_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	-

getNodeStorageCall

public okhttp3.Call getNodeStorageCall(ApiCallback _callback)
                                throws ApiException

Build call for getNodeStorage

Parameters:

_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	-

getNodeStorage

public StorageInfoDTO getNodeStorage()
                              throws ApiException

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

Returns:

StorageInfoDTO

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	-

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

getNodeStorageAsync

public okhttp3.Call getNodeStorageAsync(ApiCallback<StorageInfoDTO> _callback)
                                 throws ApiException

Get the storage information of the node (asynchronously) Returns storage information about the node.

Parameters:

_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	-

getNodeTimeCall

public okhttp3.Call getNodeTimeCall(ApiCallback _callback)
                             throws ApiException

Build call for getNodeTime

Parameters:

_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	-

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

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

getNodeTimeAsync

public okhttp3.Call getNodeTimeAsync(ApiCallback<NodeTimeDTO> _callback)
                              throws ApiException

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

Parameters:

_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	-

getServerInfoCall

public okhttp3.Call getServerInfoCall(ApiCallback _callback)
                               throws ApiException

Build call for getServerInfo

Parameters:

_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	-

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

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

getServerInfoAsync

public okhttp3.Call getServerInfoAsync(ApiCallback<ServerInfoDTO> _callback)
                                throws ApiException

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

Parameters:

_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	-