Package io.camunda.zeebe.gateway.protocol

Class GatewayGrpc.GatewayBlockingStub

java.lang.Object
io.grpc.stub.AbstractStub<S>
io.grpc.stub.AbstractBlockingStub<GatewayGrpc.GatewayBlockingStub>
io.camunda.zeebe.gateway.protocol.GatewayGrpc.GatewayBlockingStub
Enclosing class:
GatewayGrpc
public static final class GatewayGrpc.GatewayBlockingStub extends io.grpc.stub.AbstractBlockingStub<GatewayGrpc.GatewayBlockingStub>

  • Method Details

    • build

      protected GatewayGrpc.GatewayBlockingStub build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
      Specified by:
      build in class io.grpc.stub.AbstractStub<GatewayGrpc.GatewayBlockingStub>

    • activateJobs

      public Iterator<GatewayOuterClass.ActivateJobsResponse> activateJobs(GatewayOuterClass.ActivateJobsRequest request)
      Iterates through all known partitions round-robin and activates up to the requested
maximum and streams them back to the client as they are activated.
Errors:
INVALID_ARGUMENT:
- type is blank (empty string, null)
- worker is blank (empty string, null)
- timeout less than 1
- maxJobsToActivate is less than 1

    • cancelProcessInstance

      public GatewayOuterClass.CancelProcessInstanceResponse cancelProcessInstance(GatewayOuterClass.CancelProcessInstanceRequest request)
      Cancels a running process instance
Errors:
NOT_FOUND:
- no process instance exists with the given key

    • completeJob

      public GatewayOuterClass.CompleteJobResponse completeJob(GatewayOuterClass.CompleteJobRequest request)
      Completes a job with the given variables, which allows completing the associated service task.
Errors:
NOT_FOUND:
- no job exists with the given job key. Note that since jobs are removed once completed,
it could be that this job did exist at some point.
FAILED_PRECONDITION:
- the job was marked as failed. In that case, the related incident must be resolved before
the job can be activated again and completed.

    • createProcessInstance

      public GatewayOuterClass.CreateProcessInstanceResponse createProcessInstance(GatewayOuterClass.CreateProcessInstanceRequest request)
      Creates and starts an instance of the specified process. The process definition to use to
create the instance can be specified either using its unique key (as returned by
DeployProcess), or using the BPMN process ID and a version. Pass -1 as the version to use the
latest deployed version. Note that only processes with none start events can be started through
this command.
Errors:
NOT_FOUND:
- no process with the given key exists (if processDefinitionKey was given)
- no process with the given process ID exists (if bpmnProcessId was given but version was -1)
- no process with the given process ID and version exists (if both bpmnProcessId and version were given)
FAILED_PRECONDITION:
- the process definition does not contain a none start event; only processes with none
start event can be started manually.
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.

    • createProcessInstanceWithResult

      public GatewayOuterClass.CreateProcessInstanceWithResultResponse createProcessInstanceWithResult(GatewayOuterClass.CreateProcessInstanceWithResultRequest request)
      Behaves similarly to `rpc CreateProcessInstance`, except that a successful response is received when the process completes successfully.

    • deployProcess

      @Deprecated public GatewayOuterClass.DeployProcessResponse deployProcess(GatewayOuterClass.DeployProcessRequest request)
      Deprecated.
      Deploys one or more processes to Zeebe. Note that this is an atomic call,
i.e. either all processes are deployed, or none of them are.
Errors:
INVALID_ARGUMENT:
- no resources given.
- if at least one resource is invalid. A resource is considered invalid if:
- the resource data is not deserializable (e.g. detected as BPMN, but it's broken XML)
- the process is invalid (e.g. an event-based gateway has an outgoing sequence flow to a task)

    • deployResource

      public GatewayOuterClass.DeployResourceResponse deployResource(GatewayOuterClass.DeployResourceRequest request)
      Deploys one or more resources (e.g. processes or decision models) to Zeebe.
Note that this is an atomic call, i.e. either all resources are deployed, or none of them are.
Errors:
INVALID_ARGUMENT:
- no resources given.
- if at least one resource is invalid. A resource is considered invalid if:
- the content is not deserializable (e.g. detected as BPMN, but it's broken XML)
- the content is invalid (e.g. an event-based gateway has an outgoing sequence flow to a task)

    • failJob

      public GatewayOuterClass.FailJobResponse failJob(GatewayOuterClass.FailJobRequest request)
      Marks the job as failed; if the retries argument is positive, then the job will be immediately
activatable again, and a worker could try again to process it. If it is zero or negative however,
an incident will be raised, tagged with the given errorMessage, and the job will not be
activatable until the incident is resolved.
Errors:
NOT_FOUND:
- no job was found with the given key
FAILED_PRECONDITION:
- the job was not activated
- the job is already in a failed state, i.e. ran out of retries

    • throwError

      public GatewayOuterClass.ThrowErrorResponse throwError(GatewayOuterClass.ThrowErrorRequest request)
      Reports a business error (i.e. non-technical) that occurs while processing a job. The error is handled in the process 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

    • publishMessage

      public GatewayOuterClass.PublishMessageResponse publishMessage(GatewayOuterClass.PublishMessageRequest request)
      Publishes a single message. Messages are published to specific partitions computed from their
correlation keys.
Errors:
ALREADY_EXISTS:
- a message with the same ID was previously published (and is still alive)

    • resolveIncident

      public GatewayOuterClass.ResolveIncidentResponse resolveIncident(GatewayOuterClass.ResolveIncidentRequest request)
      Resolves a given incident. This simply marks the incident as resolved; most likely a call to
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

    • setVariables

      public GatewayOuterClass.SetVariablesResponse setVariables(GatewayOuterClass.SetVariablesRequest request)
      Updates all the variables of a particular scope (e.g. process 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.

    • topology

      public GatewayOuterClass.TopologyResponse topology(GatewayOuterClass.TopologyRequest request)
      Obtains the current topology of the cluster the gateway is part of.

    • updateJobRetries

      public GatewayOuterClass.UpdateJobRetriesResponse updateJobRetries(GatewayOuterClass.UpdateJobRetriesRequest request)
      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.
Errors:
NOT_FOUND:
- no job exists with the given key
INVALID_ARGUMENT:
- retries is not greater than 0