org.iota.jota.dto.response

Class GetNodeAPIConfigurationResponse

java.lang.Object

org.iota.jota.dto.response.AbstractResponse

org.iota.jota.dto.response.GetNodeAPIConfigurationResponse

public class GetNodeAPIConfigurationResponse
extends AbstractResponse

Contains information about the result of a successful com.iota.iri.service.API#getNodeAPIConfigurationStatement() API call. Response of api request 'GetNodeAPIConfiguration'.

Constructor Summary

Constructors

Constructor and Description
GetNodeAPIConfigurationResponse()

Method Summary

Modifier and Type	Method and Description
static AbstractResponse	create(int maxFindTransactions, int maxRequestsList, int maxGetTrytes, int maxBodyLength, boolean testNet, int milestoneStartIndex) Initializes a new instance of the GetBundleResponse class.
int	getMaxBodyLength() The maximal number of characters the body of an API call may hold.
int	getMaxFindTransactions() The maximal number of transactions that may be returned by the "findTransactions" API call.
int	getMaxGetTrytes() The maximal number of trytes that may be returned by the "getTrytes" API call.
int	getMaxRequestsList() The maximal number of parameters one can place in an API call.
int	getMilestoneStartIndex() The start index of the milestones.
boolean	isTestNet() If this node has started in testnet mode.

Methods inherited from class org.iota.jota.dto.response.AbstractResponse

equals, getDuration, hashCode, setDuration, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetNodeAPIConfigurationResponse

public GetNodeAPIConfigurationResponse()

Method Detail

create

public static AbstractResponse create(int maxFindTransactions,
                                      int maxRequestsList,
                                      int maxGetTrytes,
                                      int maxBodyLength,
                                      boolean testNet,
                                      int milestoneStartIndex)

Initializes a new instance of the GetBundleResponse class.

getMaxFindTransactions

public int getMaxFindTransactions()

The maximal number of transactions that may be returned by the "findTransactions" API call. If the number of transactions found exceeds this number an error will be returned.

Returns:

The maximum number of transactions returned

getMaxRequestsList

public int getMaxRequestsList()

The maximal number of parameters one can place in an API call. If the number parameters exceeds this number an error will be returned.

Returns:

The maximum number of request parameters

getMaxGetTrytes

public int getMaxGetTrytes()

The maximal number of trytes that may be returned by the "getTrytes" API call. If the number of transactions found exceeds this number an error will be returned.

Returns:

The maximum number of trytes returned

getMaxBodyLength

public int getMaxBodyLength()

The maximal number of characters the body of an API call may hold. If a request body length exceeds this number an error will be returned.

Returns:

The maximum length of the request body

isTestNet

public boolean isTestNet()

If this node has started in testnet mode.

Returns:

true if it is, otherwise false

getMilestoneStartIndex

public int getMilestoneStartIndex()

The start index of the milestones. This index is encoded in each milestone transaction by the coordinator. Usually the last global snapshot, with local snapshots it is the last/oldest local snapshot milestone

Returns:

The starting milestone index