Package com.daml.ledger.api.v2

Class UpdateServiceGrpc.UpdateServiceStub

java.lang.Object

io.grpc.stub.AbstractStub<UpdateServiceGrpc.UpdateServiceStub>

io.grpc.stub.AbstractAsyncStub<UpdateServiceGrpc.UpdateServiceStub>

com.daml.ledger.api.v2.UpdateServiceGrpc.UpdateServiceStub

Enclosing class:

UpdateServiceGrpc

public static final class UpdateServiceGrpc.UpdateServiceStub
extends io.grpc.stub.AbstractAsyncStub<UpdateServiceGrpc.UpdateServiceStub>

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

 Allows clients to read updates (transactions, (un)assignments, topology events) from the ledger.
 ``GetUpdates`` provides 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``
 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.UpdateServiceStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
void	getUpdateById(UpdateServiceOuterClass.GetUpdateByIdRequest request, io.grpc.stub.StreamObserver<UpdateServiceOuterClass.GetUpdateResponse> responseObserver)	Lookup an update by its ID.
void	getUpdateByOffset(UpdateServiceOuterClass.GetUpdateByOffsetRequest request, io.grpc.stub.StreamObserver<UpdateServiceOuterClass.GetUpdateResponse> responseObserver)	Lookup an update by its offset.
void	getUpdates(UpdateServiceOuterClass.GetUpdatesRequest request, io.grpc.stub.StreamObserver<UpdateServiceOuterClass.GetUpdatesResponse> responseObserver)	Read the ledger's filtered update stream for the specified contents and filters.
void	getUpdatesPage(UpdateServiceOuterClass.GetUpdatesPageRequest request, io.grpc.stub.StreamObserver<UpdateServiceOuterClass.GetUpdatesPageResponse> responseObserver)	Read a page of ledger's filtered updates.

Methods inherited from class io.grpc.stub.AbstractAsyncStub

newStub, newStub

Methods inherited from class io.grpc.stub.AbstractStub

getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, 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.UpdateServiceStub build(io.grpc.Channel channel,
 io.grpc.CallOptions callOptions)

Specified by:

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

getUpdates

public void getUpdates(UpdateServiceOuterClass.GetUpdatesRequest request,
 io.grpc.stub.StreamObserver<UpdateServiceOuterClass.GetUpdatesResponse> responseObserver)

 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 event for it to be included.
 

getUpdateByOffset

public void getUpdateByOffset(UpdateServiceOuterClass.GetUpdateByOffsetRequest request,
 io.grpc.stub.StreamObserver<UpdateServiceOuterClass.GetUpdateResponse> responseObserver)

 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 void getUpdateById(UpdateServiceOuterClass.GetUpdateByIdRequest request,
 io.grpc.stub.StreamObserver<UpdateServiceOuterClass.GetUpdateResponse> responseObserver)

 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.
 

getUpdatesPage

public void getUpdatesPage(UpdateServiceOuterClass.GetUpdatesPageRequest request,
 io.grpc.stub.StreamObserver<UpdateServiceOuterClass.GetUpdatesPageResponse> responseObserver)

 Read a page of ledger's filtered updates. It returns the event types in accordance with
 the specified contents and filters.
 Additionally, the selection criteria for individual events depends on the transaction shape chosen.
 - ACS delta: an event is included only if the requesting party is a stakeholder.
 - ledger effects: an event is included if the requesting party is a witness.