io.nats.client

Class PublishOptions.Builder

java.lang.Object

io.nats.client.PublishOptions.Builder

Enclosing class:

PublishOptions

public static class PublishOptions.Builder
extends java.lang.Object

PublishOptions are created using a Builder. The builder supports chaining and will create a default set of options if no methods are calls. The builder can also be created from a properties object using the property names defined with the prefix PROP_ in this class.

Constructor Summary

Constructors

Constructor and Description
Builder() Constructs a new publish options Builder with the default values.
Builder(java.util.Properties properties) Constructs a builder from properties

Method Summary

Modifier and Type	Method and Description
PublishOptions	build() Builds the publish options.
PublishOptions.Builder	clearExpected() Clears the expected so the build can be re-used.
PublishOptions.Builder	expectedLastMsgId(java.lang.String lastMsgId) Sets the expected last ID of the previously published message.
PublishOptions.Builder	expectedLastSequence(long sequence) Sets the expected message ID of the publish
PublishOptions.Builder	expectedStream(java.lang.String stream) Sets the expected stream of the publish.
PublishOptions.Builder	messageId(java.lang.String msgId) Sets the message id.
PublishOptions.Builder	stream(java.lang.String stream) Sets the stream name for publishing.
PublishOptions.Builder	streamTimeout(java.time.Duration timeout) Sets the timeout to wait for a publish acknowledgement from a JetStream enabled NATS server.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Constructs a new publish options Builder with the default values.

Builder

public Builder(java.util.Properties properties)

Constructs a builder from properties

Parameters:

properties - properties

Method Detail

stream

public PublishOptions.Builder stream(java.lang.String stream)

Sets the stream name for publishing. The default is undefined.

Parameters:

stream - The name of the stream.

Returns:

Builder

streamTimeout

public PublishOptions.Builder streamTimeout(java.time.Duration timeout)

Sets the timeout to wait for a publish acknowledgement from a JetStream enabled NATS server.

Parameters:

timeout - the publish timeout.

Returns:

Builder

expectedStream

public PublishOptions.Builder expectedStream(java.lang.String stream)

Sets the expected stream of the publish. If the stream does not match the server will not save the message.

Parameters:

stream - expected stream

Returns:

builder

expectedLastMsgId

public PublishOptions.Builder expectedLastMsgId(java.lang.String lastMsgId)

Sets the expected last ID of the previously published message. If the message ID does not match the server will not save the message.

Parameters:

lastMsgId - the stream

Returns:

builder

expectedLastSequence

public PublishOptions.Builder expectedLastSequence(long sequence)

Sets the expected message ID of the publish

Parameters:

sequence - the expected last sequence number

Returns:

builder

messageId

public PublishOptions.Builder messageId(java.lang.String msgId)

Sets the message id. Message IDs are used for de-duplication and should be unique to each message payload.

Parameters:

msgId - the unique message id.

Returns:

publish options

clearExpected

public PublishOptions.Builder clearExpected()

Clears the expected so the build can be re-used. Clears the expectedLastId, expectedLastSequence and messageId fields.

Returns:

publish options

build

public PublishOptions build()

Builds the publish options.

Returns:

publish options