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

Interface GetAccountDetailsResponse.AccountDetailsOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
All Known Implementing Classes:
GetAccountDetailsResponse.AccountDetails, GetAccountDetailsResponse.AccountDetails.Builder
Enclosing class:
GetAccountDetailsResponse
public static interface GetAccountDetailsResponse.AccountDetailsOrBuilder extends com.google.protobuf.MessageLiteOrBuilder

  • Method Details

    • hasAccountId

      boolean hasAccountId()
       *
 The unique ID of this account.
 <p>
 An account ID, when assigned to this field, SHALL be of
 the form `shard.realm.number`.<br/>
 Transactions MAY reference the account by alias, but the account
 itself MUST always have a purely numeric identifier. This numeric
 ID is the value used to reference the account in query responses,
 transaction receipts, transaction records, and the block stream.
      .proto.AccountID account_id = 1;
      Returns:
      Whether the accountId field is set.

    • getAccountId

      AccountID getAccountId()
       *
 The unique ID of this account.
 <p>
 An account ID, when assigned to this field, SHALL be of
 the form `shard.realm.number`.<br/>
 Transactions MAY reference the account by alias, but the account
 itself MUST always have a purely numeric identifier. This numeric
 ID is the value used to reference the account in query responses,
 transaction receipts, transaction records, and the block stream.
      .proto.AccountID account_id = 1;
      Returns:
      The accountId.

    • getContractAccountId

      String getContractAccountId()
       *
 A Solidity ID.<br/>
 This identifies the contract instance, and the `Account` associated
 with that contract instance.
 <p>
 This SHALL be populated if this account is a smart contract, and
 SHALL NOT be populated otherwise.<br/>
 This SHALL be formatted as a string according to Solidity ID
 standards.
      string contract_account_id = 2;
      Returns:
      The contractAccountId.

    • getContractAccountIdBytes

      com.google.protobuf.ByteString getContractAccountIdBytes()
       *
 A Solidity ID.<br/>
 This identifies the contract instance, and the `Account` associated
 with that contract instance.
 <p>
 This SHALL be populated if this account is a smart contract, and
 SHALL NOT be populated otherwise.<br/>
 This SHALL be formatted as a string according to Solidity ID
 standards.
      string contract_account_id = 2;
      Returns:
      The bytes for contractAccountId.

    • getDeleted

      boolean getDeleted()
       *
 A boolean indicating that this account is deleted.
      bool deleted = 3;
      Returns:
      The deleted.

    • hasProxyAccountId

      @Deprecated boolean hasProxyAccountId()
      Deprecated.
      proto.GetAccountDetailsResponse.AccountDetails.proxy_account_id is deprecated. See get_account_details.proto;l=132
       *
 Replaced by StakingInfo.<br/>
 ID of the account to which this account is staking its balances. If
 this account is not currently staking its balances, then this field,
 if set, SHALL be the sentinel value of `0.0.0`.
      .proto.AccountID proxy_account_id = 4 [deprecated = true];
      Returns:
      Whether the proxyAccountId field is set.

    • getProxyAccountId

      @Deprecated AccountID getProxyAccountId()
      Deprecated.
      proto.GetAccountDetailsResponse.AccountDetails.proxy_account_id is deprecated. See get_account_details.proto;l=132
       *
 Replaced by StakingInfo.<br/>
 ID of the account to which this account is staking its balances. If
 this account is not currently staking its balances, then this field,
 if set, SHALL be the sentinel value of `0.0.0`.
      .proto.AccountID proxy_account_id = 4 [deprecated = true];
      Returns:
      The proxyAccountId.

    • getProxyReceived

      long getProxyReceived()
       *
 The total amount of tinybar proxy staked to this account.
      int64 proxy_received = 5;
      Returns:
      The proxyReceived.

    • hasKey

      boolean hasKey()
       *
 The key to be used to sign transactions from this account, if any.
 <p>
 This key SHALL NOT be set for hollow accounts until the account
 is finalized.<br/>
 This key SHALL be set on all other accounts, except for certain
 immutable accounts (0.0.800 and 0.0.801) necessary for network
 function and otherwise secured by the governing council.
      .proto.Key key = 6;
      Returns:
      Whether the key field is set.

    • getKey

      Key getKey()
       *
 The key to be used to sign transactions from this account, if any.
 <p>
 This key SHALL NOT be set for hollow accounts until the account
 is finalized.<br/>
 This key SHALL be set on all other accounts, except for certain
 immutable accounts (0.0.800 and 0.0.801) necessary for network
 function and otherwise secured by the governing council.
      .proto.Key key = 6;
      Returns:
      The key.

    • getBalance

      long getBalance()
       *
 The HBAR balance of this account, in tinybar (10<sup>-8</sup> HBAR).
 <p>
 This value SHALL always be a whole number.
      uint64 balance = 7;
      Returns:
      The balance.

    • getReceiverSigRequired

      boolean getReceiverSigRequired()
       *
 A boolean indicating that the account requires a receiver signature
 for inbound token transfer transactions.
 <p>
 If this value is `true` then a transaction to transfer tokens to this
 account SHALL NOT succeed unless this account has signed the
 transfer transaction.
      bool receiver_sig_required = 8;
      Returns:
      The receiverSigRequired.

    • hasExpirationTime

      boolean hasExpirationTime()
       *
 The current expiration time for this account.
 <p>
 This account SHALL be due standard renewal fees when the network
 consensus time exceeds this time.<br/>
 If rent and expiration are enabled for the network, and automatic
 renewal is enabled for this account, renewal fees SHALL be charged
 after this time, and, if charged, the expiration time SHALL be
 extended for another renewal period.<br/>
 This account MAY be expired and removed from state at any point
 after this time if not renewed.<br/>
 An account holder MAY extend this time by submitting an account
 update transaction to modify expiration time, subject to the current
 maximum expiration time for the network.
      .proto.Timestamp expiration_time = 9;
      Returns:
      Whether the expirationTime field is set.

    • getExpirationTime

      Timestamp getExpirationTime()
       *
 The current expiration time for this account.
 <p>
 This account SHALL be due standard renewal fees when the network
 consensus time exceeds this time.<br/>
 If rent and expiration are enabled for the network, and automatic
 renewal is enabled for this account, renewal fees SHALL be charged
 after this time, and, if charged, the expiration time SHALL be
 extended for another renewal period.<br/>
 This account MAY be expired and removed from state at any point
 after this time if not renewed.<br/>
 An account holder MAY extend this time by submitting an account
 update transaction to modify expiration time, subject to the current
 maximum expiration time for the network.
      .proto.Timestamp expiration_time = 9;
      Returns:
      The expirationTime.

    • hasAutoRenewPeriod

      boolean hasAutoRenewPeriod()
       *
 A duration to extend this account's expiration.
 <p>
 The network SHALL extend the account's expiration by this
 duration, if funds are available, upon automatic renewal.<br/>
 This SHALL NOT apply if the account is already deleted
 upon expiration.<br/>
 If this is not provided in an allowed range on account creation, the
 transaction SHALL fail with INVALID_AUTO_RENEWAL_PERIOD. The default
 values for the minimum period and maximum period are currently
 30 days and 90 days, respectively.
      .proto.Duration auto_renew_period = 10;
      Returns:
      Whether the autoRenewPeriod field is set.

    • getAutoRenewPeriod

      Duration getAutoRenewPeriod()
       *
 A duration to extend this account's expiration.
 <p>
 The network SHALL extend the account's expiration by this
 duration, if funds are available, upon automatic renewal.<br/>
 This SHALL NOT apply if the account is already deleted
 upon expiration.<br/>
 If this is not provided in an allowed range on account creation, the
 transaction SHALL fail with INVALID_AUTO_RENEWAL_PERIOD. The default
 values for the minimum period and maximum period are currently
 30 days and 90 days, respectively.
      .proto.Duration auto_renew_period = 10;
      Returns:
      The autoRenewPeriod.

    • getTokenRelationshipsList

      List<TokenRelationship> getTokenRelationshipsList()
       *
 As of `HIP-367`, which enabled unlimited token associations, the
 potential scale for this value requires that users consult a mirror
 node for this information. Only the top `maxRelsPerInfoQuery`
 (default 1000) relationships will be returned by this query.<br/>
 A list of tokens to which this account is "associated", enabling the
 transfer of that token type by this account.
      repeated .proto.TokenRelationship token_relationships = 11;

    • getTokenRelationships

      TokenRelationship getTokenRelationships(int index)
       *
 As of `HIP-367`, which enabled unlimited token associations, the
 potential scale for this value requires that users consult a mirror
 node for this information. Only the top `maxRelsPerInfoQuery`
 (default 1000) relationships will be returned by this query.<br/>
 A list of tokens to which this account is "associated", enabling the
 transfer of that token type by this account.
      repeated .proto.TokenRelationship token_relationships = 11;

    • getTokenRelationshipsCount

      int getTokenRelationshipsCount()
       *
 As of `HIP-367`, which enabled unlimited token associations, the
 potential scale for this value requires that users consult a mirror
 node for this information. Only the top `maxRelsPerInfoQuery`
 (default 1000) relationships will be returned by this query.<br/>
 A list of tokens to which this account is "associated", enabling the
 transfer of that token type by this account.
      repeated .proto.TokenRelationship token_relationships = 11;

    • getMemo

      String getMemo()
       *
 A short description of this account.
 <p>
 This value, if set, MUST NOT exceed `transaction.maxMemoUtf8Bytes`
 (default 100) bytes when encoded as UTF-8.
      string memo = 12;
      Returns:
      The memo.

    • getMemoBytes

      com.google.protobuf.ByteString getMemoBytes()
       *
 A short description of this account.
 <p>
 This value, if set, MUST NOT exceed `transaction.maxMemoUtf8Bytes`
 (default 100) bytes when encoded as UTF-8.
      string memo = 12;
      Returns:
      The bytes for memo.

    • getOwnedNfts

      long getOwnedNfts()
       *
 The total number of non-fungible/unique tokens owned by this account.
      int64 owned_nfts = 13;
      Returns:
      The ownedNfts.

    • getMaxAutomaticTokenAssociations

      int getMaxAutomaticTokenAssociations()
       *
 The maximum number of tokens that can be auto-associated with the
 account.
 <p>
 If this is less than or equal to `used_auto_associations` (or 0),
 then this account MUST manually associate with a token before
 transacting in that token.<br/>
 Following HIP-904 This value may also be `-1` to indicate no
 limit.<br/>
 This value MUST NOT be less than `-1`.
      int32 max_automatic_token_associations = 14;
      Returns:
      The maxAutomaticTokenAssociations.

    • getAlias

      com.google.protobuf.ByteString getAlias()
       *
 An account EVM alias.<br/>
 This is a value used in some contexts to reference an account when
 the tripartite account identifier is not available.
 <p>
 This field, when set to a non-default value, is immutable and
 SHALL NOT be changed.
      bytes alias = 15;
      Returns:
      The alias.

    • getLedgerId

      com.google.protobuf.ByteString getLedgerId()
       *
 The ledger ID of the network that generated this response.
 <p>
 This value SHALL identify the distributed ledger that responded to
 this query.
      bytes ledger_id = 16;
      Returns:
      The ledgerId.

    • getGrantedCryptoAllowancesList

      List<GrantedCryptoAllowance> getGrantedCryptoAllowancesList()
       *
 A list of crypto (HBAR) allowances approved by this account.
 <p>
 If this is not empty, each allowance SHALL permit a specified
 "spender" account to spend this account's HBAR balance, up
 to a designated limit.<br/>
 This field SHALL permit spending only HBAR balance, not other
 tokens the account may hold.<br/>
 Allowances for other tokens SHALL be listed in the
 `token_allowances` field or the
 `approve_for_all_nft_allowances` field.
      repeated .proto.GrantedCryptoAllowance granted_crypto_allowances = 17;

    • getGrantedCryptoAllowances

      GrantedCryptoAllowance getGrantedCryptoAllowances(int index)
       *
 A list of crypto (HBAR) allowances approved by this account.
 <p>
 If this is not empty, each allowance SHALL permit a specified
 "spender" account to spend this account's HBAR balance, up
 to a designated limit.<br/>
 This field SHALL permit spending only HBAR balance, not other
 tokens the account may hold.<br/>
 Allowances for other tokens SHALL be listed in the
 `token_allowances` field or the
 `approve_for_all_nft_allowances` field.
      repeated .proto.GrantedCryptoAllowance granted_crypto_allowances = 17;

    • getGrantedCryptoAllowancesCount

      int getGrantedCryptoAllowancesCount()
       *
 A list of crypto (HBAR) allowances approved by this account.
 <p>
 If this is not empty, each allowance SHALL permit a specified
 "spender" account to spend this account's HBAR balance, up
 to a designated limit.<br/>
 This field SHALL permit spending only HBAR balance, not other
 tokens the account may hold.<br/>
 Allowances for other tokens SHALL be listed in the
 `token_allowances` field or the
 `approve_for_all_nft_allowances` field.
      repeated .proto.GrantedCryptoAllowance granted_crypto_allowances = 17;

    • getGrantedNftAllowancesList

      List<GrantedNftAllowance> getGrantedNftAllowancesList()
       *
 A list of non-fungible token (NFT) allowances approved by
 this account.
 <p>
 If this is not empty, each allowance SHALL permit a specified
 "spender" account to transfer _all_ of this account's
 non-fungible/unique tokens from a particular collection.<br/>
 Allowances for a specific serial number MUST be directly
 associated with that specific non-fungible/unique token, rather
 than the holding account.
      repeated .proto.GrantedNftAllowance granted_nft_allowances = 18;

    • getGrantedNftAllowances

      GrantedNftAllowance getGrantedNftAllowances(int index)
       *
 A list of non-fungible token (NFT) allowances approved by
 this account.
 <p>
 If this is not empty, each allowance SHALL permit a specified
 "spender" account to transfer _all_ of this account's
 non-fungible/unique tokens from a particular collection.<br/>
 Allowances for a specific serial number MUST be directly
 associated with that specific non-fungible/unique token, rather
 than the holding account.
      repeated .proto.GrantedNftAllowance granted_nft_allowances = 18;

    • getGrantedNftAllowancesCount

      int getGrantedNftAllowancesCount()
       *
 A list of non-fungible token (NFT) allowances approved by
 this account.
 <p>
 If this is not empty, each allowance SHALL permit a specified
 "spender" account to transfer _all_ of this account's
 non-fungible/unique tokens from a particular collection.<br/>
 Allowances for a specific serial number MUST be directly
 associated with that specific non-fungible/unique token, rather
 than the holding account.
      repeated .proto.GrantedNftAllowance granted_nft_allowances = 18;

    • getGrantedTokenAllowancesList

      List<GrantedTokenAllowance> getGrantedTokenAllowancesList()
       *
 A list of fungible token allowances approved by this account.
 <p>
 If this is not empty, each allowance SHALL permit a specified
 "spender" to spend this account's fungible tokens, of the
 designated type, up to a designated limit.
      repeated .proto.GrantedTokenAllowance granted_token_allowances = 19;

    • getGrantedTokenAllowances

      GrantedTokenAllowance getGrantedTokenAllowances(int index)
       *
 A list of fungible token allowances approved by this account.
 <p>
 If this is not empty, each allowance SHALL permit a specified
 "spender" to spend this account's fungible tokens, of the
 designated type, up to a designated limit.
      repeated .proto.GrantedTokenAllowance granted_token_allowances = 19;

    • getGrantedTokenAllowancesCount

      int getGrantedTokenAllowancesCount()
       *
 A list of fungible token allowances approved by this account.
 <p>
 If this is not empty, each allowance SHALL permit a specified
 "spender" to spend this account's fungible tokens, of the
 designated type, up to a designated limit.
      repeated .proto.GrantedTokenAllowance granted_token_allowances = 19;