io.nats.streaming

Class SubscriptionOptions

java.lang.Object

io.nats.streaming.SubscriptionOptions

public class SubscriptionOptions
extends Object

A SubscriptionOptions object defines the configurable parameters of a STAN Subscription object.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SubscriptionOptions.Builder A Builder implementation for creating an immutable SubscriptionOptions object.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
Duration	getAckWait() Returns the timeout for waiting for an ACK from the cluster's point of view for delivered messages.
String	getDurableName() Returns the name of the durable subscriber.
int	getMaxInFlight() Returns the maximum number of messages the cluster will send without an ACK.
io.nats.streaming.protobuf.StartPosition	getStartAt() Returns the desired start position for the message stream.
long	getStartSequence() Returns the desired start sequence position.
Instant	getStartTime() Returns the desired start time position.
long	getStartTime(TimeUnit unit) Returns the desired start time position in the requested units.
int	hashCode()
boolean	isManualAcks() Returns whether or not messages for this subscription must be acknowledged individually by calling Message.ack().
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

getDurableName

public String getDurableName()

Returns the name of the durable subscriber.

Returns:

the name of the durable subscriber

getMaxInFlight

public int getMaxInFlight()

Returns the maximum number of messages the cluster will send without an ACK.

Returns:

the maximum number of messages the cluster will send without an ACK

getAckWait

public Duration getAckWait()

Returns the timeout for waiting for an ACK from the cluster's point of view for delivered messages.

Returns:

the timeout for waiting for an ACK from the cluster's point of view for delivered messages

getStartAt

public io.nats.streaming.protobuf.StartPosition getStartAt()

Returns the desired start position for the message stream.

Returns:

the desired start position for the message stream

getStartSequence

public long getStartSequence()

Returns the desired start sequence position.

Returns:

the desired start sequence position

getStartTime

public Instant getStartTime()

Returns the desired start time position.

Returns:

the desired start time position

getStartTime

public long getStartTime(TimeUnit unit)

Returns the desired start time position in the requested units.

Parameters:

unit - the unit of time

Returns:

the desired start time position

isManualAcks

public boolean isManualAcks()

Returns whether or not messages for this subscription must be acknowledged individually by calling Message.ack().

Returns:

whether or not manual acks are required for this subscription.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object