Package com.daml.ledger.api.v2

Interface UpdateServiceOuterClass.GetTransactionByOffsetRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
UpdateServiceOuterClass.GetTransactionByOffsetRequest, UpdateServiceOuterClass.GetTransactionByOffsetRequest.Builder
Enclosing class:
UpdateServiceOuterClass
public static interface UpdateServiceOuterClass.GetTransactionByOffsetRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getOffset

      long getOffset()
       The offset of the transaction being looked up.
 Must be a valid absolute offset (positive integer).
 Required
      int64 offset = 1 [json_name = "offset"];
      Returns:
      The offset.

    • getRequestingPartiesList

      List<String> getRequestingPartiesList()
       Provided for backwards compatibility, it will be removed in the Canton version 3.4.0.
 The parties whose events the client expects to see.
 Events that are not visible for the parties in this collection will not be present in the response.
 Each element must be a valid PartyIdString (as described in ``value.proto``).
 Must be set for GetTransactionTreeByOffset request.
 Optional for backwards compatibility for GetTransactionByOffset request: if defined transaction_format must be
 unset (falling back to defaults).
      repeated string requesting_parties = 2 [json_name = "requestingParties"];
      Returns:
      A list containing the requestingParties.

    • getRequestingPartiesCount

      int getRequestingPartiesCount()
       Provided for backwards compatibility, it will be removed in the Canton version 3.4.0.
 The parties whose events the client expects to see.
 Events that are not visible for the parties in this collection will not be present in the response.
 Each element must be a valid PartyIdString (as described in ``value.proto``).
 Must be set for GetTransactionTreeByOffset request.
 Optional for backwards compatibility for GetTransactionByOffset request: if defined transaction_format must be
 unset (falling back to defaults).
      repeated string requesting_parties = 2 [json_name = "requestingParties"];
      Returns:
      The count of requestingParties.

    • getRequestingParties

      String getRequestingParties(int index)
       Provided for backwards compatibility, it will be removed in the Canton version 3.4.0.
 The parties whose events the client expects to see.
 Events that are not visible for the parties in this collection will not be present in the response.
 Each element must be a valid PartyIdString (as described in ``value.proto``).
 Must be set for GetTransactionTreeByOffset request.
 Optional for backwards compatibility for GetTransactionByOffset request: if defined transaction_format must be
 unset (falling back to defaults).
      repeated string requesting_parties = 2 [json_name = "requestingParties"];
      Parameters:
      index - The index of the element to return.
      Returns:
      The requestingParties at the given index.

    • getRequestingPartiesBytes

      com.google.protobuf.ByteString getRequestingPartiesBytes(int index)
       Provided for backwards compatibility, it will be removed in the Canton version 3.4.0.
 The parties whose events the client expects to see.
 Events that are not visible for the parties in this collection will not be present in the response.
 Each element must be a valid PartyIdString (as described in ``value.proto``).
 Must be set for GetTransactionTreeByOffset request.
 Optional for backwards compatibility for GetTransactionByOffset request: if defined transaction_format must be
 unset (falling back to defaults).
      repeated string requesting_parties = 2 [json_name = "requestingParties"];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the requestingParties at the given index.

    • hasTransactionFormat

      boolean hasTransactionFormat()
       Must be unset for GetTransactionTreeByOffset request.
 Optional for GetTransactionByOffset request for backwards compatibility: defaults to a TransactionFormat, where:

 - event_format.filters_by_party will have template-wildcard filters for all the requesting_parties
 - event_format.filters_for_any_party is unset
 - event_format.verbose = true
 - transaction_shape = TRANSACTION_SHAPE_ACS_DELTA
      .com.daml.ledger.api.v2.TransactionFormat transaction_format = 3 [json_name = "transactionFormat"];
      Returns:
      Whether the transactionFormat field is set.

    • getTransactionFormat

      TransactionFilterOuterClass.TransactionFormat getTransactionFormat()
       Must be unset for GetTransactionTreeByOffset request.
 Optional for GetTransactionByOffset request for backwards compatibility: defaults to a TransactionFormat, where:

 - event_format.filters_by_party will have template-wildcard filters for all the requesting_parties
 - event_format.filters_for_any_party is unset
 - event_format.verbose = true
 - transaction_shape = TRANSACTION_SHAPE_ACS_DELTA
      .com.daml.ledger.api.v2.TransactionFormat transaction_format = 3 [json_name = "transactionFormat"];
      Returns:
      The transactionFormat.

    • getTransactionFormatOrBuilder

      TransactionFilterOuterClass.TransactionFormatOrBuilder getTransactionFormatOrBuilder()
       Must be unset for GetTransactionTreeByOffset request.
 Optional for GetTransactionByOffset request for backwards compatibility: defaults to a TransactionFormat, where:

 - event_format.filters_by_party will have template-wildcard filters for all the requesting_parties
 - event_format.filters_for_any_party is unset
 - event_format.verbose = true
 - transaction_shape = TRANSACTION_SHAPE_ACS_DELTA
      .com.daml.ledger.api.v2.TransactionFormat transaction_format = 3 [json_name = "transactionFormat"];