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

Class CorrelationMessageDto

java.lang.Object
org.camunda.community.rest.client.dto.CorrelationMessageDto
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2024-06-04T13:43:01.451833574Z[Etc/UTC]") public class CorrelationMessageDto extends Object
CorrelationMessageDto

  • Field Details

  • Constructor Details

    • CorrelationMessageDto

      public CorrelationMessageDto()

  • Method Details

    • messageName

      public CorrelationMessageDto messageName(String messageName)

    • getMessageName

      @Nullable public String getMessageName()
      The name of the message to deliver.
      Returns:
      messageName

    • getMessageName_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getMessageName_JsonNullable()

    • setMessageName_JsonNullable

      public void setMessageName_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> 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

    • getBusinessKey_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getBusinessKey_JsonNullable()

    • setBusinessKey_JsonNullable

      public void setBusinessKey_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> 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

    • getTenantId_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getTenantId_JsonNullable()

    • setTenantId_JsonNullable

      public void setTenantId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> 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

    • getWithoutTenantId_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<Boolean> getWithoutTenantId_JsonNullable()

    • setWithoutTenantId_JsonNullable

      public void setWithoutTenantId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> 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

    • getProcessInstanceId_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getProcessInstanceId_JsonNullable()

    • setProcessInstanceId_JsonNullable

      public void setProcessInstanceId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> 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

    • getCorrelationKeys_JsonNullable

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

    • setCorrelationKeys_JsonNullable

      public void setCorrelationKeys_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Map<String,VariableValueDto>> 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

    • getLocalCorrelationKeys_JsonNullable

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

    • setLocalCorrelationKeys_JsonNullable

      public void setLocalCorrelationKeys_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Map<String,VariableValueDto>> 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

    • getProcessVariables_JsonNullable

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

    • setProcessVariables_JsonNullable

      public void setProcessVariables_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Map<String,VariableValueDto>> 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 execution waiting on the message. Each key is a variable name and each value a JSON variable value object with the following properties.
      Returns:
      processVariablesLocal

    • getProcessVariablesLocal_JsonNullable

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

    • setProcessVariablesLocal_JsonNullable

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

    • setProcessVariablesLocal

      public void setProcessVariablesLocal(Map<String,VariableValueDto> processVariablesLocal)

    • processVariablesToTriggeredScope

      public CorrelationMessageDto processVariablesToTriggeredScope(Map<String,VariableValueDto> processVariablesToTriggeredScope)

    • putProcessVariablesToTriggeredScopeItem

      public CorrelationMessageDto putProcessVariablesToTriggeredScopeItem(String key, VariableValueDto processVariablesToTriggeredScopeItem)

    • getProcessVariablesToTriggeredScope

      @Nullable public Map<String,VariableValueDto> getProcessVariablesToTriggeredScope()
      A map of variables that is injected into the new scope triggered by message correlation. Each key is a variable name and each value a JSON variable value object with the following properties.
      Returns:
      processVariablesToTriggeredScope

    • getProcessVariablesToTriggeredScope_JsonNullable

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

    • setProcessVariablesToTriggeredScope_JsonNullable

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

    • setProcessVariablesToTriggeredScope

      public void setProcessVariablesToTriggeredScope(Map<String,VariableValueDto> processVariablesToTriggeredScope)

    • 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

    • getAll_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<Boolean> getAll_JsonNullable()

    • setAll_JsonNullable

      public void setAll_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> 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

    • getResultEnabled_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<Boolean> getResultEnabled_JsonNullable()

    • setResultEnabled_JsonNullable

      public void setResultEnabled_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> 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

    • getVariablesInResultEnabled_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<Boolean> getVariablesInResultEnabled_JsonNullable()

    • setVariablesInResultEnabled_JsonNullable

      public void setVariablesInResultEnabled_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> 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

    • 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