Package io.camunda.client.protocol.rest

Class CreateProcessInstanceResult

java.lang.Object

io.camunda.client.protocol.rest.CreateProcessInstanceResult

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           comments="Generator version: 7.23.0")
public class CreateProcessInstanceResult
extends Object

CreateProcessInstanceResult

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_BUSINESS_ID
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_PROCESS_INSTANCE_KEY
static final String	JSON_PROPERTY_TAGS
static final String	JSON_PROPERTY_TENANT_ID
static final String	JSON_PROPERTY_VARIABLES

Constructor Summary

Constructors

Constructor	Description
CreateProcessInstanceResult()

Method Summary

Modifier and Type	Method	Description
CreateProcessInstanceResult	addTagsItem(String tagsItem)
CreateProcessInstanceResult	businessId(String businessId)
boolean	equals(Object o)
String	getBusinessId()	Business id as provided on creation.
String	getProcessDefinitionId()	The BPMN process id of the process definition which was used to create the process. instance
String	getProcessDefinitionKey()	The key of the process definition which was used to create the process instance.
Integer	getProcessDefinitionVersion()	The version of the process definition which was used to create the process instance.
String	getProcessInstanceKey()	The unique identifier of the created process instance; to be used wherever a request needs a process instance key (e.g.
Set<String>	getTags()	List of tags.
String	getTenantId()	The tenant id of the created process instance.
Map<String,Object>	getVariables()	All the variables visible in the root scope.
int	hashCode()
CreateProcessInstanceResult	processDefinitionId(String processDefinitionId)
CreateProcessInstanceResult	processDefinitionKey(String processDefinitionKey)
CreateProcessInstanceResult	processDefinitionVersion(Integer processDefinitionVersion)
CreateProcessInstanceResult	processInstanceKey(String processInstanceKey)
CreateProcessInstanceResult	putVariablesItem(String key, Object variablesItem)
void	setBusinessId(String businessId)
void	setProcessDefinitionId(String processDefinitionId)
void	setProcessDefinitionKey(String processDefinitionKey)
void	setProcessDefinitionVersion(Integer processDefinitionVersion)
void	setProcessInstanceKey(String processInstanceKey)
void	setTags(Set<String> tags)
void	setTenantId(String tenantId)
void	setVariables(Map<String,Object> variables)
CreateProcessInstanceResult	tags(Set<String> tags)
CreateProcessInstanceResult	tenantId(String tenantId)
String	toString()
CreateProcessInstanceResult	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_TENANT_ID

public static final String JSON_PROPERTY_TENANT_ID

See Also:

• Constant Field Values

JSON_PROPERTY_VARIABLES

public static final String JSON_PROPERTY_VARIABLES

See Also:

• Constant Field Values

JSON_PROPERTY_PROCESS_DEFINITION_KEY

public static final String JSON_PROPERTY_PROCESS_DEFINITION_KEY

See Also:

• Constant Field Values

JSON_PROPERTY_PROCESS_INSTANCE_KEY

public static final String JSON_PROPERTY_PROCESS_INSTANCE_KEY

See Also:

• Constant Field Values

JSON_PROPERTY_TAGS

public static final String JSON_PROPERTY_TAGS

See Also:

• Constant Field Values

JSON_PROPERTY_BUSINESS_ID

public static final String JSON_PROPERTY_BUSINESS_ID

See Also:

• Constant Field Values

Constructor Details

CreateProcessInstanceResult

public CreateProcessInstanceResult()

Method Details

processDefinitionId

public CreateProcessInstanceResult processDefinitionId(@Nonnull
 String processDefinitionId)

getProcessDefinitionId

@Nonnull
public String getProcessDefinitionId()

The BPMN process id of the process definition which was used to create the process. instance

Returns:

processDefinitionId

setProcessDefinitionId

public void setProcessDefinitionId(@Nonnull
 String processDefinitionId)

processDefinitionVersion

public CreateProcessInstanceResult processDefinitionVersion(@Nonnull
 Integer processDefinitionVersion)

getProcessDefinitionVersion

@Nonnull
public Integer getProcessDefinitionVersion()

The version of the process definition which was used to create the process instance.

Returns:

processDefinitionVersion

setProcessDefinitionVersion

public void setProcessDefinitionVersion(@Nonnull
 Integer processDefinitionVersion)

tenantId

public CreateProcessInstanceResult tenantId(@Nonnull
 String tenantId)

getTenantId

@Nonnull
public String getTenantId()

The tenant id of the created process instance.

Returns:

tenantId

setTenantId

public void setTenantId(@Nonnull
 String tenantId)

variables

public CreateProcessInstanceResult variables(@Nonnull
 Map<String,Object> variables)

putVariablesItem

public CreateProcessInstanceResult putVariablesItem(String key,
 Object variablesItem)

getVariables

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

All the variables visible in the root scope.

Returns:

variables

setVariables

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

processDefinitionKey

public CreateProcessInstanceResult processDefinitionKey(@Nonnull
 String processDefinitionKey)

getProcessDefinitionKey

@Nonnull
public String getProcessDefinitionKey()

The key of the process definition which was used to create the process instance.

Returns:

processDefinitionKey

setProcessDefinitionKey

public void setProcessDefinitionKey(@Nonnull
 String processDefinitionKey)

processInstanceKey

public CreateProcessInstanceResult processInstanceKey(@Nonnull
 String processInstanceKey)

getProcessInstanceKey

@Nonnull
public String getProcessInstanceKey()

The unique identifier of the created process instance; to be used wherever a request needs a process instance key (e.g. CancelProcessInstanceRequest).

Returns:

processInstanceKey

setProcessInstanceKey

public void setProcessInstanceKey(@Nonnull
 String processInstanceKey)

tags

public CreateProcessInstanceResult tags(@Nonnull
 Set<String> tags)

addTagsItem

public CreateProcessInstanceResult addTagsItem(String tagsItem)

getTags

@Nonnull
public Set<String> getTags()

List of tags. Tags need to start with a letter; then alphanumerics, `_`, `-`, `:`, or `.`; length ≤ 100.

Returns:

tags

setTags

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

businessId

public CreateProcessInstanceResult businessId(@Nullable
 String businessId)

getBusinessId

@Nullable
public String getBusinessId()

Business id as provided on creation.

Returns:

businessId

setBusinessId

public void setBusinessId(@Nullable
 String businessId)

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