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

Class TransactionGetReceiptQuery.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder<TransactionGetReceiptQuery,TransactionGetReceiptQuery.Builder>
com.google.protobuf.GeneratedMessageLite.Builder<TransactionGetReceiptQuery,TransactionGetReceiptQuery.Builder>
com.hedera.hashgraph.sdk.proto.TransactionGetReceiptQuery.Builder
All Implemented Interfaces:
com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, TransactionGetReceiptQueryOrBuilder, Cloneable
Enclosing class:
TransactionGetReceiptQuery
public static final class TransactionGetReceiptQuery.Builder extends com.google.protobuf.GeneratedMessageLite.Builder<TransactionGetReceiptQuery,TransactionGetReceiptQuery.Builder> implements TransactionGetReceiptQueryOrBuilder
 *
 A query to retrieve a transaction receipt.
 This query retrieves the post-consensus (final) result of a transaction.
 A transaction receipt may not be available if queried too early
 (less than 5-10 seconds), or too late (more than 3 minutes). If a receipt
 is available, it contains basic transaction results. A query to a mirror
 node (or other archival system) is required to obtain full detail for a
 transaction, or any result after the basic receipt time period.

 This query is "free". The payment field in the header MUST be empty.<br/>
 If a receipt is not available, the response SHALL be `UNKNOWN`.<br/>
 A transaction receipt SHALL be available after the network reaches
 consensus for a transaction.<br/>
 A transaction receipt SHALL NOT be available after the end of the network
 configured "receipt period", typically three(3) minutes.

 <dl>
 <dt>What is the "first" transaction?</dt>
 <dd>The "first" transaction SHALL be the the transaction with
 the earliest consensus time and a status that is neither
 `INVALID_NODE_ACCOUNT` nor `INVALID_PAYER_SIGNATURE`.<br/>
 If no transaction is found meeting this status criteria, the
 "first" transaction SHALL be the transaction with the earliest
 consensus time.</dd>
 <dt>What is a "child" transaction?</dt>
 <dd>A "child" transaction is any transaction created in the process of
 completing another transaction. These are most common with a smart
 contract call, where a call to a contract may initiate one or more
 additional transactions to complete a complex process.</dd>
 </dl>
Protobuf type proto.TransactionGetReceiptQuery

  • Method Details

    • hasHeader

      public boolean hasHeader()
       *
 Standard information sent with every query operation.<br/>
 This includes the signed payment and what kind of response is requested
 (cost, state proof, both, or neither).
      .proto.QueryHeader header = 1;
      Specified by:
      hasHeader in interface TransactionGetReceiptQueryOrBuilder
      Returns:
      Whether the header field is set.

    • getHeader

      public QueryHeader getHeader()
       *
 Standard information sent with every query operation.<br/>
 This includes the signed payment and what kind of response is requested
 (cost, state proof, both, or neither).
      .proto.QueryHeader header = 1;
      Specified by:
      getHeader in interface TransactionGetReceiptQueryOrBuilder
      Returns:
      The header.

    • setHeader

      public TransactionGetReceiptQuery.Builder setHeader(QueryHeader value)
       *
 Standard information sent with every query operation.<br/>
 This includes the signed payment and what kind of response is requested
 (cost, state proof, both, or neither).
      .proto.QueryHeader header = 1;

    • setHeader

      public TransactionGetReceiptQuery.Builder setHeader(QueryHeader.Builder builderForValue)
       *
 Standard information sent with every query operation.<br/>
 This includes the signed payment and what kind of response is requested
 (cost, state proof, both, or neither).
      .proto.QueryHeader header = 1;

    • mergeHeader

      public TransactionGetReceiptQuery.Builder mergeHeader(QueryHeader value)
       *
 Standard information sent with every query operation.<br/>
 This includes the signed payment and what kind of response is requested
 (cost, state proof, both, or neither).
      .proto.QueryHeader header = 1;

    • clearHeader

      public TransactionGetReceiptQuery.Builder clearHeader()
       *
 Standard information sent with every query operation.<br/>
 This includes the signed payment and what kind of response is requested
 (cost, state proof, both, or neither).
      .proto.QueryHeader header = 1;

    • hasTransactionID

      public boolean hasTransactionID()
       *
 A transaction identifier.
 <p>
 This MUST contain the full identifier, as submitted, for the
 transaction to query.
      .proto.TransactionID transactionID = 2;
      Specified by:
      hasTransactionID in interface TransactionGetReceiptQueryOrBuilder
      Returns:
      Whether the transactionID field is set.

    • getTransactionID

      public TransactionID getTransactionID()
       *
 A transaction identifier.
 <p>
 This MUST contain the full identifier, as submitted, for the
 transaction to query.
      .proto.TransactionID transactionID = 2;
      Specified by:
      getTransactionID in interface TransactionGetReceiptQueryOrBuilder
      Returns:
      The transactionID.

    • setTransactionID

      public TransactionGetReceiptQuery.Builder setTransactionID(TransactionID value)
       *
 A transaction identifier.
 <p>
 This MUST contain the full identifier, as submitted, for the
 transaction to query.
      .proto.TransactionID transactionID = 2;

    • setTransactionID

      public TransactionGetReceiptQuery.Builder setTransactionID(TransactionID.Builder builderForValue)
       *
 A transaction identifier.
 <p>
 This MUST contain the full identifier, as submitted, for the
 transaction to query.
      .proto.TransactionID transactionID = 2;

    • mergeTransactionID

      public TransactionGetReceiptQuery.Builder mergeTransactionID(TransactionID value)
       *
 A transaction identifier.
 <p>
 This MUST contain the full identifier, as submitted, for the
 transaction to query.
      .proto.TransactionID transactionID = 2;

    • clearTransactionID

      public TransactionGetReceiptQuery.Builder clearTransactionID()
       *
 A transaction identifier.
 <p>
 This MUST contain the full identifier, as submitted, for the
 transaction to query.
      .proto.TransactionID transactionID = 2;

    • getIncludeDuplicates

      public boolean getIncludeDuplicates()
       *
 A flag to request duplicates.
 <p>
 If set, every transaction receipt within the receipt period that
 matches the requested transaction identifier SHALL be returned.<br/>
 If not set, duplicate transactions SHALL NOT be returned.<br/>
 If not set, only the receipt for the first matching transaction to
 reach consensus SHALL be returned.
      bool includeDuplicates = 3;
      Specified by:
      getIncludeDuplicates in interface TransactionGetReceiptQueryOrBuilder
      Returns:
      The includeDuplicates.

    • setIncludeDuplicates

      public TransactionGetReceiptQuery.Builder setIncludeDuplicates(boolean value)
       *
 A flag to request duplicates.
 <p>
 If set, every transaction receipt within the receipt period that
 matches the requested transaction identifier SHALL be returned.<br/>
 If not set, duplicate transactions SHALL NOT be returned.<br/>
 If not set, only the receipt for the first matching transaction to
 reach consensus SHALL be returned.
      bool includeDuplicates = 3;
      Parameters:
      value - The includeDuplicates to set.
      Returns:
      This builder for chaining.

    • clearIncludeDuplicates

      public TransactionGetReceiptQuery.Builder clearIncludeDuplicates()
       *
 A flag to request duplicates.
 <p>
 If set, every transaction receipt within the receipt period that
 matches the requested transaction identifier SHALL be returned.<br/>
 If not set, duplicate transactions SHALL NOT be returned.<br/>
 If not set, only the receipt for the first matching transaction to
 reach consensus SHALL be returned.
      bool includeDuplicates = 3;
      Returns:
      This builder for chaining.

    • getIncludeChildReceipts

      public boolean getIncludeChildReceipts()
       *
 A flag to request "child" receipts.
 <p>
 If set, the response SHALL include receipts for each child transaction
 executed as part of the requested parent transaction.<br/>
 If not set, the response SHALL NOT include any receipts for child
 transactions.
      bool include_child_receipts = 4;
      Specified by:
      getIncludeChildReceipts in interface TransactionGetReceiptQueryOrBuilder
      Returns:
      The includeChildReceipts.

    • setIncludeChildReceipts

      public TransactionGetReceiptQuery.Builder setIncludeChildReceipts(boolean value)
       *
 A flag to request "child" receipts.
 <p>
 If set, the response SHALL include receipts for each child transaction
 executed as part of the requested parent transaction.<br/>
 If not set, the response SHALL NOT include any receipts for child
 transactions.
      bool include_child_receipts = 4;
      Parameters:
      value - The includeChildReceipts to set.
      Returns:
      This builder for chaining.

    • clearIncludeChildReceipts

      public TransactionGetReceiptQuery.Builder clearIncludeChildReceipts()
       *
 A flag to request "child" receipts.
 <p>
 If set, the response SHALL include receipts for each child transaction
 executed as part of the requested parent transaction.<br/>
 If not set, the response SHALL NOT include any receipts for child
 transactions.
      bool include_child_receipts = 4;
      Returns:
      This builder for chaining.