Package io.zeebe.client.impl.command

Class CreateProcessInstanceCommandImpl

java.lang.Object

io.zeebe.client.impl.command.CreateProcessInstanceCommandImpl

All Implemented Interfaces:

CreateProcessInstanceCommandStep1, CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep2, CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3, FinalCommandStep<ProcessInstanceEvent>

public final class CreateProcessInstanceCommandImpl
extends Object
implements CreateProcessInstanceCommandStep1, CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep2, CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3

Nested Class Summary

Nested classes/interfaces inherited from interface io.zeebe.client.api.command.CreateProcessInstanceCommandStep1

CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep2, CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3, CreateProcessInstanceCommandStep1.CreateProcessInstanceWithResultCommandStep1

Field Summary

Fields inherited from interface io.zeebe.client.api.command.CreateProcessInstanceCommandStep1

LATEST_VERSION

Constructor Summary

Constructors

Constructor	Description
CreateProcessInstanceCommandImpl(GatewayGrpc.GatewayStub asyncStub, JsonMapper jsonMapper, Duration requestTimeout, Predicate<Throwable> retryPredicate)

Method Summary

Modifier and Type	Method	Description
CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep2	bpmnProcessId(String id)	Set the BPMN process id of the process to create an instance of.
CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3	latestVersion()	Use the latest version of the process to create an instance of.
CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3	processDefinitionKey(long processDefinitionKey)	Set the key of the process to create an instance of.
FinalCommandStep<ProcessInstanceEvent>	requestTimeout(Duration requestTimeout)	Sets the request timeout for the command.
ZeebeFuture<ProcessInstanceEvent>	send()	Sends the command to the Zeebe broker.
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.CreateProcessInstanceCommandStep3	version(int version)	Set the version of the process to create an instance of.
CreateProcessInstanceCommandStep1.CreateProcessInstanceWithResultCommandStep1	withResult()	When this method is called, the response to the command will be received after the process is completed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CreateProcessInstanceCommandImpl

public CreateProcessInstanceCommandImpl(GatewayGrpc.GatewayStub asyncStub,
                                        JsonMapper jsonMapper,
                                        Duration requestTimeout,
                                        Predicate<Throwable> retryPredicate)

Method Detail

variables

public CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3 variables(InputStream variables)

Description copied from interface: CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3

Set the initial variables of the process instance.

Specified by:

variables in interface CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3

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

public CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3 variables(String variables)

Description copied from interface: CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3

Set the initial variables of the process instance.

Specified by:

variables in interface CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3

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

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

Description copied from interface: CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3

Set the initial variables of the process instance.

Specified by:

variables in interface CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3

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

public CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3 variables(Object variables)

Description copied from interface: CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3

Set the initial variables of the process instance.

Specified by:

variables in interface CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3

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.

withResult

public CreateProcessInstanceCommandStep1.CreateProcessInstanceWithResultCommandStep1 withResult()

Description copied from interface: CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3

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.

Specified by:

withResult in interface CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3

Returns:

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

bpmnProcessId

public CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep2 bpmnProcessId(String id)

Description copied from interface: CreateProcessInstanceCommandStep1

Set the BPMN process id of the process to create an instance of. This is the static id of the process in the BPMN XML (i.e. "<bpmn:process id='my-process'>").

Specified by:

bpmnProcessId in interface CreateProcessInstanceCommandStep1

Parameters:

id - the BPMN process id of the process

Returns:

the builder for this command

processDefinitionKey

public CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3 processDefinitionKey(long processDefinitionKey)

Description copied from interface: CreateProcessInstanceCommandStep1

Set the key of the process to create an instance of. The key is assigned by the broker while deploying the process. It can be picked from the deployment or process event.

Specified by:

processDefinitionKey in interface CreateProcessInstanceCommandStep1

Parameters:

processDefinitionKey - the key of the process

Returns:

the builder for this command

version

public CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3 version(int version)

Description copied from interface: CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep2

Set the version of the process to create an instance of. The version is assigned by the broker while deploying the process. It can be picked from the deployment or process event.

Specified by:

version in interface CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep2

Parameters:

version - the version of the process

Returns:

the builder for this command

latestVersion

public CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3 latestVersion()

Description copied from interface: CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep2

Use the latest version of the process to create an instance of.

If the latest version was deployed few moments before then it can happen that the new instance is created of the previous version.

Specified by:

latestVersion in interface CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep2

Returns:

the builder for this command

requestTimeout

public FinalCommandStep<ProcessInstanceEvent> requestTimeout(Duration requestTimeout)

Description copied from interface: FinalCommandStep

Sets the request timeout for the command. The default request timeout can be configured using ZeebeClientBuilder.defaultRequestTimeout(Duration).

Specified by:

requestTimeout in interface FinalCommandStep<ProcessInstanceEvent>

Parameters:

requestTimeout - the request timeout

Returns:

the configured command

send

public ZeebeFuture<ProcessInstanceEvent> send()

Description copied from interface: FinalCommandStep

Sends the command to the Zeebe broker. This operation is asynchronous. In case of success, the future returns the event that was generated by the Zeebe broker in response to the command.

Call ZeebeFuture.join() to wait until the response is available.

 Future<JobEvent> future = command.send();
 JobEvent event = future.join();
 

Specified by:

send in interface FinalCommandStep<ProcessInstanceEvent>

Returns:

a future tracking state of success/failure of the command.