Zeebe C# Client 2.7.0
C# Client to communicate with an Zeebe Gateway
Loading...
Searching...
No Matches
Zeebe.Client.Api.Commands.IPublishMessageCommandStep3 Interface Reference
Inheritance diagram for Zeebe.Client.Api.Commands.IPublishMessageCommandStep3:
Zeebe.Client.Api.Commands.IFinalCommandWithRetryStep< IPublishMessageResponse >

Public Member Functions

IPublishMessageCommandStep3 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.
 
IPublishMessageCommandStep3 TimeToLive (TimeSpan timeToLive)
 Set the time-to-live of the message. The message can only be correlated within the given time-to-live.
 
IPublishMessageCommandStep3 Variables (string variables)
 Set the variables of the message.
 
- Public Member Functions inherited from Zeebe.Client.Api.Commands.IFinalCommandWithRetryStep< IPublishMessageResponse >
Task< T > SendWithRetry (TimeSpan? timeout=null, CancellationToken token=default)
 Sends the command with retry to the Zeebe broker. This operation is asynchronous. In case of success, the task returns the event that was generated by the Zeebe broker in response to the command. If the sending of the command fails, because of broker back pressure or network issues the request is retried until the command succeeds. The wait time between retries can be configured on the ZeebeClientBuilder. Per default the wait time is based on power two, which means 2^1 seconds, 2^2 seconds etc. until it reaches the maximum of one minute.
 

Member Function Documentation

◆ MessageId()

IPublishMessageCommandStep3 Zeebe.Client.Api.Commands.IPublishMessageCommandStep3.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
messageIdthe id of the message.
Returns
the builder for this command. Call IFinalCommandWithRetryStep<T>.Send to complete the command and send it to the broker.

◆ TimeToLive()

IPublishMessageCommandStep3 Zeebe.Client.Api.Commands.IPublishMessageCommandStep3.TimeToLive ( TimeSpan  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).

Parameters
timeToLivethe time-to-live of the message
Returns
the builder for this command. Call IFinalCommandStep<T>.Send to complete the command and send it to the broker.

◆ Variables()

IPublishMessageCommandStep3 Zeebe.Client.Api.Commands.IPublishMessageCommandStep3.Variables ( string  variables)

Set the variables of the message.

Parameters
variablesthe variables (JSON) as String.
Returns
the builder for this command. Call IFinalCommandStep<T>.Send to complete the command and send it to the broker.

The documentation for this interface was generated from the following file: