Package io.camunda.client.api.command

Interface CorrelateMessageCommandStep1.CorrelateMessageCommandStep2

All Known Implementing Classes:
CorrelateMessageCommandImpl
Enclosing interface:
CorrelateMessageCommandStep1
public static interface CorrelateMessageCommandStep1.CorrelateMessageCommandStep2

  • Method Details

    • correlationKey

      CorrelateMessageCommandStep1.CorrelateMessageCommandStep3 correlationKey(String correlationKey)
      Set the value of the correlation key of the message.

      This value will be used together with the message name to find matching message subscriptions.

      Parameters:
      correlationKey - the correlation key value of the message
      Returns:
      the builder for this command

    • withoutCorrelationKey

      CorrelateMessageCommandStep1.CorrelateMessageCommandStep3 withoutCorrelationKey()
      Skip specifying a correlation key for the message.

      This method allows the message to be correlated without a correlation key, making it suitable for scenarios where the correlation key is not necessary (e.g. for the message start event). When used, this will create a new process instance without checking for an active instance with the same correlation key.

      Returns:
      the builder for this command, continuing to the next step without a correlation key.