Module com.hedera.hashgraph.sdk
Package com.hedera.hashgraph.sdk.proto

Class StakingInfo

java.lang.Object
com.google.protobuf.AbstractMessageLite<StakingInfo,StakingInfo.Builder>
com.google.protobuf.GeneratedMessageLite<StakingInfo,StakingInfo.Builder>
com.hedera.hashgraph.sdk.proto.StakingInfo
All Implemented Interfaces:
com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, StakingInfoOrBuilder
@Generated public final class StakingInfo extends com.google.protobuf.GeneratedMessageLite<StakingInfo,StakingInfo.Builder> implements StakingInfoOrBuilder
 *
 Staking information for an account or a contract.

 This is used for responses returned from `CryptoGetInfo` or
 `ContractGetInfo` queries.
Protobuf type proto.StakingInfo

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    StakingInfo.Builder
    * Staking information for an account or a contract.
    static enum 
    StakingInfo.StakedIdCase
     

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageLite

    com.google.protobuf.GeneratedMessageLite.DefaultInstanceBasedParser<T extends com.google.protobuf.GeneratedMessageLite<T,?>>, com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.GeneratedExtension<ContainingType extends com.google.protobuf.MessageLite,Type>, com.google.protobuf.GeneratedMessageLite.MethodToInvoke, com.google.protobuf.GeneratedMessageLite.SerializedForm

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    DECLINE_REWARD_FIELD_NUMBER
     
    static final int
    PENDING_REWARD_FIELD_NUMBER
     
    static final int
    STAKE_PERIOD_START_FIELD_NUMBER
     
    static final int
    STAKED_ACCOUNT_ID_FIELD_NUMBER
     
    static final int
    STAKED_NODE_ID_FIELD_NUMBER
     
    static final int
    STAKED_TO_ME_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageLite

    unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    protected final Object
    dynamicMethod(com.google.protobuf.GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1)
     
    boolean
    getDeclineReward()
    * A flag indicating that the holder of this account has chosen to decline staking rewards.
    static StakingInfo
    getDefaultInstance()
     
    long
    getPendingReward()
    * An amount, in tinybar, to be received in the next reward payout.<br/> Rewards are not paid out immediately; for efficiency reasons rewards are only paid out as part of another transaction involving that account.
    AccountID
    getStakedAccountId()
    * A delegated stake.
    StakingInfo.StakedIdCase
    getStakedIdCase()
     
    long
    getStakedNodeId()
    * A direct stake.
    long
    getStakedToMe()
    * A proxy-staked balance.<br/> The total HBAR balance of all accounts that delegate staking to this account or contract.
    Timestamp
    getStakePeriodStart()
    * A `Timestamp` of the start time for the latest active staking period.
    boolean
    hasStakedAccountId()
    * A delegated stake.
    boolean
    hasStakedNodeId()
    * A direct stake.
    boolean
    hasStakePeriodStart()
    * A `Timestamp` of the start time for the latest active staking period.
    static StakingInfo.Builder
    newBuilder()
     
    static StakingInfo.Builder
    newBuilder(StakingInfo prototype)
     
    static StakingInfo
    parseDelimitedFrom(InputStream input)
     
    static StakingInfo
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static StakingInfo
    parseFrom(byte[] data)
     
    static StakingInfo
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static StakingInfo
    parseFrom(com.google.protobuf.ByteString data)
     
    static StakingInfo
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static StakingInfo
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static StakingInfo
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static StakingInfo
    parseFrom(InputStream input)
     
    static StakingInfo
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static StakingInfo
    parseFrom(ByteBuffer data)
     
    static StakingInfo
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<StakingInfo>
    parser()
     

    Methods inherited from class com.google.protobuf.GeneratedMessageLite

    createBuilder, createBuilder, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, emptyProtobufList, equals, getDefaultInstanceForType, getParserForType, getSerializedSize, hashCode, isInitialized, makeImmutable, mergeLengthDelimitedField, mergeUnknownFields, mergeVarintField, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBuilderForType, newMessageInfo, newRepeatedGeneratedExtension, newSingularGeneratedExtension, parseDelimitedFrom, parseDelimitedFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parsePartialFrom, parseUnknownField, registerDefaultInstance, toBuilder, toString, writeTo

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    getDefaultInstanceForType, isInitialized

  • Field Details

    • DECLINE_REWARD_FIELD_NUMBER

      public static final int DECLINE_REWARD_FIELD_NUMBER
      See Also:

    • STAKE_PERIOD_START_FIELD_NUMBER

      public static final int STAKE_PERIOD_START_FIELD_NUMBER
      See Also:

    • PENDING_REWARD_FIELD_NUMBER

      public static final int PENDING_REWARD_FIELD_NUMBER
      See Also:

    • STAKED_TO_ME_FIELD_NUMBER

      public static final int STAKED_TO_ME_FIELD_NUMBER
      See Also:

    • STAKED_ACCOUNT_ID_FIELD_NUMBER

      public static final int STAKED_ACCOUNT_ID_FIELD_NUMBER
      See Also:

    • STAKED_NODE_ID_FIELD_NUMBER

      public static final int STAKED_NODE_ID_FIELD_NUMBER
      See Also:

  • Method Details

    • getStakedIdCase

      public StakingInfo.StakedIdCase getStakedIdCase()
      Specified by:
      getStakedIdCase in interface StakingInfoOrBuilder

    • getDeclineReward

      public boolean getDeclineReward()
       *
 A flag indicating that the holder of this account has chosen to decline
 staking rewards.
      bool decline_reward = 1;
      Specified by:
      getDeclineReward in interface StakingInfoOrBuilder
      Returns:
      The declineReward.

    • hasStakePeriodStart

      public boolean hasStakePeriodStart()
       *
 A `Timestamp` of the start time for the latest active staking period.
 <p>
 This MUST be a period during which either the staking settings for this
 account or contract changed or the account or contract received staking
 rewards, whichever is later. Examples of a change in staking settings
 include starting staking or changing the staked_node_id.<br/>
 If this account or contract is not currently staked to a node, then this
 field SHALL NOT be set.
      .proto.Timestamp stake_period_start = 2;
      Specified by:
      hasStakePeriodStart in interface StakingInfoOrBuilder
      Returns:
      Whether the stakePeriodStart field is set.

    • getStakePeriodStart

      public Timestamp getStakePeriodStart()
       *
 A `Timestamp` of the start time for the latest active staking period.
 <p>
 This MUST be a period during which either the staking settings for this
 account or contract changed or the account or contract received staking
 rewards, whichever is later. Examples of a change in staking settings
 include starting staking or changing the staked_node_id.<br/>
 If this account or contract is not currently staked to a node, then this
 field SHALL NOT be set.
      .proto.Timestamp stake_period_start = 2;
      Specified by:
      getStakePeriodStart in interface StakingInfoOrBuilder
      Returns:
      The stakePeriodStart.

    • getPendingReward

      public long getPendingReward()
       *
 An amount, in tinybar, to be received in the next reward payout.<br/>
 Rewards are not paid out immediately; for efficiency reasons rewards are
 only paid out as part of another transaction involving that account.
      int64 pending_reward = 3;
      Specified by:
      getPendingReward in interface StakingInfoOrBuilder
      Returns:
      The pendingReward.

    • getStakedToMe

      public long getStakedToMe()
       *
 A proxy-staked balance.<br/>
 The total HBAR balance of all accounts that delegate staking to this
 account or contract.
      int64 staked_to_me = 4;
      Specified by:
      getStakedToMe in interface StakingInfoOrBuilder
      Returns:
      The stakedToMe.

    • hasStakedAccountId

      public boolean hasStakedAccountId()
       *
 A delegated stake.
 <p>
 This account delegates to the indicated account for staking purposes.
      .proto.AccountID staked_account_id = 5;
      Specified by:
      hasStakedAccountId in interface StakingInfoOrBuilder
      Returns:
      Whether the stakedAccountId field is set.

    • getStakedAccountId

      public AccountID getStakedAccountId()
       *
 A delegated stake.
 <p>
 This account delegates to the indicated account for staking purposes.
      .proto.AccountID staked_account_id = 5;
      Specified by:
      getStakedAccountId in interface StakingInfoOrBuilder
      Returns:
      The stakedAccountId.

    • hasStakedNodeId

      public boolean hasStakedNodeId()
       *
 A direct stake.
 <p>
 This accounts stakes its balance to the designated node.
      int64 staked_node_id = 6;
      Specified by:
      hasStakedNodeId in interface StakingInfoOrBuilder
      Returns:
      Whether the stakedNodeId field is set.

    • getStakedNodeId

      public long getStakedNodeId()
       *
 A direct stake.
 <p>
 This accounts stakes its balance to the designated node.
      int64 staked_node_id = 6;
      Specified by:
      getStakedNodeId in interface StakingInfoOrBuilder
      Returns:
      The stakedNodeId.

    • parseFrom

      public static StakingInfo parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StakingInfo parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StakingInfo parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StakingInfo parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StakingInfo parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StakingInfo parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StakingInfo parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static StakingInfo parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static StakingInfo parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static StakingInfo parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static StakingInfo parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static StakingInfo parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilder

      public static StakingInfo.Builder newBuilder()

    • newBuilder

      public static StakingInfo.Builder newBuilder(StakingInfo prototype)

    • dynamicMethod

      protected final Object dynamicMethod(com.google.protobuf.GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1)
      Specified by:
      dynamicMethod in class com.google.protobuf.GeneratedMessageLite<StakingInfo,StakingInfo.Builder>

    • getDefaultInstance

      public static StakingInfo getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<StakingInfo> parser()