Package org.openapitools.client.model

Class StartProcessInstanceDto

java.lang.Object

org.openapitools.client.model.StartProcessInstanceDto

public class StartProcessInstanceDto
extends Object

StartProcessInstanceDto

Field Summary

Fields

Modifier and Type	Field	Description
static String	SERIALIZED_NAME_BUSINESS_KEY
static String	SERIALIZED_NAME_CASE_INSTANCE_ID
static String	SERIALIZED_NAME_SKIP_CUSTOM_LISTENERS
static String	SERIALIZED_NAME_SKIP_IO_MAPPINGS
static String	SERIALIZED_NAME_START_INSTRUCTIONS
static String	SERIALIZED_NAME_VARIABLES
static String	SERIALIZED_NAME_WITH_VARIABLES_IN_RETURN

Constructor Summary

Constructors

Constructor	Description
StartProcessInstanceDto()

Method Summary

Modifier and Type	Method	Description
StartProcessInstanceDto	addStartInstructionsItem(ProcessInstanceModificationInstructionDto startInstructionsItem)
StartProcessInstanceDto	businessKey(String businessKey)
StartProcessInstanceDto	caseInstanceId(String caseInstanceId)
boolean	equals(Object o)
String	getBusinessKey()	The business key of the process instance.
String	getCaseInstanceId()	The case instance id the process instance is to be initialized with.
Boolean	getSkipCustomListeners()	Skip execution listener invocation for activities that are started or ended as part of this request.
Boolean	getSkipIoMappings()	Skip execution of [input/output variable mappings](https://docs.camunda.org/manual/7.18/user-guide/process-engine/variables/#input-output-variable-mapping) for activities that are started or ended as part of this request.
List<ProcessInstanceModificationInstructionDto>	getStartInstructions()	**Optional**.
Map<String,VariableValueDto>	getVariables()	Get variables
Boolean	getWithVariablesInReturn()	Indicates if the variables, which was used by the process instance during execution, should be returned.
int	hashCode()
StartProcessInstanceDto	putVariablesItem(String key, VariableValueDto variablesItem)
void	setBusinessKey(String businessKey)
void	setCaseInstanceId(String caseInstanceId)
void	setSkipCustomListeners(Boolean skipCustomListeners)
void	setSkipIoMappings(Boolean skipIoMappings)
void	setStartInstructions(List<ProcessInstanceModificationInstructionDto> startInstructions)
void	setVariables(Map<String,VariableValueDto> variables)
void	setWithVariablesInReturn(Boolean withVariablesInReturn)
StartProcessInstanceDto	skipCustomListeners(Boolean skipCustomListeners)
StartProcessInstanceDto	skipIoMappings(Boolean skipIoMappings)
StartProcessInstanceDto	startInstructions(List<ProcessInstanceModificationInstructionDto> startInstructions)
String	toString()
StartProcessInstanceDto	variables(Map<String,VariableValueDto> variables)
StartProcessInstanceDto	withVariablesInReturn(Boolean withVariablesInReturn)

Methods inherited from class java.lang.Object

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

Field Detail

SERIALIZED_NAME_BUSINESS_KEY

public static final String SERIALIZED_NAME_BUSINESS_KEY

See Also:

Constant Field Values

SERIALIZED_NAME_VARIABLES

public static final String SERIALIZED_NAME_VARIABLES

See Also:

Constant Field Values

SERIALIZED_NAME_CASE_INSTANCE_ID

public static final String SERIALIZED_NAME_CASE_INSTANCE_ID

See Also:

Constant Field Values

SERIALIZED_NAME_START_INSTRUCTIONS

public static final String SERIALIZED_NAME_START_INSTRUCTIONS

See Also:

Constant Field Values

SERIALIZED_NAME_SKIP_CUSTOM_LISTENERS

public static final String SERIALIZED_NAME_SKIP_CUSTOM_LISTENERS

See Also:

Constant Field Values

SERIALIZED_NAME_SKIP_IO_MAPPINGS

public static final String SERIALIZED_NAME_SKIP_IO_MAPPINGS

See Also:

Constant Field Values

SERIALIZED_NAME_WITH_VARIABLES_IN_RETURN

public static final String SERIALIZED_NAME_WITH_VARIABLES_IN_RETURN

See Also:

Constant Field Values

Constructor Detail

StartProcessInstanceDto

public StartProcessInstanceDto()

Method Detail

businessKey

public StartProcessInstanceDto businessKey(String businessKey)

getBusinessKey

public String getBusinessKey()

The business key of the process instance.

Returns:

businessKey

setBusinessKey

public void setBusinessKey(String businessKey)

variables

public StartProcessInstanceDto variables(Map<String,VariableValueDto> variables)

putVariablesItem

public StartProcessInstanceDto putVariablesItem(String key,
                                                VariableValueDto variablesItem)

getVariables

public Map<String,VariableValueDto> getVariables()

Get variables

Returns:

variables

setVariables

public void setVariables(Map<String,VariableValueDto> variables)

caseInstanceId

public StartProcessInstanceDto caseInstanceId(String caseInstanceId)

getCaseInstanceId

public String getCaseInstanceId()

The case instance id the process instance is to be initialized with.

Returns:

caseInstanceId

setCaseInstanceId

public void setCaseInstanceId(String caseInstanceId)

startInstructions

public StartProcessInstanceDto startInstructions(List<ProcessInstanceModificationInstructionDto> startInstructions)

addStartInstructionsItem

public StartProcessInstanceDto addStartInstructionsItem(ProcessInstanceModificationInstructionDto startInstructionsItem)

getStartInstructions

public List<ProcessInstanceModificationInstructionDto> getStartInstructions()

**Optional**. A JSON array of instructions that specify which activities to start the process instance at. If this property is omitted, the process instance starts at its default blank start event.

Returns:

startInstructions

setStartInstructions

public void setStartInstructions(List<ProcessInstanceModificationInstructionDto> startInstructions)

skipCustomListeners

public StartProcessInstanceDto skipCustomListeners(Boolean skipCustomListeners)

getSkipCustomListeners

public Boolean getSkipCustomListeners()

Skip execution listener invocation for activities that are started or ended as part of this request. **Note**: This option is currently only respected when start instructions are submitted via the `startInstructions` property.

Returns:

skipCustomListeners

setSkipCustomListeners

public void setSkipCustomListeners(Boolean skipCustomListeners)

skipIoMappings

public StartProcessInstanceDto skipIoMappings(Boolean skipIoMappings)

getSkipIoMappings

public Boolean getSkipIoMappings()

Skip execution of [input/output variable mappings](https://docs.camunda.org/manual/7.18/user-guide/process-engine/variables/#input-output-variable-mapping) for activities that are started or ended as part of this request. **Note**: This option is currently only respected when start instructions are submitted via the `startInstructions` property.

Returns:

skipIoMappings

setSkipIoMappings

public void setSkipIoMappings(Boolean skipIoMappings)

withVariablesInReturn

public StartProcessInstanceDto withVariablesInReturn(Boolean withVariablesInReturn)

getWithVariablesInReturn

public Boolean getWithVariablesInReturn()

Indicates if the variables, which was used by the process instance during execution, should be returned. Default value: `false`

Returns:

withVariablesInReturn

setWithVariablesInReturn

public void setWithVariablesInReturn(Boolean withVariablesInReturn)

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