io.nats.client

Class JetStreamOptions.Builder

java.lang.Object

io.nats.client.JetStreamOptions.Builder

Enclosing class:

JetStreamOptions

public static class JetStreamOptions.Builder
extends java.lang.Object

JetStreamOptions can be created using a Builder. The builder supports chaining and will create a default set of options if no methods are calls.

Constructor Summary

Constructors

Constructor and Description
Builder()
Builder(JetStreamOptions jso)

Method Summary

Modifier and Type	Method and Description
JetStreamOptions	build() Builds the JetStream options.
JetStreamOptions.Builder	domain(java.lang.String domain) Sets the domain for JetStream subjects, creating a standard prefix from that domain in the form $JS.(domain).API.
JetStreamOptions.Builder	optOut290ConsumerCreate(boolean optOut) Set whether to opt-out of the server v2.9.0 consumer create api.
JetStreamOptions.Builder	prefix(java.lang.String prefix) Sets the prefix for JetStream subjects.
JetStreamOptions.Builder	publishNoAck(boolean publishNoAck) Sets whether the streams in use by contexts created with these options are no-ack streams.
JetStreamOptions.Builder	requestTimeout(java.time.Duration requestTimeout) Sets the request timeout for JetStream API calls.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Builder

public Builder(JetStreamOptions jso)

Method Detail

requestTimeout

public JetStreamOptions.Builder requestTimeout(java.time.Duration requestTimeout)

Sets the request timeout for JetStream API calls.

Parameters:

requestTimeout - the duration to wait for responses.

Returns:

the builder

prefix

public JetStreamOptions.Builder prefix(java.lang.String prefix)

Sets the prefix for JetStream subjects. A prefix can be used in conjunction with user permissions to restrict access to certain JetStream instances. This must match the prefix used in the server.

Parameters:

prefix - the JetStream prefix

Returns:

the builder.

domain

public JetStreamOptions.Builder domain(java.lang.String domain)

Sets the domain for JetStream subjects, creating a standard prefix from that domain in the form $JS.(domain).API. A domain can be used in conjunction with user permissions to restrict access to certain JetStream instances. This must match the domain used in the server.

Parameters:

domain - the JetStream domain

Returns:

the builder.

publishNoAck

public JetStreamOptions.Builder publishNoAck(boolean publishNoAck)

Sets whether the streams in use by contexts created with these options are no-ack streams.

Parameters:

publishNoAck - how to treat publishes to the stream

Returns:

the builder

optOut290ConsumerCreate

public JetStreamOptions.Builder optOut290ConsumerCreate(boolean optOut)

Set whether to opt-out of the server v2.9.0 consumer create api. Default is false (opt-in)

Returns:

the builder

build

public JetStreamOptions build()

Builds the JetStream options.

Returns:

JetStream options