io.nats.client

Class JetStreamOptions

java.lang.Object

io.nats.client.JetStreamOptions

public class JetStreamOptions
extends java.lang.Object

The JetStreamOptions class specifies the general options for JetStream. Options are created using the Builder.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static JetStreamOptions	DEFAULT_JS_OPTIONS
static java.time.Duration	DEFAULT_TIMEOUT

Method Summary

Modifier and Type	Method and Description
static JetStreamOptions.Builder	builder() Creates a builder for the options.
static JetStreamOptions.Builder	builder(JetStreamOptions jso) Creates a builder to copy the options.
static java.lang.String	convertDomainToPrefix(java.lang.String domain)
static JetStreamOptions	defaultOptions() Get an instance of JetStreamOptions with all defaults
java.lang.String	getPrefix() Gets the prefix for this JetStream context.
java.time.Duration	getRequestTimeout() Gets the request timeout the stream.
boolean	isDefaultPrefix() Returns true if the prefix for the options is the default prefix.
boolean	isOptOut290ConsumerCreate() Gets whether the opt-out of the server v2.9.0 consumer create api is set
boolean	isPublishNoAck() Gets the whether the publish no ack flag was set

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_TIMEOUT

public static final java.time.Duration DEFAULT_TIMEOUT

DEFAULT_JS_OPTIONS

public static final JetStreamOptions DEFAULT_JS_OPTIONS

Method Detail

getRequestTimeout

public java.time.Duration getRequestTimeout()

Gets the request timeout the stream.

Returns:

the name of the stream.

getPrefix

public java.lang.String getPrefix()

Gets the prefix for this JetStream context. A prefix can be used in conjunction with user permissions to restrict access to certain JetStream instances.

Returns:

the prefix.

isDefaultPrefix

public boolean isDefaultPrefix()

Returns true if the prefix for the options is the default prefix.

Returns:

the true for default prefix.

isPublishNoAck

public boolean isPublishNoAck()

Gets the whether the publish no ack flag was set

Returns:

the flag

isOptOut290ConsumerCreate

public boolean isOptOut290ConsumerCreate()

Gets whether the opt-out of the server v2.9.0 consumer create api is set

Returns:

the flag

builder

public static JetStreamOptions.Builder builder()

Creates a builder for the options.

Returns:

the builder.

builder

public static JetStreamOptions.Builder builder(JetStreamOptions jso)

Creates a builder to copy the options.

Parameters:

jso - an existing JetStreamOptions

Returns:

a JetStreamOptions builder

defaultOptions

public static JetStreamOptions defaultOptions()

Get an instance of JetStreamOptions with all defaults

Returns:

the configuration

convertDomainToPrefix

public static java.lang.String convertDomainToPrefix(java.lang.String domain)