Module com.hedera.hashgraph.sdk
Package com.hedera.hashgraph.sdk.proto
Class StakingNodeInfo.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder<StakingNodeInfo,StakingNodeInfo.Builder>
com.google.protobuf.GeneratedMessageLite.Builder<StakingNodeInfo,StakingNodeInfo.Builder>
com.hedera.hashgraph.sdk.proto.StakingNodeInfo.Builder
- All Implemented Interfaces:
com.google.protobuf.MessageLite.Builder,com.google.protobuf.MessageLiteOrBuilder,StakingNodeInfoOrBuilder,Cloneable
- Enclosing class:
StakingNodeInfo
public static final class StakingNodeInfo.Builder
extends com.google.protobuf.GeneratedMessageLite.Builder<StakingNodeInfo,StakingNodeInfo.Builder>
implements StakingNodeInfoOrBuilder
* An Hedera Token Service staking info entity. Staking info is per node. Shard and Realm are implied based on the network address book entry for this node.Protobuf type
proto.StakingNodeInfo-
Field Summary
Fields inherited from class com.google.protobuf.GeneratedMessageLite.Builder
instance -
Method Summary
Modifier and TypeMethodDescriptionaddAllRewardSumHistory(Iterable<? extends Long> values) * A running list of reward amounts for the last 365+1 staking periods (typically a year and a day).addRewardSumHistory(long value) * A running list of reward amounts for the last 365+1 staking periods (typically a year and a day).* A flag indicating that this node has been removed from this network.* The maximum stake to this node that is considered to calculate its weight in the network consensus.* The minimum stake, in tinybar, that is required for this node to have a non-zero weight in the network consensus.* The entity number of this node.<br/> The shard and realm numbers are implied, based on the network address book entry for this node.* The total staking rewards in tinybars that MAY be collected by all accounts staking to the current node after the end of this staking period.* A running list of reward amounts for the last 365+1 staking periods (typically a year and a day).* The total amount of HBAR staked to this node.* The snapshot of stake_to_reward value at the beginning of the current staking period.* The sum of balances of all accounts staked to this node, considering only accounts that decline to receive rewards.* The sum of balances of all accounts staked to this node, considering only accounts that choose to receive rewards.* The amount of staked HBAR from `stake_reward_start` that will have unclaimed rewards due to accounts changing their staking metadata in a way that disqualifies them for the current staking period.Deprecated.proto.StakingNodeInfo.weight is deprecated.boolean* A flag indicating that this node has been removed from this network.long* The maximum stake to this node that is considered to calculate its weight in the network consensus.long* The minimum stake, in tinybar, that is required for this node to have a non-zero weight in the network consensus.long* The entity number of this node.<br/> The shard and realm numbers are implied, based on the network address book entry for this node.long* The total staking rewards in tinybars that MAY be collected by all accounts staking to the current node after the end of this staking period.longgetRewardSumHistory(int index) * A running list of reward amounts for the last 365+1 staking periods (typically a year and a day).int* A running list of reward amounts for the last 365+1 staking periods (typically a year and a day).* A running list of reward amounts for the last 365+1 staking periods (typically a year and a day).longgetStake()* The total amount of HBAR staked to this node.long* The snapshot of stake_to_reward value at the beginning of the current staking period.long* The sum of balances of all accounts staked to this node, considering only accounts that decline to receive rewards.long* The sum of balances of all accounts staked to this node, considering only accounts that choose to receive rewards.long* The amount of staked HBAR from `stake_reward_start` that will have unclaimed rewards due to accounts changing their staking metadata in a way that disqualifies them for the current staking period.intDeprecated.proto.StakingNodeInfo.weight is deprecated.setDeleted(boolean value) * A flag indicating that this node has been removed from this network.setMaxStake(long value) * The maximum stake to this node that is considered to calculate its weight in the network consensus.setMinStake(long value) * The minimum stake, in tinybar, that is required for this node to have a non-zero weight in the network consensus.setNodeNumber(long value) * The entity number of this node.<br/> The shard and realm numbers are implied, based on the network address book entry for this node.setPendingRewards(long value) * The total staking rewards in tinybars that MAY be collected by all accounts staking to the current node after the end of this staking period.setRewardSumHistory(int index, long value) * A running list of reward amounts for the last 365+1 staking periods (typically a year and a day).setStake(long value) * The total amount of HBAR staked to this node.setStakeRewardStart(long value) * The snapshot of stake_to_reward value at the beginning of the current staking period.setStakeToNotReward(long value) * The sum of balances of all accounts staked to this node, considering only accounts that decline to receive rewards.setStakeToReward(long value) * The sum of balances of all accounts staked to this node, considering only accounts that choose to receive rewards.setUnclaimedStakeRewardStart(long value) * The amount of staked HBAR from `stake_reward_start` that will have unclaimed rewards due to accounts changing their staking metadata in a way that disqualifies them for the current staking period.setWeight(int value) Deprecated.proto.StakingNodeInfo.weight is deprecated.Methods inherited from class com.google.protobuf.GeneratedMessageLite.Builder
build, buildPartial, clear, clone, copyOnWrite, copyOnWriteInternal, getDefaultInstanceForType, internalMergeFrom, isInitialized, mergeFrom, mergeFrom, mergeFrom, mergeFromMethods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageExceptionMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLiteOrBuilder
getDefaultInstanceForType, isInitialized
-
Method Details
-
getNodeNumber
public long getNodeNumber()* The entity number of this node.<br/> The shard and realm numbers are implied, based on the network address book entry for this node. <p> This value SHALL be unique within a given shard and realm.<br/> This value MAY be repeated across shards and/or realms.
int64 node_number = 1;- Specified by:
getNodeNumberin interfaceStakingNodeInfoOrBuilder- Returns:
- The nodeNumber.
-
setNodeNumber
* The entity number of this node.<br/> The shard and realm numbers are implied, based on the network address book entry for this node. <p> This value SHALL be unique within a given shard and realm.<br/> This value MAY be repeated across shards and/or realms.
int64 node_number = 1;- Parameters:
value- The nodeNumber to set.- Returns:
- This builder for chaining.
-
clearNodeNumber
* The entity number of this node.<br/> The shard and realm numbers are implied, based on the network address book entry for this node. <p> This value SHALL be unique within a given shard and realm.<br/> This value MAY be repeated across shards and/or realms.
int64 node_number = 1;- Returns:
- This builder for chaining.
-
getMinStake
public long getMinStake()* The minimum stake, in tinybar, that is required for this node to have a non-zero weight in the network consensus. <p> If the current value of `stake` is below this value, this node SHALL have a zero weight in network consensus.
int64 min_stake = 2;- Specified by:
getMinStakein interfaceStakingNodeInfoOrBuilder- Returns:
- The minStake.
-
setMinStake
* The minimum stake, in tinybar, that is required for this node to have a non-zero weight in the network consensus. <p> If the current value of `stake` is below this value, this node SHALL have a zero weight in network consensus.
int64 min_stake = 2;- Parameters:
value- The minStake to set.- Returns:
- This builder for chaining.
-
clearMinStake
* The minimum stake, in tinybar, that is required for this node to have a non-zero weight in the network consensus. <p> If the current value of `stake` is below this value, this node SHALL have a zero weight in network consensus.
int64 min_stake = 2;- Returns:
- This builder for chaining.
-
getMaxStake
public long getMaxStake()* The maximum stake to this node that is considered to calculate its weight in the network consensus. <p> If the current `stake` value is above this limit, the excess staked HBAR SHALL NOT be considered when determining consensus weight.
int64 max_stake = 3;- Specified by:
getMaxStakein interfaceStakingNodeInfoOrBuilder- Returns:
- The maxStake.
-
setMaxStake
* The maximum stake to this node that is considered to calculate its weight in the network consensus. <p> If the current `stake` value is above this limit, the excess staked HBAR SHALL NOT be considered when determining consensus weight.
int64 max_stake = 3;- Parameters:
value- The maxStake to set.- Returns:
- This builder for chaining.
-
clearMaxStake
* The maximum stake to this node that is considered to calculate its weight in the network consensus. <p> If the current `stake` value is above this limit, the excess staked HBAR SHALL NOT be considered when determining consensus weight.
int64 max_stake = 3;- Returns:
- This builder for chaining.
-
getStakeToReward
public long getStakeToReward()* The sum of balances of all accounts staked to this node, considering only accounts that choose to receive rewards.
int64 stake_to_reward = 4;- Specified by:
getStakeToRewardin interfaceStakingNodeInfoOrBuilder- Returns:
- The stakeToReward.
-
setStakeToReward
* The sum of balances of all accounts staked to this node, considering only accounts that choose to receive rewards.
int64 stake_to_reward = 4;- Parameters:
value- The stakeToReward to set.- Returns:
- This builder for chaining.
-
clearStakeToReward
* The sum of balances of all accounts staked to this node, considering only accounts that choose to receive rewards.
int64 stake_to_reward = 4;- Returns:
- This builder for chaining.
-
getStakeToNotReward
public long getStakeToNotReward()* The sum of balances of all accounts staked to this node, considering only accounts that decline to receive rewards.
int64 stake_to_not_reward = 5;- Specified by:
getStakeToNotRewardin interfaceStakingNodeInfoOrBuilder- Returns:
- The stakeToNotReward.
-
setStakeToNotReward
* The sum of balances of all accounts staked to this node, considering only accounts that decline to receive rewards.
int64 stake_to_not_reward = 5;- Parameters:
value- The stakeToNotReward to set.- Returns:
- This builder for chaining.
-
clearStakeToNotReward
* The sum of balances of all accounts staked to this node, considering only accounts that decline to receive rewards.
int64 stake_to_not_reward = 5;- Returns:
- This builder for chaining.
-
getStakeRewardStart
public long getStakeRewardStart()* The snapshot of stake_to_reward value at the beginning of the current staking period. <p> This is necessary when calculating rewards for the current staking period without considering changes to `stake_to_reward` _within_ the current staking period.<br/> This value SHALL be reset at the beginning of every staking period.
int64 stake_reward_start = 6;- Specified by:
getStakeRewardStartin interfaceStakingNodeInfoOrBuilder- Returns:
- The stakeRewardStart.
-
setStakeRewardStart
* The snapshot of stake_to_reward value at the beginning of the current staking period. <p> This is necessary when calculating rewards for the current staking period without considering changes to `stake_to_reward` _within_ the current staking period.<br/> This value SHALL be reset at the beginning of every staking period.
int64 stake_reward_start = 6;- Parameters:
value- The stakeRewardStart to set.- Returns:
- This builder for chaining.
-
clearStakeRewardStart
* The snapshot of stake_to_reward value at the beginning of the current staking period. <p> This is necessary when calculating rewards for the current staking period without considering changes to `stake_to_reward` _within_ the current staking period.<br/> This value SHALL be reset at the beginning of every staking period.
int64 stake_reward_start = 6;- Returns:
- This builder for chaining.
-
getUnclaimedStakeRewardStart
public long getUnclaimedStakeRewardStart()* The amount of staked HBAR from `stake_reward_start` that will have unclaimed rewards due to accounts changing their staking metadata in a way that disqualifies them for the current staking period. <p> This value SHALL be reset at the beginning of every staking period.
int64 unclaimed_stake_reward_start = 7;- Specified by:
getUnclaimedStakeRewardStartin interfaceStakingNodeInfoOrBuilder- Returns:
- The unclaimedStakeRewardStart.
-
setUnclaimedStakeRewardStart
* The amount of staked HBAR from `stake_reward_start` that will have unclaimed rewards due to accounts changing their staking metadata in a way that disqualifies them for the current staking period. <p> This value SHALL be reset at the beginning of every staking period.
int64 unclaimed_stake_reward_start = 7;- Parameters:
value- The unclaimedStakeRewardStart to set.- Returns:
- This builder for chaining.
-
clearUnclaimedStakeRewardStart
* The amount of staked HBAR from `stake_reward_start` that will have unclaimed rewards due to accounts changing their staking metadata in a way that disqualifies them for the current staking period. <p> This value SHALL be reset at the beginning of every staking period.
int64 unclaimed_stake_reward_start = 7;- Returns:
- This builder for chaining.
-
getStake
public long getStake()* The total amount of HBAR staked to this node. <p> This is sum of stake_to_reward and stake_to_not_reward.<br/> If the sum is greater than `max_stake`, then the _effective_ stake SHALL be `max_stake`.<br/> If the sum is less than `min_stake`, then the _effective_ stake SHALL be `0`.
int64 stake = 8;- Specified by:
getStakein interfaceStakingNodeInfoOrBuilder- Returns:
- The stake.
-
setStake
* The total amount of HBAR staked to this node. <p> This is sum of stake_to_reward and stake_to_not_reward.<br/> If the sum is greater than `max_stake`, then the _effective_ stake SHALL be `max_stake`.<br/> If the sum is less than `min_stake`, then the _effective_ stake SHALL be `0`.
int64 stake = 8;- Parameters:
value- The stake to set.- Returns:
- This builder for chaining.
-
clearStake
* The total amount of HBAR staked to this node. <p> This is sum of stake_to_reward and stake_to_not_reward.<br/> If the sum is greater than `max_stake`, then the _effective_ stake SHALL be `max_stake`.<br/> If the sum is less than `min_stake`, then the _effective_ stake SHALL be `0`.
int64 stake = 8;- Returns:
- This builder for chaining.
-
getRewardSumHistoryList
* A running list of reward amounts for the last 365+1 staking periods (typically a year and a day). <p> The first element SHALL be the reward up to and including the last full period prior to the present reward period.<br/> The second element SHALL be the reward up to and including the period before the last full period prior to the present period.<br/> The list SHALL continue in reverse chronological order until the reward history limit is reached.
repeated int64 reward_sum_history = 9;- Specified by:
getRewardSumHistoryListin interfaceStakingNodeInfoOrBuilder- Returns:
- A list containing the rewardSumHistory.
-
getRewardSumHistoryCount
public int getRewardSumHistoryCount()* A running list of reward amounts for the last 365+1 staking periods (typically a year and a day). <p> The first element SHALL be the reward up to and including the last full period prior to the present reward period.<br/> The second element SHALL be the reward up to and including the period before the last full period prior to the present period.<br/> The list SHALL continue in reverse chronological order until the reward history limit is reached.
repeated int64 reward_sum_history = 9;- Specified by:
getRewardSumHistoryCountin interfaceStakingNodeInfoOrBuilder- Returns:
- The count of rewardSumHistory.
-
getRewardSumHistory
public long getRewardSumHistory(int index) * A running list of reward amounts for the last 365+1 staking periods (typically a year and a day). <p> The first element SHALL be the reward up to and including the last full period prior to the present reward period.<br/> The second element SHALL be the reward up to and including the period before the last full period prior to the present period.<br/> The list SHALL continue in reverse chronological order until the reward history limit is reached.
repeated int64 reward_sum_history = 9;- Specified by:
getRewardSumHistoryin interfaceStakingNodeInfoOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The rewardSumHistory at the given index.
-
setRewardSumHistory
* A running list of reward amounts for the last 365+1 staking periods (typically a year and a day). <p> The first element SHALL be the reward up to and including the last full period prior to the present reward period.<br/> The second element SHALL be the reward up to and including the period before the last full period prior to the present period.<br/> The list SHALL continue in reverse chronological order until the reward history limit is reached.
repeated int64 reward_sum_history = 9;- Parameters:
value- The rewardSumHistory to set.- Returns:
- This builder for chaining.
-
addRewardSumHistory
* A running list of reward amounts for the last 365+1 staking periods (typically a year and a day). <p> The first element SHALL be the reward up to and including the last full period prior to the present reward period.<br/> The second element SHALL be the reward up to and including the period before the last full period prior to the present period.<br/> The list SHALL continue in reverse chronological order until the reward history limit is reached.
repeated int64 reward_sum_history = 9;- Parameters:
value- The rewardSumHistory to add.- Returns:
- This builder for chaining.
-
addAllRewardSumHistory
* A running list of reward amounts for the last 365+1 staking periods (typically a year and a day). <p> The first element SHALL be the reward up to and including the last full period prior to the present reward period.<br/> The second element SHALL be the reward up to and including the period before the last full period prior to the present period.<br/> The list SHALL continue in reverse chronological order until the reward history limit is reached.
repeated int64 reward_sum_history = 9;- Parameters:
values- The rewardSumHistory to add.- Returns:
- This builder for chaining.
-
clearRewardSumHistory
* A running list of reward amounts for the last 365+1 staking periods (typically a year and a day). <p> The first element SHALL be the reward up to and including the last full period prior to the present reward period.<br/> The second element SHALL be the reward up to and including the period before the last full period prior to the present period.<br/> The list SHALL continue in reverse chronological order until the reward history limit is reached.
repeated int64 reward_sum_history = 9;- Returns:
- This builder for chaining.
-
getWeight
Deprecated.proto.StakingNodeInfo.weight is deprecated. See staking_node_info.proto;l=133* The consensus weight of this node in the network. <p> This is recomputed based on the `stake` of this node at midnight UTC of each day. If the `stake` of this node at that time is less than `min_stake`, then the weight SHALL be 0.<br/> <p> Given the following: <ul> <li>The `effective stake` of a single node SHALL be `0` if the node `stake` is less than `min_stake`.</li> <li>The `effective stake` SHALL be `max_stake` if the node `stake` is greater than `max_stake`.</li> <li>The `effective stake` SHALL be the actual value of `stake` if `min_stake` < `stake` < `max_stake`.</li> <li>The `effective network stake` SHALL be calculated as ∑(`effective stake` of each node) for all nodes in the network address book.</li> </ul> <p> This field is deprecated and SHALL NOT be used when RosterLifecycle is enabled. The weight SHALL be same as the `effective_stake` described above.
int32 weight = 10 [deprecated = true];- Specified by:
getWeightin interfaceStakingNodeInfoOrBuilder- Returns:
- The weight.
-
setWeight
Deprecated.proto.StakingNodeInfo.weight is deprecated. See staking_node_info.proto;l=133* The consensus weight of this node in the network. <p> This is recomputed based on the `stake` of this node at midnight UTC of each day. If the `stake` of this node at that time is less than `min_stake`, then the weight SHALL be 0.<br/> <p> Given the following: <ul> <li>The `effective stake` of a single node SHALL be `0` if the node `stake` is less than `min_stake`.</li> <li>The `effective stake` SHALL be `max_stake` if the node `stake` is greater than `max_stake`.</li> <li>The `effective stake` SHALL be the actual value of `stake` if `min_stake` < `stake` < `max_stake`.</li> <li>The `effective network stake` SHALL be calculated as ∑(`effective stake` of each node) for all nodes in the network address book.</li> </ul> <p> This field is deprecated and SHALL NOT be used when RosterLifecycle is enabled. The weight SHALL be same as the `effective_stake` described above.
int32 weight = 10 [deprecated = true];- Parameters:
value- The weight to set.- Returns:
- This builder for chaining.
-
clearWeight
Deprecated.proto.StakingNodeInfo.weight is deprecated. See staking_node_info.proto;l=133* The consensus weight of this node in the network. <p> This is recomputed based on the `stake` of this node at midnight UTC of each day. If the `stake` of this node at that time is less than `min_stake`, then the weight SHALL be 0.<br/> <p> Given the following: <ul> <li>The `effective stake` of a single node SHALL be `0` if the node `stake` is less than `min_stake`.</li> <li>The `effective stake` SHALL be `max_stake` if the node `stake` is greater than `max_stake`.</li> <li>The `effective stake` SHALL be the actual value of `stake` if `min_stake` < `stake` < `max_stake`.</li> <li>The `effective network stake` SHALL be calculated as ∑(`effective stake` of each node) for all nodes in the network address book.</li> </ul> <p> This field is deprecated and SHALL NOT be used when RosterLifecycle is enabled. The weight SHALL be same as the `effective_stake` described above.
int32 weight = 10 [deprecated = true];- Returns:
- This builder for chaining.
-
getPendingRewards
public long getPendingRewards()* The total staking rewards in tinybars that MAY be collected by all accounts staking to the current node after the end of this staking period. <p> This SHALL be calculated assuming that no account "renounces" its rewards by setting `decline_reward` to true, or is ineligible for some other reason.<br/> When the current node is deleted, this amount SHALL be subtracted from the total pending rewards of all accounts staking to all nodes in the network in NetworkStakingRewards.
int64 pending_rewards = 11;- Specified by:
getPendingRewardsin interfaceStakingNodeInfoOrBuilder- Returns:
- The pendingRewards.
-
setPendingRewards
* The total staking rewards in tinybars that MAY be collected by all accounts staking to the current node after the end of this staking period. <p> This SHALL be calculated assuming that no account "renounces" its rewards by setting `decline_reward` to true, or is ineligible for some other reason.<br/> When the current node is deleted, this amount SHALL be subtracted from the total pending rewards of all accounts staking to all nodes in the network in NetworkStakingRewards.
int64 pending_rewards = 11;- Parameters:
value- The pendingRewards to set.- Returns:
- This builder for chaining.
-
clearPendingRewards
* The total staking rewards in tinybars that MAY be collected by all accounts staking to the current node after the end of this staking period. <p> This SHALL be calculated assuming that no account "renounces" its rewards by setting `decline_reward` to true, or is ineligible for some other reason.<br/> When the current node is deleted, this amount SHALL be subtracted from the total pending rewards of all accounts staking to all nodes in the network in NetworkStakingRewards.
int64 pending_rewards = 11;- Returns:
- This builder for chaining.
-
getDeleted
public boolean getDeleted()* A flag indicating that this node has been removed from this network.
bool deleted = 12;- Specified by:
getDeletedin interfaceStakingNodeInfoOrBuilder- Returns:
- The deleted.
-
setDeleted
* A flag indicating that this node has been removed from this network.
bool deleted = 12;- Parameters:
value- The deleted to set.- Returns:
- This builder for chaining.
-
clearDeleted
* A flag indicating that this node has been removed from this network.
bool deleted = 12;- Returns:
- This builder for chaining.
-