io.nats.client

Class KeyValueOptions.Builder

java.lang.Object

io.nats.client.KeyValueOptions.Builder

Enclosing class:

KeyValueOptions

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

KeyValueOptions 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(KeyValueOptions kvo)

Method Summary

Modifier and Type	Method and Description
KeyValueOptions	build() Builds the JetStream options.
KeyValueOptions.Builder	jetStreamOptions(JetStreamOptions jso) Sets the JetStreamOptions.
KeyValueOptions.Builder	jsDomain(java.lang.String domain) Sets the domain for JetStream subjects, creating a standard prefix from that domain in the form $JS.(domain).API.
KeyValueOptions.Builder	jsPrefix(java.lang.String prefix) Sets the prefix for JetStream subjects.
KeyValueOptions.Builder	jsRequestTimeout(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(KeyValueOptions kvo)

Method Detail

jetStreamOptions

public KeyValueOptions.Builder jetStreamOptions(JetStreamOptions jso)

Sets the JetStreamOptions.

Parameters:

jso - the JetStreamOptions

Returns:

the builder.

jsRequestTimeout

public KeyValueOptions.Builder jsRequestTimeout(java.time.Duration requestTimeout)

Sets the request timeout for JetStream API calls.

Parameters:

requestTimeout - the duration to wait for responses.

Returns:

the builder

jsPrefix

public KeyValueOptions.Builder jsPrefix(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.

jsDomain

public KeyValueOptions.Builder jsDomain(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.

build

public KeyValueOptions build()

Builds the JetStream options.

Returns:

JetStream options