Module com.hedera.hashgraph.sdk

Package com.hedera.hashgraph.sdk

Class AccountBalanceQuery

java.lang.Object

com.hedera.hashgraph.sdk.Executable<AccountBalanceQuery,Query,Response,AccountBalance>

com.hedera.hashgraph.sdk.Query<AccountBalance,AccountBalanceQuery>

com.hedera.hashgraph.sdk.AccountBalanceQuery

public final class AccountBalanceQuery
extends Query<AccountBalance,AccountBalanceQuery>

Get the balance of a Hedera™ crypto-currency account. This returns only the balance, so it is a smaller and faster reply than AccountInfoQuery.

This query is free.

Nested Class Summary

Nested classes/interfaces inherited from class com.hedera.hashgraph.sdk.Executable

Executable.GrpcRequest

Field Summary

Fields inherited from class com.hedera.hashgraph.sdk.Query

paymentTransactionId, paymentTransactions

Fields inherited from class com.hedera.hashgraph.sdk.Executable

attemptedAllNodes, blockingUnaryCall, grpcDeadline, logger, maxAttempts, maxBackoff, minBackoff, nodeAccountIds, nodes, random, RST_STREAM

Constructor Summary

Constructors

Constructor	Description
AccountBalanceQuery()	Constructor.

Method Summary

Modifier and Type	Method	Description
AccountId	getAccountId()	Return the account's id.
ContractId	getContractId()	Extract the contract id.
(package private) io.grpc.MethodDescriptor<Query,Response>	getMethodDescriptor()	Called to direct the invocation of the query to the appropriate gRPC service.
(package private) boolean	isPaymentRequired()	Does this query require a payment?
(package private) QueryHeader	mapRequestHeader(Query request)	The derived class should access its request header and return.
(package private) AccountBalance	mapResponse(Response response, AccountId nodeId, Query request)	Called after receiving the query response from Hedera.
(package private) ResponseHeader	mapResponseHeader(Response response)	The derived class should access its response header and return.
(package private) void	onMakeRequest(Query.Builder queryBuilder, QueryHeader header)	Called in Query.makeRequest() just before the query is built.
AccountBalanceQuery	setAccountId(AccountId accountId)	The account ID for which the balance is being requested.
AccountBalanceQuery	setContractId(ContractId contractId)	The contract ID for which the balance is being requested.
(package private) void	validateChecksums(Client client)	Validate the checksums.

Methods inherited from class com.hedera.hashgraph.sdk.Query

getCost, getCost, getCostAsync, getCostAsync, getCostAsync, getCostAsync, getCostAsync, getCostAsync, getOperatorFromClient, getPaymentTransaction, getPaymentTransactionId, getTransactionIdInternal, makeRequest, mapResponseStatus, onExecute, onExecuteAsync, setMaxQueryPayment, setPaymentTransactionId, setQueryPayment, toString

Methods inherited from class com.hedera.hashgraph.sdk.Executable

advanceRequest, checkNodeAccountIds, execute, execute, executeAsync, executeAsync, executeAsync, executeAsync, executeAsync, executeAsync, getExecutionState, getGrpcRequest, getMaxAttempts, getMaxBackoff, getMaxRetry, getMinBackoff, getNodeAccountIds, getNodeForExecute, grpcDeadline, isBatchedAndNotBatchTransaction, logTransaction, mergeFromClient, setGrpcDeadline, setLogger, setMaxAttempts, setMaxBackoff, setMaxRetry, setMinBackoff, setNodeAccountIds, setNodesFromNodeAccountIds, setRequestListener, setResponseListener, shouldRetryExceptionally

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

AccountBalanceQuery

public AccountBalanceQuery()

Constructor.

Method Details

getAccountId

@Nullable
public AccountId getAccountId()

Return the account's id.

Returns:

accountId

setAccountId

public AccountBalanceQuery setAccountId(AccountId accountId)

The account ID for which the balance is being requested.

This is mutually exclusive with setContractId(ContractId).

Parameters:

accountId - The AccountId to set

Returns:

this

getContractId

@Nullable
public ContractId getContractId()

Extract the contract id.

Returns:

the contract id

setContractId

public AccountBalanceQuery setContractId(ContractId contractId)

The contract ID for which the balance is being requested.

This is mutually exclusive with setAccountId(AccountId).

Parameters:

contractId - The ContractId to set

Returns:

this

validateChecksums

void validateChecksums(Client client)
                throws BadEntityIdException

Description copied from class: Query

Validate the checksums.

Specified by:

validateChecksums in class Query<AccountBalance,AccountBalanceQuery>

Throws:

BadEntityIdException

isPaymentRequired

boolean isPaymentRequired()

Description copied from class: Query

Does this query require a payment?

Overrides:

isPaymentRequired in class Query<AccountBalance,AccountBalanceQuery>

Returns:

does this query require a payment

onMakeRequest

void onMakeRequest(Query.Builder queryBuilder,
 QueryHeader header)

Description copied from class: Query

Called in Query.makeRequest() just before the query is built. The intent is for the derived class to assign their data variant to the query.

Specified by:

onMakeRequest in class Query<AccountBalance,AccountBalanceQuery>

mapResponse

AccountBalance mapResponse(Response response,
 AccountId nodeId,
 Query request)

Description copied from class: Executable

Called after receiving the query response from Hedera. The derived class should map into its output type.

Specified by:

mapResponse in class Executable<AccountBalanceQuery,Query,Response,AccountBalance>

mapResponseHeader

ResponseHeader mapResponseHeader(Response response)

Description copied from class: Query

The derived class should access its response header and return.

Specified by:

mapResponseHeader in class Query<AccountBalance,AccountBalanceQuery>

mapRequestHeader

QueryHeader mapRequestHeader(Query request)

Description copied from class: Query

The derived class should access its request header and return.

Specified by:

mapRequestHeader in class Query<AccountBalance,AccountBalanceQuery>

getMethodDescriptor

io.grpc.MethodDescriptor<Query,Response> getMethodDescriptor()

Description copied from class: Executable

Called to direct the invocation of the query to the appropriate gRPC service.

Specified by:

getMethodDescriptor in class Executable<AccountBalanceQuery,Query,Response,AccountBalance>