Package org.camunda.community.rest.client.dto

Class MessageCorrelationResultWithVariableDto

java.lang.Object

org.camunda.community.rest.client.dto.MessageCorrelationResultWithVariableDto

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-06-04T13:43:01.451833574Z[Etc/UTC]")
public class MessageCorrelationResultWithVariableDto
extends Object

The `processInstance` property only has a value if the resultType is set to `ProcessDefinition`. The processInstance with the properties as described in the [get single instance](https://docs.camunda.org/manual/7.21/reference/rest/process-instance/get/) method. The `execution` property only has a value if the resultType is set to `Execution`. The execution with the properties as described in the [get single execution](https://docs.camunda.org/manual/7.21/reference/rest/execution/get/) method.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	MessageCorrelationResultWithVariableDto.ResultTypeEnum	Indicates if the message was correlated to a message start event or an intermediate message catching event.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_EXECUTION
static final String	JSON_PROPERTY_PROCESS_INSTANCE
static final String	JSON_PROPERTY_RESULT_TYPE
static final String	JSON_PROPERTY_VARIABLES

Constructor Summary

Constructors

Constructor	Description
MessageCorrelationResultWithVariableDto()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
MessageCorrelationResultWithVariableDto	execution(ExecutionDto execution)
ExecutionDto	getExecution()	Get execution
ProcessInstanceDto	getProcessInstance()	Get processInstance
MessageCorrelationResultWithVariableDto.ResultTypeEnum	getResultType()	Indicates if the message was correlated to a message start event or an intermediate message catching event.
org.openapitools.jackson.nullable.JsonNullable<MessageCorrelationResultWithVariableDto.ResultTypeEnum>	getResultType_JsonNullable()
Map<String,VariableValueDto>	getVariables()	This property is returned if the `variablesInResultEnabled` is set to `true`.
org.openapitools.jackson.nullable.JsonNullable<Map<String,VariableValueDto>>	getVariables_JsonNullable()
int	hashCode()
MessageCorrelationResultWithVariableDto	processInstance(ProcessInstanceDto processInstance)
MessageCorrelationResultWithVariableDto	putVariablesItem(String key, VariableValueDto variablesItem)
MessageCorrelationResultWithVariableDto	resultType(MessageCorrelationResultWithVariableDto.ResultTypeEnum resultType)
void	setExecution(ExecutionDto execution)
void	setProcessInstance(ProcessInstanceDto processInstance)
void	setResultType(MessageCorrelationResultWithVariableDto.ResultTypeEnum resultType)
void	setResultType_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<MessageCorrelationResultWithVariableDto.ResultTypeEnum> resultType)
void	setVariables(Map<String,VariableValueDto> variables)
void	setVariables_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Map<String,VariableValueDto>> variables)
String	toString()
String	toUrlQueryString()	Convert the instance into URL query string.
String	toUrlQueryString(String prefix)	Convert the instance into URL query string.
MessageCorrelationResultWithVariableDto	variables(Map<String,VariableValueDto> variables)

Methods inherited from class java.lang.Object

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

Field Details

JSON_PROPERTY_RESULT_TYPE

public static final String JSON_PROPERTY_RESULT_TYPE

See Also:

• Constant Field Values

JSON_PROPERTY_PROCESS_INSTANCE

public static final String JSON_PROPERTY_PROCESS_INSTANCE

See Also:

• Constant Field Values

JSON_PROPERTY_EXECUTION

public static final String JSON_PROPERTY_EXECUTION

See Also:

• Constant Field Values

JSON_PROPERTY_VARIABLES

public static final String JSON_PROPERTY_VARIABLES

See Also:

• Constant Field Values

Constructor Details

MessageCorrelationResultWithVariableDto

public MessageCorrelationResultWithVariableDto()

Method Details

resultType

public MessageCorrelationResultWithVariableDto resultType(MessageCorrelationResultWithVariableDto.ResultTypeEnum resultType)

getResultType

@Nullable
public MessageCorrelationResultWithVariableDto.ResultTypeEnum getResultType()

Indicates if the message was correlated to a message start event or an intermediate message catching event. In the first case, the resultType is `ProcessDefinition` and otherwise `Execution`.

Returns:

resultType

getResultType_JsonNullable

public org.openapitools.jackson.nullable.JsonNullable<MessageCorrelationResultWithVariableDto.ResultTypeEnum> getResultType_JsonNullable()

setResultType_JsonNullable

public void setResultType_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<MessageCorrelationResultWithVariableDto.ResultTypeEnum> resultType)

setResultType

public void setResultType(MessageCorrelationResultWithVariableDto.ResultTypeEnum resultType)

processInstance

public MessageCorrelationResultWithVariableDto processInstance(ProcessInstanceDto processInstance)

getProcessInstance

@Nullable
public ProcessInstanceDto getProcessInstance()

Get processInstance

Returns:

processInstance

setProcessInstance

public void setProcessInstance(ProcessInstanceDto processInstance)

execution

public MessageCorrelationResultWithVariableDto execution(ExecutionDto execution)

getExecution

@Nullable
public ExecutionDto getExecution()

Get execution

Returns:

execution

setExecution

public void setExecution(ExecutionDto execution)

variables

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

putVariablesItem

public MessageCorrelationResultWithVariableDto putVariablesItem(String key,
 VariableValueDto variablesItem)

getVariables

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

This property is returned if the `variablesInResultEnabled` is set to `true`. Contains a list of the process variables.

Returns:

variables

getVariables_JsonNullable

public org.openapitools.jackson.nullable.JsonNullable<Map<String,VariableValueDto>> getVariables_JsonNullable()

setVariables_JsonNullable

public void setVariables_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Map<String,VariableValueDto>> variables)

setVariables

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

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