Package com.daml.ledger.api.v1

Class TransactionServiceGrpc.TransactionServiceImplBase

  • All Implemented Interfaces:
    io.grpc.BindableService
    Enclosing class:
    TransactionServiceGrpc
    public abstract static class TransactionServiceGrpc.TransactionServiceImplBase
extends java.lang.Object
implements io.grpc.BindableService
     Allows clients to read transactions from the ledger.

    • Constructor Detail

      • TransactionServiceImplBase

        public TransactionServiceImplBase()

    • Method Detail

      • getTransactions

        public void getTransactions​(TransactionServiceOuterClass.GetTransactionsRequest request,
                            io.grpc.stub.StreamObserver<TransactionServiceOuterClass.GetTransactionsResponse> responseObserver)
         Read the ledger's filtered transaction stream for a set of parties.
 Lists only creates and archives, but not other events.
 Omits all events on transient contracts, i.e., contracts that were both created and archived in the same transaction.
 Errors:
 - ``UNAUTHENTICATED``: if the request does not include a valid access token
 - ``PERMISSION_DENIED``: if the claims in the token are insufficient to perform a given operation
 - ``NOT_FOUND``: if the request does not include a valid ledger id
 - ``INVALID_ARGUMENT``: if the payload is malformed or is missing required fields (e.g. if ``before`` is not before ``end``)
 - ``FAILED_PRECONDITION``: if the ledger has been pruned after the subscription start offset
 - ``OUT_OF_RANGE``: if the ``begin`` parameter value is not before the end of the ledger

      • getTransactionTrees

        public void getTransactionTrees​(TransactionServiceOuterClass.GetTransactionsRequest request,
                                io.grpc.stub.StreamObserver<TransactionServiceOuterClass.GetTransactionTreesResponse> responseObserver)
         Read the ledger's complete transaction tree stream for a set of parties.
 The stream can be filtered only by parties, but not templates (template filter must be empty).
 Errors:
 - ``UNAUTHENTICATED``: if the request does not include a valid access token
 - ``PERMISSION_DENIED``: if the claims in the token are insufficient to perform a given operation
 - ``NOT_FOUND``: if the request does not include a valid ledger id
 - ``INVALID_ARGUMENT``: if the payload is malformed or is missing required fields (e.g. if ``before`` is not before ``end``)
 - ``FAILED_PRECONDITION``: if the ledger has been pruned after the subscription start offset
 - ``OUT_OF_RANGE``: if the ``begin`` parameter value is not before the end of the ledger

      • getTransactionByEventId

        public void getTransactionByEventId​(TransactionServiceOuterClass.GetTransactionByEventIdRequest request,
                                    io.grpc.stub.StreamObserver<TransactionServiceOuterClass.GetTransactionResponse> responseObserver)
         Lookup a transaction tree by the ID of an event that appears within it.
 For looking up a transaction instead of a transaction tree, please see GetFlatTransactionByEventId
 Errors:
 - ``UNAUTHENTICATED``: if the request does not include a valid access token
 - ``PERMISSION_DENIED``: if the claims in the token are insufficient to perform a given operation
 - ``NOT_FOUND``: if the request does not include a valid ledger id or no such transaction exists
 - ``INVALID_ARGUMENT``: if the payload is malformed or is missing required fields (e.g. if requesting parties are invalid or empty)

      • getTransactionById

        public void getTransactionById​(TransactionServiceOuterClass.GetTransactionByIdRequest request,
                               io.grpc.stub.StreamObserver<TransactionServiceOuterClass.GetTransactionResponse> responseObserver)
         Lookup a transaction tree by its ID.
 For looking up a transaction instead of a transaction tree, please see GetFlatTransactionById
 Errors:
 - ``UNAUTHENTICATED``: if the request does not include a valid access token
 - ``PERMISSION_DENIED``: if the claims in the token are insufficient to perform a given operation
 - ``NOT_FOUND``: if the request does not include a valid ledger id or no such transaction exists
 - ``INVALID_ARGUMENT``: if the payload is malformed or is missing required fields (e.g. if requesting parties are invalid or empty)

      • getFlatTransactionByEventId

        public void getFlatTransactionByEventId​(TransactionServiceOuterClass.GetTransactionByEventIdRequest request,
                                        io.grpc.stub.StreamObserver<TransactionServiceOuterClass.GetFlatTransactionResponse> responseObserver)
         Lookup a transaction by the ID of an event that appears within it.
 Errors:
 - ``UNAUTHENTICATED``: if the request does not include a valid access token
 - ``PERMISSION_DENIED``: if the claims in the token are insufficient to perform a given operation
 - ``NOT_FOUND``: if the request does not include a valid ledger id or no such transaction exists
 - ``INVALID_ARGUMENT``: if the payload is malformed or is missing required fields (e.g. if requesting parties are invalid or empty)

      • getFlatTransactionById

        public void getFlatTransactionById​(TransactionServiceOuterClass.GetTransactionByIdRequest request,
                                   io.grpc.stub.StreamObserver<TransactionServiceOuterClass.GetFlatTransactionResponse> responseObserver)
         Lookup a transaction by its ID.
 Errors:
 - ``UNAUTHENTICATED``: if the request does not include a valid access token
 - ``PERMISSION_DENIED``: if the claims in the token are insufficient to perform a given operation
 - ``NOT_FOUND``: if the request does not include a valid ledger id or no such transaction exists
 - ``INVALID_ARGUMENT``: if the payload is malformed or is missing required fields (e.g. if requesting parties are invalid or empty)

      • getLedgerEnd

        public void getLedgerEnd​(TransactionServiceOuterClass.GetLedgerEndRequest request,
                         io.grpc.stub.StreamObserver<TransactionServiceOuterClass.GetLedgerEndResponse> responseObserver)
         Get the current ledger end.
 Subscriptions started with the returned offset will serve transactions created after this RPC was called.
 Errors:
 - ``UNAUTHENTICATED``: if the request does not include a valid access token
 - ``PERMISSION_DENIED``: if the claims in the token are insufficient to perform a given operation
 - ``NOT_FOUND``: if the request does not include a valid ledger id

      • bindService

        public final io.grpc.ServerServiceDefinition bindService()
        Specified by:
        bindService in interface io.grpc.BindableService