Struct camunda_client::models::correlation_message_dto::CorrelationMessageDto

pub struct CorrelationMessageDto {
    pub message_name: Option<String>,
    pub business_key: Option<String>,
    pub tenant_id: Option<String>,
    pub without_tenant_id: Option<bool>,
    pub process_instance_id: Option<String>,
    pub correlation_keys: Option<HashMap<String, VariableValueDto>>,
    pub local_correlation_keys: Option<HashMap<String, VariableValueDto>>,
    pub process_variables: Option<HashMap<String, VariableValueDto>>,
    pub process_variables_local: Option<HashMap<String, VariableValueDto>>,
    pub all: Option<bool>,
    pub result_enabled: Option<bool>,
    pub variables_in_result_enabled: Option<bool>,
}

Fields

message_name: Option<String>

The name of the message to deliver.

business_key: Option<String>

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.

tenant_id: Option<String>

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.

without_tenant_id: Option<bool>

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.

process_instance_id: Option<String>

Used to correlate the message to the process instance with the given id.

correlation_keys: Option<HashMap<String, VariableValueDto>>

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.

local_correlation_keys: Option<HashMap<String, VariableValueDto>>

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.

process_variables: Option<HashMap<String, VariableValueDto>>

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.

process_variables_local: Option<HashMap<String, VariableValueDto>>

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.

all: Option<bool>

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.

result_enabled: Option<bool>

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.

variables_in_result_enabled: Option<bool>

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.

Implementations

impl CorrelationMessageDto

pub fn new() -> CorrelationMessageDto

Trait Implementations

impl Clone for CorrelationMessageDto

fn clone(&self) -> CorrelationMessageDto

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CorrelationMessageDto

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CorrelationMessageDto

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<CorrelationMessageDto> for CorrelationMessageDto

fn eq(&self, other: &CorrelationMessageDto) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &CorrelationMessageDto) -> bool

This method tests for !=.

impl Serialize for CorrelationMessageDto

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CorrelationMessageDto