com.daml.ledger.api.v1

Class CommandCompletionServiceGrpc.CommandCompletionServiceStub

java.lang.Object

io.grpc.stub.AbstractStub<CommandCompletionServiceGrpc.CommandCompletionServiceStub>

com.daml.ledger.api.v1.CommandCompletionServiceGrpc.CommandCompletionServiceStub

Enclosing class:

CommandCompletionServiceGrpc

public static final class CommandCompletionServiceGrpc.CommandCompletionServiceStub
extends io.grpc.stub.AbstractStub<CommandCompletionServiceGrpc.CommandCompletionServiceStub>

 Allows clients to observe the status of their submissions.
 Commands may be submitted via the Command Submission Service.
 The on-ledger effects of their submissions are disclosed by the Transaction Service.
 Commands may fail in 2 distinct manners:
 1. Failure communicated in the gRPC error of the submission.
 2. Failure communicated in a Completion.
 Only successfully submitted commands may produce a completion event.
 Clients that do not receive a successful completion about their submission MUST NOT assume that it was successful.
 Clients SHOULD subscribe to the CompletionStream before starting to submit commands to prevent race conditions.
 Interprocess tracing of command submissions may be achieved via Zipkin by filling out the ``trace_context`` field.
 The server will return a child context of the submitted one, (or a new one if the context was missing) on both the Completion and Transaction streams.
 

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 CommandCompletionServiceGrpc.CommandCompletionServiceStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
void	completionEnd(CommandCompletionServiceOuterClass.CompletionEndRequest request, io.grpc.stub.StreamObserver<CommandCompletionServiceOuterClass.CompletionEndResponse> responseObserver) Returns the offset after the latest completion.
void	completionStream(CommandCompletionServiceOuterClass.CompletionStreamRequest request, io.grpc.stub.StreamObserver<CommandCompletionServiceOuterClass.CompletionStreamResponse> responseObserver) Subscribe to command completion events.

Methods inherited from class io.grpc.stub.AbstractStub

getCallOptions, getChannel, newStub, newStub, 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 CommandCompletionServiceGrpc.CommandCompletionServiceStub build(io.grpc.Channel channel,
                                                                          io.grpc.CallOptions callOptions)

Specified by:

build in class io.grpc.stub.AbstractStub<CommandCompletionServiceGrpc.CommandCompletionServiceStub>

completionStream

public void completionStream(CommandCompletionServiceOuterClass.CompletionStreamRequest request,
                             io.grpc.stub.StreamObserver<CommandCompletionServiceOuterClass.CompletionStreamResponse> responseObserver)

 Subscribe to command completion events.
 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
 - ``OUT_OF_RANGE``: if the absolute offset is not before the end of the ledger
 

completionEnd

public void completionEnd(CommandCompletionServiceOuterClass.CompletionEndRequest request,
                          io.grpc.stub.StreamObserver<CommandCompletionServiceOuterClass.CompletionEndResponse> responseObserver)

 Returns the offset after the latest completion.
 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