Module com.hedera.hashgraph.sdk

Package com.hedera.hashgraph.sdk

Class TransactionReceiptQuery

java.lang.Object

com.hedera.hashgraph.sdk.Executable<TransactionReceiptQuery,Query,Response,TransactionReceipt>

com.hedera.hashgraph.sdk.Query<TransactionReceipt,TransactionReceiptQuery>

com.hedera.hashgraph.sdk.TransactionReceiptQuery

public final class TransactionReceiptQuery
extends Query<TransactionReceipt,TransactionReceiptQuery>

Get the receipt of a transaction, given its transaction ID.

Once a transaction reaches consensus, then information about whether it succeeded or failed will be available until the end of the receipt period.

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
TransactionReceiptQuery()	Constructor.

Method Summary

Modifier and Type	Method	Description
(package private) ExecutionState	getExecutionState(Status status, Response response)	Default implementation, may be overridden in subclasses (especially for query case).
boolean	getIncludeChildren()	Should the children be included?
boolean	getIncludeDuplicates()	Should duplicates be included?
(package private) io.grpc.MethodDescriptor<Query,Response>	getMethodDescriptor()	Called to direct the invocation of the query to the appropriate gRPC service.
TransactionId	getTransactionIdInternal()	Extract the transaction id.
(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) TransactionReceipt	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) Status	mapResponseStatus(Response response)
(package private) void	onMakeRequest(Query.Builder queryBuilder, QueryHeader header)	Called in Query.makeRequest() just before the query is built.
TransactionReceiptQuery	setIncludeChildren(boolean value)	Whether the response should include the records of any child transactions spawned by the top-level transaction with the given transactionID.
TransactionReceiptQuery	setIncludeDuplicates(boolean value)	Whether records of processing duplicate transactions should be returned along with the record of processing the first consensus transaction with the given id whose status was neither INVALID_NODE_ACCOUNT nor INVALID_PAYER_SIGNATURE or, if no such record exists, the record of processing the first transaction to reach consensus with the given transaction id.
TransactionReceiptQuery	setTransactionId(TransactionId transactionId)	Set the ID of the transaction for which the receipt 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, makeRequest, 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, 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

TransactionReceiptQuery

public TransactionReceiptQuery()

Constructor.

Method Details

getTransactionIdInternal

@Nullable
public TransactionId getTransactionIdInternal()

Extract the transaction id.

Overrides:

getTransactionIdInternal in class Query<TransactionReceipt,TransactionReceiptQuery>

Returns:

the transaction id

setTransactionId

public TransactionReceiptQuery setTransactionId(TransactionId transactionId)

Set the ID of the transaction for which the receipt is being requested.

Parameters:

transactionId - The TransactionId to be set

Returns:

this

getIncludeChildren

public boolean getIncludeChildren()

Should the children be included?

Returns:

should children be included

setIncludeChildren

public TransactionReceiptQuery setIncludeChildren(boolean value)

Whether the response should include the records of any child transactions spawned by the top-level transaction with the given transactionID.

Parameters:

value - The value that includeChildren should be set to; true to include children, false to exclude

Returns:

this

getIncludeDuplicates

public boolean getIncludeDuplicates()

Should duplicates be included?

Returns:

should duplicates be included

setIncludeDuplicates

public TransactionReceiptQuery setIncludeDuplicates(boolean value)

Whether records of processing duplicate transactions should be returned along with the record of processing the first consensus transaction with the given id whose status was neither INVALID_NODE_ACCOUNT nor INVALID_PAYER_SIGNATURE or, if no such record exists, the record of processing the first transaction to reach consensus with the given transaction id.

Parameters:

value - The value that includeDuplicates should be set to; true to include duplicates, false to exclude

Returns:

this

isPaymentRequired

boolean isPaymentRequired()

Description copied from class: Query

Does this query require a payment?

Overrides:

isPaymentRequired in class Query<TransactionReceipt,TransactionReceiptQuery>

Returns:

does this query require a payment

validateChecksums

void validateChecksums(Client client)
                throws BadEntityIdException

Description copied from class: Query

Validate the checksums.

Specified by:

validateChecksums in class Query<TransactionReceipt,TransactionReceiptQuery>

Throws:

BadEntityIdException

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<TransactionReceipt,TransactionReceiptQuery>

mapResponseStatus

Status mapResponseStatus(Response response)

Overrides:

mapResponseStatus in class Query<TransactionReceipt,TransactionReceiptQuery>

mapResponse

TransactionReceipt 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<TransactionReceiptQuery,Query,Response,TransactionReceipt>

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<TransactionReceipt,TransactionReceiptQuery>

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<TransactionReceipt,TransactionReceiptQuery>

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<TransactionReceiptQuery,Query,Response,TransactionReceipt>

getExecutionState

ExecutionState getExecutionState(Status status,
 Response response)

Description copied from class: Executable

Default implementation, may be overridden in subclasses (especially for query case). Called just after receiving the query response from Hedera. By default it triggers a retry when the pre-check status is BUSY.

Overrides:

getExecutionState in class Executable<TransactionReceiptQuery,Query,Response,TransactionReceipt>