CorrelationMessageDto (Camunda Platform Javadocs 7.15.19-ee)

java.lang.Object
- org.openapitools.client.model.CorrelationMessageDto

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2022-09-29T11:12:16.359+02:00[Europe/Berlin]")
public class CorrelationMessageDto
extends Object

CorrelationMessageDto

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SERIALIZED_NAME_ALL`
`static String`	`SERIALIZED_NAME_BUSINESS_KEY`
`static String`	`SERIALIZED_NAME_CORRELATION_KEYS`
`static String`	`SERIALIZED_NAME_LOCAL_CORRELATION_KEYS`
`static String`	`SERIALIZED_NAME_MESSAGE_NAME`
`static String`	`SERIALIZED_NAME_PROCESS_INSTANCE_ID`
`static String`	`SERIALIZED_NAME_PROCESS_VARIABLES`
`static String`	`SERIALIZED_NAME_PROCESS_VARIABLES_LOCAL`
`static String`	`SERIALIZED_NAME_RESULT_ENABLED`
`static String`	`SERIALIZED_NAME_TENANT_ID`
`static String`	`SERIALIZED_NAME_VARIABLES_IN_RESULT_ENABLED`
`static String`	`SERIALIZED_NAME_WITHOUT_TENANT_ID`

Constructor Summary

Constructors
Constructor and Description

CorrelationMessageDto()

Constructors
Constructor and Description
`CorrelationMessageDto()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CorrelationMessageDto`	`all(Boolean all)`
`CorrelationMessageDto`	`businessKey(String businessKey)`
`CorrelationMessageDto`	`correlationKeys(Map<String,VariableValueDto> correlationKeys)`
`boolean`	`equals(Object o)`
`Boolean`	`getAll()` A Boolean value that indicates whether the message should be correlated to exactly one entity or multiple entities.
`String`	`getBusinessKey()` Used for correlation of process instances that wait for incoming messages.
`Map<String,VariableValueDto>`	`getCorrelationKeys()` Used for correlation of process instances that wait for incoming messages.
`Map<String,VariableValueDto>`	`getLocalCorrelationKeys()` Local variables used for correlation of executions (process instances) that wait for incoming messages.
`String`	`getMessageName()` The name of the message to deliver.
`String`	`getProcessInstanceId()` Used to correlate the message to the process instance with the given id.
`Map<String,VariableValueDto>`	`getProcessVariables()` A map of variables that is injected into the triggered execution or process instance after the message has been delivered.
`Map<String,VariableValueDto>`	`getProcessVariablesLocal()` A map of local variables that is injected into the triggered execution or process instance after the message has been delivered.
`Boolean`	`getResultEnabled()` A Boolean value that indicates whether the result of the correlation should be returned or not.
`String`	`getTenantId()` Used to correlate the message for a tenant with the given id.
`Boolean`	`getVariablesInResultEnabled()` A Boolean value that indicates whether the result of the correlation should contain process variables or not.
`Boolean`	`getWithoutTenantId()` A Boolean value that indicates whether the message should only be correlated to executions and process definitions which belong to no tenant or not.
`int`	`hashCode()`
`CorrelationMessageDto`	`localCorrelationKeys(Map<String,VariableValueDto> localCorrelationKeys)`
`CorrelationMessageDto`	`messageName(String messageName)`
`CorrelationMessageDto`	`processInstanceId(String processInstanceId)`
`CorrelationMessageDto`	`processVariables(Map<String,VariableValueDto> processVariables)`
`CorrelationMessageDto`	`processVariablesLocal(Map<String,VariableValueDto> processVariablesLocal)`
`CorrelationMessageDto`	`putCorrelationKeysItem(String key, VariableValueDto correlationKeysItem)`
`CorrelationMessageDto`	`putLocalCorrelationKeysItem(String key, VariableValueDto localCorrelationKeysItem)`
`CorrelationMessageDto`	`putProcessVariablesItem(String key, VariableValueDto processVariablesItem)`
`CorrelationMessageDto`	`putProcessVariablesLocalItem(String key, VariableValueDto processVariablesLocalItem)`
`CorrelationMessageDto`	`resultEnabled(Boolean resultEnabled)`
`void`	`setAll(Boolean all)`
`void`	`setBusinessKey(String businessKey)`
`void`	`setCorrelationKeys(Map<String,VariableValueDto> correlationKeys)`
`void`	`setLocalCorrelationKeys(Map<String,VariableValueDto> localCorrelationKeys)`
`void`	`setMessageName(String messageName)`
`void`	`setProcessInstanceId(String processInstanceId)`
`void`	`setProcessVariables(Map<String,VariableValueDto> processVariables)`
`void`	`setProcessVariablesLocal(Map<String,VariableValueDto> processVariablesLocal)`
`void`	`setResultEnabled(Boolean resultEnabled)`
`void`	`setTenantId(String tenantId)`
`void`	`setVariablesInResultEnabled(Boolean variablesInResultEnabled)`
`void`	`setWithoutTenantId(Boolean withoutTenantId)`
`CorrelationMessageDto`	`tenantId(String tenantId)`
`String`	`toString()`
`CorrelationMessageDto`	`variablesInResultEnabled(Boolean variablesInResultEnabled)`
`CorrelationMessageDto`	`withoutTenantId(Boolean withoutTenantId)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - SERIALIZED_NAME_MESSAGE_NAME
```
public static final String SERIALIZED_NAME_MESSAGE_NAME
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_BUSINESS_KEY
```
public static final String SERIALIZED_NAME_BUSINESS_KEY
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_TENANT_ID
```
public static final String SERIALIZED_NAME_TENANT_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_WITHOUT_TENANT_ID
```
public static final String SERIALIZED_NAME_WITHOUT_TENANT_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_PROCESS_INSTANCE_ID
```
public static final String SERIALIZED_NAME_PROCESS_INSTANCE_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_CORRELATION_KEYS
```
public static final String SERIALIZED_NAME_CORRELATION_KEYS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_LOCAL_CORRELATION_KEYS
```
public static final String SERIALIZED_NAME_LOCAL_CORRELATION_KEYS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_PROCESS_VARIABLES
```
public static final String SERIALIZED_NAME_PROCESS_VARIABLES
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_PROCESS_VARIABLES_LOCAL
```
public static final String SERIALIZED_NAME_PROCESS_VARIABLES_LOCAL
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_ALL
```
public static final String SERIALIZED_NAME_ALL
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_RESULT_ENABLED
```
public static final String SERIALIZED_NAME_RESULT_ENABLED
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_VARIABLES_IN_RESULT_ENABLED
```
public static final String SERIALIZED_NAME_VARIABLES_IN_RESULT_ENABLED
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - CorrelationMessageDto
```
public CorrelationMessageDto()
```
- Method Detail
  - messageName
```
public CorrelationMessageDto messageName(String messageName)
```
  - getMessageName
```
@Nullable
public String getMessageName()
```
    The name of the message to deliver.
    
    Returns:
    
    messageName
  - setMessageName
```
public void setMessageName(String messageName)
```
  - businessKey
```
public CorrelationMessageDto businessKey(String businessKey)
```
  - getBusinessKey
```
@Nullable
public String getBusinessKey()
```
    Used for correlation of process instances that wait for incoming messages. Will only correlate to executions that belong to a process instance with the provided business key.
    
    Returns:
    
    businessKey
  - setBusinessKey
```
public void setBusinessKey(String businessKey)
```
  - tenantId
```
public CorrelationMessageDto tenantId(String tenantId)
```
  - getTenantId
```
@Nullable
public String getTenantId()
```
    Used to correlate the message for a tenant with the given id. Will only correlate to executions and process definitions which belong to the tenant. Must not be supplied in conjunction with a `withoutTenantId`.
    
    Returns:
    
    tenantId
  - setTenantId
```
public void setTenantId(String tenantId)
```
  - withoutTenantId
```
public CorrelationMessageDto withoutTenantId(Boolean withoutTenantId)
```
  - getWithoutTenantId
```
@Nullable
public Boolean getWithoutTenantId()
```
    A Boolean value that indicates whether the message should only be correlated to executions and process definitions which belong to no tenant or not. Value may only be `true`, as `false` is the default behavior. Must not be supplied in conjunction with a `tenantId`.
    
    Returns:
    
    withoutTenantId
  - setWithoutTenantId
```
public void setWithoutTenantId(Boolean withoutTenantId)
```
  - processInstanceId
```
public CorrelationMessageDto processInstanceId(String processInstanceId)
```
  - getProcessInstanceId
```
@Nullable
public String getProcessInstanceId()
```
    Used to correlate the message to the process instance with the given id.
    
    Returns:
    
    processInstanceId
  - setProcessInstanceId
```
public void setProcessInstanceId(String processInstanceId)
```
  - correlationKeys
```
public CorrelationMessageDto correlationKeys(Map<String,VariableValueDto> correlationKeys)
```
  - putCorrelationKeysItem
```
public CorrelationMessageDto putCorrelationKeysItem(String key,
                                                    VariableValueDto correlationKeysItem)
```
  - getCorrelationKeys
```
@Nullable
public Map<String,VariableValueDto> getCorrelationKeys()
```
    Used for correlation of process instances that wait for incoming messages. Has to be a JSON object containing key-value pairs that are matched against process instance variables during correlation. Each key is a variable name and each value a JSON variable value object with the following properties.
    
    Returns:
    
    correlationKeys
  - setCorrelationKeys
```
public void setCorrelationKeys(Map<String,VariableValueDto> correlationKeys)
```
  - localCorrelationKeys
```
public CorrelationMessageDto localCorrelationKeys(Map<String,VariableValueDto> localCorrelationKeys)
```
  - putLocalCorrelationKeysItem
```
public CorrelationMessageDto putLocalCorrelationKeysItem(String key,
                                                         VariableValueDto localCorrelationKeysItem)
```
  - getLocalCorrelationKeys
```
@Nullable
public Map<String,VariableValueDto> getLocalCorrelationKeys()
```
    Local variables used for correlation of executions (process instances) that wait for incoming messages. Has to be a JSON object containing key-value pairs that are matched against local variables during correlation. Each key is a variable name and each value a JSON variable value object with the following properties.
    
    Returns:
    
    localCorrelationKeys
  - setLocalCorrelationKeys
```
public void setLocalCorrelationKeys(Map<String,VariableValueDto> localCorrelationKeys)
```
  - processVariables
```
public CorrelationMessageDto processVariables(Map<String,VariableValueDto> processVariables)
```
  - putProcessVariablesItem
```
public CorrelationMessageDto putProcessVariablesItem(String key,
                                                     VariableValueDto processVariablesItem)
```
  - getProcessVariables
```
@Nullable
public Map<String,VariableValueDto> getProcessVariables()
```
    A map of variables that is injected into the triggered execution or process instance after the message has been delivered. Each key is a variable name and each value a JSON variable value object with the following properties.
    
    Returns:
    
    processVariables
  - setProcessVariables
```
public void setProcessVariables(Map<String,VariableValueDto> processVariables)
```
  - processVariablesLocal
```
public CorrelationMessageDto processVariablesLocal(Map<String,VariableValueDto> processVariablesLocal)
```
  - putProcessVariablesLocalItem
```
public CorrelationMessageDto putProcessVariablesLocalItem(String key,
                                                          VariableValueDto processVariablesLocalItem)
```
  - getProcessVariablesLocal
```
@Nullable
public Map<String,VariableValueDto> getProcessVariablesLocal()
```
    A map of local variables that is injected into the triggered execution or process instance after the message has been delivered. Each key is a variable name and each value a JSON variable value object with the following properties.
    
    Returns:
    
    processVariablesLocal
  - setProcessVariablesLocal
```
public void setProcessVariablesLocal(Map<String,VariableValueDto> processVariablesLocal)
```
  - all
```
public CorrelationMessageDto all(Boolean all)
```
  - getAll
```
@Nullable
public Boolean getAll()
```
    A Boolean value that indicates whether the message should be correlated to exactly one entity or multiple entities. If the value is set to `false`, the message will be correlated to exactly one entity (execution or process definition). If the value is set to `true`, the message will be correlated to multiple executions and a process definition that can be instantiated by this message in one go.
    
    Returns:
    
    all
  - setAll
```
public void setAll(Boolean all)
```
  - resultEnabled
```
public CorrelationMessageDto resultEnabled(Boolean resultEnabled)
```
  - getResultEnabled
```
@Nullable
public Boolean getResultEnabled()
```
    A Boolean value that indicates whether the result of the correlation should be returned or not. If this property is set to `true`, there will be returned a list of message correlation result objects. Depending on the all property, there will be either one ore more returned results in the list. The default value is `false`, which means no result will be returned.
    
    Returns:
    
    resultEnabled
  - setResultEnabled
```
public void setResultEnabled(Boolean resultEnabled)
```
  - variablesInResultEnabled
```
public CorrelationMessageDto variablesInResultEnabled(Boolean variablesInResultEnabled)
```
  - getVariablesInResultEnabled
```
@Nullable
public Boolean getVariablesInResultEnabled()
```
    A Boolean value that indicates whether the result of the correlation should contain process variables or not. The parameter resultEnabled should be set to `true` in order to use this it. The default value is `false`, which means the variables will not be returned.
    
    Returns:
    
    variablesInResultEnabled
  - setVariablesInResultEnabled
```
public void setVariablesInResultEnabled(Boolean variablesInResultEnabled)
```
  - 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

Class CorrelationMessageDto

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_MESSAGE_NAME

SERIALIZED_NAME_BUSINESS_KEY

SERIALIZED_NAME_TENANT_ID

SERIALIZED_NAME_WITHOUT_TENANT_ID

SERIALIZED_NAME_PROCESS_INSTANCE_ID

SERIALIZED_NAME_CORRELATION_KEYS

SERIALIZED_NAME_LOCAL_CORRELATION_KEYS

SERIALIZED_NAME_PROCESS_VARIABLES

SERIALIZED_NAME_PROCESS_VARIABLES_LOCAL

SERIALIZED_NAME_ALL

SERIALIZED_NAME_RESULT_ENABLED

SERIALIZED_NAME_VARIABLES_IN_RESULT_ENABLED

Constructor Detail

CorrelationMessageDto

Method Detail

messageName

getMessageName

setMessageName

businessKey

getBusinessKey

setBusinessKey

tenantId

getTenantId

setTenantId

withoutTenantId

getWithoutTenantId

setWithoutTenantId

processInstanceId

getProcessInstanceId

setProcessInstanceId

correlationKeys

putCorrelationKeysItem

getCorrelationKeys

setCorrelationKeys

localCorrelationKeys

putLocalCorrelationKeysItem

getLocalCorrelationKeys

setLocalCorrelationKeys

processVariables

putProcessVariablesItem

getProcessVariables

setProcessVariables

processVariablesLocal

putProcessVariablesLocalItem

getProcessVariablesLocal

setProcessVariablesLocal

all

getAll

setAll

resultEnabled

getResultEnabled

setResultEnabled

variablesInResultEnabled

getVariablesInResultEnabled

setVariablesInResultEnabled

equals

hashCode

toString