com.daml.ledger.api.v1

Class TransactionServiceGrpc.TransactionServiceBlockingStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractBlockingStub<TransactionServiceGrpc.TransactionServiceBlockingStub>

com.daml.ledger.api.v1.TransactionServiceGrpc.TransactionServiceBlockingStub

Enclosing class:

TransactionServiceGrpc

public static final class TransactionServiceGrpc.TransactionServiceBlockingStub
extends io.grpc.stub.AbstractBlockingStub<TransactionServiceGrpc.TransactionServiceBlockingStub>

 Allows clients to read transactions from the ledger.
 

Nested Class Summary

Nested classes/interfaces inherited from class io.grpc.stub.AbstractStub

io.grpc.stub.AbstractStub.StubFactory<T extends io.grpc.stub.AbstractStub<T>>

Method Summary

Modifier and Type	Method and Description
protected TransactionServiceGrpc.TransactionServiceBlockingStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
TransactionServiceOuterClass.GetFlatTransactionResponse	getFlatTransactionByEventId(TransactionServiceOuterClass.GetTransactionByEventIdRequest request) Lookup a transaction by the ID of an event that appears within it.
TransactionServiceOuterClass.GetFlatTransactionResponse	getFlatTransactionById(TransactionServiceOuterClass.GetTransactionByIdRequest request) Lookup a transaction by its ID.
TransactionServiceOuterClass.GetLedgerEndResponse	getLedgerEnd(TransactionServiceOuterClass.GetLedgerEndRequest request) Get the current ledger end.
TransactionServiceOuterClass.GetTransactionResponse	getTransactionByEventId(TransactionServiceOuterClass.GetTransactionByEventIdRequest request) Lookup a transaction tree by the ID of an event that appears within it.
TransactionServiceOuterClass.GetTransactionResponse	getTransactionById(TransactionServiceOuterClass.GetTransactionByIdRequest request) Lookup a transaction tree by its ID.
java.util.Iterator<TransactionServiceOuterClass.GetTransactionsResponse>	getTransactions(TransactionServiceOuterClass.GetTransactionsRequest request) Read the ledger's filtered transaction stream for a set of parties.
java.util.Iterator<TransactionServiceOuterClass.GetTransactionTreesResponse>	getTransactionTrees(TransactionServiceOuterClass.GetTransactionsRequest request) Read the ledger's complete transaction tree stream for a set of parties.

Methods inherited from class io.grpc.stub.AbstractBlockingStub

newStub, newStub

Methods inherited from class io.grpc.stub.AbstractStub

getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOption, withWaitForReady

Methods inherited from class java.lang.Object

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

Method Detail

build

protected TransactionServiceGrpc.TransactionServiceBlockingStub build(io.grpc.Channel channel,
                                                                      io.grpc.CallOptions callOptions)

Specified by:

build in class io.grpc.stub.AbstractStub<TransactionServiceGrpc.TransactionServiceBlockingStub>

getTransactions

public java.util.Iterator<TransactionServiceOuterClass.GetTransactionsResponse> getTransactions(TransactionServiceOuterClass.GetTransactionsRequest request)

 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 or if the ledger has been pruned before ``begin``
 - ``INVALID_ARGUMENT``: if the payload is malformed or is missing required fields (e.g. if ``before`` is not before ``end``)
 - ``OUT_OF_RANGE``: if the ``begin`` parameter value is not before the end of the ledger
 

getTransactionTrees

public java.util.Iterator<TransactionServiceOuterClass.GetTransactionTreesResponse> getTransactionTrees(TransactionServiceOuterClass.GetTransactionsRequest request)

 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 or if the ledger has been pruned before ``begin``
 - ``INVALID_ARGUMENT``: if the payload is malformed or is missing required fields (e.g. if ``before`` is not before ``end``)
 - ``OUT_OF_RANGE``: if the ``begin`` parameter value is not before the end of the ledger
 

getTransactionByEventId

public TransactionServiceOuterClass.GetTransactionResponse getTransactionByEventId(TransactionServiceOuterClass.GetTransactionByEventIdRequest request)

 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 TransactionServiceOuterClass.GetTransactionResponse getTransactionById(TransactionServiceOuterClass.GetTransactionByIdRequest request)

 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 TransactionServiceOuterClass.GetFlatTransactionResponse getFlatTransactionByEventId(TransactionServiceOuterClass.GetTransactionByEventIdRequest request)

 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 TransactionServiceOuterClass.GetFlatTransactionResponse getFlatTransactionById(TransactionServiceOuterClass.GetTransactionByIdRequest request)

 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 TransactionServiceOuterClass.GetLedgerEndResponse getLedgerEnd(TransactionServiceOuterClass.GetLedgerEndRequest request)

 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 or no such transaction exists