WorkflowClient (Zeebe Client Java 0.12.0 API)

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`CancelWorkflowInstanceCommandStep1`	`newCancelInstanceCommand(long workflowInstanceKey)` Command to cancel a workflow instance.
`CreateWorkflowInstanceCommandStep1`	`newCreateInstanceCommand()` Command to create/start a new instance of a workflow.
`DeployWorkflowCommandStep1`	`newDeployCommand()` Command to deploy new workflows.
`PublishMessageCommandStep1`	`newPublishMessageCommand()` Command to publish a message which can be correlated to a workflow instance.
`WorkflowResourceRequestStep1`	`newResourceRequest()` Request to get the resource of a workflow (i.e.
`UpdatePayloadWorkflowInstanceCommandStep1`	`newUpdatePayloadCommand(long activityInstanceKey)` Command to update the payload of a workflow instance.
`WorkflowRequestStep1`	`newWorkflowRequest()` Request to get all deployed workflows.

- Method Detail
  - newDeployCommand
```
DeployWorkflowCommandStep1 newDeployCommand()
```
    Command to deploy new workflows.
```
 workflowClient
  .newDeployCommand()
  .addResourceFile("~/wf/workflow1.bpmn")
  .addResourceFile("~/wf/workflow2.bpmn")
  .send();
 
```
    Returns:
    
    a builder for the command
  - newCreateInstanceCommand
```
CreateWorkflowInstanceCommandStep1 newCreateInstanceCommand()
```
    Command to create/start a new instance of a workflow.
```
 workflowClient
  .newCreateInstanceCommand()
  .bpmnProcessId("my-process")
  .latestVersion()
  .payload(json)
  .send();
 
```
    Returns:
    
    a builder for the command
  - newCancelInstanceCommand
```
CancelWorkflowInstanceCommandStep1 newCancelInstanceCommand(long workflowInstanceKey)
```
    Command to cancel a workflow instance.
```
 workflowClient
  .newCancelInstanceCommand(workflowInstanceEvent)
  .send();
 
```
    The workflow instance is specified by the given event. The event must be the latest event of the workflow instance to ensure that the command is based on the latest state of the workflow instance. If it's not the latest one then the command is rejected.
    Parameters:
    
    event - the latest workflow instance event
    
    Returns:
    
    a builder for the command
  - newUpdatePayloadCommand
```
UpdatePayloadWorkflowInstanceCommandStep1 newUpdatePayloadCommand(long activityInstanceKey)
```
    Command to update the payload of a workflow instance.
```
 workflowClient
  .newUpdatePayloadCommand(workflowInstanceEvent)
  .payload(json)
  .send();
 
```
    The workflow instance is specified by the given event. The event must be the latest event of the workflow instance to ensure that the command is based on the latest state of the workflow instance. If it's not the latest one then the command is rejected.
    If the workflow instance failed because of a payload-related incident then it will try to resolve the incident with the given payload.
    Parameters:
    
    event - the latest workflow instance event
    
    Returns:
    
    a builder for the command
  - newPublishMessageCommand
```
PublishMessageCommandStep1 newPublishMessageCommand()
```
    Command to publish a message which can be correlated to a workflow instance.
```
 workflowClient
  .newPublishMessageCommand()
  .messageName("order canceled")
  .correlationKey(orderId)
  .payload(json)
  .send();
 
```
    Returns:
    
    a builder for the command
  - newResourceRequest
```
WorkflowResourceRequestStep1 newResourceRequest()
```
    Request to get the resource of a workflow (i.e. the XML representation).
```
 WorkflowResource resource = workflowClient
  .newResourceRequest()
  .bpmnProcessId("my-process")
  .lastestVersion()
  .send()
  .join();

 String bpmnXml = resoure.getBpmnXml();
 
```
    Returns:
    
    a builder of the request
  - newWorkflowRequest
```
WorkflowRequestStep1 newWorkflowRequest()
```
    Request to get all deployed workflows.
```
 List<Workflow> workflows = workflowClient
  .newWorkflowRequest()
  .send()
  .join()
  .getWorkflows();

 String bpmnProcessId = workflow.getBpmnProcessId();
 
```
    The response does not contain the resources of the workflows. Use newResourceRequest() to get the resource of a workflow.
    Returns:
    
    a builder of the request
    
    See Also:
    
    newResourceRequest()

Interface WorkflowClient

Method Summary

Method Detail

newDeployCommand

newCreateInstanceCommand

newCancelInstanceCommand

newUpdatePayloadCommand

newPublishMessageCommand

newResourceRequest

newWorkflowRequest