Package io.camunda.client.api.command

Interface CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3

All Superinterfaces:

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

All Known Implementing Classes:

CreateProcessInstanceCommandImpl

Enclosing interface:

CreateProcessInstanceCommandStep1

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

Field Summary

Fields inherited from interface io.camunda.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	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	terminateAfterElement(String elementId)	Adds a runtime instruction to terminate the process instance after the given element is completed or terminated.
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.client.api.command.CommandWithTenantStep

tenantId

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

execute, requestTimeout, send

Method Details

variables

CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3 variables(String variables)

Set the initial variables of the process instance.

Specified by:

variables in interface CommandWithVariables<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

CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3 variables(Object variables)

Set the initial variables of the process instance.

Specified by:

variables in interface CommandWithVariables<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.

variables

CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3 variables(InputStream variables)

Set the initial variables of the process instance.

Specified by:

variables in interface CommandWithVariables<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

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

Set the initial variables of the process instance.

Specified by:

variables in interface CommandWithVariables<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.

variable

CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3 variable(String key,
 Object value)

Set a single initial variable of the process instance.

Specified by:

variable in interface CommandWithVariables<CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3>

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.

terminateAfterElement

CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3 terminateAfterElement(String elementId)

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.

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

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

tags

CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3 tags(String... tags)

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.

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

CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3 tags(Iterable<String> tags)

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.

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

CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3 tags(Set<String> tags)

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.

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.