io.nats.client

Class PublishOptions

java.lang.Object

io.nats.client.PublishOptions

public class PublishOptions
extends java.lang.Object

The PublishOptions class specifies the options for publishing with JetStream enabled servers. Options are created using a Builder.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PublishOptions.Builder PublishOptions are created using a Builder.

Field Summary

Fields

Modifier and Type	Field and Description
static java.time.Duration	DEFAULT_TIMEOUT Use this variable for timeout in publish options.
static java.lang.String	PROP_PUBLISH_TIMEOUT Property used to configure a builder from a Properties object..
static java.lang.String	PROP_STREAM_NAME Property used to configure a builder from a Properties object.
static long	UNSET_LAST_SEQUENCE Use this variable to unset a sequence number in publish options.
static java.lang.String	UNSET_STREAM Use this variable to unset a stream in publish options.

Method Summary

Modifier and Type	Method and Description
static PublishOptions.Builder	builder() Creates a builder for the publish options.
java.lang.String	getExpectedLastMsgId() Gets the expected last message ID in the stream.
long	getExpectedLastSequence() Gets the expected last sequence number of the stream.
java.lang.String	getExpectedStream() Gets the expected stream.
java.lang.String	getMessageId() Gets the message ID
java.lang.String	getStream() Gets the name of the stream.
java.time.Duration	getStreamTimeout() Gets the publish timeout.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_TIMEOUT

public static final java.time.Duration DEFAULT_TIMEOUT

Use this variable for timeout in publish options.

UNSET_STREAM

public static final java.lang.String UNSET_STREAM

Use this variable to unset a stream in publish options.

UNSET_LAST_SEQUENCE

public static final long UNSET_LAST_SEQUENCE

Use this variable to unset a sequence number in publish options.

See Also:

Constant Field Values

PROP_STREAM_NAME

public static final java.lang.String PROP_STREAM_NAME

Property used to configure a builder from a Properties object.

See Also:

Constant Field Values

PROP_PUBLISH_TIMEOUT

public static final java.lang.String PROP_PUBLISH_TIMEOUT

Property used to configure a builder from a Properties object..

See Also:

Constant Field Values

Method Detail

getStream

public java.lang.String getStream()

Gets the name of the stream.

Returns:

the name of the stream.

getStreamTimeout

public java.time.Duration getStreamTimeout()

Gets the publish timeout.

Returns:

the publish timeout.

getExpectedStream

public java.lang.String getExpectedStream()

Gets the expected stream.

Returns:

the stream.

getExpectedLastMsgId

public java.lang.String getExpectedLastMsgId()

Gets the expected last message ID in the stream.

Returns:

the message ID.

getExpectedLastSequence

public long getExpectedLastSequence()

Gets the expected last sequence number of the stream.

Returns:

sequence number

getMessageId

public java.lang.String getMessageId()

Gets the message ID

Returns:

the message id;

builder

public static PublishOptions.Builder builder()

Creates a builder for the publish options.

Returns:

the builder.s