io.nats.streaming

Class SubscriptionOptions.Builder

java.lang.Object

io.nats.streaming.SubscriptionOptions.Builder

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

SubscriptionOptions

public static final class SubscriptionOptions.Builder
extends java.lang.Object
implements java.io.Serializable

A Builder implementation for creating an immutable SubscriptionOptions object.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
SubscriptionOptions.Builder	ackWait(java.time.Duration ackWait) Sets the amount of time the subscription will wait for ACKs from the cluster.
SubscriptionOptions.Builder	ackWait(long ackWait, java.util.concurrent.TimeUnit unit) Sets the amount of time the subscription will wait for ACKs from the cluster.
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	dispatcher(java.lang.String dispatcherName) Specify a dispatcher for this subscription.
SubscriptionOptions.Builder	durableName(java.lang.String durableName) Sets the durable subscriber name for the subscription.
SubscriptionOptions.Builder	manualAcks() Sets whether or not messages must be acknowledge individually by calling Message.ack().
SubscriptionOptions.Builder	maxInFlight(int max) 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(java.time.Instant start) Specifies the desired start time position using java.time.Instant.
SubscriptionOptions.Builder	startAtTimeDelta(java.time.Duration ago) Specifies the desired delta start time as a Duration.
SubscriptionOptions.Builder	startAtTimeDelta(long ago, java.util.concurrent.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.
SubscriptionOptions.Builder	subscriptionTimeout(java.time.Duration timeout) Sets the amount of time the subscription will wait during creation on a network failure.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

durableName

public SubscriptionOptions.Builder durableName(java.lang.String durableName)

Sets the durable subscriber name for the subscription.

Parameters:

durableName - the name of the durable subscriber

Returns:

this

maxInFlight

public SubscriptionOptions.Builder maxInFlight(int max)

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

Parameters:

max - the maximum number of in-flight messages

Returns:

this

subscriptionTimeout

public SubscriptionOptions.Builder subscriptionTimeout(java.time.Duration timeout)

Sets the amount of time the subscription will wait during creation on a network failure.

Parameters:

timeout - the amount of time the subscription will wait to be created

Returns:

this

ackWait

public SubscriptionOptions.Builder ackWait(java.time.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

ackWait

public SubscriptionOptions.Builder ackWait(long ackWait,
                                           java.util.concurrent.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

manualAcks

public SubscriptionOptions.Builder manualAcks()

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

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(java.time.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,
                                                    java.util.concurrent.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(java.time.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

dispatcher

public SubscriptionOptions.Builder dispatcher(java.lang.String dispatcherName)

Specify a dispatcher for this subscription. Dispatchers are essentially a message queue and thread to handle callbacks. By sharing dispatchers an application can reduce thread resources. By splitting subscriptions between dispatchers it is possible to have multiple messages handled at the same time. A unique dispatcher will be created automatically for each name. Reusing the name reuses the dispatcher.

Parameters:

dispatcherName - the shared name to use for the dispatcher

Returns:

this

build

public SubscriptionOptions build()

Creates a SubscriptionOptions instance based on the current configuration.

Returns:

the created SubscriptionOptions instance