com.hedera.hashgraph.sdk.proto.StakingInfoOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sdk-full Show documentation
Hedera™ Hashgraph SDK for Java
The newest version!
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: basic_types.proto

// Protobuf Java Version: 3.25.3
package com.hedera.hashgraph.sdk.proto;

public interface StakingInfoOrBuilder extends
    // @@protoc_insertion_point(interface_extends:proto.StakingInfo)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    **
   * If true, this account or contract declined to receive a staking reward.
   * 
   *
   * bool decline_reward = 1;
   * @return The declineReward.
   */
  boolean getDeclineReward();

  /**
   *    **
   * The staking period during which either the staking settings for this account or contract changed (such as starting
   * staking or changing staked_node_id) or the most recent reward was earned, whichever is later. If this account or contract
   * is not currently staked to a node, then this field is not set.
   * 
   *
   * .proto.Timestamp stake_period_start = 2;
   * @return Whether the stakePeriodStart field is set.
   */
  boolean hasStakePeriodStart();
  /**
   *    **
   * The staking period during which either the staking settings for this account or contract changed (such as starting
   * staking or changing staked_node_id) or the most recent reward was earned, whichever is later. If this account or contract
   * is not currently staked to a node, then this field is not set.
   * 
   *
   * .proto.Timestamp stake_period_start = 2;
   * @return The stakePeriodStart.
   */
  com.hedera.hashgraph.sdk.proto.Timestamp getStakePeriodStart();
  /**
   *    **
   * The staking period during which either the staking settings for this account or contract changed (such as starting
   * staking or changing staked_node_id) or the most recent reward was earned, whichever is later. If this account or contract
   * is not currently staked to a node, then this field is not set.
   * 
   *
   * .proto.Timestamp stake_period_start = 2;
   */
  com.hedera.hashgraph.sdk.proto.TimestampOrBuilder getStakePeriodStartOrBuilder();

  /**
   *    **
   * The amount in tinybars that will be received in the next reward situation.
   * 
   *
   * int64 pending_reward = 3;
   * @return The pendingReward.
   */
  long getPendingReward();

  /**
   *    **
   * The total of balance of all accounts staked to this account or contract.
   * 
   *
   * int64 staked_to_me = 4;
   * @return The stakedToMe.
   */
  long getStakedToMe();

  /**
   *    **
   * The account to which this account or contract is staking.
   * 
   *
   * .proto.AccountID staked_account_id = 5;
   * @return Whether the stakedAccountId field is set.
   */
  boolean hasStakedAccountId();
  /**
   *    **
   * The account to which this account or contract is staking.
   * 
   *
   * .proto.AccountID staked_account_id = 5;
   * @return The stakedAccountId.
   */
  com.hedera.hashgraph.sdk.proto.AccountID getStakedAccountId();
  /**
   *    **
   * The account to which this account or contract is staking.
   * 
   *
   * .proto.AccountID staked_account_id = 5;
   */
  com.hedera.hashgraph.sdk.proto.AccountIDOrBuilder getStakedAccountIdOrBuilder();

  /**
   *    **
   * The ID of the node this account or contract is staked to.
   * 
   *
   * int64 staked_node_id = 6;
   * @return Whether the stakedNodeId field is set.
   */
  boolean hasStakedNodeId();
  /**
   *    **
   * The ID of the node this account or contract is staked to.
   * 
   *
   * int64 staked_node_id = 6;
   * @return The stakedNodeId.
   */
  long getStakedNodeId();

  com.hedera.hashgraph.sdk.proto.StakingInfo.StakedIdCase getStakedIdCase();
}