ZeebeClientImpl (Zeebe Client Java 0.15.0 API)

java.lang.Object
- io.zeebe.client.impl.ZeebeClientImpl

All Implemented Interfaces:: JobClient, ZeebeClient, AutoCloseable

public class ZeebeClientImpl
extends Object
implements ZeebeClient

Constructor Summary

Constructors
Constructor and Description
`ZeebeClientImpl(ZeebeClientConfiguration configuration)`
`ZeebeClientImpl(ZeebeClientConfiguration configuration, io.grpc.ManagedChannel channel)`
`ZeebeClientImpl(ZeebeClientConfiguration config, io.grpc.ManagedChannel channel, ScheduledExecutorService executorService)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static io.grpc.ManagedChannel`	`buildChannel(ZeebeClientConfiguration config)`
`void`	`close()`
`ZeebeClientConfiguration`	`getConfiguration()`
`ActivateJobsCommandStep1`	`newActivateJobsCommand()` Command to activate multiple jobs of a given type.
`CancelWorkflowInstanceCommandStep1`	`newCancelInstanceCommand(long workflowInstanceKey)` Command to cancel a workflow instance.
`CompleteJobCommandStep1`	`newCompleteCommand(long jobKey)` Command to complete a job.
`CreateWorkflowInstanceCommandStep1`	`newCreateInstanceCommand()` Command to create/start a new instance of a workflow.
`DeployWorkflowCommandStep1`	`newDeployCommand()` Command to deploy new workflows.
`FailJobCommandStep1`	`newFailCommand(long jobKey)` Command to mark a job as failed.
`PublishMessageCommandStep1`	`newPublishMessageCommand()` Command to publish a message which can be correlated to a workflow instance.
`ResolveIncidentCommandStep1`	`newResolveIncidentCommand(long incidentKey)` Command to resolve an existing incident.
`WorkflowResourceRequestStep1`	`newResourceRequest()` Request to get the resource of a workflow (i.e.
`TopologyRequestStep1`	`newTopologyRequest()` Request the current cluster topology.
`UpdatePayloadWorkflowInstanceCommandStep1`	`newUpdatePayloadCommand(long elementInstanceKey)` Command to update the payload of a workflow instance.
`UpdateRetriesJobCommandStep1`	`newUpdateRetriesCommand(long jobKey)` Command to update the retries of a job.
`JobWorkerBuilderStep1`	`newWorker()` Registers a new job worker for jobs of a given type.
`WorkflowRequestStep1`	`newWorkflowRequest()` Request to get all deployed workflows.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.zeebe.client.ZeebeClient
newClient, newClient, newClientBuilder

- Constructor Detail
  - ZeebeClientImpl
```
public ZeebeClientImpl(ZeebeClientConfiguration configuration)
```
  - ZeebeClientImpl
```
public ZeebeClientImpl(ZeebeClientConfiguration configuration,
                       io.grpc.ManagedChannel channel)
```
  - ZeebeClientImpl
```
public ZeebeClientImpl(ZeebeClientConfiguration config,
                       io.grpc.ManagedChannel channel,
                       ScheduledExecutorService executorService)
```
- Method Detail
  - buildChannel
```
public static io.grpc.ManagedChannel buildChannel(ZeebeClientConfiguration config)
```
  - newTopologyRequest
```
public TopologyRequestStep1 newTopologyRequest()
```
    Description copied from interface: ZeebeClient
    Request the current cluster topology. Can be used to inspect which brokers are available at which endpoint and which broker is the leader of which partition.
```
 List<BrokerInfo> brokers = zeebeClient
  .newTopologyRequest()
  .send()
  .join()
  .getBrokers();

  SocketAddress address = broker.getSocketAddress();

  List<PartitionInfo> partitions = broker.getPartitions();
 
```
    Specified by:
    
    newTopologyRequest in interface ZeebeClient
    
    Returns:
    
    the request where you must call send()
  - getConfiguration
```
public ZeebeClientConfiguration getConfiguration()
```
    Specified by:
    
    getConfiguration in interface ZeebeClient
    
    Returns:
    
    the client's configuration
  - close
```
public void close()
```
    Specified by:
    
    close in interface ZeebeClient
    
    Specified by:
    
    close in interface AutoCloseable
  - newDeployCommand
```
public DeployWorkflowCommandStep1 newDeployCommand()
```
    Description copied from interface: ZeebeClient
    Command to deploy new workflows.
```
 zeebeClient
  .newDeployCommand()
  .addResourceFile("~/wf/workflow1.bpmn")
  .addResourceFile("~/wf/workflow2.bpmn")
  .send();
 
```
    Specified by:
    
    newDeployCommand in interface ZeebeClient
    
    Returns:
    
    a builder for the command
  - newCreateInstanceCommand
```
public CreateWorkflowInstanceCommandStep1 newCreateInstanceCommand()
```
    Description copied from interface: ZeebeClient
    Command to create/start a new instance of a workflow.
```
 zeebeClient
  .newCreateInstanceCommand()
  .bpmnProcessId("my-process")
  .latestVersion()
  .payload(json)
  .send();
 
```
    Specified by:
    
    newCreateInstanceCommand in interface ZeebeClient
    
    Returns:
    
    a builder for the command
  - newCancelInstanceCommand
```
public CancelWorkflowInstanceCommandStep1 newCancelInstanceCommand(long workflowInstanceKey)
```
    Description copied from interface: ZeebeClient
    Command to cancel a workflow instance.
```
 zeebeClient
  .newCancelInstanceCommand(workflowInstanceKey)
  .send();
 
```
    Specified by:
    
    newCancelInstanceCommand in interface ZeebeClient
    
    Parameters:
    
    workflowInstanceKey - the key which identifies the corresponding workflow instance
    
    Returns:
    
    a builder for the command
  - newUpdatePayloadCommand
```
public UpdatePayloadWorkflowInstanceCommandStep1 newUpdatePayloadCommand(long elementInstanceKey)
```
    Description copied from interface: ZeebeClient
    Command to update the payload of a workflow instance.
```
 zeebeClient
  .newUpdatePayloadCommand(elementInstanceKey)
  .payload(json)
  .send();
 
```
    Specified by:
    
    newUpdatePayloadCommand in interface ZeebeClient
    
    Parameters:
    
    elementInstanceKey - the key of the element instance to update the payload for
    
    Returns:
    
    a builder for the command
  - newPublishMessageCommand
```
public PublishMessageCommandStep1 newPublishMessageCommand()
```
    Description copied from interface: ZeebeClient
    Command to publish a message which can be correlated to a workflow instance.
```
 zeebeClient
  .newPublishMessageCommand()
  .messageName("order canceled")
  .correlationKey(orderId)
  .payload(json)
  .send();
 
```
    Specified by:
    
    newPublishMessageCommand in interface ZeebeClient
    
    Returns:
    
    a builder for the command
  - newResourceRequest
```
public WorkflowResourceRequestStep1 newResourceRequest()
```
    Description copied from interface: ZeebeClient
    Request to get the resource of a workflow (i.e. the XML representation).
```
 WorkflowResource resource = zeebeClient
  .newResourceRequest()
  .bpmnProcessId("my-process")
  .lastestVersion()
  .send()
  .join();

 String bpmnXml = resoure.getBpmnXml();
 
```
    Specified by:
    
    newResourceRequest in interface ZeebeClient
    
    Returns:
    
    a builder of the request
  - newWorkflowRequest
```
public WorkflowRequestStep1 newWorkflowRequest()
```
    Description copied from interface: ZeebeClient
    Request to get all deployed workflows.
```
 List<Workflow> workflows = zeebeClient
  .newWorkflowRequest()
  .send()
  .join()
  .getWorkflows();

 String bpmnProcessId = workflow.getBpmnProcessId();
 
```
    The response does not contain the resources of the workflows. Use ZeebeClient.newResourceRequest() to get the resource of a workflow.
    Specified by:
    
    newWorkflowRequest in interface ZeebeClient
    
    Returns:
    
    a builder of the request
    
    See Also:
    
    ZeebeClient.newResourceRequest()
  - newResolveIncidentCommand
```
public ResolveIncidentCommandStep1 newResolveIncidentCommand(long incidentKey)
```
    Description copied from interface: ZeebeClient
    Command to resolve an existing incident.
```
 zeebeClient
  .newResolveIncidentCommand(incidentKey)
  .send();
 
```
    Specified by:
    
    newResolveIncidentCommand in interface ZeebeClient
    
    Parameters:
    
    incidentKey - the key of the corresponding incident
    
    Returns:
    
    the builder for the command
  - newUpdateRetriesCommand
```
public UpdateRetriesJobCommandStep1 newUpdateRetriesCommand(long jobKey)
```
    Description copied from interface: ZeebeClient
    Command to update the retries of a job.
```
 long jobKey = ..;

 zeebeClient
  .newUpdateRetriesCommand(jobKey)
  .retries(3)
  .send();
 
```
    If the given retries are greater than zero then this job will be picked up again by a job subscription and a related incident will be marked as resolved.
    Specified by:
    
    newUpdateRetriesCommand in interface ZeebeClient
    
    Parameters:
    
    jobKey - the key of the job to update
    
    Returns:
    
    a builder for the command
  - newWorker
```
public JobWorkerBuilderStep1 newWorker()
```
    Description copied from interface: ZeebeClient
    Registers a new job worker for jobs of a given type.
    After registration, the broker activates available jobs and assigns them to this worker. It then publishes them to the client. The given worker is called for every received job, works on them and eventually completes them.
```
 JobWorker worker = zeebeClient
  .newWorker()
  .jobType("payment")
  .handler(paymentHandler)
  .open();

 ...
 worker.close();
 
```
    Example JobHandler implementation:
```
 public class PaymentHandler implements JobHandler
 {
   @Override
   public void handle(JobClient client, JobEvent jobEvent)
   {
     String json = jobEvent.getPayload();
     // modify payload

     client
      .newCompleteCommand()
      .event(jobEvent)
      .payload(json)
      .send();
   }
 };
 
```
    Specified by:
    
    newWorker in interface ZeebeClient
    
    Returns:
    
    a builder for the worker registration
  - newActivateJobsCommand
```
public ActivateJobsCommandStep1 newActivateJobsCommand()
```
    Description copied from interface: ZeebeClient
    Command to activate multiple jobs of a given type.
```
 zeebeClient
  .newActivateJobsCommand()
  .jobType("payment")
  .amount(10)
  .workerName("paymentWorker")
  .timeout(Duration.ofMinutes(10))
  .send();
 
```
    The command will try to activate maximal amount jobs of given jobType. If less then amount jobs of the jobType are available for activation the returned list will have fewer elements.
    Specified by:
    
    newActivateJobsCommand in interface ZeebeClient
    
    Returns:
    
    a builder for the command
  - newCompleteCommand
```
public CompleteJobCommandStep1 newCompleteCommand(long jobKey)
```
    Description copied from interface: JobClient
    Command to complete a job.
```
 long jobKey = ..;

 jobClient
  .newCompleteCommand(jobKey)
  .payload(json)
  .send();
 
```
    If the job is linked to a workflow instance then this command will complete the related activity and continue the flow.
    Specified by:
    
    newCompleteCommand in interface JobClient
    
    Parameters:
    
    jobKey - the key which identifies the job
    
    Returns:
    
    a builder for the command
  - newFailCommand
```
public FailJobCommandStep1 newFailCommand(long jobKey)
```
    Description copied from interface: JobClient
    Command to mark a job as failed.
```
 long jobKey = ..;

 jobClient
  .newFailCommand(jobKey)
  .retries(3)
  .send();
 
```
    If the given retries are greater than zero then this job will be picked up again by a job subscription. Otherwise, an incident is created for this job.
    Specified by:
    
    newFailCommand in interface JobClient
    
    Parameters:
    
    jobKey - the key which identifies the job
    
    Returns:
    
    a builder for the command

Class ZeebeClientImpl

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface io.zeebe.client.ZeebeClient

Constructor Detail

ZeebeClientImpl

ZeebeClientImpl

ZeebeClientImpl

Method Detail

buildChannel

newTopologyRequest

getConfiguration

close

newDeployCommand

newCreateInstanceCommand

newCancelInstanceCommand

newUpdatePayloadCommand

newPublishMessageCommand

newResourceRequest

newWorkflowRequest

newResolveIncidentCommand

newUpdateRetriesCommand

newWorker

newActivateJobsCommand

newCompleteCommand

newFailCommand