Class CommandServiceGrpc.CommandServiceFutureStub

  • Enclosing class:
    CommandServiceGrpc

    public static final class CommandServiceGrpc.CommandServiceFutureStub
    extends io.grpc.stub.AbstractFutureStub<CommandServiceGrpc.CommandServiceFutureStub>
     Command Service is able to correlate submitted commands with completion data, identify timeouts, and return contextual
     information with each tracking result. This supports the implementation of stateless clients.
     Note that submitted commands generally produce completion events as well, even in case a command gets rejected.
     For example, the participant MAY choose to produce a completion event for a rejection of a duplicate command.
     
    • Method Detail

      • submitAndWait

        public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> submitAndWait​(CommandServiceOuterClass.SubmitAndWaitRequest request)
         Submits a single composite command and waits for its result.
         Propagates the gRPC error of failed submissions including Daml interpretation errors.
         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.
         - ``DEADLINE_EXCEEDED``: if the request failed to receive its completion within the predefined timeout.
         
      • submitAndWaitForTransactionId

        public com.google.common.util.concurrent.ListenableFuture<CommandServiceOuterClass.SubmitAndWaitForTransactionIdResponse> submitAndWaitForTransactionId​(CommandServiceOuterClass.SubmitAndWaitRequest request)
         Submits a single composite command, waits for its result, and returns the transaction id.
         Propagates the gRPC error of failed submissions including Daml interpretation errors.
         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.
         - ``DEADLINE_EXCEEDED``: if the request failed to receive its completion within the predefined timeout.
         
      • submitAndWaitForTransaction

        public com.google.common.util.concurrent.ListenableFuture<CommandServiceOuterClass.SubmitAndWaitForTransactionResponse> submitAndWaitForTransaction​(CommandServiceOuterClass.SubmitAndWaitRequest request)
         Submits a single composite command, waits for its result, and returns the transaction.
         Propagates the gRPC error of failed submissions including Daml interpretation errors.
         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.
         - ``DEADLINE_EXCEEDED``: if the request failed to receive its completion within the predefined timeout.
         
      • submitAndWaitForTransactionTree

        public com.google.common.util.concurrent.ListenableFuture<CommandServiceOuterClass.SubmitAndWaitForTransactionTreeResponse> submitAndWaitForTransactionTree​(CommandServiceOuterClass.SubmitAndWaitRequest request)
         Submits a single composite command, waits for its result, and returns the transaction tree.
         Propagates the gRPC error of failed submissions including Daml interpretation errors.
         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.
         - ``DEADLINE_EXCEEDED``: if the request failed to receive its completion within the predefined timeout.