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

Class CorrelationMessageAsyncDto

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

  • Field Details

  • Constructor Details

    • CorrelationMessageAsyncDto

      public CorrelationMessageAsyncDto()

  • Method Details

    • messageName

      public CorrelationMessageAsyncDto messageName(String messageName)

    • getMessageName

      @Nullable public String getMessageName()
      The name of the message to correlate. Corresponds to the 'name' element of the message defined in BPMN 2.0 XML. Can be null to correlate by other criteria only.
      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)

    • processInstanceIds

      public CorrelationMessageAsyncDto processInstanceIds(List<String> processInstanceIds)

    • addProcessInstanceIdsItem

      public CorrelationMessageAsyncDto addProcessInstanceIdsItem(String processInstanceIdsItem)

    • getProcessInstanceIds

      @Nullable public List<String> getProcessInstanceIds()
      A list of process instance ids that define a group of process instances to which the operation will correlate a message. Please note that if `processInstanceIds`, `processInstanceQuery` and `historicProcessInstanceQuery` are defined, the resulting operation will be performed on the union of these sets.
      Returns:
      processInstanceIds

    • getProcessInstanceIds_JsonNullable

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

    • setProcessInstanceIds_JsonNullable

      public void setProcessInstanceIds_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<String>> processInstanceIds)

    • setProcessInstanceIds

      public void setProcessInstanceIds(List<String> processInstanceIds)

    • processInstanceQuery

      public CorrelationMessageAsyncDto processInstanceQuery(ProcessInstanceQueryDto processInstanceQuery)

    • getProcessInstanceQuery

      @Nullable public ProcessInstanceQueryDto getProcessInstanceQuery()
      Get processInstanceQuery
      Returns:
      processInstanceQuery

    • setProcessInstanceQuery

      public void setProcessInstanceQuery(ProcessInstanceQueryDto processInstanceQuery)

    • historicProcessInstanceQuery

      public CorrelationMessageAsyncDto historicProcessInstanceQuery(HistoricProcessInstanceQueryDto historicProcessInstanceQuery)

    • getHistoricProcessInstanceQuery

      @Nullable public HistoricProcessInstanceQueryDto getHistoricProcessInstanceQuery()
      Get historicProcessInstanceQuery
      Returns:
      historicProcessInstanceQuery

    • setHistoricProcessInstanceQuery

      public void setHistoricProcessInstanceQuery(HistoricProcessInstanceQueryDto historicProcessInstanceQuery)

    • variables

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

    • putVariablesItem

      public CorrelationMessageAsyncDto putVariablesItem(String key, VariableValueDto variablesItem)

    • getVariables

      @Nullable public Map<String,VariableValueDto> getVariables()
      All variables the operation will set in the root scope of the process instances the message is correlated to.
      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