Package io.camunda.client.protocol.rest

Class ProcessInstanceCreationInstruction

java.lang.Object

io.camunda.client.protocol.rest.ProcessInstanceCreationInstruction

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2025-10-08T19:37:20.302687113Z[GMT]",
           comments="Generator version: 7.12.0")
public class ProcessInstanceCreationInstruction
extends Object

ProcessInstanceCreationInstruction

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_AWAIT_COMPLETION
static final String	JSON_PROPERTY_FETCH_VARIABLES
static final String	JSON_PROPERTY_OPERATION_REFERENCE
static final String	JSON_PROPERTY_PROCESS_DEFINITION_ID
static final String	JSON_PROPERTY_PROCESS_DEFINITION_KEY
static final String	JSON_PROPERTY_PROCESS_DEFINITION_VERSION
static final String	JSON_PROPERTY_REQUEST_TIMEOUT
static final String	JSON_PROPERTY_RUNTIME_INSTRUCTIONS
static final String	JSON_PROPERTY_START_INSTRUCTIONS
static final String	JSON_PROPERTY_TAGS
static final String	JSON_PROPERTY_TENANT_ID
static final String	JSON_PROPERTY_VARIABLES

Constructor Summary

Constructors

Constructor	Description
ProcessInstanceCreationInstruction()

Method Summary

Modifier and Type	Method	Description
ProcessInstanceCreationInstruction	addFetchVariablesItem(String fetchVariablesItem)
ProcessInstanceCreationInstruction	addRuntimeInstructionsItem(ProcessInstanceCreationRuntimeInstruction runtimeInstructionsItem)
ProcessInstanceCreationInstruction	addStartInstructionsItem(ProcessInstanceCreationStartInstruction startInstructionsItem)
ProcessInstanceCreationInstruction	addTagsItem(String tagsItem)
ProcessInstanceCreationInstruction	awaitCompletion(Boolean awaitCompletion)
boolean	equals(Object o)
ProcessInstanceCreationInstruction	fetchVariables(List<String> fetchVariables)
Boolean	getAwaitCompletion()	Wait for the process instance to complete.
List<String>	getFetchVariables()	List of variables by name to be included in the response when awaitCompletion is set to true.
Long	getOperationReference()	A reference key chosen by the user that will be part of all records resulting from this operation.
String	getProcessDefinitionId()	The BPMN process ID of the process definition to start an instance of.
String	getProcessDefinitionKey()	The unique key identifying the process definition, for example, returned for a process in the deploy resources endpoint.
Integer	getProcessDefinitionVersion()	The version of the process.
Long	getRequestTimeout()	Timeout (in ms) the request waits for the process to complete.
List<ProcessInstanceCreationRuntimeInstruction>	getRuntimeInstructions()	Runtime instructions (alpha).
List<ProcessInstanceCreationStartInstruction>	getStartInstructions()	List of start instructions.
Set<String>	getTags()	List of tags
String	getTenantId()	The tenant ID of the process definition.
Map<String,Object>	getVariables()	JSON object that will instantiate the variables for the root variable scope of the process instance.
int	hashCode()
ProcessInstanceCreationInstruction	operationReference(Long operationReference)
ProcessInstanceCreationInstruction	processDefinitionId(String processDefinitionId)
ProcessInstanceCreationInstruction	processDefinitionKey(String processDefinitionKey)
ProcessInstanceCreationInstruction	processDefinitionVersion(Integer processDefinitionVersion)
ProcessInstanceCreationInstruction	putVariablesItem(String key, Object variablesItem)
ProcessInstanceCreationInstruction	requestTimeout(Long requestTimeout)
ProcessInstanceCreationInstruction	runtimeInstructions(List<ProcessInstanceCreationRuntimeInstruction> runtimeInstructions)
void	setAwaitCompletion(Boolean awaitCompletion)
void	setFetchVariables(List<String> fetchVariables)
void	setOperationReference(Long operationReference)
void	setProcessDefinitionId(String processDefinitionId)
void	setProcessDefinitionKey(String processDefinitionKey)
void	setProcessDefinitionVersion(Integer processDefinitionVersion)
void	setRequestTimeout(Long requestTimeout)
void	setRuntimeInstructions(List<ProcessInstanceCreationRuntimeInstruction> runtimeInstructions)
void	setStartInstructions(List<ProcessInstanceCreationStartInstruction> startInstructions)
void	setTags(Set<String> tags)
void	setTenantId(String tenantId)
void	setVariables(Map<String,Object> variables)
ProcessInstanceCreationInstruction	startInstructions(List<ProcessInstanceCreationStartInstruction> startInstructions)
ProcessInstanceCreationInstruction	tags(Set<String> tags)
ProcessInstanceCreationInstruction	tenantId(String tenantId)
String	toString()
String	toUrlQueryString()	Convert the instance into URL query string.
String	toUrlQueryString(String prefix)	Convert the instance into URL query string.
ProcessInstanceCreationInstruction	variables(Map<String,Object> variables)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

JSON_PROPERTY_PROCESS_DEFINITION_ID

public static final String JSON_PROPERTY_PROCESS_DEFINITION_ID

See Also:

• Constant Field Values

JSON_PROPERTY_PROCESS_DEFINITION_VERSION

public static final String JSON_PROPERTY_PROCESS_DEFINITION_VERSION

See Also:

• Constant Field Values

JSON_PROPERTY_VARIABLES

public static final String JSON_PROPERTY_VARIABLES

See Also:

• Constant Field Values

JSON_PROPERTY_TENANT_ID

public static final String JSON_PROPERTY_TENANT_ID

See Also:

• Constant Field Values

JSON_PROPERTY_TAGS

public static final String JSON_PROPERTY_TAGS

See Also:

• Constant Field Values

JSON_PROPERTY_OPERATION_REFERENCE

public static final String JSON_PROPERTY_OPERATION_REFERENCE

See Also:

• Constant Field Values

JSON_PROPERTY_START_INSTRUCTIONS

public static final String JSON_PROPERTY_START_INSTRUCTIONS

See Also:

• Constant Field Values

JSON_PROPERTY_RUNTIME_INSTRUCTIONS

public static final String JSON_PROPERTY_RUNTIME_INSTRUCTIONS

See Also:

• Constant Field Values

JSON_PROPERTY_AWAIT_COMPLETION

public static final String JSON_PROPERTY_AWAIT_COMPLETION

See Also:

• Constant Field Values

JSON_PROPERTY_FETCH_VARIABLES

public static final String JSON_PROPERTY_FETCH_VARIABLES

See Also:

• Constant Field Values

JSON_PROPERTY_REQUEST_TIMEOUT

public static final String JSON_PROPERTY_REQUEST_TIMEOUT

See Also:

• Constant Field Values

JSON_PROPERTY_PROCESS_DEFINITION_KEY

public static final String JSON_PROPERTY_PROCESS_DEFINITION_KEY

See Also:

• Constant Field Values

Constructor Details

ProcessInstanceCreationInstruction

public ProcessInstanceCreationInstruction()

Method Details

processDefinitionId

public ProcessInstanceCreationInstruction processDefinitionId(@Nullable
 String processDefinitionId)

getProcessDefinitionId

@Nullable
public String getProcessDefinitionId()

The BPMN process ID of the process definition to start an instance of. Cannot be used together with processDefinitionKey.

Returns:

processDefinitionId

setProcessDefinitionId

public void setProcessDefinitionId(@Nullable
 String processDefinitionId)

processDefinitionVersion

public ProcessInstanceCreationInstruction processDefinitionVersion(@Nullable
 Integer processDefinitionVersion)

getProcessDefinitionVersion

@Nullable
public Integer getProcessDefinitionVersion()

The version of the process. Only considered when a processDefinitionId is provided. By default, the latest version of the process is used.

Returns:

processDefinitionVersion

setProcessDefinitionVersion

public void setProcessDefinitionVersion(@Nullable
 Integer processDefinitionVersion)

variables

public ProcessInstanceCreationInstruction variables(@Nullable
 Map<String,Object> variables)

putVariablesItem

public ProcessInstanceCreationInstruction putVariablesItem(String key,
 Object variablesItem)

getVariables

@Nullable
public Map<String,Object> getVariables()

JSON object that will instantiate the variables for the root variable scope of the process instance.

Returns:

variables

setVariables

public void setVariables(@Nullable
 Map<String,Object> variables)

tenantId

public ProcessInstanceCreationInstruction tenantId(@Nullable
 String tenantId)

getTenantId

@Nullable
public String getTenantId()

The tenant ID of the process definition.

Returns:

tenantId

setTenantId

public void setTenantId(@Nullable
 String tenantId)

tags

public ProcessInstanceCreationInstruction tags(@Nullable
 Set<String> tags)

addTagsItem

public ProcessInstanceCreationInstruction addTagsItem(String tagsItem)

getTags

@Nullable
public Set<String> getTags()

List of tags

Returns:

tags

setTags

public void setTags(@Nullable
 Set<String> tags)

operationReference

public ProcessInstanceCreationInstruction operationReference(@Nullable
 Long operationReference)

getOperationReference

@Nullable
public Long getOperationReference()

A reference key chosen by the user that will be part of all records resulting from this operation. Must be > 0 if provided. minimum: 1

Returns:

operationReference

setOperationReference

public void setOperationReference(@Nullable
 Long operationReference)

startInstructions

public ProcessInstanceCreationInstruction startInstructions(@Nullable
 List<ProcessInstanceCreationStartInstruction> startInstructions)

addStartInstructionsItem

public ProcessInstanceCreationInstruction addStartInstructionsItem(ProcessInstanceCreationStartInstruction startInstructionsItem)

getStartInstructions

@Nullable
public List<ProcessInstanceCreationStartInstruction> getStartInstructions()

List of start instructions. By default, the process instance will start at the start event. If provided, the process instance will apply start instructions after it has been created.

Returns:

startInstructions

setStartInstructions

public void setStartInstructions(@Nullable
 List<ProcessInstanceCreationStartInstruction> startInstructions)

runtimeInstructions

public ProcessInstanceCreationInstruction runtimeInstructions(@Nullable
 List<ProcessInstanceCreationRuntimeInstruction> runtimeInstructions)

addRuntimeInstructionsItem

public ProcessInstanceCreationInstruction addRuntimeInstructionsItem(ProcessInstanceCreationRuntimeInstruction runtimeInstructionsItem)

getRuntimeInstructions

@Nullable
public List<ProcessInstanceCreationRuntimeInstruction> getRuntimeInstructions()

Runtime instructions (alpha). List of instructions that affect the runtime behavior of the process instance. Refer to specific instruction types for more details. This parameter is an alpha feature and may be subject to change in future releases.

Returns:

runtimeInstructions

setRuntimeInstructions

public void setRuntimeInstructions(@Nullable
 List<ProcessInstanceCreationRuntimeInstruction> runtimeInstructions)

awaitCompletion

public ProcessInstanceCreationInstruction awaitCompletion(@Nullable
 Boolean awaitCompletion)

getAwaitCompletion

@Nullable
public Boolean getAwaitCompletion()

Wait for the process instance to complete. If the process instance completion does not occur within the requestTimeout, the request will be closed. This can lead to a 504 response status. Disabled by default.

Returns:

awaitCompletion

setAwaitCompletion

public void setAwaitCompletion(@Nullable
 Boolean awaitCompletion)

fetchVariables

public ProcessInstanceCreationInstruction fetchVariables(@Nullable
 List<String> fetchVariables)

addFetchVariablesItem

public ProcessInstanceCreationInstruction addFetchVariablesItem(String fetchVariablesItem)

getFetchVariables

@Nullable
public List<String> getFetchVariables()

List of variables by name to be included in the response when awaitCompletion is set to true. If empty, all visible variables in the root scope will be returned.

Returns:

fetchVariables

setFetchVariables

public void setFetchVariables(@Nullable
 List<String> fetchVariables)

requestTimeout

public ProcessInstanceCreationInstruction requestTimeout(@Nullable
 Long requestTimeout)

getRequestTimeout

@Nullable
public Long getRequestTimeout()

Timeout (in ms) the request waits for the process to complete. By default or when set to 0, the generic request timeout configured in the cluster is applied.

Returns:

requestTimeout

setRequestTimeout

public void setRequestTimeout(@Nullable
 Long requestTimeout)

processDefinitionKey

public ProcessInstanceCreationInstruction processDefinitionKey(@Nullable
 String processDefinitionKey)

getProcessDefinitionKey

@Nullable
public String getProcessDefinitionKey()

The unique key identifying the process definition, for example, returned for a process in the deploy resources endpoint. Cannot be used together with processDefinitionId.

Returns:

processDefinitionKey

setProcessDefinitionKey

public void setProcessDefinitionKey(@Nullable
 String processDefinitionKey)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

toUrlQueryString

public String toUrlQueryString()

Convert the instance into URL query string.

Returns:

URL query string

toUrlQueryString

public String toUrlQueryString(String prefix)

Convert the instance into URL query string.

Parameters:

prefix - prefix of the query string

Returns:

URL query string