lib/zeebe/client/proto/gateway_services_pb.rb in zeebe-client-0.8.0 vs lib/zeebe/client/proto/gateway_services_pb.rb in zeebe-client-0.9.0
- old
+ new
@@ -64,10 +64,13 @@
# INVALID_ARGUMENT:
# - the given variables argument is not a valid JSON document; it is expected to be a valid
# JSON document where the root node is an object.
rpc :CreateWorkflowInstance, CreateWorkflowInstanceRequest, CreateWorkflowInstanceResponse
#
+ # Behaves similarly to `rpc CreateWorkflowInstance`, except that a successful response is received when the workflow completes successfully.
+ rpc :CreateWorkflowInstanceWithResult, CreateWorkflowInstanceWithResultRequest, CreateWorkflowInstanceWithResultResponse
+ #
# Deploys one or more workflows to Zeebe. Note that this is an atomic call,
# i.e. either all workflows are deployed, or none of them are.
#
# Errors:
# INVALID_ARGUMENT:
@@ -89,9 +92,19 @@
#
# FAILED_PRECONDITION:
# - the job was not activated
# - the job is already in a failed state, i.e. ran out of retries
rpc :FailJob, FailJobRequest, FailJobResponse
+ #
+ # Reports a business error (i.e. non-technical) that occurs while processing a job. The error is handled in the workflow by an error catch event. If there is no error catch event with the specified errorCode then an incident will be raised instead.
+ #
+ # Errors:
+ # NOT_FOUND:
+ # - no job was found with the given key
+ #
+ # FAILED_PRECONDITION:
+ # - the job is not in an activated state
+ rpc :ThrowError, ThrowErrorRequest, ThrowErrorResponse
#
# Publishes a single message. Messages are published to specific partitions computed from their
# correlation keys.
#
# Errors: