Class CommandSubmissionServiceGrpc.CommandSubmissionServiceBlockingStub

  • Enclosing class:
    CommandSubmissionServiceGrpc

    public static final class CommandSubmissionServiceGrpc.CommandSubmissionServiceBlockingStub
    extends io.grpc.stub.AbstractBlockingStub<CommandSubmissionServiceGrpc.CommandSubmissionServiceBlockingStub>
     Allows clients to attempt advancing the ledger's state by submitting commands.
     The final states of their submissions are disclosed by the Command Completion Service.
     The on-ledger effects of their submissions are disclosed by the Transaction Service.
     Commands may fail in 2 distinct manners:
     1. Failure communicated synchronously in the gRPC error of the submission.
     2. Failure communicated asynchronously in a Completion, see ``completion.proto``.
     Note that not only successfully submitted commands MAY produce a completion event. For example, the participant MAY
     choose to produce a completion event for a rejection of a duplicate command.
     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.
     
    • 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

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected CommandSubmissionServiceGrpc.CommandSubmissionServiceBlockingStub build​(io.grpc.Channel channel, io.grpc.CallOptions callOptions)  
      com.google.protobuf.Empty submit​(CommandSubmissionServiceOuterClass.SubmitRequest request)
      Submit a single composite command.
      • 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

      • submit

        public com.google.protobuf.Empty submit​(CommandSubmissionServiceOuterClass.SubmitRequest request)
         Submit a single composite command.
         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 a resource is missing (e.g. contract key)
         due to for example contention on resources
         - ``ALREADY_EXISTS`` if a resource is duplicated (e.g. contract key)
         - ``INVALID_ARGUMENT``: if the payload is malformed or is missing required fields
         - ``ABORTED``: if the number of in-flight commands reached the maximum (if a limit is configured)
         - ``FAILED_PRECONDITION``: on consistency errors (e.g. the contract key has changed since the submission)
         or if an interpretation error occurred
         - ``UNAVAILABLE``: if the participant is not yet ready to submit commands or if the service has been shut down.