io.nats.client

Class PushSubscribeOptions

java.lang.Object

io.nats.client.SubscribeOptions

io.nats.client.PushSubscribeOptions

public class PushSubscribeOptions
extends SubscribeOptions

The PushSubscribeOptions class specifies the options for subscribing with JetStream enabled servers. Options are set using the PushSubscribeOptions.Builder or static helper methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PushSubscribeOptions.Builder PushSubscribeOptions can be created using a Builder.

Field Summary

Fields

Modifier and Type	Field and Description
static PushSubscribeOptions	DEFAULT_PUSH_OPTS

Fields inherited from class io.nats.client.SubscribeOptions

bind, consumerConfig, DEFAULT_ORDERED_HEARTBEAT, fastBind, messageAlarmTime, name, ordered, pendingByteLimit, pendingMessageLimit, pull, stream

Method Summary

Modifier and Type	Method and Description
static PushSubscribeOptions	bind(java.lang.String stream) Deprecated. This method resolves to stream(String) as bind has a different meaning and requires both stream and consumer name
static PushSubscribeOptions	bind(java.lang.String stream, java.lang.String name) Create PushSubscribeOptions for binding to a specific stream and consumer by name.
static PushSubscribeOptions.Builder	builder() Macro to start a PushSubscribeOptions builder
java.lang.String	getDeliverGroup() Gets the deliver group held in the consumer configuration.
java.lang.String	getDeliverSubject() Gets the deliver subject held in the consumer configuration.
static PushSubscribeOptions	stream(java.lang.String stream) Macro to create a default PushSubscribeOptions except for where you must specify the stream because the subject could apply to both a stream and a mirror.

Methods inherited from class io.nats.client.SubscribeOptions

getConsumerConfiguration, getDurable, getMessageAlarmTime, getName, getPendingByteLimit, getPendingMessageLimit, getStream, isBind, isFastBind, isOrdered, isPull, toString

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PUSH_OPTS

public static final PushSubscribeOptions DEFAULT_PUSH_OPTS

Method Detail

getDeliverSubject

public java.lang.String getDeliverSubject()

Gets the deliver subject held in the consumer configuration.

Returns:

the deliver subject

getDeliverGroup

public java.lang.String getDeliverGroup()

Gets the deliver group held in the consumer configuration.

Returns:

the deliver group

bind

@Deprecated
public static PushSubscribeOptions bind(java.lang.String stream)

Deprecated. This method resolves to stream(String) as bind has a different meaning and requires both stream and consumer name

Macro to create a default PushSubscribeOptions except for where you must specify the stream because the subject could apply to both a stream and a mirror.

Parameters:

stream - the stream name

Returns:

push subscribe options

stream

public static PushSubscribeOptions stream(java.lang.String stream)

Macro to create a default PushSubscribeOptions except for where you must specify the stream because the subject could apply to both a stream and a mirror.

Parameters:

stream - the stream name

Returns:

push subscribe options

bind

public static PushSubscribeOptions bind(java.lang.String stream,
                                        java.lang.String name)

Create PushSubscribeOptions for binding to a specific stream and consumer by name. The client validates regular (non-fast) binds to ensure that provided consumer configuration is consistent with the server version and that consumer type (push versus pull) matches the subscription type. and that it matches the subscription type.

Parameters:

stream - the stream name

name - the consumer name

Returns:

push subscribe options

builder

public static PushSubscribeOptions.Builder builder()

Macro to start a PushSubscribeOptions builder

Returns:

push subscribe options builder