lib/zeebe/client/proto/gateway_services_pb.rb in zeebe-client-0.3.0 vs lib/zeebe/client/proto/gateway_services_pb.rb in zeebe-client-0.4.0
- old
+ new
@@ -60,12 +60,12 @@
# FAILED_PRECONDITION:
# - the workflow definition does not contain a none start event; only workflows with none
# start event can be started manually.
#
# INVALID_ARGUMENT:
- # - the given payload is not a valid JSON document; all payloads are expected to be
- # valid JSON documents where the root node is an object.
+ # - 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
#
# 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.
#
@@ -117,18 +117,29 @@
# ALREADY_EXISTS:
# - a message with the same ID was previously published (and is still alive)
rpc :PublishMessage, PublishMessageRequest, PublishMessageResponse
#
# Resolves a given incident. This simply marks the incident as resolved; most likely a call to
- # UpdateJobRetries or UpdateWorkflowInstancePayload will be necessary to actually resolve the
+ # UpdateJobRetries or SetVariables will be necessary to actually resolve the
# problem, following by this call.
#
# Errors:
# NOT_FOUND:
# - no incident with the given key exists
rpc :ResolveIncident, ResolveIncidentRequest, ResolveIncidentResponse
#
+ # Updates all the variables of a particular scope (e.g. workflow instance, flow element instance)
+ # from the given JSON document.
+ #
+ # Errors:
+ # NOT_FOUND:
+ # - no element with the given elementInstanceKey exists
+ # INVALID_ARGUMENT:
+ # - the given variables document is not a valid JSON document; valid documents are expected to
+ # be JSON documents where the root node is an object.
+ rpc :SetVariables, SetVariablesRequest, SetVariablesResponse
+ #
# Obtains the current topology of the cluster the gateway is part of.
rpc :Topology, TopologyRequest, TopologyResponse
#
# Updates the number of retries a job has left. This is mostly useful for jobs that have run out of
# retries, should the underlying problem be solved.
@@ -138,19 +149,9 @@
# - no job exists with the given key
#
# INVALID_ARGUMENT:
# - retries is not greater than 0
rpc :UpdateJobRetries, UpdateJobRetriesRequest, UpdateJobRetriesResponse
- #
- # Updates all the variables in the workflow instance scope from the given JSON document.
- #
- # Errors:
- # NOT_FOUND:
- # - no element with the given elementInstanceKey exists
- # INVALID_ARGUMENT:
- # - the given payload is not a valid JSON document; all payloads are expected to be
- # valid JSON documents where the root node is an object.
- rpc :UpdateWorkflowInstancePayload, UpdateWorkflowInstancePayloadRequest, UpdateWorkflowInstancePayloadResponse
end
Stub = Service.rpc_stub_class
end
end