Package io.camunda.client.protocol.rest

Class MessagePublicationRequest

java.lang.Object

io.camunda.client.protocol.rest.MessagePublicationRequest

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

MessagePublicationRequest

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_MESSAGE_ID
static final String	JSON_PROPERTY_NAME
static final String	JSON_PROPERTY_TENANT_ID
static final String	JSON_PROPERTY_TIME_TO_LIVE
static final String	JSON_PROPERTY_VARIABLES

Constructor Summary

Constructors

Constructor	Description
MessagePublicationRequest()

Method Summary

Modifier and Type	Method	Description
MessagePublicationRequest	businessId(String businessId)
MessagePublicationRequest	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	getMessageId()	The unique ID of the message.
String	getName()	The name of the message.
String	getTenantId()	The tenant of the message sender.
Long	getTimeToLive()	Timespan (in ms) to buffer the message on the broker.
Map<String,Object>	getVariables()	The message variables as JSON document.
int	hashCode()
MessagePublicationRequest	messageId(String messageId)
MessagePublicationRequest	name(String name)
MessagePublicationRequest	putVariablesItem(String key, Object variablesItem)
void	setBusinessId(String businessId)
void	setCorrelationKey(String correlationKey)
void	setMessageId(String messageId)
void	setName(String name)
void	setTenantId(String tenantId)
void	setTimeToLive(Long timeToLive)
void	setVariables(Map<String,Object> variables)
MessagePublicationRequest	tenantId(String tenantId)
MessagePublicationRequest	timeToLive(Long timeToLive)
String	toString()
MessagePublicationRequest	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_TIME_TO_LIVE

public static final String JSON_PROPERTY_TIME_TO_LIVE

See Also:

• Constant Field Values

JSON_PROPERTY_MESSAGE_ID

public static final String JSON_PROPERTY_MESSAGE_ID

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

MessagePublicationRequest

public MessagePublicationRequest()

Method Details

name

public MessagePublicationRequest name(@Nonnull
 String name)

getName

@Nonnull
public String getName()

The name of the message.

Returns:

name

setName

public void setName(@Nonnull
 String name)

correlationKey

public MessagePublicationRequest correlationKey(@Nullable
 String correlationKey)

getCorrelationKey

@Nullable
public String getCorrelationKey()

The correlation key of the message.

Returns:

correlationKey

setCorrelationKey

public void setCorrelationKey(@Nullable
 String correlationKey)

timeToLive

public MessagePublicationRequest timeToLive(@Nullable
 Long timeToLive)

getTimeToLive

@Nullable
public Long getTimeToLive()

Timespan (in ms) to buffer the message on the broker.

Returns:

timeToLive

setTimeToLive

public void setTimeToLive(@Nullable
 Long timeToLive)

messageId

public MessagePublicationRequest messageId(@Nullable
 String messageId)

getMessageId

@Nullable
public String getMessageId()

The unique ID of the message. This is used to ensure only one message with the given ID will be published during the lifetime of the message (if `timeToLive` is set).

Returns:

messageId

setMessageId

public void setMessageId(@Nullable
 String messageId)

variables

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

putVariablesItem

public MessagePublicationRequest 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 MessagePublicationRequest tenantId(@Nullable
 String tenantId)

getTenantId

@Nullable
public String getTenantId()

The tenant of the message sender.

Returns:

tenantId

setTenantId

public void setTenantId(@Nullable
 String tenantId)

businessId

public MessagePublicationRequest 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