Package io.camunda.client.protocol.rest

Class MessageCorrelationRequest

java.lang.Object

io.camunda.client.protocol.rest.MessageCorrelationRequest

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           comments="Generator version: 7.23.0")
public class MessageCorrelationRequest
extends Object

MessageCorrelationRequest

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_BUSINESS_ID
static final String	JSON_PROPERTY_CORRELATION_KEY
static final String	JSON_PROPERTY_NAME
static final String	JSON_PROPERTY_TENANT_ID
static final String	JSON_PROPERTY_VARIABLES

Constructor Summary

Constructors

Constructor	Description
MessageCorrelationRequest()

Method Summary

Modifier and Type	Method	Description
MessageCorrelationRequest	businessId(String businessId)
MessageCorrelationRequest	correlationKey(String correlationKey)
boolean	equals(Object o)
String	getBusinessId()	An optional business id used to enforce uniqueness of the process instance that a message start event would create.
String	getCorrelationKey()	The correlation key of the message.
String	getName()	The message name as defined in the BPMN process
String	getTenantId()	the tenant for which the message is published
Map<String,Object>	getVariables()	The message variables as JSON document
int	hashCode()
MessageCorrelationRequest	name(String name)
MessageCorrelationRequest	putVariablesItem(String key, Object variablesItem)
void	setBusinessId(String businessId)
void	setCorrelationKey(String correlationKey)
void	setName(String name)
void	setTenantId(String tenantId)
void	setVariables(Map<String,Object> variables)
MessageCorrelationRequest	tenantId(String tenantId)
String	toString()
MessageCorrelationRequest	variables(Map<String,Object> variables)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

JSON_PROPERTY_NAME

public static final String JSON_PROPERTY_NAME

See Also:

• Constant Field Values

JSON_PROPERTY_CORRELATION_KEY

public static final String JSON_PROPERTY_CORRELATION_KEY

See Also:

• Constant Field Values

JSON_PROPERTY_VARIABLES

public static final String JSON_PROPERTY_VARIABLES

See Also:

• Constant Field Values

JSON_PROPERTY_TENANT_ID

public static final String JSON_PROPERTY_TENANT_ID

See Also:

• Constant Field Values

JSON_PROPERTY_BUSINESS_ID

public static final String JSON_PROPERTY_BUSINESS_ID

See Also:

• Constant Field Values

Constructor Details

MessageCorrelationRequest

public MessageCorrelationRequest()

Method Details

name

public MessageCorrelationRequest name(@Nonnull
 String name)

getName

@Nonnull
public String getName()

The message name as defined in the BPMN process

Returns:

name

setName

public void setName(@Nonnull
 String name)

correlationKey

public MessageCorrelationRequest correlationKey(@Nullable
 String correlationKey)

getCorrelationKey

@Nullable
public String getCorrelationKey()

The correlation key of the message.

Returns:

correlationKey

setCorrelationKey

public void setCorrelationKey(@Nullable
 String correlationKey)

variables

public MessageCorrelationRequest variables(@Nullable
 Map<String,Object> variables)

putVariablesItem

public MessageCorrelationRequest putVariablesItem(String key,
 Object variablesItem)

getVariables

@Nullable
public Map<String,Object> getVariables()

The message variables as JSON document

Returns:

variables

setVariables

public void setVariables(@Nullable
 Map<String,Object> variables)

tenantId

public MessageCorrelationRequest tenantId(@Nullable
 String tenantId)

getTenantId

@Nullable
public String getTenantId()

the tenant for which the message is published

Returns:

tenantId

setTenantId

public void setTenantId(@Nullable
 String tenantId)

businessId

public MessageCorrelationRequest businessId(@Nullable
 String businessId)

getBusinessId

@Nullable
public String getBusinessId()

An optional business id used to enforce uniqueness of the process instance that a message start event would create. If provided and uniqueness enforcement is enabled, the engine rejects starting a new process instance when another root process instance with the same business id is already active for the same process definition. It has no effect when the message correlates to a catch, boundary, or intermediate event.

Returns:

businessId

setBusinessId

public void setBusinessId(@Nullable
 String businessId)

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