io.nats.stan

Class SubscriptionOptions.Builder

java.lang.Object

io.nats.stan.SubscriptionOptions.Builder

Enclosing class:

SubscriptionOptions

public static final class SubscriptionOptions.Builder
extends Object

A Builder implementation for creating an immutable SubscriptionOptions object.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
SubscriptionOptions	build() Creates a SubscriptionOptions instance based on the current configuration.
SubscriptionOptions.Builder	deliverAllAvailable() Specifies that message delivery should begin at the oldest available message for this subject.
SubscriptionOptions.Builder	setAckWait(Duration ackWait) Sets the amount of time the subscription will wait for ACKs from the cluster.
SubscriptionOptions.Builder	setAckWait(long ackWait, TimeUnit unit) Sets the amount of time the subscription will wait for ACKs from the cluster.
SubscriptionOptions.Builder	setDurableName(String durableName) Sets the durable subscriber name for the subscription.
SubscriptionOptions.Builder	setManualAcks(boolean manualAcks) Sets whether or not messages must be acknowledge individually by calling Message.ack().
SubscriptionOptions.Builder	setMaxInFlight(int maxInFlight) Sets the maximum number of in-flight (unacknowledged) messages for the subscription.
SubscriptionOptions.Builder	startAtSequence(long seq) Specifies the sequence number from which to start receiving messages.
SubscriptionOptions.Builder	startAtTime(Instant start) Specifies the desired start time position using java.time.Instant.
SubscriptionOptions.Builder	startAtTimeDelta(Duration ago) Specifies the desired delta start time as a Duration.
SubscriptionOptions.Builder	startAtTimeDelta(long ago, TimeUnit unit) Specifies the desired delta start time position in the desired unit.
SubscriptionOptions.Builder	startWithLastReceived() Specifies that message delivery should start with the last (most recent) message stored for this subject.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

setDurableName

public SubscriptionOptions.Builder setDurableName(String durableName)

Sets the durable subscriber name for the subscription.

Parameters:

durableName - the name of the durable subscriber

Returns:

this

setMaxInFlight

public SubscriptionOptions.Builder setMaxInFlight(int maxInFlight)

Sets the maximum number of in-flight (unacknowledged) messages for the subscription.

Parameters:

maxInFlight - the maximum number of in-flight messages

Returns:

this

setAckWait

public SubscriptionOptions.Builder setAckWait(Duration ackWait)

Sets the amount of time the subscription will wait for ACKs from the cluster.

Parameters:

ackWait - the amount of time the subscription will wait for an ACK from the cluster

Returns:

this

setAckWait

public SubscriptionOptions.Builder setAckWait(long ackWait,
                                              TimeUnit unit)

Sets the amount of time the subscription will wait for ACKs from the cluster.

Parameters:

ackWait - the amount of time the subscription will wait for an ACK from the cluster

unit - the time unit

Returns:

this

setManualAcks

public SubscriptionOptions.Builder setManualAcks(boolean manualAcks)

Sets whether or not messages must be acknowledge individually by calling Message.ack().

Parameters:

manualAcks - whether or not messages must be manually acknowledged

Returns:

this

startAtSequence

public SubscriptionOptions.Builder startAtSequence(long seq)

Specifies the sequence number from which to start receiving messages.

Parameters:

seq - the sequence number from which to start receiving messages

Returns:

this

startAtTime

public SubscriptionOptions.Builder startAtTime(Instant start)

Specifies the desired start time position using java.time.Instant.

Parameters:

start - the desired start time position expressed as a java.time.Instant

Returns:

this

startAtTimeDelta

public SubscriptionOptions.Builder startAtTimeDelta(long ago,
                                                    TimeUnit unit)

Specifies the desired delta start time position in the desired unit.

Parameters:

ago - the historical time delta (from now) from which to start receiving messages

unit - the time unit

Returns:

this

startAtTimeDelta

public SubscriptionOptions.Builder startAtTimeDelta(Duration ago)

Specifies the desired delta start time as a Duration.

Parameters:

ago - the historical time delta (from now) from which to start receiving messages

Returns:

this

startWithLastReceived

public SubscriptionOptions.Builder startWithLastReceived()

Specifies that message delivery should start with the last (most recent) message stored for this subject.

Returns:

this

deliverAllAvailable

public SubscriptionOptions.Builder deliverAllAvailable()

Specifies that message delivery should begin at the oldest available message for this subject.

Returns:

this

build

public SubscriptionOptions build()

Creates a SubscriptionOptions instance based on the current configuration.

Returns:

the created SubscriptionOptions instance