io.nats.client

Class PullSubscribeOptions

java.lang.Object

io.nats.client.SubscribeOptions

io.nats.client.PullSubscribeOptions

public class PullSubscribeOptions
extends SubscribeOptions

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

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static PullSubscribeOptions	DEFAULT_PULL_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 PullSubscribeOptions	bind(java.lang.String stream, java.lang.String name) Create PullSubscribeOptions for binding to a specific stream and consumer by name.
static PullSubscribeOptions.Builder	builder() Macro to start a PullSubscribeOptions builder
static PullSubscribeOptions	fastBind(java.lang.String stream, java.lang.String name) Create PullSubscribeOptions where you are fast-binding to a specific stream and consumer by name.

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_PULL_OPTS

public static final PullSubscribeOptions DEFAULT_PULL_OPTS

Method Detail

builder

public static PullSubscribeOptions.Builder builder()

Macro to start a PullSubscribeOptions builder

Returns:

push subscribe options builder

bind

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

Create PullSubscribeOptions 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 to bind to

name - the consumer name

Returns:

push subscribe options

fastBind

public static PullSubscribeOptions fastBind(java.lang.String stream,
                                            java.lang.String name)

Create PullSubscribeOptions where you are fast-binding to a specific stream and consumer by name. The client does not validate that the provided consumer configuration is consistent with the server version or that consumer type (push versus pull) matches the subscription type. An inconsistent consumer configuration for instance can result in receiving messages from unexpected subjects. A consumer type mismatch will result in an error from the server.

Parameters:

stream - the stream name to bind to

name - the consumer name, commonly the durable name

Returns:

push subscribe options