Package io.camunda.zeebe.client.api.command

Interface CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3

All Superinterfaces:

CommandWithTenantStep<CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3>, FinalCommandStep<ProcessInstanceEvent>

All Known Implementing Classes:

CreateProcessInstanceCommandImpl

Enclosing interface:

CreateProcessInstanceCommandStep1

public static interface CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3
extends CommandWithTenantStep<CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3>, FinalCommandStep<ProcessInstanceEvent>

Field Summary

Fields inherited from interface io.camunda.zeebe.client.api.command.CommandWithTenantStep

DEFAULT_TENANT_IDENTIFIER

Method Summary

Modifier and Type	Method	Description
CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3	startBeforeElement(String elementId)	Overrides the default start position of the process.
CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3	variable(String key, Object value)	Set a single initial variable of the process instance.
CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3	variables(InputStream variables)	Set the initial variables of the process instance.
CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3	variables(Object variables)	Set the initial variables of the process instance.
CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3	variables(String variables)	Set the initial variables of the process instance.
CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3	variables(Map<String,Object> variables)	Set the initial variables of the process instance.
CreateProcessInstanceCommandStep1.CreateProcessInstanceWithResultCommandStep1	withResult()	When this method is called, the response to the command will be received after the process is completed.

Methods inherited from interface io.camunda.zeebe.client.api.command.CommandWithTenantStep

tenantId

Methods inherited from interface io.camunda.zeebe.client.api.command.FinalCommandStep

requestTimeout, send

Method Details

variables

CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3 variables(InputStream variables)

Set the initial variables of the process instance.

Parameters:

variables - the variables JSON document as stream

Returns:

the builder for this command. Call FinalCommandStep.send() to complete the command and send it to the broker.

variables

CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3 variables(String variables)

Set the initial variables of the process instance.

Parameters:

variables - the variables JSON document as String

Returns:

the builder for this command. Call FinalCommandStep.send() to complete the command and send it to the broker.

variables

CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3 variables(Map<String,Object> variables)

Set the initial variables of the process instance.

Parameters:

variables - the variables document as map

Returns:

the builder for this command. Call FinalCommandStep.send() to complete the command and send it to the broker.

variables

CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3 variables(Object variables)

Set the initial variables of the process instance.

Parameters:

variables - the variables document as object to be serialized to JSON

Returns:

the builder for this command. Call FinalCommandStep.send() to complete the command and send it to the broker.

variable

CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3 variable(String key,
 Object value)

Set a single initial variable of the process instance.

Parameters:

key - the key of the variable as string

value - the value of the variable as object

Returns:

the builder for this command. Call FinalCommandStep.send() to complete the command and send it to the broker.

startBeforeElement

CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3 startBeforeElement(String elementId)

Overrides the default start position of the process. Calling this method will make the process start at the given elementId, if possible. This method can be called more than once to simultaneously start at different elements in different branches of the process.

Parameters:

elementId - the id of the BPMN element where to start the process instance

Returns:

the builder for this command. Call FinalCommandStep.send() to complete the command and send * it to the broker.

withResult

CreateProcessInstanceCommandStep1.CreateProcessInstanceWithResultCommandStep1 withResult()

When this method is called, the response to the command will be received after the process is completed. The response consists of a set of variables.

Returns:

the builder for this command. Call FinalCommandStep.send() to complete the command and send it to the broker