Package io.camunda.client.api.command

Interface PublishMessageCommandStep1.PublishMessageCommandStep3

All Superinterfaces:

CommandWithTenantStep<PublishMessageCommandStep1.PublishMessageCommandStep3>, CommandWithVariables<PublishMessageCommandStep1.PublishMessageCommandStep3>, FinalCommandStep<PublishMessageResponse>

All Known Implementing Classes:

PublishMessageCommandImpl

Enclosing interface:

PublishMessageCommandStep1

public static interface PublishMessageCommandStep1.PublishMessageCommandStep3
extends CommandWithTenantStep<PublishMessageCommandStep1.PublishMessageCommandStep3>, FinalCommandStep<PublishMessageResponse>, CommandWithVariables<PublishMessageCommandStep1.PublishMessageCommandStep3>

Field Summary

Fields inherited from interface io.camunda.client.api.command.CommandWithTenantStep

DEFAULT_TENANT_IDENTIFIER

Method Summary

Modifier and Type	Method	Description
PublishMessageCommandStep1.PublishMessageCommandStep3	messageId(String messageId)	Set the id of the message.
PublishMessageCommandStep1.PublishMessageCommandStep3	timeToLive(Duration timeToLive)	Set the time-to-live of the message.
PublishMessageCommandStep1.PublishMessageCommandStep3	variable(String key, Object value)	Set a single variable of the message.
PublishMessageCommandStep1.PublishMessageCommandStep3	variables(InputStream variables)	Set the variables of the message.
PublishMessageCommandStep1.PublishMessageCommandStep3	variables(Object variables)	Set the variables of the message.
PublishMessageCommandStep1.PublishMessageCommandStep3	variables(String variables)	Set the variables of the message.
PublishMessageCommandStep1.PublishMessageCommandStep3	variables(Map<String,Object> variables)	Set the variables of the message.

Methods inherited from interface io.camunda.client.api.command.CommandWithTenantStep

tenantId

Methods inherited from interface io.camunda.client.api.command.FinalCommandStep

execute, requestTimeout, send

Method Details

messageId

PublishMessageCommandStep1.PublishMessageCommandStep3 messageId(String messageId)

Set the id of the message. The message is rejected if another message is already published with the same id, name and correlation-key.

Parameters:

messageId - the id of the message

Returns:

the builder for this command. Call FinalCommandStep.send() to complete the command and send it to the broker.

timeToLive

PublishMessageCommandStep1.PublishMessageCommandStep3 timeToLive(Duration timeToLive)

Set the time-to-live of the message. The message can only be correlated within the given time-to-live.

If the duration is zero or negative then the message can only be correlated to open subscriptions (e.g. to an entered message catch event).

If no duration is set then the default is used from the configuration.

Parameters:

timeToLive - the time-to-live of the message

Returns:

the builder for this command. Call FinalCommandStep.send() to complete the command and send it to the broker.

variables

PublishMessageCommandStep1.PublishMessageCommandStep3 variables(String variables)

Set the variables of the message.

Specified by:

variables in interface CommandWithVariables<PublishMessageCommandStep1.PublishMessageCommandStep3>

Parameters:

variables - the variables (JSON) as String

Returns:

the builder for this command. Call FinalCommandStep.send() to complete the command and send it to the broker.

variables

PublishMessageCommandStep1.PublishMessageCommandStep3 variables(Object variables)

Set the variables of the message.

Specified by:

variables in interface CommandWithVariables<PublishMessageCommandStep1.PublishMessageCommandStep3>

Parameters:

variables - the variables as object

Returns:

the builder for this command. Call FinalCommandStep.send() to complete the command and send it to the broker.

variables

PublishMessageCommandStep1.PublishMessageCommandStep3 variables(InputStream variables)

Set the variables of the message.

Specified by:

variables in interface CommandWithVariables<PublishMessageCommandStep1.PublishMessageCommandStep3>

Parameters:

variables - the variables (JSON) as stream

Returns:

the builder for this command. Call FinalCommandStep.send() to complete the command and send it to the broker.

variables

PublishMessageCommandStep1.PublishMessageCommandStep3 variables(Map<String,Object> variables)

Set the variables of the message.

Specified by:

variables in interface CommandWithVariables<PublishMessageCommandStep1.PublishMessageCommandStep3>

Parameters:

variables - the variables as map

Returns:

the builder for this command. Call FinalCommandStep.send() to complete the command and send it to the broker.

variable

PublishMessageCommandStep1.PublishMessageCommandStep3 variable(String key,
 Object value)

Set a single variable of the message.

Specified by:

variable in interface CommandWithVariables<PublishMessageCommandStep1.PublishMessageCommandStep3>

Parameters:

key - the key of the variable as string

value - the value of the variable as object

Returns:

the builder for this command. Call FinalCommandStep.send() to complete the command and send it to the broker.