Package org.camunda.community.rest.client.api

Class MessageApi

java.lang.Object

org.camunda.community.rest.client.api.MessageApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-06-04T13:43:01.451833574Z[Etc/UTC]")
public class MessageApi
extends Object

Constructor Summary

Constructors

Constructor	Description
MessageApi()
MessageApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
List<MessageCorrelationResultWithVariableDto>	deliverMessage(CorrelationMessageDto correlationMessageDto)	Correlate Correlates a message to the process engine to either trigger a message start event or an intermediate message catching event.
List<MessageCorrelationResultWithVariableDto>	deliverMessage(CorrelationMessageDto correlationMessageDto, Map<String,String> additionalHeaders)	Correlate Correlates a message to the process engine to either trigger a message start event or an intermediate message catching event.
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

MessageApi

public MessageApi()

MessageApi

public MessageApi(ApiClient apiClient)

Method Details

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

deliverMessage

public List<MessageCorrelationResultWithVariableDto> deliverMessage(CorrelationMessageDto correlationMessageDto)
                                                             throws ApiException

Correlate Correlates a message to the process engine to either trigger a message start event or an intermediate message catching event. Internally this maps to the engine's message correlation builder methods `MessageCorrelationBuilder#correlateWithResult()` and `MessageCorrelationBuilder#correlateAllWithResult()`. For more information about the correlation behavior, see the [Message Events](https://docs.camunda.org/manual/7.21/bpmn20/events/message-events/) section of the [BPMN 2.0 Implementation Reference](https://docs.camunda.org/manual/7.21/reference/bpmn20/).

Parameters:

correlationMessageDto - (optional)

Returns:

List<MessageCorrelationResultWithVariableDto>

Throws:

ApiException - if fails to make API call

deliverMessage

public List<MessageCorrelationResultWithVariableDto> deliverMessage(CorrelationMessageDto correlationMessageDto,
 Map<String,String> additionalHeaders)
                                                             throws ApiException

Correlate Correlates a message to the process engine to either trigger a message start event or an intermediate message catching event. Internally this maps to the engine's message correlation builder methods `MessageCorrelationBuilder#correlateWithResult()` and `MessageCorrelationBuilder#correlateAllWithResult()`. For more information about the correlation behavior, see the [Message Events](https://docs.camunda.org/manual/7.21/bpmn20/events/message-events/) section of the [BPMN 2.0 Implementation Reference](https://docs.camunda.org/manual/7.21/reference/bpmn20/).

Parameters:

correlationMessageDto - (optional)

additionalHeaders - additionalHeaders for this call

Returns:

List<MessageCorrelationResultWithVariableDto>

Throws:

ApiException - if fails to make API call