Package io.camunda.client.impl.command

Class CreateProcessInstanceCommandImpl

java.lang.Object

io.camunda.client.impl.command.CommandWithVariables<CreateProcessInstanceCommandImpl>

io.camunda.client.impl.command.CreateProcessInstanceCommandImpl

All Implemented Interfaces:

CommandWithCommunicationApiStep<CreateProcessInstanceCommandStep1>, CommandWithTenantStep<CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3>, CommandWithVariables<CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3>, CreateProcessInstanceCommandStep1, CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep2, CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3, FinalCommandStep<ProcessInstanceEvent>

public final class CreateProcessInstanceCommandImpl
extends CommandWithVariables<CreateProcessInstanceCommandImpl>
implements CreateProcessInstanceCommandStep1, CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep2, CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3

Nested Class Summary

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

CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep2, CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3, CreateProcessInstanceCommandStep1.CreateProcessInstanceWithResultCommandStep1

Field Summary

Fields inherited from class io.camunda.client.impl.command.CommandWithVariables

objectMapper

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

DEFAULT_TENANT_IDENTIFIER

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

LATEST_VERSION

Constructor Summary

Constructors

Constructor	Description
CreateProcessInstanceCommandImpl(io.camunda.zeebe.gateway.protocol.GatewayGrpc.GatewayStub asyncStub, JsonMapper jsonMapper, CamundaClientConfiguration config, Predicate<CredentialsProvider.StatusCode> retryPredicate, HttpClient httpClient, boolean preferRestOverGrpc)

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	businessId(String businessId)	Set the business id of the process instance to be created.
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.
CamundaFuture<ProcessInstanceEvent>	send()	Sends the command to the Camunda gateway.
protected CreateProcessInstanceCommandImpl	setVariablesInternal(String variables)
CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3	startBeforeElement(String elementId)	Overrides the default start position of the process.
CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3	tags(Iterable<String> tags)	Add tags to the process instance to be created.
CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3	tags(String... tags)	Add tags to the process instance to be created.
CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3	tags(Set<String> tags)	Set the tags of the process instance to be created.
CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3	tenantId(String tenantId)	Specifies the tenant that will own any entities (e.g. process definition, process instances, etc.) resulting from this command, or that owns any entities (e.g. jobs) referred to from this command.
CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3	terminateAfterElement(String elementId)	Adds a runtime instruction to terminate the process instance after the given element is completed or terminated.
CreateProcessInstanceCommandStep1	useGrpc()	Sets gRPC as the communication API for this command.
CreateProcessInstanceCommandStep1	useRest()	Sets REST as the communication API for this command.
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 io.camunda.client.impl.command.CommandWithVariables

variable, variables, variables, variables, variables

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.camunda.client.api.command.CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3

variable, variables, variables, variables, variables

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

execute

Constructor Details

CreateProcessInstanceCommandImpl

public CreateProcessInstanceCommandImpl(io.camunda.zeebe.gateway.protocol.GatewayGrpc.GatewayStub asyncStub,
 JsonMapper jsonMapper,
 CamundaClientConfiguration config,
 Predicate<CredentialsProvider.StatusCode> retryPredicate,
 HttpClient httpClient,
 boolean preferRestOverGrpc)

Method Details

setVariablesInternal

protected CreateProcessInstanceCommandImpl setVariablesInternal(String variables)

Specified by:

setVariablesInternal in class CommandWithVariables<CreateProcessInstanceCommandImpl>

startBeforeElement

public CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3 startBeforeElement(String elementId)

Description copied from interface: CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3

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.

Specified by:

startBeforeElement in interface CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3

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.

terminateAfterElement

public CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3 terminateAfterElement(String elementId)

Description copied from interface: CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3

Adds a runtime instruction to terminate the process instance after the given element is completed or terminated. This method can be called more than once to add multiple runtime instructions.

Specified by:

terminateAfterElement in interface CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3

Parameters:

elementId - the id of the BPMN element after which the process instance should be terminated

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

tags

public CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3 tags(String... tags)

Description copied from interface: CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3

Add tags to the process instance to be created.

Tags are de-duplicated. Each tag must follow this format:

• Start with a letter (a-z, A-Z)
• Subsequent characters may be letters, digits, underscore (_), minus (-), colon (:), or period (.)
• Length between 1 and 100 characters
• Must not be null or blank

At most 10 tags can be set.

Specified by:

tags in interface CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3

Parameters:

tags - one or more tag values

Returns:

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

tags

public CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3 tags(Iterable<String> tags)

Description copied from interface: CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3

Add tags to the process instance to be created.

Tags are de-duplicated. Each tag must follow this format:

• Start with a letter (a-z, A-Z)
• Subsequent characters may be letters, digits, underscore (_), minus (-), colon (:), or period (.)
• Length between 1 and 100 characters
• Must not be null or blank

At most 10 tags can be set.

Specified by:

tags in interface CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3

Parameters:

tags - a collection of tag values

Returns:

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

tags

public CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3 tags(Set<String> tags)

Description copied from interface: CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3

Set the tags of the process instance to be created.

Duplicates are naturally excluded by the Set contract. Each tag must follow this format:

• Start with a letter (a-z, A-Z)
• Subsequent characters may be letters, digits, underscore (_), minus (-), colon (:), or period (.)
• Length between 1 and 100 characters
• Must not be null or blank

At most 10 tags can be set.

Specified by:

tags in interface CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3

Parameters:

tags - the set of tag values to apply

Returns:

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

businessId

public CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3 businessId(String businessId)

Description copied from interface: CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3

Set the business id of the process instance to be created.

The business id is an optional, user-defined string identifier that identifies the process instance within the scope of a process definition (scoped by tenant).

If provided and uniqueness enforcement is enabled, the engine will reject creation if another root process instance with the same business id is already active for the same process definition.

Note that any active child process instances with the same business id are not taken into account.

Specified by:

businessId in interface CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3

Parameters:

businessId - the business id to set

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 CamundaClientBuilder.defaultRequestTimeout(Duration).

Specified by:

requestTimeout in interface FinalCommandStep<ProcessInstanceEvent>

Parameters:

requestTimeout - the request timeout

Returns:

the configured command

send

public CamundaFuture<ProcessInstanceEvent> send()

Description copied from interface: FinalCommandStep

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

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

 Future<JobEventinvalid input: '&#62' 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.

tenantId

public CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3 tenantId(String tenantId)

Description copied from interface: CommandWithTenantStep

Specifies the tenant that will own any entities (e.g. process definition, process instances, etc.) resulting from this command, or that owns any entities (e.g. jobs) referred to from this command.

Multi-tenancy

Multiple tenants can share a Camunda cluster. Entities can be assigned to a specific tenant using an identifier. Only that tenant can access these entities.

Any entities created before multi-tenancy has been enabled in the Camunda cluster, are assigned to the CommandWithTenantStep.DEFAULT_TENANT_IDENTIFIER.

If no tenant is explicitly specified, then the command is rejected.

Specified by:

tenantId in interface CommandWithTenantStep<CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3>

Parameters:

tenantId - the identifier of the tenant to specify for this command, e.g. "ACME"

Returns:

the builder for this command with the tenant specified

useRest

public CreateProcessInstanceCommandStep1 useRest()

Description copied from interface: CommandWithCommunicationApiStep

Sets REST as the communication API for this command. If this command doesn't support communication over REST, it simply returns the command builder instance unchanged. The default communication API can be configured using CamundaClientBuilder.preferRestOverGrpc(boolean).

Specified by:

useRest in interface CommandWithCommunicationApiStep<CreateProcessInstanceCommandStep1>

Returns:

the configured command

useGrpc

public CreateProcessInstanceCommandStep1 useGrpc()

Description copied from interface: CommandWithCommunicationApiStep

Sets gRPC as the communication API for this command. If this command doesn't support communication over gRPC, it simply returns the command builder instance unchanged. The default communication API can be configured using CamundaClientBuilder.preferRestOverGrpc(boolean).

Specified by:

useGrpc in interface CommandWithCommunicationApiStep<CreateProcessInstanceCommandStep1>

Returns:

the configured command