io.nats.client

Class SubscribeOptions

java.lang.Object

io.nats.client.SubscribeOptions

Direct Known Subclasses:

PullSubscribeOptions, PushSubscribeOptions

public abstract class SubscribeOptions
extends java.lang.Object

The SubscribeOptions is the base class for PushSubscribeOptions and PullSubscribeOptions

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	SubscribeOptions.Builder<B,SO> PushSubscribeOptions can be created using a Builder.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	bind
protected ConsumerConfiguration	consumerConfig
protected long	messageAlarmTime
protected boolean	pull
protected java.lang.String	stream

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SubscribeOptions(SubscribeOptions.Builder builder, boolean pull, java.lang.String deliverSubject, java.lang.String deliverGroup)

Method Summary

Modifier and Type	Method and Description
ConsumerConfiguration	getConsumerConfiguration() Gets the consumer configuration.
java.lang.String	getDurable() Gets the durable consumer name held in the consumer configuration.
long	getMessageAlarmTime()
java.lang.String	getStream() Gets the name of the stream.
boolean	isBind() Gets whether this subscription is expected to bind to an existing stream and durable consumer
boolean	isPull() Gets whether this is a pull subscription
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

stream

protected final java.lang.String stream

pull

protected final boolean pull

bind

protected final boolean bind

consumerConfig

protected final ConsumerConfiguration consumerConfig

messageAlarmTime

protected final long messageAlarmTime

Constructor Detail

SubscribeOptions

protected SubscribeOptions(SubscribeOptions.Builder builder,
                           boolean pull,
                           java.lang.String deliverSubject,
                           java.lang.String deliverGroup)

Method Detail

getStream

public java.lang.String getStream()

Gets the name of the stream.

Returns:

the name of the stream.

getDurable

public java.lang.String getDurable()

Gets the durable consumer name held in the consumer configuration.

Returns:

the durable consumer name

isPull

public boolean isPull()

Gets whether this is a pull subscription

Returns:

the pull flag

isBind

public boolean isBind()

Gets whether this subscription is expected to bind to an existing stream and durable consumer

Returns:

the bind flag

getMessageAlarmTime

public long getMessageAlarmTime()

getConsumerConfiguration

public ConsumerConfiguration getConsumerConfiguration()

Gets the consumer configuration.

Returns:

the consumer configuration.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object