Package com.daml.ledger.api.v2

Class UpdateServiceGrpc.UpdateServiceBlockingStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractBlockingStub<UpdateServiceGrpc.UpdateServiceBlockingStub>

com.daml.ledger.api.v2.UpdateServiceGrpc.UpdateServiceBlockingStub

Enclosing class:

UpdateServiceGrpc

public static final class UpdateServiceGrpc.UpdateServiceBlockingStub
extends io.grpc.stub.AbstractBlockingStub<UpdateServiceGrpc.UpdateServiceBlockingStub>

A stub to allow clients to do synchronous rpc calls to service UpdateService.

 Allows clients to read updates (transactions, (un)assignments, topology events) from the ledger.
 ``GetUpdates`` and ``GetUpdateTrees`` provide a comprehensive stream of updates/changes
 which happened on the virtual shared ledger. These streams are indexed with ledger
 offsets, which are strictly increasing.
 The virtual shared ledger consist of changes happening on multiple synchronizers which are
 connected to the serving participant. Each update belongs to one synchronizer, this is
 provided in the result (the ``synchronizer_id`` field in ``Transaction`` and ``TransactionTree``
 for transactions, the ``source`` field in ``UnassignedEvent`` and the ``target`` field in ``AssignedEvent``).
 Consumers can rely on strong causal guarantees on the virtual shared ledger for a single
 synchronizer: updates which have greater offsets are happened after than updates with smaller
 offsets for the same synchronizer. Across different synchronizers this is not guaranteed.
 

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	Description
protected UpdateServiceGrpc.UpdateServiceBlockingStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
UpdateServiceOuterClass.GetTransactionResponse	getTransactionById(UpdateServiceOuterClass.GetTransactionByIdRequest request)	Provided for backwards compatibility, it will be removed in the Canton version 3.4.0.
UpdateServiceOuterClass.GetTransactionResponse	getTransactionByOffset(UpdateServiceOuterClass.GetTransactionByOffsetRequest request)	Provided for backwards compatibility, it will be removed in the Canton version 3.4.0.
UpdateServiceOuterClass.GetTransactionTreeResponse	getTransactionTreeById(UpdateServiceOuterClass.GetTransactionByIdRequest request)	Provided for backwards compatibility, it will be removed in the Canton version 3.4.0.
UpdateServiceOuterClass.GetTransactionTreeResponse	getTransactionTreeByOffset(UpdateServiceOuterClass.GetTransactionByOffsetRequest request)	Provided for backwards compatibility, it will be removed in the Canton version 3.4.0.
UpdateServiceOuterClass.GetUpdateResponse	getUpdateById(UpdateServiceOuterClass.GetUpdateByIdRequest request)	Lookup an update by its ID.
UpdateServiceOuterClass.GetUpdateResponse	getUpdateByOffset(UpdateServiceOuterClass.GetUpdateByOffsetRequest request)	Lookup an update by its offset.
Iterator<UpdateServiceOuterClass.GetUpdatesResponse>	getUpdates(UpdateServiceOuterClass.GetUpdatesRequest request)	Read the ledger's filtered update stream for the specified contents and filters.
Iterator<UpdateServiceOuterClass.GetUpdateTreesResponse>	getUpdateTrees(UpdateServiceOuterClass.GetUpdatesRequest request)	Provided for backwards compatibility, it will be removed in the Canton version 3.4.0.

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, withOnReadyThreshold, withOption, withWaitForReady

Methods inherited from class java.lang.Object

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

Method Details

build

protected UpdateServiceGrpc.UpdateServiceBlockingStub build(io.grpc.Channel channel,
 io.grpc.CallOptions callOptions)

Specified by:

build in class io.grpc.stub.AbstractStub<UpdateServiceGrpc.UpdateServiceBlockingStub>

getUpdates

public Iterator<UpdateServiceOuterClass.GetUpdatesResponse> getUpdates(UpdateServiceOuterClass.GetUpdatesRequest request)

 Read the ledger's filtered update stream for the specified contents and filters.
 It returns the event types in accordance with the stream contents selected. Also the selection criteria
 for individual events depends on the transaction shape chosen.
 - ACS delta: a requesting party must be a stakeholder of an event for it to be included.
 - ledger effects: a requesting party must be a witness of an en event for it to be included.
 

getUpdateTrees

public Iterator<UpdateServiceOuterClass.GetUpdateTreesResponse> getUpdateTrees(UpdateServiceOuterClass.GetUpdatesRequest request)

 Provided for backwards compatibility, it will be removed in the Canton version 3.4.0.
 Read the ledger's complete transaction tree stream and related (un)assignments for a set of parties.
 The stream will be filtered only by the parties as wildcard parties.
 The template/interface filters describe the respective fields in the ``CreatedEvent`` results.
 

getTransactionTreeByOffset

public UpdateServiceOuterClass.GetTransactionTreeResponse getTransactionTreeByOffset(UpdateServiceOuterClass.GetTransactionByOffsetRequest request)

 Provided for backwards compatibility, it will be removed in the Canton version 3.4.0.
 Lookup a transaction tree by its offset.
 For looking up a transaction instead of a transaction tree, please see GetTransactionByEventId
 If the transaction cannot be found for the request, or all the events are filtered, a TRANSACTION_NOT_FOUND error will be raised.
 

getTransactionTreeById

public UpdateServiceOuterClass.GetTransactionTreeResponse getTransactionTreeById(UpdateServiceOuterClass.GetTransactionByIdRequest request)

 Provided for backwards compatibility, it will be removed in the Canton version 3.4.0.
 Lookup a transaction tree by its ID.
 For looking up a transaction instead of a transaction tree, please see GetTransactionById
 If the transaction cannot be found for the request, or all the events are filtered, a TRANSACTION_NOT_FOUND error will be raised.
 

getTransactionByOffset

public UpdateServiceOuterClass.GetTransactionResponse getTransactionByOffset(UpdateServiceOuterClass.GetTransactionByOffsetRequest request)

 Provided for backwards compatibility, it will be removed in the Canton version 3.4.0.
 Lookup a transaction by its offset.
 If there is no transaction with this offset, or all the events are filtered, a TRANSACTION_NOT_FOUND error will be raised.
 Use a wildcard template filter if you want to retrieve any transaction visible to the parties you can read as.
 

getTransactionById

public UpdateServiceOuterClass.GetTransactionResponse getTransactionById(UpdateServiceOuterClass.GetTransactionByIdRequest request)

 Provided for backwards compatibility, it will be removed in the Canton version 3.4.0.
 Lookup a transaction by its ID.
 If there is no transaction with this id, or all the events are filtered, a TRANSACTION_NOT_FOUND error will be raised.
 Use a wildcard template filter if you want to retrieve any transaction visible to the parties you can read as.
 

getUpdateByOffset

public UpdateServiceOuterClass.GetUpdateResponse getUpdateByOffset(UpdateServiceOuterClass.GetUpdateByOffsetRequest request)

 Lookup an update by its offset.
 If there is no update with this offset, or all the events are filtered, an UPDATE_NOT_FOUND error will be raised.
 

getUpdateById

public UpdateServiceOuterClass.GetUpdateResponse getUpdateById(UpdateServiceOuterClass.GetUpdateByIdRequest request)

 Lookup an update by its ID.
 If there is no update with this ID, or all the events are filtered, an UPDATE_NOT_FOUND error will be raised.