Skip navigation links
A B C D E F G H I J K L M N O P Q R S T U V W 

A

acceptDiscoveredUrls(List<String>) - Method in interface io.nats.client.ServerPool
When the connection received discovered servers (ServerInfo.getConnectURLs) it passes them on to the provider for later use
AccountLimits - Class in io.nats.client.api
Represents the JetStream Account Limits
AccountStatistics - Class in io.nats.client.api
The JetStream Account Statistics
AccountStatistics(Message) - Constructor for class io.nats.client.api.AccountStatistics
Construct an AccountStatistics
AccountTier - Class in io.nats.client.api
Represents the JetStream Account Tier
ack() - Method in interface io.nats.client.Message
ack acknowledges a JetStream messages received from a Consumer, indicating the message should not be received again later.
AckPolicy - Enum in io.nats.client.api
Represents the Ack Policy of a consumer
ackPolicy(AckPolicy) - Method in class io.nats.client.api.ConsumerConfiguration.Builder
Sets the acknowledgement policy of the ConsumerConfiguration.
ackPolicyWasSet() - Method in class io.nats.client.api.ConsumerConfiguration
Gets whether ack policy for this consumer configuration was set or left unset
ackSync(Duration) - Method in interface io.nats.client.Message
ack acknowledges a JetStream messages received from a Consumer, indicating the message should not be received again later.
ackWait(Duration) - Method in class io.nats.client.api.ConsumerConfiguration.Builder
Sets the acknowledgement wait duration of the ConsumerConfiguration.
ackWait(long) - Method in class io.nats.client.api.ConsumerConfiguration.Builder
Sets the acknowledgement wait duration of the ConsumerConfiguration.
addBucketLink(String, ObjectStore) - Method in interface io.nats.client.ObjectStore
Add a link to another object store (bucket).
addConnectionListener(ConnectionListener) - Method in interface io.nats.client.Connection
Attach another ConnectionListener.
addLink(String, ObjectInfo) - Method in interface io.nats.client.ObjectStore
Add a link to another object.
addOrUpdateConsumer(String, ConsumerConfiguration) - Method in interface io.nats.client.JetStreamManagement
Loads or creates a consumer.
addServiceEndpoint(ServiceEndpoint) - Method in class io.nats.service.ServiceBuilder
Add a service endpoint into the service.
addServiceEndpoints(ServiceEndpoint...) - Method in class io.nats.service.Service
Adds one or more service endpoint to the list of service contexts and starts it if the service is running.
addServiceEndpoints(Collection<ServiceEndpoint>) - Method in class io.nats.service.Service
Adds all service endpoints to the list of service contexts and starts it if the service is running.
addSource(Source) - Method in class io.nats.client.api.KeyValueConfiguration.Builder
Add a source into the KeyValueConfiguration.
addSource(Source) - Method in class io.nats.client.api.StreamConfiguration.Builder
Add a source into the StreamConfiguration.
addSources(Source...) - Method in class io.nats.client.api.KeyValueConfiguration.Builder
Adds the sources into the KeyValueConfiguration
addSources(Collection<Source>) - Method in class io.nats.client.api.KeyValueConfiguration.Builder
Adds the sources into the KeyValueConfiguration
addSources(Source...) - Method in class io.nats.client.api.StreamConfiguration.Builder
Add the sources into the StreamConfiguration.
addSources(Collection<Source>) - Method in class io.nats.client.api.StreamConfiguration.Builder
Sets the sources in the StreamConfiguration.
addStream(StreamConfiguration) - Method in interface io.nats.client.JetStreamManagement
Loads or creates a stream.
addSubjects(String...) - Method in class io.nats.client.api.StreamConfiguration.Builder
Adds unique subjects into the StreamConfiguration.
addSubjects(Collection<String>) - Method in class io.nats.client.api.StreamConfiguration.Builder
Adds unique subjects into the StreamConfiguration.
allowAtomicPublish() - Method in class io.nats.client.api.StreamConfiguration.Builder
Set allow atomic publish to true
allowAtomicPublish(boolean) - Method in class io.nats.client.api.StreamConfiguration.Builder
Set allow atomic publish flag
allowDirect(boolean) - Method in class io.nats.client.api.StreamConfiguration.Builder
Set whether to allow direct message access for a stream
allowMessageCounter() - Method in class io.nats.client.api.StreamConfiguration.Builder
Set allow message counter to true
allowMessageCounter(boolean) - Method in class io.nats.client.api.StreamConfiguration.Builder
Set the allow message counter flag
allowMessageSchedules() - Method in class io.nats.client.api.StreamConfiguration.Builder
Set to allow message Schedules to true
allowMessageSchedules(boolean) - Method in class io.nats.client.api.StreamConfiguration.Builder
Set allow message Schedules flag
allowMessageTtl() - Method in class io.nats.client.api.StreamConfiguration.Builder
Set allow per message TTL to true
allowMessageTtl(boolean) - Method in class io.nats.client.api.StreamConfiguration.Builder
Set the allow per message TTL flag
allowRollup(boolean) - Method in class io.nats.client.api.StreamConfiguration.Builder
Set whether to allow the rollup feature for a stream
allSubjects() - Static method in class io.nats.client.api.StreamInfoOptions
Create options that get subject information, filtering for all subjects.
allSubjects() - Method in class io.nats.client.api.StreamInfoOptions.Builder
Set the subjects filter to >, which turns on getting subject info.
api(String) - Method in class io.nats.client.api.External.Builder
Set the api string.
ApiResponse<T> - Class in io.nats.client.api
ApiResponse is the base class for all api responses from the server
ApiResponse(Message) - Constructor for class io.nats.client.api.ApiResponse
construct an ApiResponse from a message
ApiResponse(JsonValue) - Constructor for class io.nats.client.api.ApiResponse
Construct an ApiResponse from a JsonValue
ApiResponse() - Constructor for class io.nats.client.api.ApiResponse
Construct an empty ApiResponse
ApiResponse(Error) - Constructor for class io.nats.client.api.ApiResponse
Construct an ApiResponse from an error object
ApiStats - Class in io.nats.client.api
Represents the JetStream Account Api Stats
appendGroup(Group) - Method in class io.nats.service.Group
Append a group at the end of the list of groups this group starts or is a part of.
AuthenticationException - Exception in io.nats.client
AuthenticationException is used when the connect process fails due to an authentication problem.
AuthenticationException(String) - Constructor for exception io.nats.client.AuthenticationException
Create a new AuthenticationException.
AuthHandler - Interface in io.nats.client
NATS provides a challenge-response based authentication scheme based on NKeys.
authHandler(AuthHandler) - Method in class io.nats.client.Options.Builder
Set the AuthHandler to sign the server nonce for authentication in nonce-mode.

B

backoff(Duration...) - Method in class io.nats.client.api.ConsumerConfiguration.Builder
Set the list of backoff.
backoff(long...) - Method in class io.nats.client.api.ConsumerConfiguration.Builder
Set the list of backoff.
backoffWasSet() - Method in class io.nats.client.api.ConsumerConfiguration
Gets whether backoff for this consumer configuration was set or left unset
BaseConsumeOptions - Class in io.nats.client
Base Consume Options are provided to customize the way the consume and fetch operate.
BaseConsumerContext - Interface in io.nats.client
The Consumer Context provides a convenient interface around a defined JetStream Consumer
BaseMessageConsumer - Interface in io.nats.client
The BaseMessageConsumer interface is the core interface replacing a subscription for a simplified consumer.
batchBytes(long) - Method in class io.nats.client.ConsumeOptions.Builder
Set the initial batch size in bytes and remove any previously set batch message constraint.
batchSize(int) - Method in class io.nats.client.ConsumeOptions.Builder
Set the initial batch size in messages and remove any previously set ConsumeOptions.Builder.batchBytes(long) constraint.
batchSize(int) - Method in class io.nats.client.PullRequestOptions.Builder
Set the batch size for the pull
bind(String, String) - Static method in class io.nats.client.PullSubscribeOptions
Create PullSubscribeOptions for binding to a specific stream and consumer by name.
bind(String) - Static method in class io.nats.client.PushSubscribeOptions
Deprecated.
This method resolves to PushSubscribeOptions.stream(String) as bind has a different meaning and requires both stream and consumer name
bind(String, String) - Static method in class io.nats.client.PushSubscribeOptions
Create PushSubscribeOptions for binding to a specific stream and consumer by name.
bucket(String) - Method in class io.nats.client.api.ObjectInfo.Builder
set the object's bucket name
bucket(String) - Static method in class io.nats.client.api.ObjectLink
create a bucket link
bucketLink(String) - Method in class io.nats.client.api.ObjectInfo.Builder
convenience method to set the object's ObjectMeta link bucket name
bufferSize(int) - Method in class io.nats.client.Options.Builder
Sets the initial size for buffers in the connection, primarily for testing.
build() - Method in class io.nats.client.api.ConsumerConfiguration.Builder
Builds the ConsumerConfiguration
build() - Method in class io.nats.client.api.ConsumerLimits.Builder
Build a ConsumerLimits object
build() - Method in class io.nats.client.api.External.Builder
Build an External object
build() - Method in class io.nats.client.api.KeyValueConfiguration.Builder
Builds the KeyValueConfiguration
build() - Method in class io.nats.client.api.KeyValuePurgeOptions.Builder
Build the Key Value Purge Options
build() - Method in class io.nats.client.api.Mirror.Builder
Build the mirror from the builder
build() - Method in class io.nats.client.api.ObjectInfo.Builder
Build an ObjectInfo
build() - Method in class io.nats.client.api.ObjectMeta.Builder
Build the Object Meta
build() - Method in class io.nats.client.api.ObjectMetaOptions.Builder
Build the ObjectMetaOptions
build() - Method in class io.nats.client.api.ObjectStoreConfiguration.Builder
Builds the ObjectStoreConfiguration
build() - Method in class io.nats.client.api.Placement.Builder
Build a Placement object
build() - Method in class io.nats.client.api.Republish.Builder
Build a Placement object
build() - Method in class io.nats.client.api.Source.Builder
Build a Source
build() - Method in class io.nats.client.api.StreamConfiguration.Builder
Builds the StreamConfiguration
build() - Method in class io.nats.client.api.StreamInfoOptions.Builder
Build the options
build() - Method in class io.nats.client.api.SubjectTransform.Builder
Build a Placement object
build() - Method in class io.nats.client.ConsumeOptions.Builder
Build the ConsumeOptions.
build() - Method in class io.nats.client.FetchConsumeOptions.Builder
Build the FetchConsumeOptions.
build() - Method in class io.nats.client.ForceReconnectOptions.Builder
Builds the ForceReconnectOptions.
build() - Method in class io.nats.client.JetStreamOptions.Builder
Builds the JetStream options.
build() - Method in class io.nats.client.KeyValueOptions.Builder
Builds the KeyValue Options.
build() - Method in class io.nats.client.ObjectStoreOptions.Builder
Builds the ObjectStore options.
build() - Method in class io.nats.client.Options.Builder
Build an Options object from this Builder.
build() - Method in class io.nats.client.PublishOptions.Builder
Builds the publish options.
build() - Method in class io.nats.client.PullRequestOptions.Builder
Build the PullRequestOptions.
build() - Method in class io.nats.client.PullSubscribeOptions.Builder
Builds the pull subscribe options.
build() - Method in class io.nats.client.PurgeOptions.Builder
Build the PurgeOptions
build() - Method in class io.nats.client.PushSubscribeOptions.Builder
Builds the push subscribe options.
build() - Method in class io.nats.service.Endpoint.Builder
Build the Endpoint instance.
build() - Method in class io.nats.service.ServiceBuilder
Build the Service instance.
build() - Method in class io.nats.service.ServiceEndpoint.Builder
Build the ServiceEndpoint instance.
buildDataPort() - Method in class io.nats.client.Options
the data port described by these options
builder() - Static method in class io.nats.client.api.ConsumerConfiguration
Creates a builder for the options.
builder(ConsumerConfiguration) - Static method in class io.nats.client.api.ConsumerConfiguration
Creates a builder for the options.
Builder() - Constructor for class io.nats.client.api.ConsumerConfiguration.Builder
Construct the builder
Builder(ConsumerConfiguration) - Constructor for class io.nats.client.api.ConsumerConfiguration.Builder
Construct the builder and initialize values with the existing ConsumerConfiguration
builder() - Static method in class io.nats.client.api.ConsumerLimits
Creates a builder for a consumer limits object.
Builder() - Constructor for class io.nats.client.api.ConsumerLimits.Builder
Construct an instance of the builder
builder() - Static method in class io.nats.client.api.External
Creates a builder for an External object.
Builder() - Constructor for class io.nats.client.api.External.Builder
Construct a builder for an External object
builder() - Static method in class io.nats.client.api.KeyValueConfiguration
Creates a builder for the Key Value Configuration.
builder(String) - Static method in class io.nats.client.api.KeyValueConfiguration
Creates a builder for the Key Value Configuration.
builder(KeyValueConfiguration) - Static method in class io.nats.client.api.KeyValueConfiguration
Creates a builder to copy the key value configuration.
Builder() - Constructor for class io.nats.client.api.KeyValueConfiguration.Builder
Default Builder
Builder(String) - Constructor for class io.nats.client.api.KeyValueConfiguration.Builder
Builder accepting the key value bucket name.
Builder(KeyValueConfiguration) - Constructor for class io.nats.client.api.KeyValueConfiguration.Builder
Construct the builder by copying another configuration
builder() - Static method in class io.nats.client.api.KeyValuePurgeOptions
Creates a builder for the Key Value Purge Options.
Builder() - Constructor for class io.nats.client.api.KeyValuePurgeOptions.Builder
Construct an instance of the builder
builder() - Static method in class io.nats.client.api.Mirror
Create an instance of the Mirror.Builder
builder(Mirror) - Static method in class io.nats.client.api.Mirror
Create an instance of the Mirror.Builder with a copy of all the information in the source mirror
Builder() - Constructor for class io.nats.client.api.Mirror.Builder
Construct a builder
Builder(Mirror) - Constructor for class io.nats.client.api.Mirror.Builder
Construct a builder with a copy of all the information in the source mirror
builder(String, String) - Static method in class io.nats.client.api.ObjectInfo
Get an instance of the builder initialized with a bucket and object meta
builder(String, ObjectMeta) - Static method in class io.nats.client.api.ObjectInfo
Get an instance of the builder initialized with a bucket and object meta
builder(ObjectInfo) - Static method in class io.nats.client.api.ObjectInfo
Get an instance of the builder initialized from existing ObjectInfo
Builder(String, String) - Constructor for class io.nats.client.api.ObjectInfo.Builder
Construct the builder initialized with a bucket and object name
Builder(String, ObjectMeta) - Constructor for class io.nats.client.api.ObjectInfo.Builder
Construct the builder initialized with a bucket and object meta
Builder(ObjectInfo) - Constructor for class io.nats.client.api.ObjectInfo.Builder
Construct the builder initialized from existing ObjectInfo
builder(String) - Static method in class io.nats.client.api.ObjectMeta
Get an instance of the ObjectMeta.Builder starting with the object name
builder(ObjectMeta) - Static method in class io.nats.client.api.ObjectMeta
Get an instance of the ObjectMeta.Builder as a copy of existing meta
Builder(String) - Constructor for class io.nats.client.api.ObjectMeta.Builder
Construct a builder starting with the object name
Builder(ObjectMeta) - Constructor for class io.nats.client.api.ObjectMeta.Builder
Construct a builder as a copy of existing meta
Builder() - Constructor for class io.nats.client.api.ObjectMetaOptions.Builder
Construct an ObjectMetaOptions.Builder
Builder(ObjectMetaOptions) - Constructor for class io.nats.client.api.ObjectMetaOptions.Builder
Construct an ObjectMetaOptions.Builder as a copy of existing options
builder() - Static method in class io.nats.client.api.ObjectStoreConfiguration
Creates a builder for the Object Store Configuration.
builder(String) - Static method in class io.nats.client.api.ObjectStoreConfiguration
Creates a builder for the Object Store Configuration.
builder(ObjectStoreConfiguration) - Static method in class io.nats.client.api.ObjectStoreConfiguration
Creates a builder to copy the Object Store configuration.
Builder() - Constructor for class io.nats.client.api.ObjectStoreConfiguration.Builder
Default Builder
Builder(String) - Constructor for class io.nats.client.api.ObjectStoreConfiguration.Builder
Builder accepting the object store bucket name.
Builder(ObjectStoreConfiguration) - Constructor for class io.nats.client.api.ObjectStoreConfiguration.Builder
Construct the builder by copying another configuration
builder() - Static method in class io.nats.client.api.Placement
Creates a builder for a placements object.
Builder() - Constructor for class io.nats.client.api.Placement.Builder
Construct a builder for Placement
builder() - Static method in class io.nats.client.api.Republish
Creates a builder for a placements object.
Builder() - Constructor for class io.nats.client.api.Republish.Builder
Construct an instance of the builder
builder() - Static method in class io.nats.client.api.Source
Get an instance of the builder
builder(Source) - Static method in class io.nats.client.api.Source
Get an instance of the builder copying an existing source
Builder() - Constructor for class io.nats.client.api.Source.Builder
Construct an instance of the builder
Builder(Source) - Constructor for class io.nats.client.api.Source.Builder
Construct an instance of the builder copying an existing source
builder() - Static method in class io.nats.client.api.StreamConfiguration
Creates a builder for the stream configuration.
builder(StreamConfiguration) - Static method in class io.nats.client.api.StreamConfiguration
Creates a builder to copy the stream configuration.
Builder() - Constructor for class io.nats.client.api.StreamConfiguration.Builder
Default Builder
Builder(StreamConfiguration) - Constructor for class io.nats.client.api.StreamConfiguration.Builder
Update Builder, useful if you need to update a configuration
builder() - Static method in class io.nats.client.api.StreamInfoOptions
Get an instance of the builder
Builder() - Constructor for class io.nats.client.api.StreamInfoOptions.Builder
Construct an instance of the builder
builder() - Static method in class io.nats.client.api.SubjectTransform
Creates a builder for a placements object.
Builder() - Constructor for class io.nats.client.api.SubjectTransform.Builder
Construct an instance of the builder
builder() - Static method in class io.nats.client.ConsumeOptions
Get an instance of the Builder
Builder() - Constructor for class io.nats.client.ConsumeOptions.Builder
Construct a Consume Options Builder
builder() - Static method in class io.nats.client.FetchConsumeOptions
Get an instance of the builder
Builder() - Constructor for class io.nats.client.FetchConsumeOptions.Builder
Construct a builder for FetchConsumeOptions
builder() - Static method in class io.nats.client.ForceReconnectOptions
Creates a builder for the options.
Builder() - Constructor for class io.nats.client.ForceReconnectOptions.Builder
Constructs a new Builder with the default values.
builder() - Static method in class io.nats.client.JetStreamOptions
Creates a builder for the options.
builder(JetStreamOptions) - Static method in class io.nats.client.JetStreamOptions
Creates a builder to copy the options.
Builder() - Constructor for class io.nats.client.JetStreamOptions.Builder
Construct a builder
Builder(JetStreamOptions) - Constructor for class io.nats.client.JetStreamOptions.Builder
Construct a builder from an existing JetStreamOptions
builder() - Static method in class io.nats.client.KeyValueOptions
Creates a builder for the options.
builder(KeyValueOptions) - Static method in class io.nats.client.KeyValueOptions
Creates a builder to copy the options.
builder(JetStreamOptions) - Static method in class io.nats.client.KeyValueOptions
Creates a builder to copy the options.
Builder() - Constructor for class io.nats.client.KeyValueOptions.Builder
Construct an instance of the builder
Builder(KeyValueOptions) - Constructor for class io.nats.client.KeyValueOptions.Builder
Construct an instance of the builder based on an existing KeyValueOptions
builder() - Static method in class io.nats.client.ObjectStoreOptions
Creates a builder for the options.
builder(ObjectStoreOptions) - Static method in class io.nats.client.ObjectStoreOptions
Creates a builder to copy the options.
builder(JetStreamOptions) - Static method in class io.nats.client.ObjectStoreOptions
Creates a builder to copy the options.
Builder() - Constructor for class io.nats.client.ObjectStoreOptions.Builder
Construct the builder
Builder(ObjectStoreOptions) - Constructor for class io.nats.client.ObjectStoreOptions.Builder
Construct the builder from existing options
builder() - Static method in class io.nats.client.Options
Creates a builder for the options in a fluent style
Builder() - Constructor for class io.nats.client.Options.Builder
Constructs a new Builder with the default values.
Builder(Properties) - Constructor for class io.nats.client.Options.Builder
Constructs a new Builder from a Properties object.
Builder(String) - Constructor for class io.nats.client.Options.Builder
Constructs a new Builder from a file that contains properties.
Builder(Options) - Constructor for class io.nats.client.Options.Builder
Construction an Options.Builder copying an existing Options
builder() - Static method in class io.nats.client.PublishOptions
Creates a builder for the options.
Builder() - Constructor for class io.nats.client.PublishOptions.Builder
Constructs a new publish options Builder with the default values.
Builder(Properties) - Constructor for class io.nats.client.PublishOptions.Builder
Constructs a builder from properties
builder(int) - Static method in class io.nats.client.PullRequestOptions
Creates a builder for the pull options, with batch size since it's always required
Builder() - Constructor for class io.nats.client.PullRequestOptions.Builder
Construct an instance of the builder
builder() - Static method in class io.nats.client.PullSubscribeOptions
Macro to start a PullSubscribeOptions builder
Builder() - Constructor for class io.nats.client.PullSubscribeOptions.Builder
Construct an instance of the builder
builder() - Static method in class io.nats.client.PurgeOptions
Creates a builder for the purge options
Builder() - Constructor for class io.nats.client.PurgeOptions.Builder
Construct a builder instance
builder() - Static method in class io.nats.client.PushSubscribeOptions
Macro to start a PushSubscribeOptions builder
Builder() - Constructor for class io.nats.client.PushSubscribeOptions.Builder
Construct an instance of the builder
builder() - Static method in class io.nats.service.Endpoint
Get an instance of an Endpoint builder.
Builder() - Constructor for class io.nats.service.Endpoint.Builder
Construct the builder
builder() - Static method in class io.nats.service.Service
Get an instance of a ServiceBuilder.
builder() - Static method in class io.nats.service.ServiceEndpoint
Get an instance of a ServiceEndpoint Builder.
Builder() - Constructor for class io.nats.service.ServiceEndpoint.Builder
Construct an instance of the builder
buildProtocolConnectOptionsString(String, boolean, byte[]) - Method in class io.nats.client.Options
Create the options string sent with the connect message.
buildPullSubscribeOptions() - Method in class io.nats.client.api.ConsumerConfiguration.Builder
Builds the PullSubscribeOptions with this configuration
buildPullSubscribeOptions(String) - Method in class io.nats.client.api.ConsumerConfiguration.Builder
Builds the PullSubscribeOptions with this configuration Providing the stream is a hint for the subscription process that saves a call to the server.
buildPushSubscribeOptions() - Method in class io.nats.client.api.ConsumerConfiguration.Builder
Builds the PushSubscribeOptions with this configuration
buildPushSubscribeOptions(String) - Method in class io.nats.client.api.ConsumerConfiguration.Builder
Builds the PushSubscribeOptions with this configuration.

C

callbackThreadFactory(ThreadFactory) - Method in class io.nats.client.Options.Builder
Sets custom thread factory for the executor service
chunks(long) - Method in class io.nats.client.api.ObjectInfo.Builder
set the object's number of chunks
chunkSize(int) - Method in class io.nats.client.api.ObjectInfo.Builder
convenience method to set the object's ObjectMeta chunk size
chunkSize(int) - Method in class io.nats.client.api.ObjectMeta.Builder
Convenience method to set the ObjectMetaOptions chunk size
chunkSize(int) - Method in class io.nats.client.api.ObjectMetaOptions.Builder
Set the chunk size
clear() - Method in class io.nats.client.NKey
Clear the seed and public key char arrays by zero-ing them out.
clearDroppedCount() - Method in interface io.nats.client.Consumer
Reset the drop count to 0.
clearExpected() - Method in class io.nats.client.PublishOptions.Builder
Clears the expected so the build can be re-used.
clearLastError() - Method in interface io.nats.client.Connection
Clear the last error from the server
CLIENT_LANGUAGE - Static variable in class io.nats.client.Nats
Current language of the library - "java"
CLIENT_VERSION - Static variable in class io.nats.client.Nats
Current version of the library
clientSideLimitChecks(boolean) - Method in class io.nats.client.Options.Builder
Set client side limit checks.
clientSideLimitChecks() - Method in class io.nats.client.Options
clientSideLimitChecks
close() - Method in interface io.nats.client.Connection
Close the connection and release all blocking calls like flush and nextMessage.
close() - Method in interface io.nats.client.MessageConsumer
Unsubscribe the underlying subject.
closeDispatcher(Dispatcher) - Method in interface io.nats.client.Connection
Close a dispatcher.
cluster(String) - Method in class io.nats.client.api.Placement.Builder
Set the cluster string.
ClusterInfo - Class in io.nats.client.api
Information about the cluster a stream is part of.
compareTo(Subject) - Method in class io.nats.client.api.Subject
 
compression(boolean) - Method in class io.nats.client.api.KeyValueConfiguration.Builder
Sets whether to use compression for the KeyValueConfiguration.
compression(boolean) - Method in class io.nats.client.api.ObjectStoreConfiguration.Builder
Sets whether to use compression for the ObjectStoreConfiguration.
CompressionOption - Enum in io.nats.client.api
Stream compression policies.
compressionOption(CompressionOption) - Method in class io.nats.client.api.StreamConfiguration.Builder
Sets the compression option in the StreamConfiguration.
connect() - Static method in class io.nats.client.Nats
Connect to the default URL, Options.DEFAULT_URL, with all the default options.
connect(String) - Static method in class io.nats.client.Nats
Connect to specific url, with all the default options.
connect(String, AuthHandler) - Static method in class io.nats.client.Nats
Connect to the specified URL with the specified auth handler.
connect(Options) - Static method in class io.nats.client.Nats
Options can be used to set the server URL, or multiple URLS, callback handlers for various errors, and connection events.
connectAsynchronously(Options, boolean) - Static method in class io.nats.client.Nats
Try to connect in another thread, a connection listener is required to get the connection.
connectFailed(NatsUri) - Method in interface io.nats.client.ServerPool
Indicate that the connection to this NatsUri failed.
Connection - Interface in io.nats.client
The Connection class is at the heart of the NATS Java client.
connection(Connection) - Method in class io.nats.service.ServiceBuilder
The connection the service runs on
Connection.Status - Enum in io.nats.client
Enum representing the status of a connection
connectionEvent(Connection, ConnectionListener.Events) - Method in interface io.nats.client.ConnectionListener
Deprecated.
use new api that gives additional details Connection related events that occur asynchronously in the client code are sent to a ConnectionListener via a single method. The ConnectionListener can use the event type to decide what to do about the problem.
connectionEvent(Connection, ConnectionListener.Events, Long, String) - Method in interface io.nats.client.ConnectionListener
Connection related events that occur asynchronously in the client code are sent to a ConnectionListener via a single method.
ConnectionListener - Interface in io.nats.client
Applications can use a ConnectionListener to track the status of a Connection.
connectionListener(ConnectionListener) - Method in class io.nats.client.Options.Builder
Set the ConnectionListener to receive asynchronous notifications of disconnect events.
ConnectionListener.Events - Enum in io.nats.client
Enum for connection events
connectionName(String) - Method in class io.nats.client.Options.Builder
Set the connection's optional Name.
connectionTimeout(Duration) - Method in class io.nats.client.Options.Builder
Set the timeout for connection attempts.
connectionTimeout(long) - Method in class io.nats.client.Options.Builder
Set the timeout for connection attempts.
connectReconnectOnConnect() - Static method in class io.nats.client.Nats
Connect to the default URL, Options.DEFAULT_URL, with all the default options, allowing re-connect attempts if the initial connection fails
connectReconnectOnConnect(String) - Static method in class io.nats.client.Nats
Connect to specific url, with all the default options, allowing re-connect attempts if the initial connection fails
connectReconnectOnConnect(String, AuthHandler) - Static method in class io.nats.client.Nats
Connect to the specified URL with the specified auth handler, allowing re-connect attempts if the initial connection fails
connectReconnectOnConnect(Options) - Static method in class io.nats.client.Nats
Connect, allowing re-connect attempts if the initial connection fails
connectSucceeded(NatsUri) - Method in interface io.nats.client.ServerPool
Indicate that the connection to this NatsUri succeeded.
connectThreadFactory(ThreadFactory) - Method in class io.nats.client.Options.Builder
Sets custom thread factory for the executor service
consume(MessageHandler) - Method in interface io.nats.client.BaseConsumerContext
Start a long-running MessageConsumer with default ConsumeOptions.
consume(Dispatcher, MessageHandler) - Method in interface io.nats.client.BaseConsumerContext
Start a long-running MessageConsumer with default ConsumeOptions.
consume(ConsumeOptions, MessageHandler) - Method in interface io.nats.client.BaseConsumerContext
Start a long-running MessageConsumer with custom ConsumeOptions.
consume(ConsumeOptions, Dispatcher, MessageHandler) - Method in interface io.nats.client.BaseConsumerContext
Start a long-running MessageConsumer with custom ConsumeOptions.
consumeByteCount() - Method in interface io.nats.client.Message
The number of bytes the server counts for the message when calculating byte counts.
consumeKeys() - Method in interface io.nats.client.KeyValue
Get a list of keys in the bucket through a LinkedBlockingQueue.
consumeKeys(String) - Method in interface io.nats.client.KeyValue
Get a list of keys in the bucket through a LinkedBlockingQueue filtered by a subject-like string, for instance "key" or "key.foo.*" or "key.>" A KeyResult with isDone being true or an exception signifies there are no more keys
consumeKeys(List<String>) - Method in interface io.nats.client.KeyValue
Get a list of keys in the bucket through a LinkedBlockingQueue filtered by subject-like strings, for instance "aaa.*", "bbb.*;" A KeyResult with isDone being true or an exception signifies there are no more keys
ConsumeOptions - Class in io.nats.client
Consume Options are provided to customize the consume operation.
ConsumeOptions.Builder - Class in io.nats.client
The Consume Options Builder
Consumer - Interface in io.nats.client
A Consumer in the NATS library is an object that represents an incoming queue of messages.
ConsumerConfiguration - Class in io.nats.client.api
The ConsumerConfiguration class specifies the configuration for creating a JetStream consumer on the client and if necessary the server.
ConsumerConfiguration.Builder - Class in io.nats.client.api
ConsumerConfiguration is created using a Builder.
ConsumerContext - Interface in io.nats.client
The Consumer Context provides a convenient interface around a defined JetStream Consumer
ConsumerInfo - Class in io.nats.client.api
The ConsumerInfo class returns information about a JetStream consumer.
ConsumerInfo(Message) - Constructor for class io.nats.client.api.ConsumerInfo
Construct a ConsumerInfo instance from a message
ConsumerInfo(JsonValue) - Constructor for class io.nats.client.api.ConsumerInfo
Construct a ConsumerInfo instance from a JsonValue
ConsumerLimits - Class in io.nats.client.api
ConsumerLimits
consumerLimits(ConsumerLimits) - Method in class io.nats.client.api.StreamConfiguration.Builder
Sets the consumerLimits config object
ConsumerLimits.Builder - Class in io.nats.client.api
ConsumerLimits can be created using a Builder.
consumerNamePrefix(String) - Method in class io.nats.client.api.OrderedConsumerConfiguration
Sets the consumer name prefix for consumers created by this configuration.
ConsumerPauseRequest - Class in io.nats.client.api
Object used to make a request to pause a consumer.
ConsumerPauseRequest(ZonedDateTime) - Constructor for class io.nats.client.api.ConsumerPauseRequest
Construct a consumer pause request with the time requested to pause
ConsumerPauseResponse - Class in io.nats.client.api
The response for a ConsumerPauseRequest
ConsumerPauseResponse(Message) - Constructor for class io.nats.client.api.ConsumerPauseResponse
Construct a ConsumerPauseResponse instance from a message
convert(Status) - Static method in class io.nats.client.api.Error
Convert a status to an Error object.
convertDomainToPrefix(String) - Static method in class io.nats.client.JetStreamOptions
Helper function to convert a domain to a prefix
create(String, byte[]) - Method in interface io.nats.client.KeyValue
Put as the value for a key iff the key does not exist (there is no history) or is deleted (history shows the key is deleted)
create(String, byte[], MessageTtl) - Method in interface io.nats.client.KeyValue
Put as the value for a key iff the key does not exist (there is no history) or is deleted (history shows the key is deleted)
create(KeyValueConfiguration) - Method in interface io.nats.client.KeyValueManagement
Create a key value store.
create(ObjectStoreConfiguration) - Method in interface io.nats.client.ObjectStoreManagement
Create an object store.
createAccount(SecureRandom) - Static method in class io.nats.client.NKey
Create an Account NKey from the provided random number generator.
createCluster(SecureRandom) - Static method in class io.nats.client.NKey
Create a Cluster NKey from the provided random number generator.
createConsumer(String, ConsumerConfiguration) - Method in interface io.nats.client.JetStreamManagement
Creates a consumer.
createDispatcher(MessageHandler) - Method in interface io.nats.client.Connection
Create a Dispatcher for this connection.
createDispatcher() - Method in interface io.nats.client.Connection
Convenience method to create a dispatcher with no default handler.
createInbox() - Method in interface io.nats.client.Connection
Create a new inbox subject, can be used for directed replies from subscribers.
createOperator(SecureRandom) - Static method in class io.nats.client.NKey
Create an Operator NKey from the provided random number generator.
createOrderedConsumer(OrderedConsumerConfiguration) - Method in interface io.nats.client.StreamContext
Create an ordered consumer context for the context's stream.
createOrUpdateConsumer(ConsumerConfiguration) - Method in interface io.nats.client.StreamContext
Management function to create or update a consumer on this stream.
createServer(SecureRandom) - Static method in class io.nats.client.NKey
Create a Server NKey from the provided random number generator.
createURIForServer(String) - Method in class io.nats.client.Options
create a URI from a server uri.
createUser(SecureRandom) - Static method in class io.nats.client.NKey
Create a User NKey from the provided random number generator.
credentialPath(String) - Method in class io.nats.client.Options.Builder
the path to the credentials file for creating an AuthHandler
credentials(String) - Static method in class io.nats.client.Nats
Create an auth handler from a creds file.
credentials(String, String) - Static method in class io.nats.client.Nats
Create an AuthHandler from a jwt file and an nkey file.
currentTimeMillis() - Static method in class io.nats.client.NatsSystemClock
Get the current milliseconds from the provider
currentTimeMillis() - Method in interface io.nats.client.NatsSystemClockProvider
Returns the current time in milliseconds
custom(String) - Static method in class io.nats.client.MessageTtl
Sets the TTL for this specific message to be published.

D

dataPortType(String) - Method in class io.nats.client.Options.Builder
The class to use for this connections data port.
decrementOutstandingRequests() - Method in interface io.nats.client.StatisticsCollector
Decrements the count of outstanding of requests from this connection.
DEFAULT_ACK_POLICY - Static variable in class io.nats.client.api.ConsumerConfiguration
The default ack policy for consumers
DEFAULT_BUFFER_SIZE - Static variable in class io.nats.client.Options
Default size for buffers in the connection, not as available as other settings, this is primarily changed for testing, getBufferSize().
DEFAULT_CONNECTION_TIMEOUT - Static variable in class io.nats.client.Options
Default connection timeout, see getConnectionTimeout().
DEFAULT_CONSUME_OPTIONS - Static variable in class io.nats.client.ConsumeOptions
An instance of ConsumeOptions representing the default consume options
DEFAULT_DATA_PORT_TYPE - Static variable in class io.nats.client.Options
Default dataport class, which will use a TCP socket, getDataPortType().
DEFAULT_DELIVER_POLICY - Static variable in class io.nats.client.api.ConsumerConfiguration
The default deliver policy for consumers
DEFAULT_DESCRIPTION - Static variable in exception io.nats.client.JetStreamStatusException
A description for an exception that does not provide one
DEFAULT_DISCARD_MESSAGES_WHEN_OUTGOING_QUEUE_FULL - Static variable in class io.nats.client.Options
This value is used internally to discard messages when the outgoing queue is full.
DEFAULT_DISCOVERY_MAX_RESULTS - Static variable in class io.nats.service.Discovery
Default discoverer max results
DEFAULT_DISCOVERY_MAX_TIME_MILLIS - Static variable in class io.nats.service.Discovery
Default discover time
DEFAULT_DRAIN_TIMEOUT - Static variable in class io.nats.service.ServiceBuilder
Constant for the default drain timeout as duration
DEFAULT_DRAIN_TIMEOUT_MILLIS - Static variable in class io.nats.service.ServiceBuilder
Constant for the default drain timeout in millis
DEFAULT_EXPIRES_IN_MILLIS - Static variable in class io.nats.client.BaseConsumeOptions
constant for default expires in millis
DEFAULT_FETCH_OPTIONS - Static variable in class io.nats.client.FetchConsumeOptions
An instance of FetchConsumeOptions representing the default fetch options
DEFAULT_INBOX_PREFIX - Static variable in class io.nats.client.Options
Default prefix used for inboxes, you can change this to manage authorization of subjects.
DEFAULT_INSTANCE - Static variable in class io.nats.client.ForceReconnectOptions
A default instance of ForceReconnectOptions
DEFAULT_JS_OPTIONS - Static variable in class io.nats.client.JetStreamOptions
An instance of default options
DEFAULT_MAX_BYTES - Static variable in interface io.nats.client.Consumer
The default number of bytes a consumer will hold before it starts to drop messages.
DEFAULT_MAX_CONTROL_LINE - Static variable in class io.nats.client.Options
The default length, 4096 bytes, the client will allow in an outgoing protocol control line, getMaxControlLine().
DEFAULT_MAX_MESSAGES - Static variable in interface io.nats.client.Consumer
The default number of messages a consumer will hold before it starts to drop them.
DEFAULT_MAX_MESSAGES_IN_OUTGOING_QUEUE - Static variable in class io.nats.client.Options
This value is used internally to limit the number of messages allowed in the outgoing queue.
DEFAULT_MAX_PINGS_OUT - Static variable in class io.nats.client.Options
Default maximum number of pings have not received a response allowed by the client, getMaxPingsOut().
DEFAULT_MAX_RECONNECT - Static variable in class io.nats.client.Options
Default maximum number of reconnect attempts, see getMaxReconnect().
DEFAULT_MESSAGE_COUNT - Static variable in class io.nats.client.BaseConsumeOptions
constant for default message count
DEFAULT_MESSAGE_COUNT_WHEN_BYTES - Static variable in class io.nats.client.BaseConsumeOptions
constant for default message count when bytes
DEFAULT_ORDERED_HEARTBEAT - Static variable in class io.nats.client.SubscribeOptions
Constant for the default ordered heartbeat time in milliseconds
DEFAULT_PING_INTERVAL - Static variable in class io.nats.client.Options
Default server ping interval.
DEFAULT_PORT - Static variable in class io.nats.client.Options
Default server port.
DEFAULT_PRIORITY_POLICY - Static variable in class io.nats.client.api.ConsumerConfiguration
The default priority policy for consumers
DEFAULT_PULL_OPTS - Static variable in class io.nats.client.PullSubscribeOptions
An instance of PullSubscribeOptions with the default options
DEFAULT_PUSH_OPTS - Static variable in class io.nats.client.PushSubscribeOptions
An instance of PushSubscribeOptions with all the default options.
DEFAULT_QGROUP - Static variable in class io.nats.service.Endpoint
The name of the default queue group
DEFAULT_RECONNECT_BUF_SIZE - Static variable in class io.nats.client.Options
Default of pending message buffer that is used for buffering messages that are published during a disconnect/reconnect, getReconnectBufferSize().
DEFAULT_RECONNECT_JITTER - Static variable in class io.nats.client.Options
Default wait time before attempting reconnection to the same server, see getReconnectJitter().
DEFAULT_RECONNECT_JITTER_TLS - Static variable in class io.nats.client.Options
Default wait time before attempting reconnection to the same server, see getReconnectJitterTls().
DEFAULT_RECONNECT_WAIT - Static variable in class io.nats.client.Options
Default wait time before attempting reconnection to the same server, see getReconnectWait().
DEFAULT_REPLAY_POLICY - Static variable in class io.nats.client.api.ConsumerConfiguration
The default replay policy for consumers
DEFAULT_REQUEST_CLEANUP_INTERVAL - Static variable in class io.nats.client.Options
Default interval to clean up cancelled/timed out requests.
DEFAULT_SERVICE_PREFIX - Static variable in class io.nats.service.Service
Constant of the service prefix
DEFAULT_SINGLE_THREAD_EXECUTOR - Static variable in class io.nats.client.Options
Default supplier for creating a single-threaded executor service.
DEFAULT_SOCKET_WRITE_TIMEOUT - Static variable in class io.nats.client.Options
Default socket write timeout, see getSocketWriteTimeout().
DEFAULT_SSL_PROTOCOL - Static variable in class io.nats.client.Options
Default SSL protocol used to create an SSLContext if the secure property is used.
DEFAULT_THREAD_NAME_PREFIX - Static variable in class io.nats.client.Options
Default thread name prefix.
DEFAULT_THRESHOLD_MILLIS - Static variable in class io.nats.client.api.KeyValuePurgeOptions
The default time in millis that is used for as the threshold to keep markers.
DEFAULT_THRESHOLD_PERCENT - Static variable in class io.nats.client.BaseConsumeOptions
constant for default threshold percent
DEFAULT_TIMEOUT - Static variable in class io.nats.client.JetStreamOptions
Deprecated.
Not used anymore
DEFAULT_TIMEOUT - Static variable in class io.nats.client.PublishOptions
Use this variable for timeout in publish options.
DEFAULT_URL - Static variable in class io.nats.client.Options
Default server URL.
defaultOptions() - Static method in class io.nats.client.JetStreamOptions
Get an instance of JetStreamOptions with all defaults
delete(String) - Method in interface io.nats.client.KeyValue
Soft deletes the key by placing a delete marker.
delete(String, long) - Method in interface io.nats.client.KeyValue
Soft deletes the key by placing a delete marker iff the key exists and its last revision matches the expected
delete(String) - Method in interface io.nats.client.KeyValueManagement
Deletes an existing bucket.
delete(String) - Method in interface io.nats.client.ObjectStore
Delete the object by name.
delete(String) - Method in interface io.nats.client.ObjectStoreManagement
Deletes an existing object store.
deleteConsumer(String, String) - Method in interface io.nats.client.JetStreamManagement
Deletes a consumer.
deleteConsumer(String) - Method in interface io.nats.client.StreamContext
Management function to deletes a consumer.
deleted(boolean) - Method in class io.nats.client.api.ObjectInfo.Builder
set the object's deleted state
deletedDetails() - Method in class io.nats.client.api.StreamInfoOptions.Builder
Turns on getting deleted details
deletedDetails() - Static method in class io.nats.client.api.StreamInfoOptions
Create options that get deleted details.
deleteMarkersNoThreshold() - Method in class io.nats.client.api.KeyValuePurgeOptions.Builder
Set the delete marker threshold to -1 so as to not keep any markers
deleteMarkersThreshold(Duration) - Method in class io.nats.client.api.KeyValuePurgeOptions.Builder
Set the delete marker threshold.
deleteMarkersThreshold(long) - Method in class io.nats.client.api.KeyValuePurgeOptions.Builder
Set the delete marker threshold.
deleteMessage(String, long) - Method in interface io.nats.client.JetStreamManagement
Deletes a message, overwriting the message data with garbage This can be considered an expensive (time-consuming) operation, but is more secure.
deleteMessage(String, long, boolean) - Method in interface io.nats.client.JetStreamManagement
Deletes a message, optionally erasing the content of the message.
deleteMessage(long) - Method in interface io.nats.client.StreamContext
Deletes a message, overwriting the message data with garbage This can be considered an expensive (time-consuming) operation, but is more secure.
deleteMessage(long, boolean) - Method in interface io.nats.client.StreamContext
Deletes a message, optionally erasing the content of the message.
deleteStream(String) - Method in interface io.nats.client.JetStreamManagement
Deletes an existing stream.
deliver(String) - Method in class io.nats.client.api.External.Builder
Set the deliver string.
deliverGroup(String) - Method in class io.nats.client.api.ConsumerConfiguration.Builder
Sets the group to deliver messages to.
deliverGroup(String) - Method in class io.nats.client.PushSubscribeOptions.Builder
Setting this specifies deliver group.
deliverPolicy(DeliverPolicy) - Method in class io.nats.client.api.ConsumerConfiguration.Builder
Sets the delivery policy of the ConsumerConfiguration.
DeliverPolicy - Enum in io.nats.client.api
The delivery policy for this consumer, the point in the stream from which to receive messages
deliverPolicy(DeliverPolicy) - Method in class io.nats.client.api.OrderedConsumerConfiguration
Sets the delivery policy of the OrderedConsumerConfiguration.
deliverPolicyWasSet() - Method in class io.nats.client.api.ConsumerConfiguration
Gets whether deliver policy of this consumer configuration was set or left unset
deliverSubject(String) - Method in class io.nats.client.api.ConsumerConfiguration.Builder
Sets the subject to deliver messages to.
deliverSubject(String) - Method in class io.nats.client.PushSubscribeOptions.Builder
Setting this specifies the push model to a delivery subject.
denyDelete(boolean) - Method in class io.nats.client.api.StreamConfiguration.Builder
Set whether to deny deleting messages from the stream
denyPurge(boolean) - Method in class io.nats.client.api.StreamConfiguration.Builder
Set whether to deny purging messages from the stream
description(String) - Method in class io.nats.client.api.ConsumerConfiguration.Builder
Sets the description
description(String) - Method in class io.nats.client.api.KeyValueConfiguration.Builder
Sets the description of the store.
description(String) - Method in class io.nats.client.api.ObjectInfo.Builder
convenience method to set the object's ObjectMeta description
description(String) - Method in class io.nats.client.api.ObjectMeta.Builder
Set the object description
description(String) - Method in class io.nats.client.api.ObjectStoreConfiguration.Builder
Sets the description of the store.
description(String) - Method in class io.nats.client.api.StreamConfiguration.Builder
Sets the description
description(String) - Method in class io.nats.service.ServiceBuilder
The simple description of the service
destination(String) - Method in class io.nats.client.api.Republish.Builder
Set the RePublish Subject template
destination(String) - Method in class io.nats.client.api.SubjectTransform.Builder
Set the SubjectTransform Subject template
digest(String) - Method in class io.nats.client.api.ObjectInfo.Builder
set the object's digest
discardMessagesWhenOutgoingQueueFull() - Method in class io.nats.client.Options.Builder
Enable discard messages when the outgoing queue full.
discardNewPerSubject(boolean) - Method in class io.nats.client.api.StreamConfiguration.Builder
Set whether discard policy new with max message per subject applies to existing subjects, not just new subjects.
DiscardPolicy - Enum in io.nats.client.api
Stream discard policies
discardPolicy(DiscardPolicy) - Method in class io.nats.client.api.StreamConfiguration.Builder
Sets the discard policy in the StreamConfiguration.
Discovery - Class in io.nats.service
Discovery is a utility class to help discover services by executing Ping, Info and Stats requests You are required to provide a connection.
Discovery(Connection) - Constructor for class io.nats.service.Discovery
Construct a Discovery instance with a connection and default maxTimeMillis / maxResults
Discovery(Connection, long, int) - Constructor for class io.nats.service.Discovery
Construct a Discovery instance
Dispatcher - Interface in io.nats.client
This library uses the concept of a Dispatcher to organize message callbacks in a way that the application can control.
dispatcher(Dispatcher) - Method in class io.nats.service.ServiceEndpoint.Builder
Set the user Dispatcher for this ServiceEndpoint
dispatcherFactory(DispatcherFactory) - Method in class io.nats.client.Options.Builder
Set the DispatcherFactory implementation for connections to use instead of the default implementation
domain(String) - Method in class io.nats.client.api.SourceBase.SourceBaseBuilder
Set the domain
domain(String) - Method in class io.nats.client.JetStreamOptions.Builder
Sets the domain for JetStream subjects, creating a standard prefix from that domain in the form $JS.(domain).API.
dontForceFlushOnRequest() - Method in class io.nats.client.Options.Builder
Instruct requests to turn off flush on requests.
drain(Duration) - Method in interface io.nats.client.Connection
Drain tells the connection to process in flight messages before closing.
drain(Duration) - Method in interface io.nats.client.Consumer
Drain tells the consumer to process in flight, or cached messages, but stop receiving new ones.
drainTimeout(Duration) - Method in class io.nats.service.ServiceBuilder
The timeout when stopping a service.
drainTimeout(long) - Method in class io.nats.service.ServiceBuilder
The timeout when stopping a service.
duplicateWindow(Duration) - Method in class io.nats.client.api.StreamConfiguration.Builder
Sets the duplicate checking window in the StreamConfiguration.
duplicateWindow(long) - Method in class io.nats.client.api.StreamConfiguration.Builder
Sets the duplicate checking window in the StreamConfiguration.
durable(String) - Method in class io.nats.client.api.ConsumerConfiguration.Builder
Sets the name of the durable consumer.
DURATION_MIN - Static variable in class io.nats.client.api.ConsumerConfiguration
Deprecated.
DURATION_MIN_LONG - Static variable in class io.nats.client.api.ConsumerConfiguration
Constant used to unset a Duration setting in the builder
DURATION_UNSET - Static variable in class io.nats.client.api.ConsumerConfiguration
Constant used to unset a Duration setting in the builder
DURATION_UNSET_LONG - Static variable in class io.nats.client.api.ConsumerConfiguration
Constant used to unset a long setting in the builder

E

EMPTY_INFO - Static variable in class io.nats.client.api.ServerInfo
Constant representing an empty info.
enableFastFallback() - Method in class io.nats.client.Options.Builder
Whether to enable Fast fallback algorithm for socket connect
endOfData() - Method in interface io.nats.client.api.Watcher
Called once if there is no data when the watch is created or if there is data, the first time the watch exhausts all existing data.
Endpoint - Class in io.nats.service
Endpoint encapsulates the name, subject and metadata for a ServiceEndpoint.
Endpoint(String) - Constructor for class io.nats.service.Endpoint
Directly construct an Endpoint with a name, which becomes the subject
Endpoint(String, Map<String, String>) - Constructor for class io.nats.service.Endpoint
Directly construct an Endpoint with a name, which becomes the subject, and metadata
Endpoint(String, String) - Constructor for class io.nats.service.Endpoint
Directly construct an Endpoint with a name and a subject
Endpoint(String, String, Map<String, String>) - Constructor for class io.nats.service.Endpoint
Directly construct an Endpoint with a name, the subject, and metadata
Endpoint(String, String, String, Map<String, String>) - Constructor for class io.nats.service.Endpoint
Directly construct an Endpoint with a name, the subject, queueGroup and metadata
endpoint(Endpoint) - Method in class io.nats.service.Endpoint.Builder
Copy the Endpoint, replacing all existing endpoint information.
endpoint(Endpoint) - Method in class io.nats.service.ServiceEndpoint.Builder
Set the Endpoint for this ServiceEndpoint replacing all existing endpoint information.
Endpoint.Builder - Class in io.nats.service
Build an Endpoint using a fluent builder.
endpointMetadata(Map<String, String>) - Method in class io.nats.service.ServiceEndpoint.Builder
Set the metadata for the Endpoint for this ServiceEndpoint replacing any metadata already set.
endpointName(String) - Method in class io.nats.service.ServiceEndpoint.Builder
Set the name for the Endpoint for this ServiceEndpoint replacing any name already set.
endpointQueueGroup(String) - Method in class io.nats.service.ServiceEndpoint.Builder
Set the queueGroup for the Endpoint for this ServiceEndpoint replacing any queueGroup already set.
EndpointStats - Class in io.nats.service
Endpoints stats contains various stats and custom data for an endpoint.
endpointSubject(String) - Method in class io.nats.service.ServiceEndpoint.Builder
Set the subject for the Endpoint for this ServiceEndpoint replacing any subject already set.
equals(Object) - Method in class io.nats.client.api.External
 
equals(Object) - Method in class io.nats.client.api.KeyValueEntry
 
equals(Object) - Method in class io.nats.client.api.ObjectInfo
 
equals(Object) - Method in class io.nats.client.api.ObjectLink
 
equals(Object) - Method in class io.nats.client.api.ObjectMeta
 
equals(Object) - Method in class io.nats.client.api.ObjectMetaOptions
 
equals(Object) - Method in class io.nats.client.api.SourceBase
 
equals(Object) - Method in class io.nats.client.api.SubjectTransform
 
equals(Object) - Method in class io.nats.client.NKey
 
equals(Object) - Method in class io.nats.service.Endpoint
 
equals(Object) - Method in class io.nats.service.EndpointStats
 
equals(Object) - Method in class io.nats.service.Group
 
equals(Object) - Method in class io.nats.service.InfoResponse
 
equals(Object) - Method in class io.nats.service.ServiceResponse
 
equals(Object) - Method in class io.nats.service.StatsResponse
 
Error - Class in io.nats.client.api
Error returned from an api request.
ErrorListener - Interface in io.nats.client
This library groups problems into four categories: Errors The server sent an error message using the -err protocol operation. Exceptions A Java exception occurred, and was handled by the library. Slow Consumers One of the connections consumers, Subscription or Dispatcher, is slow, and starting to drop messages. Fast Producers One of the connections producers is too fast, and is discarding messages
errorListener(ErrorListener) - Method in class io.nats.client.Options.Builder
Set the ErrorListener to receive asynchronous error events related to this connection.
ErrorListener.FlowControlSource - Enum in io.nats.client
Enum for the flow control source
errorOccurred(Connection, String) - Method in interface io.nats.client.ErrorListener
NATs related errors that occur asynchronously in the client library are sent to an ErrorListener via errorOccurred.
exceptionOccurred(Connection, Exception) - Method in interface io.nats.client.ErrorListener
Exceptions that occur in the "normal" course of operations are sent to the ErrorListener using exceptionOccurred.
executor(ExecutorService) - Method in class io.nats.client.Options.Builder
Set the ExecutorService used to run threaded tasks.
executorIsInternal() - Method in class io.nats.client.Options
whether the general executor is the internal one versus a user supplied one
expectedLastMsgId(String) - Method in class io.nats.client.PublishOptions.Builder
Sets the expected last ID of the previously published message.
expectedLastSequence(long) - Method in class io.nats.client.PublishOptions.Builder
Sets the expected message sequence of the publish
expectedLastSubjectSequence(long) - Method in class io.nats.client.PublishOptions.Builder
Sets the expected subject message sequence of the publish
expectedLastSubjectSequenceSubject(String) - Method in class io.nats.client.PublishOptions.Builder
Sets the filter subject for the expected last subject sequence This can be used for a wildcard since it is used in place of the message subject along with expectedLastSubjectSequence
expectedStream(String) - Method in class io.nats.client.PublishOptions.Builder
Sets the expected stream for the publish.
expiresIn(long) - Method in class io.nats.client.FetchConsumeOptions.Builder
 
expiresIn(long) - Method in class io.nats.client.PullRequestOptions.Builder
Set the expires time in millis
expiresIn(Duration) - Method in class io.nats.client.PullRequestOptions.Builder
Set the expires duration
External - Class in io.nats.client.api
External configuration referencing a stream source in another account
External(String, String) - Constructor for class io.nats.client.api.External
Construct the External configuration
External(External) - Constructor for class io.nats.client.api.External
Construct an External configuration copying the information from an External configuration
external(External) - Method in class io.nats.client.api.SourceBase.SourceBaseBuilder
Set the external reference
External.Builder - Class in io.nats.client.api
External can be created using a Builder.

F

fastBind(boolean) - Method in class io.nats.client.PullSubscribeOptions.Builder
Specify binding to an existing consumer via name.
fastBind(String, String) - Static method in class io.nats.client.PullSubscribeOptions
Create PullSubscribeOptions where you are fast-binding to a specific stream and consumer by name.
FeatureConfiguration - Class in io.nats.client.api
base class for feature configurations
FeatureConfiguration(StreamConfiguration, String) - Constructor for class io.nats.client.api.FeatureConfiguration
Construct a FeatureConfiguration from a StreamConfiguration and a bucket name
FeatureOptions - Class in io.nats.client
The FeatureOptions is a base class of general options for features.
fetch(FetchConsumeOptions) - Method in interface io.nats.client.BaseConsumerContext
Start a one-use Fetch Consumer with custom FetchConsumeOptions.
fetch(int, Duration) - Method in interface io.nats.client.JetStreamSubscription
Fetch a list of messages up to the batch size, waiting no longer than maxWait.
fetch(int, long) - Method in interface io.nats.client.JetStreamSubscription
Fetch a list of messages up to the batch size, waiting no longer than maxWait.
fetchBytes(int) - Method in interface io.nats.client.BaseConsumerContext
Start a one use Fetch Consumer using all defaults other than the number of bytes.
FetchConsumeOptions - Class in io.nats.client
Fetch Consume Options are provided to customize the fetch operation.
FetchConsumeOptions.Builder - Class in io.nats.client
The builder for FetchConsumeOptions
FetchConsumer - Interface in io.nats.client
A fetch consumer gets messages by calling nextMessage.
fetchMessages(int) - Method in interface io.nats.client.BaseConsumerContext
Start a one use Fetch Consumer using all defaults other than the number of messages.
filterSubject(String) - Method in class io.nats.client.api.ConsumerConfiguration.Builder
Sets the filter subject of the ConsumerConfiguration.
filterSubject(String) - Method in class io.nats.client.api.OrderedConsumerConfiguration
Sets the filter subject of the OrderedConsumerConfiguration.
filterSubject(String) - Method in class io.nats.client.api.SourceBase.SourceBaseBuilder
Set the filter subject
filterSubjects(String...) - Method in class io.nats.client.api.ConsumerConfiguration.Builder
Sets the filter subjects of the ConsumerConfiguration.
filterSubjects(List<String>) - Method in class io.nats.client.api.ConsumerConfiguration.Builder
Sets the filter subjects of the ConsumerConfiguration.
filterSubjects(String...) - Method in class io.nats.client.api.OrderedConsumerConfiguration
Sets the filter subjects of the OrderedConsumerConfiguration.
filterSubjects(List<String>) - Method in class io.nats.client.api.OrderedConsumerConfiguration
Sets the filter subject of the OrderedConsumerConfiguration.
filterSubjects(String) - Method in class io.nats.client.api.StreamInfoOptions.Builder
Set the subjects filter, which turns on getting subject info.
filterSubjects(String) - Static method in class io.nats.client.api.StreamInfoOptions
Create options that get subject information, filtering for subjects.
firstSequence(long) - Method in class io.nats.client.api.StreamConfiguration.Builder
Sets the first sequence to be used.
flowControl(Duration) - Method in class io.nats.client.api.ConsumerConfiguration.Builder
set the flow control on and set the idle heartbeat
flowControl(long) - Method in class io.nats.client.api.ConsumerConfiguration.Builder
set the flow control on and set the idle heartbeat
flowControlProcessed(Connection, JetStreamSubscription, String, ErrorListener.FlowControlSource) - Method in interface io.nats.client.ErrorListener
Called by the connection when a flow control is processed.
flowControlWasSet() - Method in class io.nats.client.api.ConsumerConfiguration
Gets whether flow control for this consumer configuration was set or left unset
flush(Duration) - Method in interface io.nats.client.Connection
Flush the connection's buffer of outgoing messages, including sending a protocol message to and from the server.
flush(Duration) - Method in class io.nats.client.ForceReconnectOptions.Builder
if supplied and at least 1 millisecond, the forceReconnect will try to flush before closing for the specified wait time.
flush(long) - Method in class io.nats.client.ForceReconnectOptions.Builder
if supplied and at least 1 millisecond, the forceReconnect will try to flush before closing for the specified wait time.
flushBuffer() - Method in interface io.nats.client.Connection
Immediately flushes the underlying connection buffer if the connection is valid.
FORCE_CLOSE_INSTANCE - Static variable in class io.nats.client.ForceReconnectOptions
An instance representing the force close option
forceClose() - Method in class io.nats.client.ForceReconnectOptions.Builder
set the force close flag to true
forceFlushOnRequest() - Method in class io.nats.client.Options
Whether to flush on any user request
forceReconnect() - Method in interface io.nats.client.Connection
Forces reconnect behavior.
forceReconnect(ForceReconnectOptions) - Method in interface io.nats.client.Connection
Forces reconnect behavior.
ForceReconnectOptions - Class in io.nats.client
The PublishOptions class specifies the options for publishing with JetStream enabled servers.
ForceReconnectOptions.Builder - Class in io.nats.client
ForceReconnectOptions are created using a Builder.
fromPrefix(int) - Static method in enum io.nats.client.NKey.Type
Get an instance of the type from a prefix
fromPublicKey(char[]) - Static method in class io.nats.client.NKey
Create an NKey object from the encoded public key.
fromSeed(char[]) - Static method in class io.nats.client.NKey
Creates an NKey object from a string encoded seed.

G

get(String) - Static method in enum io.nats.client.api.AckPolicy
Get an instance of the AckPolicy or null if the string does not match the JSON value text
get(String) - Static method in enum io.nats.client.api.CompressionOption
Get an instance of the CompressionOption or null if the string does not match the JSON value text
get(String) - Static method in enum io.nats.client.api.DeliverPolicy
Get an instance from the JSON value
get(String) - Static method in enum io.nats.client.api.DiscardPolicy
Get an instance from the JSON value
get(String) - Static method in enum io.nats.client.api.PersistMode
Get an instance from the JSON value
get(String) - Static method in enum io.nats.client.api.PriorityPolicy
Get an instance from the JSON value
get(String) - Static method in enum io.nats.client.api.ReplayPolicy
Get an instance from the JSON value
get(String) - Static method in enum io.nats.client.api.RetentionPolicy
Get an instance from the JSON value
get(String) - Static method in enum io.nats.client.api.StorageType
Get an instance from the JSON value
get(String) - Method in interface io.nats.client.KeyValue
Get the entry for a key when the key exists and is live (not deleted and not purged)
get(String, long) - Method in interface io.nats.client.KeyValue
Get the specific revision of an entry for a key when the key exists and is live (not deleted and not purged)
get(String, OutputStream) - Method in interface io.nats.client.ObjectStore
Get an object by name from the store, reading it into the output stream, if the object exists.
getAccountStatistics() - Method in interface io.nats.client.JetStreamManagement
Gets the account statistics for the logged in account.
getAckFloor() - Method in class io.nats.client.api.ConsumerInfo
The highest contiguous acknowledged message
getAckPolicy() - Method in class io.nats.client.api.ConsumerConfiguration
Gets the acknowledgment policy of this consumer configuration.
getAckWait() - Method in class io.nats.client.api.ConsumerConfiguration
Gets the acknowledgment wait of this consumer configuration.
getActive() - Method in class io.nats.client.api.PeerInfo
Time since this peer was last seen
getAllowAtomicPublish() - Method in class io.nats.client.api.StreamConfiguration
Whether Allow Atomic Publish is set
getAllowDirect() - Method in class io.nats.client.api.StreamConfiguration
Get the flag indicating if the stream allows direct message access.
getAllowMessageCounter() - Method in class io.nats.client.api.StreamConfiguration
Whether Allow Message Counter is set
getAllowMessageTtl() - Method in class io.nats.client.api.StreamConfiguration
Whether Allow Message TTL is set
getAllowMsgSchedules() - Method in class io.nats.client.api.StreamConfiguration
Whether Allow Message Schedules is set
getAllowRollup() - Method in class io.nats.client.api.StreamConfiguration
Get the flag indicating if the stream allows rollup.
getAlternates() - Method in class io.nats.client.api.StreamInfo
Gets the stream alternates
getApi() - Method in class io.nats.client.api.AccountStatistics
Gets the account api stats
getApi() - Method in class io.nats.client.api.External
The subject prefix that imports the other account $JS.API.CONSUMER.> subjects
getApiErrorCode() - Method in class io.nats.client.api.ApiResponse
The api error code from the server
getApiErrorCode() - Method in class io.nats.client.api.Error
The api error code from the server
getApiErrorCode() - Method in exception io.nats.client.JetStreamApiException
Get the error code from the response
getAuthHandler() - Method in class io.nats.client.Options
the auth handler, or null, see authHandler() in the builder doc
getAverageProcessingTime() - Method in class io.nats.service.EndpointStats
Average processing time is the total processing time divided by the num requests
getBackingConfig() - Method in class io.nats.client.api.FeatureConfiguration
Gets the stream configuration for the stream which backs the bucket
getBackingStore() - Method in class io.nats.client.api.KeyValueStatus
Gets the name of the type of backing store, currently only "JetStream"
getBackingStore() - Method in class io.nats.client.api.ObjectStoreStatus
Gets the name of the type of backing store, currently only "JetStream"
getBackingStreamInfo() - Method in class io.nats.client.api.KeyValueStatus
Gets the info for the stream which backs the bucket.
getBackingStreamInfo() - Method in class io.nats.client.api.ObjectStoreStatus
Gets the info for the stream which backs the bucket.
getBackoff() - Method in class io.nats.client.api.ConsumerConfiguration
Get the backoff list; may be empty, will never be null.
getBatchBytes() - Method in class io.nats.client.ConsumeOptions
The initial batch size in bytes.
getBatchId() - Method in class io.nats.client.api.PublishAck
Gets the batch id.
getBatchSize() - Method in class io.nats.client.api.PublishAck
Gets the batch size.
getBatchSize() - Method in class io.nats.client.ConsumeOptions
The initial batch size in messages.
getBatchSize() - Method in class io.nats.client.PullRequestOptions
Get the batch size option value
getBucket() - Method in class io.nats.client.api.KeyValueEntry
Get the key value bucket this key in.
getBucket() - Method in class io.nats.client.api.ObjectInfo
the bucket name
getBucket() - Method in class io.nats.client.api.ObjectLink
Get the bucket the linked object is in
getBucketInfo(String) - Method in interface io.nats.client.KeyValueManagement
Deprecated.
getBucketName() - Method in class io.nats.client.api.FeatureConfiguration
Gets the name of this bucket.
getBucketName() - Method in class io.nats.client.api.KeyValueStatus
Get the name of the bucket
getBucketName() - Method in class io.nats.client.api.ObjectStoreStatus
Get the name of the object store
getBucketName() - Method in interface io.nats.client.KeyValue
Get the name of the bucket.
getBucketName() - Method in interface io.nats.client.ObjectStore
Get the name of the object store's bucket.
getBucketNames() - Method in interface io.nats.client.KeyValueManagement
Get the list of bucket names.
getBucketNames() - Method in interface io.nats.client.ObjectStoreManagement
Get the list of object stores bucket names
getBufferSize() - Method in class io.nats.client.Options
the default size for buffers in the connection code, see bufferSize() in the builder doc
getByteCount() - Method in class io.nats.client.api.KeyValueStatus
Get the size of the bucket in bytes
getByteCount() - Method in class io.nats.client.api.StreamState
Gets the byte count of the stream.
getBytes() - Method in class io.nats.client.api.LostStreamData
Get the number of bytes that were lost
getCachedConsumerInfo() - Method in interface io.nats.client.ConsumerContext
Gets information about the consumer behind this subscription.
getCachedConsumerInfo() - Method in interface io.nats.client.MessageConsumer
Gets information about the consumer behind this subscription.
getCalculatedPending() - Method in class io.nats.client.api.ConsumerInfo
A way to more accurately calculate pending during the initial state of the consumer when messages may be unaccounted for in flight
getCallbackExecutor() - Method in class io.nats.client.Options
the callback executor, see callbackThreadFactory() in the builder doc
getChunks() - Method in class io.nats.client.api.ObjectInfo
The total number of chunks in the object
getChunkSize() - Method in class io.nats.client.api.ObjectMetaOptions
Get the chunk size
getClientId() - Method in class io.nats.client.api.ServerInfo
the client id as determined by the server
getClientInetAddress() - Method in interface io.nats.client.Connection
the InetAddress of client as known by the NATS server, otherwise null.
getClientIp() - Method in class io.nats.client.api.ServerInfo
the client ip address as determined by the server
getCluster() - Method in class io.nats.client.api.Placement
The desired cluster name to place the stream.
getCluster() - Method in class io.nats.client.api.ServerInfo
the cluster name the server is in
getCluster() - Method in class io.nats.client.api.StreamAlternate
The name of the cluster holding the stream
getClusterInfo() - Method in class io.nats.client.api.ConsumerInfo
Information about the cluster for clustered environments
getClusterInfo() - Method in class io.nats.client.api.StreamInfo
Gets the cluster info
getCode() - Method in class io.nats.client.api.Error
The request error code from the server
getCompressionOption() - Method in class io.nats.client.api.StreamConfiguration
Gets the compression option for this stream configuration.
getConfig() - Method in class io.nats.client.api.StreamInfo
Gets the stream configuration.
getConfiguration() - Method in class io.nats.client.api.KeyValueStatus
Gets the configuration object directly
getConfiguration() - Method in class io.nats.client.api.ObjectStoreStatus
Gets the configuration object directly
getConfiguration() - Method in class io.nats.client.api.StreamInfo
Gets the stream configuration.
getConnectedUrl() - Method in interface io.nats.client.Connection
the url used for the current connection, or null if disconnected
getConnectExecutor() - Method in class io.nats.client.Options
the connect executor, see connectThreadFactory() in the builder doc
getConnection() - Method in interface io.nats.client.Message
the connection which can be used for publishing, will be null if the subscription is null
getConnectionListener() - Method in class io.nats.client.Options
the connection listener, or null, see connectionListener() in the builder doc
getConnectionName() - Method in class io.nats.client.Options
the connectionName, see connectionName() in the builder doc
getConnectionTimeout() - Method in class io.nats.client.Options
the connectionTimeout, see connectionTimeout() in the builder doc
getConnectURLs() - Method in class io.nats.client.api.ServerInfo
the connectable urls in the cluster
getConsumerConfiguration() - Method in class io.nats.client.api.ConsumerInfo
The consumer configuration representing this consumer.
getConsumerConfiguration() - Method in class io.nats.client.SubscribeOptions
Gets the consumer configuration.
getConsumerContext(String, String) - Method in interface io.nats.client.Connection
Get a consumer context for a specific named stream and specific named consumer.
getConsumerContext(String, String, JetStreamOptions) - Method in interface io.nats.client.Connection
Get a consumer context for a specific named stream and specific named consumer.
getConsumerContext(String, String) - Method in interface io.nats.client.JetStream
Get a consumer context for a specific named stream and specific named consumer.
getConsumerContext(String) - Method in interface io.nats.client.StreamContext
Get a consumer context for the context's stream and specific named consumer.
getConsumerCount() - Method in class io.nats.client.api.StreamState
Gets the number of consumers attached to the stream.
getConsumerInfo() - Method in interface io.nats.client.ConsumerContext
Gets the current information about the consumer behind this subscription by making a call to the server.
getConsumerInfo(String, String) - Method in interface io.nats.client.JetStreamManagement
Gets the info for an existing consumer.
getConsumerInfo() - Method in interface io.nats.client.JetStreamSubscription
Gets information about the consumer behind this subscription.
getConsumerInfo() - Method in interface io.nats.client.MessageConsumer
Gets information about the consumer behind this subscription.
getConsumerInfo(String) - Method in interface io.nats.client.StreamContext
Gets the info for an existing consumer.
getConsumerLimits() - Method in class io.nats.client.api.StreamConfiguration
Get the consumerLimits configuration.
getConsumerName() - Method in interface io.nats.client.BaseConsumerContext
Gets the consumer name that was used to create the context.
getConsumerName() - Method in interface io.nats.client.JetStreamSubscription
Gets the consumer name associated with the subscription.
getConsumerName() - Method in interface io.nats.client.MessageConsumer
Gets the consumer name associated with the subscription.
getConsumerName() - Method in interface io.nats.client.OrderedConsumerContext
Gets the consumer name created for the underlying Ordered Consumer This will return null until the first consume (next, iterate, fetch, consume) is executed because the JetStream consumer, which carries the name, has not been created yet.
getConsumerNamePrefix() - Method in class io.nats.client.api.OrderedConsumerConfiguration
Gets the prefix that will be used for names of underlying consumers
getConsumerNamePrefix() - Method in interface io.nats.client.api.Watcher
The watcher can supply a prefix to use on the consumer name that is generated when creating the internal watch consumer.
getConsumerNames(String) - Method in interface io.nats.client.JetStreamManagement
Return a list of consumers by name
getConsumerNames() - Method in interface io.nats.client.StreamContext
Return a list of consumers by name
getConsumers() - Method in class io.nats.client.api.AccountStatistics
Gets the number of consumers used by the JetStream deployment.
getConsumers() - Method in class io.nats.client.api.AccountTier
Number of active consumers in this tier.
getConsumers(String) - Method in interface io.nats.client.JetStreamManagement
Return a list of ConsumerInfo objects.
getConsumers() - Method in interface io.nats.client.StreamContext
Return a list of ConsumerInfo objects.
getConsumerSequence() - Method in class io.nats.client.api.SequencePair
Gets the consumer sequence number.
getCount() - Method in class io.nats.client.api.Subject
Get the subject message count
getCreated() - Method in class io.nats.client.api.KeyValueEntry
Get the creation time of the current version of the key
getCreateTime() - Method in class io.nats.client.api.StreamInfo
Gets the creation time of the stream.
getCreationTime() - Method in class io.nats.client.api.ConsumerInfo
Gets the creation time of the consumer.
getData() - Method in class io.nats.client.api.MessageInfo
Get the message data
getData() - Method in interface io.nats.client.Message
the data from the message
getData() - Method in class io.nats.service.EndpointStats
A field that can be customized with any data as returned by stats handler
getData() - Method in class io.nats.service.ServiceMessage
the data from the message
getDataAsJson() - Method in class io.nats.service.EndpointStats
The json representation of the custom data.
getDataLen() - Method in class io.nats.client.api.KeyValueEntry
Get the number of bytes in the data.
getDataPortType() - Method in class io.nats.client.Options
the DataPort class type for connections created by this options object, see dataPortType() in the builder doc
getDeleted() - Method in class io.nats.client.api.StreamState
Get a list of the Deleted objects.
getDeletedCount() - Method in class io.nats.client.api.StreamState
Gets the count of deleted messages
getDeleteMarkersThresholdMillis() - Method in class io.nats.client.api.KeyValuePurgeOptions
The value of the delete marker threshold, in milliseconds.
getDeliver() - Method in class io.nats.client.api.External
The delivery subject to use for the push consumer.
getDelivered() - Method in class io.nats.client.api.ConsumerInfo
The last message delivered from this Consumer
getDeliveredCount() - Method in interface io.nats.client.Consumer
the total number of messages delivered to this consumer, for all time
getDeliverGroup() - Method in class io.nats.client.api.ConsumerConfiguration
Gets the deliver group of this consumer configuration.
getDeliverGroup() - Method in class io.nats.client.PushSubscribeOptions
Gets the deliver group held in the consumer configuration.
getDeliverPolicy() - Method in class io.nats.client.api.ConsumerConfiguration
Gets the deliver policy of this consumer configuration.
getDeliverPolicy() - Method in class io.nats.client.api.OrderedConsumerConfiguration
Gets the deliver policy of this consumer configuration.
getDeliverSubject() - Method in class io.nats.client.api.ConsumerConfiguration
Gets the deliver subject of this consumer configuration.
getDeliverSubject() - Method in class io.nats.client.PushSubscribeOptions
Gets the deliver subject held in the consumer configuration.
getDelta() - Method in class io.nats.client.api.KeyValueEntry
Internal reference to pending message from the entry request
getDenyDelete() - Method in class io.nats.client.api.StreamConfiguration
Get the flag indicating if deny delete is set for the stream
getDenyPurge() - Method in class io.nats.client.api.StreamConfiguration
Get the flag indicating if deny purge is set for the stream
getDescription() - Method in class io.nats.client.api.ApiResponse
Get the error description
getDescription() - Method in class io.nats.client.api.ConsumerConfiguration
Gets the name of the description of this consumer configuration.
getDescription() - Method in class io.nats.client.api.Error
Get the error description
getDescription() - Method in class io.nats.client.api.FeatureConfiguration
Gets the description of this bucket.
getDescription() - Method in class io.nats.client.api.KeyValueStatus
Gets the description of this bucket.
getDescription() - Method in class io.nats.client.api.ObjectInfo
The object meta description
getDescription() - Method in class io.nats.client.api.ObjectMeta
The description
getDescription() - Method in class io.nats.client.api.ObjectStoreStatus
Gets the description of this bucket.
getDescription() - Method in class io.nats.client.api.StreamConfiguration
Gets the description of this stream configuration.
getDescription() - Method in exception io.nats.client.JetStreamStatusException
Deprecated.
getDescription() - Method in class io.nats.service.InfoResponse
Description for the service
getDescription() - Method in class io.nats.service.Service
Get the description of the service
getDestination() - Method in class io.nats.client.api.Republish
Get destination, the RePublish Subject template
getDestination() - Method in class io.nats.client.api.SubjectTransform
Get destination, the SubjectTransform Subject template
getDigest() - Method in class io.nats.client.api.ObjectInfo
The digest string for the object
getDiscardPolicy() - Method in class io.nats.client.api.StreamConfiguration
Gets the discard policy for this stream configuration.
getDispatcher() - Method in interface io.nats.client.Subscription
the Dispatcher that owns this subscription, or null
getDispatcherFactory() - Method in class io.nats.client.Options
Get the DispatcherFactory implementation.
getDomain() - Method in class io.nats.client.api.AccountStatistics
Gets the account domain.
getDomain() - Method in class io.nats.client.api.PublishAck
Gets the domain of a stream
getDomain() - Method in class io.nats.client.api.StreamAlternate
The domain
getDrainTimeout() - Method in class io.nats.service.Service
Get the drain timeout setting
getDroppedCount() - Method in interface io.nats.client.Consumer
the number of messages dropped from this consumer, since the last call to clearDroppedCount.
getDroppedCount() - Method in interface io.nats.client.Statistics
the total number of messages dropped by this connection across all slow consumers.
getDuplicateRepliesReceived() - Method in interface io.nats.client.Statistics
the total number of duplicate replies received by this connection.
getDuplicateWindow() - Method in class io.nats.client.api.StreamConfiguration
Gets the duplicate checking window stream configuration.
getDurable() - Method in class io.nats.client.api.ConsumerConfiguration
Gets the name of the durable name for this consumer configuration.
getDurable() - Method in class io.nats.client.SubscribeOptions
Gets the durable consumer name held in the consumer configuration.
getEndpoints() - Method in class io.nats.service.InfoResponse
List of endpoints
getEndpointStats(String) - Method in class io.nats.service.Service
Get the up-to-date EndpointStats for a specific endpoint
getEndpointStatsList() - Method in class io.nats.service.StatsResponse
Get the list of EndpointStats
getEntryCount() - Method in class io.nats.client.api.KeyValueStatus
Get the number of total entries in the bucket, including historical entries
getError() - Method in class io.nats.client.api.ApiResponse
Get the error object string
getErrorCode() - Method in class io.nats.client.api.ApiResponse
The request error code from the server
getErrorCode() - Method in exception io.nats.client.JetStreamApiException
Get the error code from the response
getErrorCount() - Method in class io.nats.client.api.ApiStats
API requests that resulted in an error response
getErrorDescription() - Method in exception io.nats.client.JetStreamApiException
Get the description from the response
getErrorListener() - Method in class io.nats.client.Options
the error listener.
getErrorObject() - Method in class io.nats.client.api.ApiResponse
Get the error object
getErrors() - Method in class io.nats.client.api.ApiStats
Deprecated.
Deprecated, replaced with getErrorErroredRequests API requests that resulted in an error response
getErrs() - Method in interface io.nats.client.Statistics
the total number of op -ERRs received by this connection.
getEvent() - Method in enum io.nats.client.ConnectionListener.Events
Get the simple event text
getException() - Method in class io.nats.client.api.KeyResult
Get the exception in this result
getExceptions() - Method in interface io.nats.client.Statistics
the total number of exceptions seen by this connection.
getExecutor() - Method in class io.nats.client.Options
Get the general executor
getExpectedLastMsgId() - Method in class io.nats.client.PublishOptions
Gets the expected last message ID in the stream.
getExpectedLastSequence() - Method in class io.nats.client.PublishOptions
Gets the expected last sequence number of the stream.
getExpectedLastSubjectSequence() - Method in class io.nats.client.PublishOptions
Gets the expected last subject sequence number of the stream.
getExpectedLastSubjectSequenceSubject() - Method in class io.nats.client.PublishOptions
Gets the expected subject to limit last subject sequence number of the stream.
getExpectedStream() - Method in class io.nats.client.PublishOptions
Gets the expected stream.
getExpiresIn() - Method in class io.nats.client.PullRequestOptions
Get the expires in option value
getExpiresInMillis() - Method in class io.nats.client.BaseConsumeOptions
Get the expires setting
getExternal() - Method in class io.nats.client.api.SourceBase
Get the External reference
getFilterSubject() - Method in class io.nats.client.api.ConsumerConfiguration
Gets the filter subject of this consumer configuration.
getFilterSubject() - Method in class io.nats.client.api.OrderedConsumerConfiguration
Gets the filter subject of this consumer configuration.
getFilterSubject() - Method in class io.nats.client.api.SourceBase
Get the configured filter subject
getFilterSubjects() - Method in class io.nats.client.api.ConsumerConfiguration
Gets the filter subjects as a list.
getFilterSubjects() - Method in class io.nats.client.api.OrderedConsumerConfiguration
Gets the filter subjects as a list.
getFirstMessage(String, String) - Method in interface io.nats.client.JetStreamManagement
Get MessageInfo for the first message of the subject.
getFirstMessage(String, ZonedDateTime) - Method in interface io.nats.client.JetStreamManagement
Get MessageInfo for the first message created at or after the start time.
getFirstMessage(String, ZonedDateTime, String) - Method in interface io.nats.client.JetStreamManagement
Get MessageInfo for the first message created at or after the start time matching the subject.
getFirstMessage(String) - Method in interface io.nats.client.StreamContext
Get MessageInfo for the first message of the subject.
getFirstSequence() - Method in class io.nats.client.api.StreamConfiguration
The first sequence used in the stream.
getFirstSequence() - Method in class io.nats.client.api.StreamState
Gets the first sequence number of the stream.
getFirstTime() - Method in class io.nats.client.api.StreamState
Gets the time stamp of the first message in the stream
getFlushCounter() - Method in interface io.nats.client.Statistics
the total number of outgoing message flushes by this connection.
getFlushWait() - Method in class io.nats.client.ForceReconnectOptions
Get the flush wait setting
getGoVersion() - Method in class io.nats.client.api.ServerInfo
the go version the server is built with
getGroup() - Method in class io.nats.client.api.PriorityGroupState
The group this status is for
getGroup() - Method in class io.nats.client.BaseConsumeOptions
Get the priority group setting
getGroup() - Method in class io.nats.client.PullRequestOptions
Get the group option
getGroupName() - Method in class io.nats.service.ServiceEndpoint
Get the name of the Group
getHeaders() - Method in class io.nats.client.api.MessageInfo
Get the headers
getHeaders() - Method in class io.nats.client.api.ObjectInfo
The object meta Headers.
getHeaders() - Method in class io.nats.client.api.ObjectMeta
Headers may be empty but will not be null.
getHeaders() - Method in interface io.nats.client.Message
the headers object for the message
getHeaders() - Method in class io.nats.service.ServiceMessage
the headers object for the message
getHeadersOnly() - Method in class io.nats.client.api.OrderedConsumerConfiguration
Get the header only flag indicating whether it's on or off.
getHeaderValue() - Method in enum io.nats.client.api.KeyValueOperation
Get the value used in the header
getHost() - Method in class io.nats.client.api.ServerInfo
the server host
getHttpRequestInterceptors() - Method in class io.nats.client.Options
the list of HttpRequest interceptors.
getID() - Method in interface io.nats.client.AuthHandler
getID should return a public key associated with a client key known to the server.
getId() - Method in class io.nats.service.Service
Get the id of the service
getId() - Method in class io.nats.service.ServiceResponse
The unique ID of the service
getIdleHeartbeat() - Method in class io.nats.client.api.ConsumerConfiguration
Gets the idle heart beat wait time
getIdleHeartbeat() - Method in class io.nats.client.BaseConsumeOptions
Get the idle heartbeat value
getIdleHeartbeat() - Method in class io.nats.client.PullRequestOptions
Get the idle heartbeat option value
getInactiveThreshold() - Method in class io.nats.client.api.ConsumerConfiguration
Get the amount of time before the consumer is deemed inactive.
getInactiveThreshold() - Method in class io.nats.client.api.ConsumerLimits
Maximum value for inactive_threshold for consumers of this stream.
getInboxPrefix() - Method in class io.nats.client.Options
the inbox prefix to use for requests, see inboxPrefix() in the builder doc
getInBytes() - Method in interface io.nats.client.Statistics
the total number of message bytes that have come in to this connection.
getInFlight() - Method in class io.nats.client.api.ApiStats
The number of inflight API requests waiting to be processed
getInfo(String) - Method in interface io.nats.client.ObjectStore
Get the info for an object if the object exists / is not deleted.
getInfo(String, boolean) - Method in interface io.nats.client.ObjectStore
Get the info for an object if the object exists, optionally including deleted.
getInfoResponse() - Method in class io.nats.service.Service
Get the pre-constructed info response.
getInMsgs() - Method in interface io.nats.client.Statistics
the total number of messages that have come in to this connection.
getJetStreamOptions() - Method in class io.nats.client.FeatureOptions
Gets the JetStream options
getJv() - Method in class io.nats.client.api.ApiResponse
Get the JsonValue used to make this object
getJWT() - Method in interface io.nats.client.AuthHandler
getJWT should return the user JWT associated with this connection.
getKeep() - Method in class io.nats.client.PurgeOptions
Get the max number of messages to keep for the Purge Options
getKey() - Method in class io.nats.client.api.KeyResult
Get the key in this result
getKey() - Method in class io.nats.client.api.KeyValueEntry
Get the key
getKeyPair() - Method in class io.nats.client.NKey
A Java security keypair that represents this NKey in Java security form.
getLag() - Method in class io.nats.client.api.PeerInfo
How many uncommitted operations this peer is behind the leader
getLastActive() - Method in class io.nats.client.api.SequenceInfo
The last time a message was delivered or acknowledged (for ack_floor)
getLastError() - Method in interface io.nats.client.Connection
the error text from the last error sent by the server to this client
getLastError() - Method in class io.nats.service.EndpointStats
If set, the last error triggered by the endpoint
getLastMessage(String, String) - Method in interface io.nats.client.JetStreamManagement
Get MessageInfo for the last message of the subject.
getLastMessage(String) - Method in interface io.nats.client.StreamContext
Get MessageInfo for the last message of the subject.
getLastSeq() - Method in class io.nats.client.api.MessageInfo
Get the sequence number of the last message in the stream.
getLastSequence() - Method in class io.nats.client.api.StreamState
Gets the last sequence of a message in the stream
getLastTime() - Method in class io.nats.client.api.StreamState
Gets the time stamp of the last message in the stream
getLeader() - Method in class io.nats.client.api.ClusterInfo
The server name of the RAFT leader
getLeaderSince() - Method in class io.nats.client.api.ClusterInfo
The time that it was elected as leader, absent when not the leader
getLevel() - Method in class io.nats.client.api.ApiStats
The JetStream API Level
getLimitMarkerTtl() - Method in class io.nats.client.api.KeyValueConfiguration
The limit marker ttl if set
getLimitMarkerTtl() - Method in class io.nats.client.api.KeyValueStatus
Get the Limit Marker TTL duration or null if configured.
getLimits() - Method in class io.nats.client.api.AccountStatistics
Gets the Account Limits object.
getLimits() - Method in class io.nats.client.api.AccountTier
The limits of this tier.
getLink() - Method in class io.nats.client.api.ObjectInfo
If this is a link to an object, get the ObjectLink instance, otherwise this will be null
getLink() - Method in class io.nats.client.api.ObjectMetaOptions
Get the link this object refers to
getList() - Method in interface io.nats.client.ObjectStore
Get a list of all object [infos] in the store.
getLostStreamData() - Method in class io.nats.client.api.StreamState
Get the lost stream data information if available.
getMaxAckPending() - Method in class io.nats.client.api.AccountLimits
The maximum number of outstanding ACKs any consumer may configure.
getMaxAckPending() - Method in class io.nats.client.api.ConsumerConfiguration
Gets the maximum ack pending configuration.
getMaxAckPending() - Method in class io.nats.client.api.ConsumerLimits
Maximum value for max_ack_pending for consumers of this stream.
getMaxAge() - Method in class io.nats.client.api.StreamConfiguration
Gets the maximum message age for this stream configuration.
getMaxBatch() - Method in class io.nats.client.api.ConsumerConfiguration
Get the max batch size for the server to allow on pull requests.
getMaxBucketSize() - Method in class io.nats.client.api.FeatureConfiguration
Gets the maximum number of bytes for this bucket.
getMaxBucketSize() - Method in class io.nats.client.api.KeyValueStatus
Gets the maximum number of bytes for this bucket.
getMaxBucketSize() - Method in class io.nats.client.api.ObjectStoreStatus
Gets the maximum number of bytes for this bucket.
getMaxBytes() - Method in class io.nats.client.api.ConsumerConfiguration
Get the max bytes size for the server to allow on pull requests.
getMaxBytes() - Method in class io.nats.client.api.StreamConfiguration
Gets the maximum number of bytes for this stream configuration.
getMaxBytes() - Method in class io.nats.client.FetchConsumeOptions
The maximum number of bytes to fetch.
getMaxBytes() - Method in class io.nats.client.PullRequestOptions
Get the max bytes size option value
getMaxConsumers() - Method in class io.nats.client.api.AccountLimits
The maximum number of Consumers an account can create.
getMaxConsumers() - Method in class io.nats.client.api.StreamConfiguration
Gets the maximum number of consumers for this stream configuration.
getMaxControlLine() - Method in class io.nats.client.Options
the maximum length of a control line, see maxControlLine() in the builder doc
getMaxDeliver() - Method in class io.nats.client.api.ConsumerConfiguration
Gets the max delivery amount of this consumer configuration.
getMaxExpires() - Method in class io.nats.client.api.ConsumerConfiguration
Get the max amount of expire time for the server to allow on pull requests.
getMaxHistoryPerKey() - Method in class io.nats.client.api.KeyValueConfiguration
Gets the maximum number of history for any one key.
getMaxHistoryPerKey() - Method in class io.nats.client.api.KeyValueStatus
Gets the maximum number of history for any one key.
getMaximumMessageSize() - Method in class io.nats.client.api.StreamConfiguration
Gets the maximum message size for this stream configuration.
getMaximumValueSize() - Method in class io.nats.client.api.KeyValueConfiguration
Gets the maximum size for an individual value in the bucket.
getMaximumValueSize() - Method in class io.nats.client.api.KeyValueStatus
Gets the maximum size for an individual value in the bucket.
getMaxMemory() - Method in class io.nats.client.api.AccountLimits
The maximum amount of Memory storage Stream Messages may consume.
getMaxMessages() - Method in class io.nats.client.FetchConsumeOptions
The maximum number of messages to fetch.
getMaxMessagesInOutgoingQueue() - Method in class io.nats.client.Options
the maximum number of messages in the outgoing queue, see maxMessagesInOutgoingQueue(int) in the builder doc
getMaxMsgs() - Method in class io.nats.client.api.StreamConfiguration
Gets the maximum messages for this stream configuration.
getMaxMsgSize() - Method in class io.nats.client.api.StreamConfiguration
Deprecated.
the server value is a 32-bit signed value. Use StreamConfiguration.getMaximumMessageSize() instead.
getMaxMsgsPerSubject() - Method in class io.nats.client.api.StreamConfiguration
Gets the maximum messages for this stream configuration.
getMaxPayload() - Method in class io.nats.client.api.ServerInfo
the server configured max payload
getMaxPayload() - Method in interface io.nats.client.Connection
MaxPayload returns the size limit that a message payload can have.
getMaxPingsOut() - Method in class io.nats.client.Options
the maxPingsOut to limit the number of pings on the wire, see maxPingsOut() in the builder doc
getMaxPullWaiting() - Method in class io.nats.client.api.ConsumerConfiguration
Get the number of pulls that can be outstanding on a pull consumer
getMaxReconnect() - Method in class io.nats.client.Options
the maxReconnect attempts to make before failing, see maxReconnects() in the builder doc
getMaxStorage() - Method in class io.nats.client.api.AccountLimits
The maximum amount of File storage Stream Messages may consume.
getMaxStreams() - Method in class io.nats.client.api.AccountLimits
The maximum number of Streams an account can create.
getMaxValueSize() - Method in class io.nats.client.api.KeyValueConfiguration
Deprecated.
the server value is a 32-bit signed value. Use KeyValueConfiguration.getMaximumValueSize() instead.
getMaxValueSize() - Method in class io.nats.client.api.KeyValueStatus
Deprecated.
the server value is a 32-bit signed value. Use KeyValueStatus.getMaximumValueSize() instead.
getMemory() - Method in class io.nats.client.api.AccountStatistics
Gets the amount of memory storage used by the JetStream deployment.
getMemory() - Method in class io.nats.client.api.AccountTier
Deprecated.
use getMemoryBytes instead Memory Storage being used for Stream Message storage in this tier.
getMemoryBytes() - Method in class io.nats.client.api.AccountTier
Memory Storage being used for Stream Message storage in this tier.
getMemoryMaxStreamBytes() - Method in class io.nats.client.api.AccountLimits
The maximum size any single memory stream may be.
getMessage(String, long) - Method in interface io.nats.client.JetStreamManagement
Get MessageInfo for the message with the exact sequence in the stream.
getMessage(String, MessageGetRequest) - Method in interface io.nats.client.JetStreamManagement
Get MessageInfo for the message matching the MessageGetRequest.
getMessage(long) - Method in interface io.nats.client.StreamContext
Get MessageInfo for the message with the exact sequence in the stream.
getMessageAlarmTime() - Method in class io.nats.client.SubscribeOptions
Get the time amount of time allowed to elapse without a heartbeat.
getMessageId() - Method in class io.nats.client.PublishOptions
Gets the message ID
getMessages() - Method in class io.nats.client.api.LostStreamData
Get the lost message ids.
getMessageTtl() - Method in class io.nats.client.PublishOptions
Gets the message ttl string.
getMetadata() - Method in class io.nats.client.api.ConsumerConfiguration
Metadata for the consumer; may be empty, will never be null.
getMetadata() - Method in class io.nats.client.api.FeatureConfiguration
Get the metadata for the feature
getMetadata() - Method in class io.nats.client.api.KeyValueStatus
Get the metadata for the store
getMetaData() - Method in class io.nats.client.api.ObjectInfo
The object meta metadata.
getMetadata() - Method in class io.nats.client.api.ObjectMeta
Metadata may be empty but will not be null.
getMetadata() - Method in class io.nats.client.api.ObjectStoreStatus
Get the metadata for the store
getMetadata() - Method in class io.nats.client.api.StreamConfiguration
Metadata for the stream
getMetadata() - Method in class io.nats.service.Endpoint
Get a copy of the metadata of the Endpoint
getMetadata() - Method in class io.nats.service.ServiceEndpoint
Get a copy of the metadata of the Endpoint
getMetadata() - Method in class io.nats.service.ServiceResponse
A copy of the metadata for the service, or null if there is no metadata
getMinAckPending() - Method in class io.nats.client.BaseConsumeOptions
Get the min ack pending setting
getMinAckPending() - Method in class io.nats.client.PullRequestOptions
Get the min ack pending setting
getMinPending() - Method in class io.nats.client.BaseConsumeOptions
Get the min pending setting
getMinPending() - Method in class io.nats.client.PullRequestOptions
Get the min pending setting
getMirror() - Method in class io.nats.client.api.KeyValueConfiguration
The mirror definition for this configuration
getMirror() - Method in class io.nats.client.api.StreamConfiguration
The mirror definition for this stream
getMirrorDirect() - Method in class io.nats.client.api.StreamConfiguration
Get the flag indicating if the stream allows higher performance and unified direct access for mirrors as well.
getMirrorInfo() - Method in class io.nats.client.api.StreamInfo
Gets the mirror info
getMode() - Method in enum io.nats.client.api.PersistMode
get the mode JSON value string
getModified() - Method in class io.nats.client.api.ObjectInfo
When the object was last modified
getMsgCount() - Method in class io.nats.client.api.StreamState
Gets the message count of the stream.
getName() - Method in class io.nats.client.api.ClusterInfo
The cluster name.
getName() - Method in class io.nats.client.api.ConsumerConfiguration
Gets the name of the consumer name for this consumer configuration.
getName() - Method in class io.nats.client.api.ConsumerInfo
A unique name for the consumer, either machine generated or the durable name
getName() - Method in class io.nats.client.api.PeerInfo
The server name of the peer
getName() - Method in class io.nats.client.api.SourceBase
Get the name of the source.
getName() - Method in class io.nats.client.api.StreamAlternate
The mirror stream name
getName() - Method in class io.nats.client.api.StreamConfiguration
Gets the name of this stream configuration.
getName() - Method in class io.nats.client.api.Subject
Get the subject name
getName() - Method in class io.nats.client.SubscribeOptions
Gets the name of the consumer.
getName() - Method in class io.nats.service.Endpoint
Get the name of the Endpoint
getName() - Method in class io.nats.service.EndpointStats
Get the name of the Endpoint
getName() - Method in class io.nats.service.Group
Get the name of the group.
getName() - Method in class io.nats.service.Service
Get the name of the service
getName() - Method in class io.nats.service.ServiceEndpoint
Get the name of the Endpoint
getName() - Method in class io.nats.service.ServiceResponse
The name of the service
getNatsEvent() - Method in enum io.nats.client.ConnectionListener.Events
Get the event text calculated with if it's a connection event and prefixed with "nats:"
getNatsServerUris() - Method in class io.nats.client.Options
the servers as configured in options as NatsUri's, see servers() in the builder doc
getNext() - Method in class io.nats.service.Group
Get the next group after this group.
getNextMessage(String, long, String) - Method in interface io.nats.client.JetStreamManagement
Get MessageInfo for the message of the message sequence is equal to or greater the requested sequence for the subject.
getNextMessage(long, String) - Method in interface io.nats.client.StreamContext
Get MessageInfo for the message of the message sequence is equal to or greater the requested sequence for the subject.
getNoAck() - Method in class io.nats.client.api.StreamConfiguration
Gets whether acknowledgements are required in this stream configuration.
getNonce() - Method in class io.nats.client.api.ServerInfo
the nonce to use in authentication
getNuid() - Method in class io.nats.client.api.ObjectInfo
the bucket nuid
getNumAckPending() - Method in class io.nats.client.api.ConsumerInfo
The number of messages pending acknowledgement
getNumErrors() - Method in class io.nats.service.EndpointStats
Number of errors that the endpoint has raised
getNumPending() - Method in class io.nats.client.api.ConsumerInfo
The number of messages left unconsumed in this Consumer
getNumPending() - Method in class io.nats.client.api.MessageInfo
Amount of pending messages that can be requested with a subsequent batch request.
getNumReplicas() - Method in class io.nats.client.api.ConsumerConfiguration
Get the number of consumer replicas.
getNumRequests() - Method in class io.nats.service.EndpointStats
The number of requests received by the endpoint
getNumWaiting() - Method in class io.nats.client.api.ConsumerInfo
The number of pull consumers waiting for messages
getObjectMeta() - Method in class io.nats.client.api.ObjectInfo
The full object meta object
getObjectMetaOptions() - Method in class io.nats.client.api.ObjectMeta
The ObjectMetaOptions are additional options describing the object
getObjectName() - Method in class io.nats.client.api.ObjectInfo
The object name
getObjectName() - Method in class io.nats.client.api.ObjectLink
Get the name of the object for the link
getObjectName() - Method in class io.nats.client.api.ObjectMeta
The object name
getOKs() - Method in interface io.nats.client.Statistics
the total number of op +OKs received by this connection.
getOperation() - Method in class io.nats.client.api.KeyValueEntry
The KeyValueOperation of this entry
getOptions() - Method in interface io.nats.client.Connection
the read-only options used to create this connection
getOrDefault(String, KeyValueOperation) - Static method in enum io.nats.client.api.KeyValueOperation
Get an instance from the string value or the default
getOrphanRepliesReceived() - Method in interface io.nats.client.Statistics
the total number of orphan replies received by this connection.
getOutBytes() - Method in interface io.nats.client.Statistics
the total number of message bytes that have gone out of this connection.
getOutMsgs() - Method in interface io.nats.client.Statistics
the total number of messages that have gone out of this connection.
getOutstandingRequests() - Method in interface io.nats.client.Statistics
the count of outstanding of requests from this connection.
getPassword() - Method in class io.nats.client.Options
Deprecated.
converts the char array to a string, use getPasswordChars instead for more security
getPasswordChars() - Method in class io.nats.client.Options
the password to use for basic authentication, see userInfo() in the builder doc
getPaused() - Method in class io.nats.client.api.ConsumerInfo
Indicates if the consumer is currently in a paused state
getPauseRemaining() - Method in class io.nats.client.api.ConsumerInfo
When paused the time remaining until unpause
getPauseRemaining() - Method in class io.nats.client.api.ConsumerPauseResponse
Returns how much time is remaining for this consumer to be paused
getPauseUntil() - Method in class io.nats.client.api.ConsumerConfiguration
Get the time until the consumer is paused.
getPauseUntil() - Method in class io.nats.client.api.ConsumerPauseResponse
Returns the time until the consumer is paused
getPendingByteCount() - Method in interface io.nats.client.Consumer
the cumulative size of the messages waiting to be delivered/popped, setPendingLimits
getPendingByteLimit() - Method in interface io.nats.client.Consumer
the pending byte limit set by setPendingLimits
getPendingByteLimit() - Method in class io.nats.client.SubscribeOptions
Gets the pending byte limit.
getPendingMessageCount() - Method in interface io.nats.client.Consumer
the number of messages waiting to be delivered/popped, setPendingLimits
getPendingMessageLimit() - Method in interface io.nats.client.Consumer
the pending message limit set by setPendingLimits
getPendingMessageLimit() - Method in class io.nats.client.SubscribeOptions
Gets the pending message limit.
getPersistMode() - Method in class io.nats.client.api.StreamConfiguration
Gets the persist mode or null if it was not explicitly set when creating or the server did not send it with stream info
getPingInterval() - Method in class io.nats.client.Options
the pingInterval, see pingInterval() in the builder doc
getPingResponse() - Method in class io.nats.service.Service
Get the pre-constructed ping response.
getPings() - Method in interface io.nats.client.Statistics
the total number of pings that have been sent from this connection.
getPinnedClientId() - Method in class io.nats.client.api.PriorityGroupState
The generated ID of the pinned client
getPinnedTime() - Method in class io.nats.client.api.PriorityGroupState
The timestamp when the client was pinned
getPlacement() - Method in class io.nats.client.api.FeatureConfiguration
Placement directives to consider when placing replicas of this stream, random placement when unset
getPlacement() - Method in class io.nats.client.api.KeyValueStatus
Gets the placement directive for the store.
getPlacement() - Method in class io.nats.client.api.ObjectStoreStatus
Gets the placement directive for the store.
getPlacement() - Method in class io.nats.client.api.StreamConfiguration
Get the placement directives to consider when placing replicas of this stream, random placement when unset.
getPort() - Method in class io.nats.client.api.ServerInfo
the server port
getPrefix() - Method in class io.nats.client.JetStreamOptions
Gets the prefix for this JetStream context.
getPriority() - Method in class io.nats.client.BaseConsumeOptions
Get the priority setting
getPriority() - Method in class io.nats.client.PullRequestOptions
Get the priority
getPriorityGroups() - Method in class io.nats.client.api.ConsumerConfiguration
Gets the priority groups as a list.
getPriorityGroupStates() - Method in class io.nats.client.api.ConsumerInfo
The state of Priority Groups
getPriorityPolicy() - Method in class io.nats.client.api.ConsumerConfiguration
Gets the priority policy of this consumer configuration.
getPriorityTimeout() - Method in class io.nats.client.api.ConsumerConfiguration
For pinned_client priority policy how long before the client times out
getPrivateKey() - Method in class io.nats.client.NKey
the encoded private key for this NKey
getProcessingTime() - Method in class io.nats.service.EndpointStats
Total processing time for the endpoint
getProtocolVersion() - Method in class io.nats.client.api.ServerInfo
the server protocol version
getProxy() - Method in class io.nats.client.Options
the proxy to used for all sockets.
getPublicKey() - Method in class io.nats.client.NKey
the encoded public key for this NKey
getPurged() - Method in class io.nats.client.api.PurgeResponse
Returns the number of items purged from the stream
getPurgedCount() - Method in class io.nats.client.api.PurgeResponse
Deprecated.
Returns the number of items purged from the stream This method is replaced since the purged value is a long value, not an int value See PurgeResponse.getPurged() instead.
getQueueGroup() - Method in class io.nats.service.Endpoint
Get the queueGroup for the Endpoint
getQueueGroup() - Method in class io.nats.service.EndpointStats
Get the queueGroup of the Endpoint
getQueueGroup() - Method in class io.nats.service.ServiceEndpoint
Get the queueGroup for the ServiceEndpoint
getQueueName() - Method in interface io.nats.client.Subscription
the queue associated with this subscription, may be null.
getRaftGroup() - Method in class io.nats.client.api.ClusterInfo
In clustered environments the name of the Raft group managing the asset
getRateLimit() - Method in class io.nats.client.api.ConsumerConfiguration
Gets the rate limit for this consumer configuration.
getReadListener() - Method in class io.nats.client.Options
the read listener, or null, see readListener() in the builder doc
getReceiveBufferSize() - Method in class io.nats.client.Options
the number of bytes to set the for the SO_RCVBUF property on the socket
getReconnectBufferSize() - Method in class io.nats.client.Options
the reconnectBufferSize, to limit the amount of data held during reconnection attempts, see reconnectBufferSize() in the builder doc
getReconnectDelayHandler() - Method in class io.nats.client.Options
the reconnection delay handler, or null, see reconnectDelayHandler() in the builder doc
getReconnectJitter() - Method in class io.nats.client.Options
the reconnectJitter, used between reconnect attempts to vary the reconnect wait, see reconnectJitter() in the builder doc
getReconnectJitterTls() - Method in class io.nats.client.Options
the reconnectJitterTls, used between reconnect attempts to vary the reconnect wait whe using tls/secure, see reconnectJitterTls() in the builder doc
getReconnects() - Method in interface io.nats.client.Statistics
the total number of times this connection has tried to reconnect.
getReconnectWait() - Method in class io.nats.client.Options
the reconnectWait, used between reconnect attempts, see reconnectWait() in the builder doc
getRedelivered() - Method in class io.nats.client.api.ConsumerInfo
The number of redeliveries that have been performed
getReplayPolicy() - Method in class io.nats.client.api.ConsumerConfiguration
Gets the replay policy of this consumer configuration.
getReplayPolicy() - Method in class io.nats.client.api.OrderedConsumerConfiguration
Gets the replay policy of this consumer configuration.
getReplicas() - Method in class io.nats.client.api.ClusterInfo
The members of the RAFT cluster.
getReplicas() - Method in class io.nats.client.api.FeatureConfiguration
Gets the number of replicas for this bucket.
getReplicas() - Method in class io.nats.client.api.KeyValueStatus
Gets the number of replicas for this bucket.
getReplicas() - Method in class io.nats.client.api.ObjectStoreStatus
Gets the number of replicas for this store.
getReplicas() - Method in class io.nats.client.api.StreamConfiguration
Gets the number of replicas for this stream configuration.
getRepliesReceived() - Method in interface io.nats.client.Statistics
the total number of replies received by this connection.
getReplyTo() - Method in interface io.nats.client.Message
the subject the application is expected to send a reply message on
getReplyTo() - Method in class io.nats.service.ServiceMessage
the subject the application is expected to send a reply message on
getRepublish() - Method in class io.nats.client.api.KeyValueConfiguration
Get the republish configuration.
getRepublish() - Method in class io.nats.client.api.KeyValueStatus
Gets the republish configuration
getRepublish() - Method in class io.nats.client.api.StreamConfiguration
Get the republish configuration.
getRequestCleanupInterval() - Method in class io.nats.client.Options
the request cleanup interval, see requestCleanupInterval() in the builder doc
getRequestsSent() - Method in interface io.nats.client.Statistics
the total number of requests sent by this connection.
getRequestTimeout() - Method in class io.nats.client.JetStreamOptions
Gets the request timeout the stream.
getReservedMemory() - Method in class io.nats.client.api.AccountStatistics
Bytes that is reserved for memory usage by this account on the server
getReservedMemory() - Method in class io.nats.client.api.AccountTier
Bytes that is reserved for memory usage by this account on the server
getReservedMemoryBytes() - Method in class io.nats.client.api.AccountTier
Bytes that is reserved for memory usage by this account on the server
getReservedStorage() - Method in class io.nats.client.api.AccountStatistics
Bytes that is reserved for disk usage by this account on the server
getReservedStorage() - Method in class io.nats.client.api.AccountTier
Bytes that is reserved for disk usage by this account on the server
getReservedStorageBytes() - Method in class io.nats.client.api.AccountTier
Bytes that is reserved for disk usage by this account on the server
getRetentionPolicy() - Method in class io.nats.client.api.StreamConfiguration
Gets the retention policy for this stream configuration.
getRevision() - Method in class io.nats.client.api.KeyValueEntry
Get the revision number of the string.
getSampleFrequency() - Method in class io.nats.client.api.ConsumerConfiguration
Gets the sample frequency.
getScheduledExecutor() - Method in class io.nats.client.Options
Get the ScheduledExecutorService instance
getSealed() - Method in class io.nats.client.api.StreamConfiguration
Get the flag indicating if the stream is sealed.
getSeed() - Method in class io.nats.client.NKey
the string encoded seed for this NKey
getSendBufferSize() - Method in class io.nats.client.Options
the number of bytes to set the for the SO_SNDBUF property on the socket
getSeq() - Method in class io.nats.client.api.MessageInfo
Get the message sequence
getSeqno() - Method in class io.nats.client.api.PublishAck
Get the stream sequence number for the corresponding published message.
getSequence() - Method in class io.nats.client.PurgeOptions
Get the upper bound sequence for the Purge Options
getServerId() - Method in class io.nats.client.api.ServerInfo
the server id
getServerInfo() - Method in interface io.nats.client.Connection
Return the server info object.
getServerList() - Method in interface io.nats.client.ServerPool
Get the list of servers known to the pool.
getServerName() - Method in class io.nats.client.api.ServerInfo
the server name
getServerPool() - Method in class io.nats.client.Options
Get the ServerPool implementation.
getServers() - Method in interface io.nats.client.Connection
Return the list of known server urls, including additional servers discovered after a connection has been established.
getServers() - Method in class io.nats.client.Options
the servers as configured in options as URI's, see servers() in the builder doc
getSID() - Method in interface io.nats.client.Message
the id associated with the subscription, used by the connection when processing an incoming message from the server
getSize() - Method in class io.nats.client.api.ObjectInfo
The size of the object
getSize() - Method in class io.nats.client.api.ObjectStoreStatus
Get the combined size of all data in the bucket including metadata, in bytes
getSocketReadTimeoutMillis() - Method in class io.nats.client.Options
the socketReadTimeoutMillis, see socketReadTimeoutMillis in the builder doc
getSocketSoLinger() - Method in class io.nats.client.Options
the socket so linger number of seconds, see socketSoLinger() in the builder doc
getSocketWriteTimeout() - Method in class io.nats.client.Options
the socketWriteTimeout, see socketWriteTimeout in the builder doc
getSource() - Method in class io.nats.client.api.Republish
Get source, the Published subject matching filter
getSource() - Method in class io.nats.client.api.SubjectTransform
Get source, the subject matching filter
getSourceInfos() - Method in class io.nats.client.api.StreamInfo
Gets the source info
getSourceName() - Method in class io.nats.client.api.SourceBase
Get the name of the source.
getSources() - Method in class io.nats.client.api.KeyValueConfiguration
The sources for this configuration
getSources() - Method in class io.nats.client.api.StreamConfiguration
The sources for this stream
getSslContext() - Method in class io.nats.client.Options
the sslContext, see secure() in the builder doc
getStarted() - Method in class io.nats.service.EndpointStats
Get the time the endpoint was started (or restarted)
getStarted() - Method in class io.nats.service.StatsResponse
Get the time the service was started
getStartSeq() - Method in class io.nats.client.api.SourceBase
Get the configured start sequence
getStartSequence() - Method in class io.nats.client.api.ConsumerConfiguration
Gets the start sequence of this consumer configuration.
getStartSequence() - Method in class io.nats.client.api.OrderedConsumerConfiguration
Gets the start sequence of this consumer configuration.
getStartTime() - Method in class io.nats.client.api.ConsumerConfiguration
Gets the start time of this consumer configuration.
getStartTime() - Method in class io.nats.client.api.OrderedConsumerConfiguration
Gets the start time of this consumer configuration.
getStartTime() - Method in class io.nats.client.api.SourceBase
Get the configured start time
getStatistics() - Method in interface io.nats.client.Connection
a wrapper for useful statistics about the connection
getStatisticsCollector() - Method in class io.nats.client.Options
the statistics collector, or null, see statisticsCollector() in the builder doc
getStatsResponse() - Method in class io.nats.service.Service
Get the up-to-date stats response which contains a list of all EndpointStats
getStatus() - Method in class io.nats.client.api.MessageInfo
Get the Status object.
getStatus() - Method in interface io.nats.client.Connection
Returns the connections current status.
getStatus() - Method in exception io.nats.client.JetStreamStatusException
Get the full status object
getStatus() - Method in interface io.nats.client.KeyValue
Get the KeyValueStatus object
getStatus(String) - Method in interface io.nats.client.KeyValueManagement
Gets the status for an existing bucket.
getStatus() - Method in interface io.nats.client.Message
the status object message if this is a status message
getStatus() - Method in interface io.nats.client.ObjectStore
Get the ObjectStoreStatus object.
getStatus(String) - Method in interface io.nats.client.ObjectStoreManagement
Gets the status for an existing object store bucket.
getStatuses() - Method in interface io.nats.client.KeyValueManagement
Get the statuses for all buckets
getStatuses() - Method in interface io.nats.client.ObjectStoreManagement
Gets the status for all object store buckets.
getStorage() - Method in class io.nats.client.api.AccountStatistics
Gets the amount of file storage used by the JetStream deployment.
getStorage() - Method in class io.nats.client.api.AccountTier
Deprecated.
use getStorageBytes instead File Storage being used for Stream Message storage in this tier.
getStorageBytes() - Method in class io.nats.client.api.AccountTier
File Storage being used for Stream Message storage in this tier.
getStorageMaxStreamBytes() - Method in class io.nats.client.api.AccountLimits
The maximum size any single storage based stream may be.
getStorageType() - Method in class io.nats.client.api.FeatureConfiguration
Gets the storage type for this bucket.
getStorageType() - Method in class io.nats.client.api.KeyValueStatus
Gets the storage type for this bucket.
getStorageType() - Method in class io.nats.client.api.ObjectStoreStatus
Gets the storage type for this bucket.
getStorageType() - Method in class io.nats.client.api.StreamConfiguration
Gets the storage type for this stream configuration.
getStream() - Method in class io.nats.client.api.MessageInfo
Get the name of the stream.
getStream() - Method in class io.nats.client.api.PublishAck
Get the name of the stream a published message was stored in.
getStream() - Method in class io.nats.client.PublishOptions
Deprecated.
this field isn't really very useful since it's used after the publish Gets the name of the stream to check after the publish has succeeded
getStream() - Method in class io.nats.client.SubscribeOptions
Gets the name of the stream.
getStreamContext(String) - Method in interface io.nats.client.Connection
Get a stream context for a specific stream.
getStreamContext(String, JetStreamOptions) - Method in interface io.nats.client.Connection
Get a stream context for a specific stream
getStreamContext(String) - Method in interface io.nats.client.JetStream
Get a stream context for a specific named stream.
getStreamInfo(String) - Method in interface io.nats.client.JetStreamManagement
Gets the info for an existing stream.
getStreamInfo(String, StreamInfoOptions) - Method in interface io.nats.client.JetStreamManagement
Gets the info for an existing stream, and include subject or deleted details as defined by StreamInfoOptions.
getStreamInfo() - Method in interface io.nats.client.StreamContext
Gets information about the stream for this context.
getStreamInfo(StreamInfoOptions) - Method in interface io.nats.client.StreamContext
Gets information about the stream for this context.
getStreamName() - Method in class io.nats.client.api.ConsumerInfo
The Stream the consumer belongs to
getStreamName() - Method in interface io.nats.client.JetStreamSubscription
Gets the stream name associated with the subscription.
getStreamName() - Method in interface io.nats.client.StreamContext
Gets the stream name that was used to create the context.
getStreamNames() - Method in interface io.nats.client.JetStreamManagement
Get the names of all streams.
getStreamNames(String) - Method in interface io.nats.client.JetStreamManagement
Get a list of stream names that have subjects matching the subject filter.
getStreams() - Method in class io.nats.client.api.AccountStatistics
Gets the number of streams used by the JetStream deployment.
getStreams() - Method in class io.nats.client.api.AccountTier
Number of active streams in this tier.
getStreams() - Method in interface io.nats.client.JetStreamManagement
Return a list of StreamInfo objects.
getStreams(String) - Method in interface io.nats.client.JetStreamManagement
Return a list of StreamInfo objects that have subjects matching the filter.
getStreamSequence() - Method in class io.nats.client.api.SequencePair
Gets the stream sequence number.
getStreamState() - Method in class io.nats.client.api.StreamInfo
Gets the stream state.
getStreamTimeout() - Method in class io.nats.client.PublishOptions
Gets the publish timeout.
getSubject() - Method in class io.nats.client.api.MessageInfo
Get the message subject
getSubject() - Method in interface io.nats.client.Message
the subject that this message was sent to
getSubject() - Method in class io.nats.client.PurgeOptions
Get the subject for the Purge Options
getSubject() - Method in interface io.nats.client.Subscription
the subject associated with this subscription, will be non-null
getSubject() - Method in class io.nats.service.Endpoint
Get the subject of the Endpoint
getSubject() - Method in class io.nats.service.EndpointStats
Get the subject of the Endpoint
getSubject() - Method in class io.nats.service.Group
Get the resolved subject of a group by concatenating the group name and any groups.
getSubject() - Method in class io.nats.service.ServiceEndpoint
Get the subject of the ServiceEndpoint which takes into account the group path and the Endpoint subject
getSubject() - Method in class io.nats.service.ServiceMessage
the subject that this message was sent to
getSubjectCount() - Method in class io.nats.client.api.StreamState
Gets the count of subjects in the stream.
getSubjectDeleteMarkerTtl() - Method in class io.nats.client.api.StreamConfiguration
Get the Subject Delete Marker TTL duration.
getSubjectMap() - Method in class io.nats.client.api.StreamState
Get a map of subjects instead of a list of Subject objects.
getSubjects() - Method in class io.nats.client.api.StreamConfiguration
Gets the subjects for this stream configuration.
getSubjects() - Method in class io.nats.client.api.StreamState
Get a list of the Subject objects.
getSubjectsFilter() - Method in class io.nats.client.api.StreamInfoOptions
Get the configured subject filter
getSubjectTransform() - Method in class io.nats.client.api.StreamConfiguration
Get the subjectTransform configuration.
getSubjectTransforms() - Method in class io.nats.client.api.SourceBase
Get the subject transforms
getSubscription() - Method in exception io.nats.client.JetStreamStatusException
Get the subscription this issue occurred on
getSubscription() - Method in interface io.nats.client.Message
the Subscription associated with this message, may be owned by a Dispatcher
getSuccess() - Method in class io.nats.client.api.SuccessApiResponse
Get the success state
getTags() - Method in class io.nats.client.api.Placement
Tags required on servers hosting this stream
getTemplateOwner() - Method in class io.nats.client.api.StreamConfiguration
Gets the template json for this stream configuration.
getThresholdPercent() - Method in class io.nats.client.BaseConsumeOptions
Get the threshold percent setting
getTiers() - Method in class io.nats.client.api.AccountStatistics
Gets the map of the Account Tiers by tier name.
getTime() - Method in class io.nats.client.api.MessageInfo
Get the time the message was received
getTimestamp() - Method in class io.nats.client.api.ConsumerInfo
Gets the server time the info was gathered
getTimestamp() - Method in class io.nats.client.api.StreamInfo
Gets the server time the info was gathered
getTimeTraceLogger() - Method in class io.nats.client.Options
If the user provided a TimeTraceLogger, it's returned here.
getToken() - Method in class io.nats.client.Options
Deprecated.
converts the char array to a string, use getTokenChars instead for more security
getTokenChars() - Method in class io.nats.client.Options
the token to be used for token-based authentication, see token() in the builder doc generated from the token supplier if the user supplied one.
getTotal() - Method in class io.nats.client.api.ApiStats
Deprecated.
Deprecated, replaced with getTotalApiRequests Total number of API requests received for this account
getTotalApiRequests() - Method in class io.nats.client.api.ApiStats
Total number of API requests received for this account
getTrafficAccount() - Method in class io.nats.client.api.ClusterInfo
The account where the replication traffic goes over.
getTtl() - Method in class io.nats.client.api.FeatureConfiguration
Gets the maximum age for a value in this bucket.
getTtl() - Method in class io.nats.client.api.KeyValueStatus
Gets the maximum age for a value in this bucket.
getTtl() - Method in class io.nats.client.api.ObjectStoreStatus
Gets the maximum age for a value in this store.
getTtlString() - Method in class io.nats.client.MessageTtl
Get the string representation of the message ttl, used as a value
getType() - Method in class io.nats.client.api.ApiResponse
The type of the response object
getType() - Method in class io.nats.client.NKey
the Type of this NKey
getType() - Method in class io.nats.service.ServiceResponse
The type of this response;
getUnprocessedServers() - Method in class io.nats.client.Options
the servers as given to the options, since the servers are normalized
getUsername() - Method in class io.nats.client.Options
Deprecated.
converts the char array to a string, use getUserNameChars instead for more security
getUsernameChars() - Method in class io.nats.client.Options
the username to use for basic authentication, see userInfo() in the builder doc
getVal() - Method in class io.nats.client.api.PublishAck
Gets a counter value.
getValue() - Method in class io.nats.client.api.KeyValueEntry
Get the value.
getValueAsLong() - Method in class io.nats.client.api.KeyValueEntry
Get the value as a long
getValueAsString() - Method in class io.nats.client.api.KeyValueEntry
Get the value as a string using UTF-8 encoding
getVersion() - Method in class io.nats.client.api.ServerInfo
the server version
getVersion() - Method in class io.nats.service.Service
Get the version of the service
getVersion() - Method in class io.nats.service.ServiceResponse
Version of the service
getWaitTime(long) - Method in interface io.nats.client.ReconnectDelayHandler
Get the duration of time to wait before trying to reconnect against the server list
group(String) - Method in class io.nats.client.PullRequestOptions.Builder
Sets the group Replaces any other groups set in the builder
Group - Class in io.nats.service
Group is way to organize endpoints by serving as a common prefix to all endpoints registered in it.
Group(String) - Constructor for class io.nats.service.Group
Construct a group.
group(Group) - Method in class io.nats.service.ServiceEndpoint.Builder
Set the Group for this ServiceEndpoint

H

handler(ServiceMessageHandler) - Method in class io.nats.service.ServiceEndpoint.Builder
Set the ServiceMessageHandler for this ServiceEndpoint
hasData() - Method in class io.nats.client.api.Placement
Whether the Placement has either a cluster or tags
hasError() - Method in class io.nats.client.api.ApiResponse
Does the response have an error
hashCode() - Method in class io.nats.client.api.External
 
hashCode() - Method in class io.nats.client.api.KeyValueEntry
 
hashCode() - Method in class io.nats.client.api.ObjectInfo
 
hashCode() - Method in class io.nats.client.api.ObjectLink
 
hashCode() - Method in class io.nats.client.api.ObjectMeta
 
hashCode() - Method in class io.nats.client.api.ObjectMetaOptions
 
hashCode() - Method in class io.nats.client.api.SourceBase
 
hashCode() - Method in class io.nats.client.api.SubjectTransform
 
hashCode() - Method in class io.nats.client.NKey
 
hashCode() - Method in class io.nats.service.Endpoint
 
hashCode() - Method in class io.nats.service.EndpointStats
 
hashCode() - Method in class io.nats.service.Group
 
hashCode() - Method in class io.nats.service.InfoResponse
 
hashCode() - Method in class io.nats.service.ServiceResponse
 
hashCode() - Method in class io.nats.service.StatsResponse
 
hasHeaders() - Method in interface io.nats.client.Message
true if there are headers
hasHeaders() - Method in class io.nats.service.ServiceMessage
true if there are headers
hasMultipleFilterSubjects() - Method in class io.nats.client.api.ConsumerConfiguration
Whether there are multiple filter subjects for this consumer configuration.
hasMultipleFilterSubjects() - Method in class io.nats.client.api.OrderedConsumerConfiguration
Whether there are multiple filter subjects for this consumer configuration.
hasSecureServer() - Method in interface io.nats.client.ServerPool
Whether the pool has any server with a secure scheme
headers(Headers) - Method in class io.nats.client.api.ObjectInfo.Builder
convenience method to set the object's ObjectMeta headers
headers(Headers) - Method in class io.nats.client.api.ObjectMeta.Builder
Set the object headers
headersOnly(Boolean) - Method in class io.nats.client.api.ConsumerConfiguration.Builder
set the headers only flag saying to deliver only the headers of messages in the stream and not the bodies
headersOnly(Boolean) - Method in class io.nats.client.api.OrderedConsumerConfiguration
set the headers only flag saying to deliver only the headers of messages in the stream and not the bodies
headersOnly(Boolean) - Method in class io.nats.client.api.Republish.Builder
set Whether to RePublish only headers (no body)
headersOnlyWasSet() - Method in class io.nats.client.api.ConsumerConfiguration
Gets whether headers only for this consumer configuration was set or left unset
heartbeatAlarm(Connection, JetStreamSubscription, long, long) - Method in interface io.nats.client.ErrorListener
Called when subscription heartbeats are missed according to the configured period and threshold.
history(String) - Method in interface io.nats.client.KeyValue
Get the history (list of KeyValueEntry) for a key
httpRequestInterceptor(Consumer<HttpRequest>) - Method in class io.nats.client.Options.Builder
Add an HttpRequest interceptor which can be used to modify the HTTP request when using websockets
httpRequestInterceptors(Collection<? extends Consumer<HttpRequest>>) - Method in class io.nats.client.Options.Builder
Overwrite the list of HttpRequest interceptors which can be used to modify the HTTP request when using websockets

I

idleHeartbeat(Duration) - Method in class io.nats.client.api.ConsumerConfiguration.Builder
sets the idle heart beat wait time
idleHeartbeat(long) - Method in class io.nats.client.api.ConsumerConfiguration.Builder
sets the idle heart beat wait time
idleHeartbeat(long) - Method in class io.nats.client.PullRequestOptions.Builder
Set the idle heartbeat time in millis
idleHeartbeat(Duration) - Method in class io.nats.client.PullRequestOptions.Builder
Set the idle heartbeat duration
ignoreDiscoveredServers() - Method in class io.nats.client.Options.Builder
Turn off use of discovered servers when connecting / reconnecting.
inactiveThreshold(Duration) - Method in class io.nats.client.api.ConsumerConfiguration.Builder
sets the amount of time before the consumer is deemed inactive.
inactiveThreshold(long) - Method in class io.nats.client.api.ConsumerConfiguration.Builder
sets the amount of time before the consumer is deemed inactive.
inactiveThreshold(Duration) - Method in class io.nats.client.api.ConsumerLimits.Builder
sets the amount of time before the consumer is deemed inactive.
inactiveThreshold(long) - Method in class io.nats.client.api.ConsumerLimits.Builder
sets the amount of time before the consumer is deemed inactive.
inboxPrefix(String) - Method in class io.nats.client.Options.Builder
Set the connection's inbox prefix.
incrementDroppedCount() - Method in interface io.nats.client.StatisticsCollector
Increments the total number of messages dropped by this connection across all slow consumers.
incrementDuplicateRepliesReceived() - Method in interface io.nats.client.StatisticsCollector
Increments the total number of duplicate replies received by this connection.
incrementErrCount() - Method in interface io.nats.client.StatisticsCollector
Increments the total number of op -ERRs received by this connection.
incrementExceptionCount() - Method in interface io.nats.client.StatisticsCollector
Increments the total number of exceptions seen by this connection.
incrementFlushCounter() - Method in interface io.nats.client.StatisticsCollector
Increment the total number of outgoing message flushes by this connection.
incrementIn(long) - Method in interface io.nats.client.StatisticsCollector
Increments the total number of messages that have come in to this connection by 1 AND the number of bytes in the same call.
incrementInBytes(long) - Method in interface io.nats.client.StatisticsCollector
Deprecated.
Was always called with incrementIn. Replaced with incrementIn(long bytes) Increment the total number of message bytes that have come in to this connection.
incrementInMsgs() - Method in interface io.nats.client.StatisticsCollector
Deprecated.
Was always called with incrementInBytes. Replaced with incrementIn(long bytes) Increments the total number of messages that have come in to this connection.
incrementOkCount() - Method in interface io.nats.client.StatisticsCollector
Increments the total number of op +OKs received by this connection.
incrementOrphanRepliesReceived() - Method in interface io.nats.client.StatisticsCollector
Increments the total number of orphan replies received by this connection.
incrementOut(long) - Method in interface io.nats.client.StatisticsCollector
Increments the total number of messages that have gone out of this connection.
incrementOutBytes(long) - Method in interface io.nats.client.StatisticsCollector
Deprecated.
Was always called with incrementOut. Replaced with incrementOut(long bytes) Increment the total number of message bytes that have gone out of this connection.
incrementOutMsgs() - Method in interface io.nats.client.StatisticsCollector
Deprecated.
Was always called with incrementOutBytes. Replaced with incrementOut(long bytes) Increments the total number of messages that have gone out of this connection.
incrementOutstandingRequests() - Method in interface io.nats.client.StatisticsCollector
Increments the count of outstanding of requests from this connection.
incrementPingCount() - Method in interface io.nats.client.StatisticsCollector
Increments the total number of pings that have been sent from this connection.
incrementReconnects() - Method in interface io.nats.client.StatisticsCollector
Increments the total number of times this connection has tried to reconnect.
incrementRepliesReceived() - Method in interface io.nats.client.StatisticsCollector
Increments the total number of replies received by this connection.
incrementRequestsSent() - Method in interface io.nats.client.StatisticsCollector
Increments the total number of requests sent by this connection.
info() - Method in class io.nats.service.Discovery
Make an info request to all services running on the server.
info(String) - Method in class io.nats.service.Discovery
Make an info request only to services having the matching service name
info(String, String) - Method in class io.nats.service.Discovery
Make an info request to a specific instance of a service having matching service name and id
infoDispatcher(Dispatcher) - Method in class io.nats.service.ServiceBuilder
Optional dispatcher for the info service
InfoResponse - Class in io.nats.service
Info response class forms the info json payload, for example: {"id":"JlkwZvmHAXCQGwwxiPwaBJ","name":"MyService","version":"0.0.1","endpoints":[{"name":"MyEndpoint","subject":"myend"}],"type":"io.nats.micro.v1.info_response"}
initialize(Options) - Method in interface io.nats.client.ServerPool
Initialize the pool.
inProgress() - Method in interface io.nats.client.Message
Indicates that this message is being worked on and reset redelivery timer in the server.
instance(String) - Static method in enum io.nats.client.api.KeyValueOperation
Get an instance from the string value
instance(String) - Static method in class io.nats.client.api.StreamConfiguration
Returns a StreamConfiguration deserialized from its JSON form.
instanceByMarkerReason(String) - Static method in enum io.nats.client.api.KeyValueOperation
Get an instance based on marker reason
INTEGER_UNSET - Static variable in class io.nats.client.api.ConsumerConfiguration
Constant used to unset a Duration setting in the builder
io.nats.client - package io.nats.client
The Java NATS client is encapsulated into this single package io.nats.client.
io.nats.client.api - package io.nats.client.api
 
io.nats.service - package io.nats.service
 
isActive() - Method in interface io.nats.client.Consumer
whether this consumer is still processing messages.
isAllowMessageTtl() - Method in class io.nats.client.api.StreamConfiguration
Deprecated.
Prefer getAllowMessageTtl Whether Allow Message TTL is set
isAuthRequired() - Method in class io.nats.client.api.ServerInfo
true if authorization is required by the server
isBind() - Method in class io.nats.client.SubscribeOptions
Gets whether this subscription is expected to bind to an existing stream and consumer
isBucketLink() - Method in class io.nats.client.api.ObjectLink
True if the object is a bucket to an object versus a link to a link
isCompressed() - Method in class io.nats.client.api.FeatureConfiguration
Gets the state of compression
isCompressed() - Method in class io.nats.client.api.KeyValueStatus
Gets the state of compression
isCompressed() - Method in class io.nats.client.api.ObjectStoreStatus
Gets the state of compression
isConnectionEvent() - Method in enum io.nats.client.ConnectionListener.Events
Whether this event is a connection event.
isCurrent() - Method in class io.nats.client.api.PeerInfo
Indicates if the server is up-to-date and synchronised
isDefaultPrefix() - Method in class io.nats.client.JetStreamOptions
Returns true if the prefix for the options is the default prefix.
isDeleted() - Method in class io.nats.client.api.ObjectInfo
Whether the object is deleted
isDeletedDetails() - Method in class io.nats.client.api.StreamInfoOptions
Get the configured flag requesting deleted details
isDiscardMessagesWhenOutgoingQueueFull() - Method in class io.nats.client.Options
should we discard messages when the outgoing queue is full, see discardMessagesWhenOutgoingQueueFull() in the builder doc
isDiscardNewPerSubject() - Method in class io.nats.client.api.StreamConfiguration
Whether discard policy with max message per subject is applied per subject.
isDone() - Method in class io.nats.client.api.KeyResult
If there is no key, the result indicates the consume is done, even if there is an exception.
isDuplicate() - Method in class io.nats.client.api.PublishAck
Gets if the server detected the published message was a duplicate.
isEnableFastFallback() - Method in class io.nats.client.Options
Whether Fast fallback algorithm is enabled for socket connect
isEobStatus() - Method in class io.nats.client.api.MessageInfo
Whether this MessageInfo is a status message and is a direct EOB status
isErrorStatus() - Method in class io.nats.client.api.MessageInfo
Whether this MessageInfo is a status message and is an error status
isException() - Method in class io.nats.client.api.KeyResult
Whether this result is an exception
isFastBind() - Method in class io.nats.client.SubscribeOptions
Gets whether this subscription is expected to fast bind to an existing stream and consumer.
isFinished() - Method in interface io.nats.client.MessageConsumer
Finish indicates all messages have been received from the server.
isFlowControl() - Method in class io.nats.client.api.ConsumerConfiguration
Get the flow control flag indicating whether it's on or off
isFlush() - Method in class io.nats.client.ForceReconnectOptions
True if these options represent to flush
isForceClose() - Method in class io.nats.client.ForceReconnectOptions
True if these options represent force close
isHeadersOnly() - Method in class io.nats.client.api.ConsumerConfiguration
Get the header only flag indicating whether it's on or off
isHeadersOnly() - Method in class io.nats.client.api.OrderedConsumerConfiguration
Get the header only flag indicating whether it's on or off.
isHeadersOnly() - Method in class io.nats.client.api.Republish
Get headersOnly, Whether to RePublish only headers (no body)
isHeadersSupported() - Method in class io.nats.client.api.ServerInfo
true if headers are supported by the server
isIgnoreDiscoveredServers() - Method in class io.nats.client.Options
Get whether to ignore discovered servers
isJetStream() - Method in interface io.nats.client.Message
Checks if a message is from JetStream or is a standard message.
isJetStreamAvailable() - Method in class io.nats.client.api.ServerInfo
true if the server supports JetStream
isKey() - Method in class io.nats.client.api.KeyResult
Whether this result is a key.
isLameDuckMode() - Method in class io.nats.client.api.ServerInfo
true if server is in lame duck mode
isLink() - Method in class io.nats.client.api.ObjectInfo
Whether the object is actually a link
isMaxBytesRequired() - Method in class io.nats.client.api.AccountLimits
Indicates if streams created in this account requires the max_bytes property set.
isMemStorage() - Method in class io.nats.client.api.ConsumerConfiguration
Get the mem storage flag whether it's on or off.
isMessage() - Method in class io.nats.client.api.MessageInfo
Whether this MessageInfo is a regular message
isNewerVersionThan(String) - Method in class io.nats.client.api.ServerInfo
function to determine is the server version is newer than the input
isNoEcho() - Method in class io.nats.client.Options
is echo-ing disabled, see noEcho() in the builder doc
isNoHeaders() - Method in class io.nats.client.Options
are headers disabled, see noHeaders() in the builder doc
isNoNoResponders() - Method in class io.nats.client.Options
is NoResponders ignored disabled, see noNoResponders() in the builder doc
isNoRandomize() - Method in class io.nats.client.Options
should we turn off randomization for server connection attempts, see noRandomize() in the builder doc
isNoResolveHostnames() - Method in class io.nats.client.Options
should we resolve hostnames for server connection attempts, see noResolveHostnames() in the builder doc
isNoWait() - Method in class io.nats.client.FetchConsumeOptions
If the options specify no wait
isNoWait() - Method in class io.nats.client.PullRequestOptions
Get the no wait flag value
isObjectLink() - Method in class io.nats.client.api.ObjectLink
True if the object is a link to an object versus a link to a bucket
isOffline() - Method in class io.nats.client.api.PeerInfo
Indicates the node is considered offline by the group
isOlderThanVersion(String) - Method in class io.nats.client.api.ServerInfo
function to determine is the server version is older than the input
isOldRequestStyle() - Method in class io.nats.client.Options
the flag to turn on old style requests, see oldStyleRequest() in the builder doc
isOptOut290ConsumerCreate() - Method in class io.nats.client.JetStreamOptions
Gets whether the opt-out of the server v2.9.0 consumer create api is set
isOrdered() - Method in class io.nats.client.SubscribeOptions
Gets whether this subscription is expected to ensure messages come in order
isPaused() - Method in class io.nats.client.api.ConsumerPauseResponse
Returns true if the consumer was paused
isPedantic() - Method in class io.nats.client.Options
are we using pedantic protocol, see pedantic() in the builder doc
isPublishNoAck() - Method in class io.nats.client.JetStreamOptions
Gets whether the publish no ack flag was set
isPull() - Method in class io.nats.client.SubscribeOptions
Gets whether this is a pull subscription
isPushBound() - Method in class io.nats.client.api.ConsumerInfo
Indicates if any client is connected and receiving messages from a push consumer
isReportNoResponders() - Method in class io.nats.client.Options
should complete with exception futures for requests that get no responders instead of cancelling the future, see reportNoResponders() in the builder doc
isSameOrNewerThanVersion(String) - Method in class io.nats.client.api.ServerInfo
function to determine is the server version is same or newer than the input
isSameOrOlderThanVersion(String) - Method in class io.nats.client.api.ServerInfo
function to determine is the server version is the same or older than the input
isSameVersion(String) - Method in class io.nats.client.api.ServerInfo
function to determine is the server version is same as the input
isSealed() - Method in class io.nats.client.api.ObjectStoreConfiguration
If true, indicates the store is sealed and cannot be modified in any way
isSealed() - Method in class io.nats.client.api.ObjectStoreStatus
If true, indicates the store is sealed and cannot be modified in any way
isStarted() - Method in class io.nats.service.Service
Get whether the service has full started
isStarted(long, TimeUnit) - Method in class io.nats.service.Service
Get
isStatus() - Method in class io.nats.client.api.MessageInfo
Whether this MessageInfo is a status message
isStatusMessage() - Method in interface io.nats.client.Message
true if there is status
isStopped() - Method in interface io.nats.client.MessageConsumer
Stopped indicates whether consuming has been stopped.
isSuccess() - Method in class io.nats.client.api.PurgeResponse
Returns true if the server was able to purge the stream
isSystemAccount() - Method in class io.nats.client.api.ClusterInfo
Indicates if the traffic_account is the system account.
isTLSAvailable() - Method in class io.nats.client.api.ServerInfo
true if TLS is available on the server
isTlsFirst() - Method in class io.nats.client.Options
Get whether to do tls first
isTLSRequired() - Method in class io.nats.client.api.ServerInfo
true if TLS is required by the server
isTLSRequired() - Method in class io.nats.client.Options
is there an sslContext for these Options, otherwise false, see secure() in the builder doc
isTraceConnection() - Method in class io.nats.client.Options
If isTraceConnection is true, the user provided a TimeTraceLogger or manually called traceConnection in the builder
isTrackAdvancedStats() - Method in class io.nats.client.Options
should we track advanced stats, see turnOnAdvancedStats() in the builder doc
isUtf8mode() - Method in interface io.nats.client.Message
Deprecated.
because the mode doesn't matter if is utf8Mode
isValidPublicAccountKey(char[]) - Static method in class io.nats.client.NKey
if the public key is an account public key
isValidPublicClusterKey(char[]) - Static method in class io.nats.client.NKey
if the public key is a cluster public key
isValidPublicOperatorKey(char[]) - Static method in class io.nats.client.NKey
if the public key is an operator public key
isValidPublicServerKey(char[]) - Static method in class io.nats.client.NKey
if the public key is a server public key
isValidPublicUserKey(char[]) - Static method in class io.nats.client.NKey
if the public key is a user public key
isVerbose() - Method in class io.nats.client.Options
are we in verbose mode, see verbose() in the builder doc
IterableConsumer - Interface in io.nats.client
A simplified consumer that does endless consume on the style of an iterator
iterate() - Method in interface io.nats.client.BaseConsumerContext
Start a long-running IterableConsumer with default ConsumeOptions.
iterate(ConsumeOptions) - Method in interface io.nats.client.BaseConsumerContext
Start a long-running IterableConsumer with custom ConsumeOptions.
iterate(int, Duration) - Method in interface io.nats.client.JetStreamSubscription
Prepares an iterator.
iterate(int, long) - Method in interface io.nats.client.JetStreamSubscription
Prepares an iterator.

J

jetStream() - Method in interface io.nats.client.Connection
Gets a context for publishing and subscribing to subjects backed by Jetstream streams and consumers.
jetStream(JetStreamOptions) - Method in interface io.nats.client.Connection
Gets a context for publishing and subscribing to subjects backed by Jetstream streams and consumers.
JetStream - Interface in io.nats.client
JetStream context for access to streams and consumers in NATS.
jetStream() - Method in interface io.nats.client.JetStreamManagement
Gets a context for publishing and subscribing to subjects backed by Jetstream streams and consumers, using the same connection and JetStreamOptions as the management.
JetStreamApiException - Exception in io.nats.client
JetStreamApiException is used to indicate that the server returned an error while make a request related to JetStream.
JetStreamApiException(ApiResponse<?>) - Constructor for exception io.nats.client.JetStreamApiException
Deprecated.
Prefer to construct with JetStreamApiException(@NonNull Error) Construct an exception with the response from the server.
JetStreamApiException(Error) - Constructor for exception io.nats.client.JetStreamApiException
Construct an exception with an Error
jetStreamManagement() - Method in interface io.nats.client.Connection
Gets a context for managing Jetstream streams and consumers.
jetStreamManagement(JetStreamOptions) - Method in interface io.nats.client.Connection
Gets a context for managing Jetstream streams and consumers.
JetStreamManagement - Interface in io.nats.client
JetStream Management context for creation and access to streams and consumers in NATS.
JetStreamOptions - Class in io.nats.client
The JetStreamOptions class specifies the general options for JetStream.
JetStreamOptions.Builder - Class in io.nats.client
JetStreamOptions can be created using a Builder.
JetStreamReader - Interface in io.nats.client
This interface provides a simple iterative access to a pull consumer.
JetStreamStatusCheckedException - Exception in io.nats.client
A checked version of a JetStreamStatusException
JetStreamStatusCheckedException(JetStreamStatusException) - Constructor for exception io.nats.client.JetStreamStatusCheckedException
construct a JetStreamStatusCheckedException from a JetStreamStatusException
JetStreamStatusException - Exception in io.nats.client
JetStreamStatusException is used to indicate an unknown status message was received.
JetStreamStatusException(Status, JetStreamSubscription) - Constructor for exception io.nats.client.JetStreamStatusException
Construct JetStreamStatusException for a subscription and a status
JetStreamStatusException(Status) - Constructor for exception io.nats.client.JetStreamStatusException
Construct JetStreamStatusException for a status
JetStreamSubscription - Interface in io.nats.client
Subscription on a JetStream context.
JsBadRequestErr - Static variable in class io.nats.client.api.Error
Error representing 400 / 10003 / "bad request"
JsNoMessageFoundErr - Static variable in class io.nats.client.api.Error
Error representing 404 / 10037 / "no message found"
json(String) - Method in class io.nats.client.api.ConsumerConfiguration.Builder
Initialize values from the json string.
jsonValue(JsonValue) - Method in class io.nats.client.api.ConsumerConfiguration.Builder
Initialize values from the JsonValue object.
jsonValue(JsonValue) - Method in class io.nats.client.FetchConsumeOptions.Builder
 

K

keep(long) - Method in class io.nats.client.PurgeOptions.Builder
set the max number of messages to keep
KeyResult - Class in io.nats.client.api
Class is used as the result or consuming keys
KeyResult() - Constructor for class io.nats.client.api.KeyResult
Construct a valueless Key Result - used as the done marker without an exception
KeyResult(String) - Constructor for class io.nats.client.api.KeyResult
Construct a key result for a specific key
KeyResult(Exception) - Constructor for class io.nats.client.api.KeyResult
Construct a key result containing an exception
keys() - Method in interface io.nats.client.KeyValue
Get a list of the keys in a bucket.
keys(String) - Method in interface io.nats.client.KeyValue
Get a list of the keys in a bucket filtered by a subject-like string, for instance "key" or "key.foo.*" or "key.>"
keys(List<String>) - Method in interface io.nats.client.KeyValue
Get a list of the keys in a bucket filtered by subject-like strings, for instance "aaa.*", "bbb.*;"
keystorePassword(char[]) - Method in class io.nats.client.Options.Builder
the password for the keystore
keystorePath(String) - Method in class io.nats.client.Options.Builder
the path to the keystore file
keyValue(String) - Method in interface io.nats.client.Connection
Gets a context for working with a Key Value bucket
keyValue(String, KeyValueOptions) - Method in interface io.nats.client.Connection
Gets a context for working with a Key Value bucket
KeyValue - Interface in io.nats.client
Key Value Store Management context for creation and access to key value buckets.
KeyValueConfiguration - Class in io.nats.client.api
The KeyValueConfiguration class contains the configuration for of a Key Value bucket.
KeyValueConfiguration.Builder - Class in io.nats.client.api
KeyValueConfiguration is created using a Builder.
KeyValueEntry - Class in io.nats.client.api
The KeyValueEntry represents a record in the Key Value history
KeyValueEntry(MessageInfo) - Constructor for class io.nats.client.api.KeyValueEntry
Construct KeyValueEntry from message info
KeyValueEntry(Message) - Constructor for class io.nats.client.api.KeyValueEntry
Construct KeyValueEntry from a message
keyValueManagement() - Method in interface io.nats.client.Connection
Gets a context for managing Key Value buckets
keyValueManagement(KeyValueOptions) - Method in interface io.nats.client.Connection
Gets a context for managing Key Value buckets
KeyValueManagement - Interface in io.nats.client
Key Value Store Management context for creation and access to key value buckets.
KeyValueOperation - Enum in io.nats.client.api
Key Value Operations Enum
KeyValueOptions - Class in io.nats.client
The KeyValueOptions class specifies the general options for KeyValueO.
KeyValueOptions.Builder - Class in io.nats.client
KeyValueOptions can be created using a Builder.
KeyValuePurgeOptions - Class in io.nats.client.api
Options used when purging keys
KeyValuePurgeOptions.Builder - Class in io.nats.client.api
KeyValuePurgeOptions is created using a Builder.
KeyValueStatus - Class in io.nats.client.api
The KeyValueStatus class contains information about a Key Value Bucket.
KeyValueStatus(StreamInfo) - Constructor for class io.nats.client.api.KeyValueStatus
Construct an instance from the underlying stream info
KeyValueWatcher - Interface in io.nats.client.api
Use the KeyValueWatcher interface to watch for updates
KeyValueWatchOption - Enum in io.nats.client.api
Options for the Key Value Watcher

L

lastAck() - Method in interface io.nats.client.Message
the last ack that was done with this message the last ack or null
limitMarker(Duration) - Method in class io.nats.client.api.KeyValueConfiguration.Builder
The limit marker TTL duration.
limitMarker(long) - Method in class io.nats.client.api.KeyValueConfiguration.Builder
The limit marker TTL duration in milliseconds.
link(ObjectLink) - Method in class io.nats.client.api.ObjectInfo.Builder
convenience method to set the object's ObjectMeta link
link(ObjectLink) - Method in class io.nats.client.api.ObjectMeta.Builder
Convenience method to set the ObjectMetaOptions to set the link
link(ObjectLink) - Method in class io.nats.client.api.ObjectMetaOptions.Builder
Set the link
LONG_UNSET - Static variable in class io.nats.client.api.ConsumerConfiguration
Constant used to unset a long setting in the builder
LostStreamData - Class in io.nats.client.api
Information about lost stream data

M

max(int, int) - Method in class io.nats.client.FetchConsumeOptions.Builder
Set maximum number of bytes or messages to fetch.
MAX_DELIVER_MIN - Static variable in class io.nats.client.api.ConsumerConfiguration
Constant representing the minimum max deliver
MAX_HEARTBEAT_MILLIS - Static variable in class io.nats.client.BaseConsumeOptions
constant for max heartbeat millis
MAX_IDLE_HEARTBEAT_PERCENT - Static variable in class io.nats.client.BaseConsumeOptions
constant for max idle heartbeat percent
MAX_MESSAGES_IN_NETWORK_BUFFER - Static variable in class io.nats.client.Options
This value is used internally to limit the number of messages sent in a single network I/O.
maxAckPending(Long) - Method in class io.nats.client.api.ConsumerConfiguration.Builder
Sets the maximum ack pending or null to unset / clear.
maxAckPending(long) - Method in class io.nats.client.api.ConsumerConfiguration.Builder
Sets the maximum ack pending.
maxAckPending(Long) - Method in class io.nats.client.api.ConsumerLimits.Builder
Sets the maximum ack pending or null to unset / clear.
maxAckPending(long) - Method in class io.nats.client.api.ConsumerLimits.Builder
Sets the maximum ack pending.
maxAckPendingWasSet() - Method in class io.nats.client.api.ConsumerConfiguration
Gets whether max ack pending for this consumer configuration was set or left unset
maxAge(Duration) - Method in class io.nats.client.api.StreamConfiguration.Builder
Sets the maximum age in the StreamConfiguration.
maxAge(long) - Method in class io.nats.client.api.StreamConfiguration.Builder
Sets the maximum age in the StreamConfiguration.
maxBatch(Long) - Method in class io.nats.client.api.ConsumerConfiguration.Builder
sets the max batch size for the server to allow on pull requests.
maxBatch(long) - Method in class io.nats.client.api.ConsumerConfiguration.Builder
sets the max batch size for the server to allow on pull requests.
maxBatchWasSet() - Method in class io.nats.client.api.ConsumerConfiguration
Gets whether max batch for this consumer configuration was set or left unset
maxBucketSize(long) - Method in class io.nats.client.api.KeyValueConfiguration.Builder
Sets the maximum number of bytes in the KeyValueConfiguration.
maxBucketSize(long) - Method in class io.nats.client.api.ObjectStoreConfiguration.Builder
Sets the maximum number of bytes in the ObjectStoreConfiguration.
maxBytes(Long) - Method in class io.nats.client.api.ConsumerConfiguration.Builder
sets the max bytes size for the server to allow on pull requests.
maxBytes(long) - Method in class io.nats.client.api.ConsumerConfiguration.Builder
sets the max bytes size for the server to allow on pull requests.
maxBytes(long) - Method in class io.nats.client.api.StreamConfiguration.Builder
Sets the maximum number of bytes in the StreamConfiguration.
maxBytes(long) - Method in class io.nats.client.FetchConsumeOptions.Builder
Set maximum number of bytes to fetch and remove any previously set constraint The number of bytes fetched will also be constrained by the expiration time.
maxBytes(long) - Method in class io.nats.client.PullRequestOptions.Builder
The maximum bytes for the pull
maxBytesWasSet() - Method in class io.nats.client.api.ConsumerConfiguration
Gets whether max bytes for this consumer configuration was set or left unset
maxConsumers(long) - Method in class io.nats.client.api.StreamConfiguration.Builder
Sets the maximum number of consumers in the StreamConfiguration.
maxControlLine(int) - Method in class io.nats.client.Options.Builder
Set the maximum length of a control line sent by this connection.
maxDeliver(Long) - Method in class io.nats.client.api.ConsumerConfiguration.Builder
Sets the maximum delivery amount of the ConsumerConfiguration or null to unset / clear.
maxDeliver(long) - Method in class io.nats.client.api.ConsumerConfiguration.Builder
Sets the maximum delivery amount of the ConsumerConfiguration.
maxDeliverWasSet() - Method in class io.nats.client.api.ConsumerConfiguration
Gets whether max deliver for this consumer configuration was set or left unset
maxExpires(Duration) - Method in class io.nats.client.api.ConsumerConfiguration.Builder
sets the max amount of expire time for the server to allow on pull requests.
maxExpires(long) - Method in class io.nats.client.api.ConsumerConfiguration.Builder
sets the max amount of expire time for the server to allow on pull requests.
maxHistoryPerKey(int) - Method in class io.nats.client.api.KeyValueConfiguration.Builder
Sets the maximum number of history for any one key.
maximumMessageSize(int) - Method in class io.nats.client.api.StreamConfiguration.Builder
Sets the maximum message size in the StreamConfiguration.
maximumValueSize(int) - Method in class io.nats.client.api.KeyValueConfiguration.Builder
Sets the maximum size for an individual value in the KeyValueConfiguration.
maxMessages(long) - Method in class io.nats.client.api.StreamConfiguration.Builder
Sets the maximum number of messages in the StreamConfiguration.
maxMessages(int) - Method in class io.nats.client.FetchConsumeOptions.Builder
Set the maximum number of messages to fetch and remove any previously set FetchConsumeOptions.Builder.maxBytes(long) constraint.
maxMessagesInOutgoingQueue(int) - Method in class io.nats.client.Options.Builder
Set the maximum number of messages in the outgoing queue.
maxMessagesPerSubject(long) - Method in class io.nats.client.api.StreamConfiguration.Builder
Sets the maximum number of message per subject in the StreamConfiguration.
maxMsgSize(long) - Method in class io.nats.client.api.StreamConfiguration.Builder
Deprecated.
the server value is a 32-bit signed value. Use StreamConfiguration.Builder.maximumMessageSize(int) instead.
maxPingsOut(int) - Method in class io.nats.client.Options.Builder
Set the maximum number of pings the client can have in flight.
maxPullWaiting(Long) - Method in class io.nats.client.api.ConsumerConfiguration.Builder
sets the max pull waiting, the number of pulls that can be outstanding on a pull consumer, pulls received after this is reached are ignored.
maxPullWaiting(long) - Method in class io.nats.client.api.ConsumerConfiguration.Builder
sets the max pull waiting, the number of pulls that can be outstanding on a pull consumer, pulls received after this is reached are ignored.
maxPullWaitingWasSet() - Method in class io.nats.client.api.ConsumerConfiguration
Gets whether max pull waiting for this consumer configuration was set or left unset
maxReconnects(int) - Method in class io.nats.client.Options.Builder
Set the maximum number of reconnect attempts.
maxValueSize(long) - Method in class io.nats.client.api.KeyValueConfiguration.Builder
Deprecated.
the server value is a 32-bit signed value. Use KeyValueConfiguration.Builder.maximumValueSize(int) instead.
memStorage(Boolean) - Method in class io.nats.client.api.ConsumerConfiguration.Builder
set the mem storage flag to force the consumer state to be kept in memory rather than inherit the setting from the stream
memStorageWasSet() - Method in class io.nats.client.api.ConsumerConfiguration
Gets whether mem storage for this consumer configuration was set or left unset
Message - Interface in io.nats.client
The NATS library uses a Message object to encapsulate incoming messages.
message(String, Message) - Method in interface io.nats.client.ReadListener
Called when the message is any non-protocol message
MessageConsumer - Interface in io.nats.client
The MessageConsumer interface is the core interface replacing a subscription for a simplified consumer.
messageDiscarded(Connection, Message) - Method in interface io.nats.client.ErrorListener
Called by the connection when a message is discarded.
MessageHandler - Interface in io.nats.client
Dispatchers use the MessageHandler interface to define the listener for their messages.
messageId(String) - Method in class io.nats.client.PublishOptions.Builder
Sets the message id.
MessageInfo - Class in io.nats.client.api
The MessageInfo class contains information about a JetStream message.
MessageInfo(Message) - Constructor for class io.nats.client.api.MessageInfo
Deprecated.
This signature was public for unit testing but is no longer used.
MessageInfo(Message, String, boolean) - Constructor for class io.nats.client.api.MessageInfo
Create a Message Info
MessageInfo(Status, String) - Constructor for class io.nats.client.api.MessageInfo
Create a Message Info
MessageInfoHandler - Interface in io.nats.client
Handler for MessageInfo.
MessageTtl - Class in io.nats.client
Class to make setting a per message ttl easier.
messageTtl(MessageTtl) - Method in class io.nats.client.PublishOptions.Builder
Sets the TTL for this specific message to be published
messageTtlCustom(String) - Method in class io.nats.client.PublishOptions.Builder
Sets the TTL for this specific message to be published.
messageTtlNever() - Method in class io.nats.client.PublishOptions.Builder
Sets the TTL for this specific message to be published and never be expired
messageTtlSeconds(int) - Method in class io.nats.client.PublishOptions.Builder
Sets the TTL for this specific message to be published.
metadata(Map<String, String>) - Method in class io.nats.client.api.ConsumerConfiguration.Builder
Sets the metadata for the configuration
metadata(Map<String, String>) - Method in class io.nats.client.api.KeyValueConfiguration.Builder
Sets the metadata for the KeyValueConfiguration
metadata(Map<String, String>) - Method in class io.nats.client.api.ObjectInfo.Builder
convenience method to set the object's ObjectMeta meta data
metadata(Map<String, String>) - Method in class io.nats.client.api.ObjectMeta.Builder
Set the object metadata
metadata(Map<String, String>) - Method in class io.nats.client.api.ObjectStoreConfiguration.Builder
Sets the metadata for the ObjectStoreConfiguration
metadata(Map<String, String>) - Method in class io.nats.client.api.StreamConfiguration.Builder
Sets the metadata for the configuration
metaData() - Method in interface io.nats.client.Message
Gets the metadata associated with a JetStream message.
metadata(Map<String, String>) - Method in class io.nats.service.Endpoint.Builder
Set the metadata for the Endpoint, replacing any metadata already set.
metadata(Map<String, String>) - Method in class io.nats.service.ServiceBuilder
Any meta information about this service
metadataWasSet() - Method in class io.nats.client.api.ConsumerConfiguration
Gets whether metadata for this consumer configuration was set or left unset
MIN_EXPIRES_MILLS - Static variable in class io.nats.client.BaseConsumeOptions
constant for min expires mills
MIN_IDLE_HEARTBEAT - Static variable in class io.nats.client.api.ConsumerConfiguration
The minimum allowed idle heartbeat setting
MIN_IDLE_HEARTBEAT_MILLIS - Static variable in class io.nats.client.api.ConsumerConfiguration
Constant representing the minimum idle heartbeat in milliseconds
MIN_IDLE_HEARTBEAT_NANOS - Static variable in class io.nats.client.api.ConsumerConfiguration
Constant representing the minimum idle heartbeat in nanos
minAckPending(long) - Method in class io.nats.client.PullRequestOptions.Builder
When specified, this Pull request will only receive messages when the consumer has at least this many ack pending messages.
MINIMUM_SOCKET_READ_TIMEOUT_GT_CONNECTION_TIMEOUT - Static variable in class io.nats.client.Options
Deprecated.
No longer enforcing a minimum
MINIMUM_SOCKET_WRITE_TIMEOUT_GT_CONNECTION_TIMEOUT - Static variable in class io.nats.client.Options
Deprecated.
No longer enforcing a minimum compared to the connection timeout
MINIMUM_SOCKET_WRITE_TIMEOUT_NANOS - Static variable in class io.nats.client.Options
This is set to 100 nanos to ensure that the scheduled task can execute
minPending(long) - Method in class io.nats.client.PullRequestOptions.Builder
When specified, the pull request will only receive messages when the consumer has at least this many pending messages.
mirror(Mirror) - Method in class io.nats.client.api.KeyValueConfiguration.Builder
Sets the mirror in the KeyValueConfiguration.
Mirror - Class in io.nats.client.api
Mirror Information.
mirror(Mirror) - Method in class io.nats.client.api.StreamConfiguration.Builder
Sets the mirror object
Mirror.Builder - Class in io.nats.client.api
The builder for a Mirror
mirrorDirect(boolean) - Method in class io.nats.client.api.StreamConfiguration.Builder
Set whether to allow unified direct access for mirrors
MirrorInfo - Class in io.nats.client.api
Information about an upstream stream source in a mirror
modified(ZonedDateTime) - Method in class io.nats.client.api.ObjectInfo.Builder
set the object's modified time

N

nak() - Method in interface io.nats.client.Message
nak acknowledges a JetStream message has been received but indicates that the message is not completely processed and should be sent again later.
nakWithDelay(Duration) - Method in interface io.nats.client.Message
nak acknowledges a JetStream message has been received but indicates that the message is not completely processed and should be sent again later, after at least the delay amount.
nakWithDelay(long) - Method in interface io.nats.client.Message
nak acknowledges a JetStream message has been received but indicates that the message is not completely processed and should be sent again later, after at least the delay amount.
name(String) - Method in class io.nats.client.api.ConsumerConfiguration.Builder
Sets the name of the consumer.
name(String) - Method in class io.nats.client.api.KeyValueConfiguration.Builder
Sets the name of the key value bucket.
name(String) - Method in class io.nats.client.api.ObjectStoreConfiguration.Builder
Sets the name of the store.
name(String) - Method in class io.nats.client.api.SourceBase.SourceBaseBuilder
Set the source name.
name(String) - Method in class io.nats.client.api.StreamConfiguration.Builder
Sets the name of the stream.
name(String) - Method in class io.nats.service.Endpoint.Builder
Set the name for the Endpoint, replacing any name already set.
name(String) - Method in class io.nats.service.ServiceBuilder
The simple name of the service
nanoTime() - Static method in class io.nats.client.NatsSystemClock
Get the current nano time from the provider, suitable for calculating elapsed time
nanoTime() - Method in interface io.nats.client.NatsSystemClockProvider
A nano time suitable for calculating elapsed time
Nats - Class in io.nats.client
The Nats class is the entry point into the NATS client for Java.
NATS_SERVICE_ERROR - Static variable in class io.nats.service.ServiceMessage
Standard header name used to report the text of an error
NATS_SERVICE_ERROR_CODE - Static variable in class io.nats.service.ServiceMessage
Standard header name used to report the code of an error
NatsSystemClock - Class in io.nats.client
Bridge to the NatsSystemClockProvider implementation
NatsSystemClockProvider - Interface in io.nats.client
Interface to implement to provide a custom clock implementation
never() - Static method in class io.nats.client.MessageTtl
Sets the TTL for this specific message to be published and never be expired
next() - Method in interface io.nats.client.BaseConsumerContext
Read the next message with max wait set to ms
next(Duration) - Method in interface io.nats.client.BaseConsumerContext
Read the next message with provided max wait
next(long) - Method in interface io.nats.client.BaseConsumerContext
Read the next message with provided max wait
next() - Method in class io.nats.client.NUID
Generate the next NUID string from this instance.
nextGlobal() - Static method in class io.nats.client.NUID
the next NUID string from a shared global NUID instance
nextGlobalSequence() - Static method in class io.nats.client.NUID
the next sequence portion of the NUID string from a shared global NUID instance
nextMessage() - Method in interface io.nats.client.FetchConsumer
Read the next message.
nextMessage(Duration) - Method in interface io.nats.client.IterableConsumer
Read the next message.
nextMessage(long) - Method in interface io.nats.client.IterableConsumer
Read the next message.
nextMessage(Duration) - Method in interface io.nats.client.JetStreamReader
Read the next message.
nextMessage(long) - Method in interface io.nats.client.JetStreamReader
Read the next message.
nextMessage(Duration) - Method in interface io.nats.client.Subscription
Read the next message for a subscription, or block until one is available.
nextMessage(long) - Method in interface io.nats.client.Subscription
Read the next message for a subscription, or block until one is available.
nextSequence() - Method in class io.nats.client.NUID
Generate the next NUID string from this instance and return only the sequence portion.
nextServer() - Method in interface io.nats.client.ServerPool
Get the next server to try to connect to.
NKey - Class in io.nats.client
The NATS ecosystem will be moving to Ed25519 keys for identity, authentication and authorization for entities such as Accounts, Users, Servers and Clusters.
NKey.Type - Enum in io.nats.client
NKeys use a prefix byte to indicate their intended owner: 'N' = server, 'C' = cluster, 'A' = account, and 'U' = user.
NO_TYPE - Static variable in class io.nats.client.api.ApiResponse
A constant for a response without a type
noAck(boolean) - Method in class io.nats.client.api.StreamConfiguration.Builder
Sets the acknowledgement mode of the StreamConfiguration.
noEcho() - Method in class io.nats.client.Options.Builder
Turn off echo.
noHeaders() - Method in class io.nats.client.Options.Builder
Turn off header support.
noNoResponders() - Method in class io.nats.client.Options.Builder
Turn off noresponder support.
noQueueGroup() - Method in class io.nats.service.Endpoint.Builder
Set to not use a queueGroup for this endpoint
noRandomize() - Method in class io.nats.client.Options.Builder
For the default server list provider, turn off server pool randomization.
noReconnect() - Method in class io.nats.client.Options.Builder
Equivalent to calling maxReconnects with 0, maxReconnects.
noResolveHostnames() - Method in class io.nats.client.Options.Builder
For the default server list provider, whether to resolve hostnames when building server list.
NOT_SET - Static variable in class io.nats.client.api.Error
represents an error code that was not set / provided
noWait() - Method in class io.nats.client.FetchConsumeOptions.Builder
Set no wait to true When no wait is true, the fetch will return immediately with as many messages as are available.
noWait() - Method in class io.nats.client.PullRequestOptions.Builder
Set no wait to true
noWait(boolean) - Method in class io.nats.client.PullRequestOptions.Builder
Set the no wait flag
noWait(int) - Static method in class io.nats.client.PullRequestOptions
Creates a builder for the pull options, setting no wait to true and accepting batch size
noWaitExpiresIn(long) - Method in class io.nats.client.FetchConsumeOptions.Builder
Set no wait to true with an expiration.
nuid(String) - Method in class io.nats.client.api.ObjectInfo.Builder
set the object's nuid
NUID - Class in io.nats.client
A highly performant unique identifier generator.
NUID() - Constructor for class io.nats.client.NUID
The default NUID constructor.
numReplicas(Integer) - Method in class io.nats.client.api.ConsumerConfiguration.Builder
set the number of replicas for the consumer.
numReplicasWasSet() - Method in class io.nats.client.api.ConsumerConfiguration
Gets whether num replicas for this consumer configuration was set or left unset

O

object(String, String) - Static method in class io.nats.client.api.ObjectLink
create an object link
ObjectInfo - Class in io.nats.client.api
The ObjectInfo is Object Meta Information plus instance information
ObjectInfo(MessageInfo) - Constructor for class io.nats.client.api.ObjectInfo
Construct ObjectInfo from message info
ObjectInfo(Message) - Constructor for class io.nats.client.api.ObjectInfo
Construct ObjectInfo from a message
ObjectInfo.Builder - Class in io.nats.client.api
A builder for ObjectInfo
objectLink(String, String) - Method in class io.nats.client.api.ObjectInfo.Builder
convenience method to set the object's ObjectMeta link
ObjectLink - Class in io.nats.client.api
The ObjectLink is used to embed links to other objects.
ObjectMeta - Class in io.nats.client.api
The ObjectMeta is Object Meta is high level information about an object
ObjectMeta.Builder - Class in io.nats.client.api
The builder for ObjectMeta
ObjectMetaOptions - Class in io.nats.client.api
The ObjectMetaOptions are additional options describing the object
ObjectMetaOptions.Builder - Class in io.nats.client.api
The builder for ObjectMetaOptions
objectName(String) - Method in class io.nats.client.api.ObjectInfo.Builder
set the object name
objectName(String) - Method in class io.nats.client.api.ObjectMeta.Builder
Set the object name
objectName(String) - Static method in class io.nats.client.api.ObjectMeta
Create object meta that only has the object name.
objectStore(String) - Method in interface io.nats.client.Connection
Gets a context for working with an Object Store.
objectStore(String, ObjectStoreOptions) - Method in interface io.nats.client.Connection
Gets a context for working with an Object Store.
ObjectStore - Interface in io.nats.client
Object Store Management context for creation and access to key value buckets.
ObjectStoreConfiguration - Class in io.nats.client.api
The ObjectStoreStatus class contains information about an object store.
ObjectStoreConfiguration.Builder - Class in io.nats.client.api
ObjectStoreConfiguration is created using a Builder.
objectStoreManagement() - Method in interface io.nats.client.Connection
Gets a context for managing Object Stores
objectStoreManagement(ObjectStoreOptions) - Method in interface io.nats.client.Connection
Gets a context for managing Object Stores
ObjectStoreManagement - Interface in io.nats.client
Object Store Management context for creation and access to object stores.
ObjectStoreOptions - Class in io.nats.client
The ObjectStoreOptions class specifies the general options for ObjectStore.
ObjectStoreOptions.Builder - Class in io.nats.client
ObjectStoreOptions can be created using a Builder.
ObjectStoreStatus - Class in io.nats.client.api
The ObjectStoreStatus class contains information about an object store.
ObjectStoreStatus(StreamInfo) - Constructor for class io.nats.client.api.ObjectStoreStatus
Create an object store from the StreamInfo for the underlying stream
ObjectStoreWatcher - Interface in io.nats.client.api
Use the ObjectStoreWatcher interface to watch for updates
ObjectStoreWatchOption - Enum in io.nats.client.api
Options for the Object Store Watcher
oldRequestStyle() - Method in class io.nats.client.Options.Builder
Turn on the old request style that uses a new inbox and subscriber for each request.
onMessage(Message) - Method in interface io.nats.client.MessageHandler
Called to deliver a message to the handler.
onMessage(ServiceMessage) - Method in interface io.nats.service.ServiceMessageHandler
Called to deliver a service request message to the handler.
onMessageInfo(MessageInfo) - Method in interface io.nats.client.MessageInfoHandler
Called to deliver a MessageInfo to the handler.
opentls() - Method in class io.nats.client.Options.Builder
Set the options to use an SSL context that accepts any server certificate and has no client certificates.
options(ObjectMetaOptions) - Method in class io.nats.client.api.ObjectInfo.Builder
convenience method to set the object's ObjectMeta meta options
options(ObjectMetaOptions) - Method in class io.nats.client.api.ObjectMeta.Builder
Set the object meta options
Options - Class in io.nats.client
The Options class specifies the connection options for a new NATs connection, including the default options.
Options.Builder - Class in io.nats.client
Options are created using a Builder.
optOut290ConsumerCreate(boolean) - Method in class io.nats.client.JetStreamOptions.Builder
Set whether to opt-out of the server v2.9.0 consumer create api.
ordered(boolean) - Method in class io.nats.client.PushSubscribeOptions.Builder
Set the ordered consumer flag
OrderedConsumerConfiguration - Class in io.nats.client.api
The ConsumerConfiguration class specifies the configuration for creating an ordered JetStream consumer
OrderedConsumerConfiguration() - Constructor for class io.nats.client.api.OrderedConsumerConfiguration
OrderedConsumerConfiguration creation works like a builder.
OrderedConsumerConfiguration(String) - Constructor for class io.nats.client.api.OrderedConsumerConfiguration
OrderedConsumerConfiguration creation works like a builder.
OrderedConsumerConfiguration(JsonValue) - Constructor for class io.nats.client.api.OrderedConsumerConfiguration
OrderedConsumerConfiguration creation works like a builder.
OrderedConsumerContext - Interface in io.nats.client
The Ordered Consumer and it's context provide a simplification interface to the ordered consumer behavior.
outgoingPendingBytes() - Method in interface io.nats.client.Connection
Get the number of bytes based to be written calculated from the messages in the outgoing queue for this connection.
outgoingPendingMessageCount() - Method in interface io.nats.client.Connection
Get the number of messages in the outgoing queue for this connection.

P

PARSE_ERROR_TYPE - Static variable in class io.nats.client.api.ApiResponse
a constant for a response that errors while parsing
pauseConsumer(String, String, ZonedDateTime) - Method in interface io.nats.client.JetStreamManagement
Pauses a consumer.
pauseUntil(ZonedDateTime) - Method in class io.nats.client.api.ConsumerConfiguration.Builder
Sets the time to pause the consumer until.
pedantic() - Method in class io.nats.client.Options.Builder
Turn on pedantic mode for the server, in relation to this connection.
peekNextServer() - Method in interface io.nats.client.ServerPool
Just take a peek at the next server without doing any processing.
PeerInfo - Class in io.nats.client.api
Server peer information
pendingByteLimit(long) - Method in class io.nats.client.PushSubscribeOptions.Builder
Set the maximum number of bytes that non-dispatched push subscriptions can hold in the internal (pending) message queue.
pendingMessageLimit(long) - Method in class io.nats.client.PushSubscribeOptions.Builder
Set the maximum number of messages that non-dispatched push subscriptions can hold in the internal (pending) message queue.
PersistMode - Enum in io.nats.client.api
Stream persist modes
persistMode(PersistMode) - Method in class io.nats.client.api.StreamConfiguration.Builder
Set the persist mode.
ping() - Method in class io.nats.service.Discovery
Make a ping request to all services running on the server.
ping(String) - Method in class io.nats.service.Discovery
Make a ping request only to services having the matching service name
ping(String, String) - Method in class io.nats.service.Discovery
Make a ping request to a specific instance of a service having matching service name and id
pingDispatcher(Dispatcher) - Method in class io.nats.service.ServiceBuilder
Optional dispatcher for the ping service
pingInterval(Duration) - Method in class io.nats.client.Options.Builder
Set the interval between attempts to pings the server.
PingResponse - Class in io.nats.service
Ping response class forms the ping json payload, for example: {"id":"JlkwZvmHAXCQGwwxiPwaBJ","name":"MyService","version":"0.0.1","type":"io.nats.micro.v1.ping_response"}
placement(Placement) - Method in class io.nats.client.api.KeyValueConfiguration.Builder
Sets the placement directive object
placement(Placement) - Method in class io.nats.client.api.ObjectStoreConfiguration.Builder
Sets the placement directive object
Placement - Class in io.nats.client.api
Placement directives to consider when placing replicas of a stream
Placement(String, List<String>) - Constructor for class io.nats.client.api.Placement
Construct a placement object
placement(Placement) - Method in class io.nats.client.api.StreamConfiguration.Builder
Sets the placement directive object
Placement.Builder - Class in io.nats.client.api
Placement can be created using a Builder.
prefix(String) - Method in class io.nats.client.JetStreamOptions.Builder
Sets the prefix for JetStream subjects.
priority(int) - Method in class io.nats.client.PullRequestOptions.Builder
Sets the priority within the group.
priorityGroups(String...) - Method in class io.nats.client.api.ConsumerConfiguration.Builder
Sets the priority groups of the ConsumerConfiguration.
priorityGroups(List<String>) - Method in class io.nats.client.api.ConsumerConfiguration.Builder
Sets the priority groups of the ConsumerConfiguration.
PriorityGroupState - Class in io.nats.client.api
Status of a specific consumer priority group
priorityPolicy(PriorityPolicy) - Method in class io.nats.client.api.ConsumerConfiguration.Builder
Sets the priority policy of the ConsumerConfiguration.
PriorityPolicy - Enum in io.nats.client.api
Represents the Priority Policy of a consumer
priorityPolicyWasSet() - Method in class io.nats.client.api.ConsumerConfiguration
Gets whether priority policy for this consumer configuration was set or left unset
priorityTimeout(Duration) - Method in class io.nats.client.api.ConsumerConfiguration.Builder
Sets the priority policy timeout
priorityTimeout(long) - Method in class io.nats.client.api.ConsumerConfiguration.Builder
Sets the priority policy timeout
priorityTimeoutWasSet() - Method in class io.nats.client.api.ConsumerConfiguration
Gets whether priority timeout for this consumer configuration was set or left unset
PROP_CALLBACK_THREAD_FACTORY_CLASS - Static variable in class io.nats.client.Options
Property used to set class name for the Callback Thread Factory callbackThreadFactory.
PROP_CLEANUP_INTERVAL - Static variable in class io.nats.client.Options
Property used to configure a builder from a Properties object.
PROP_CLIENT_SIDE_LIMIT_CHECKS - Static variable in class io.nats.client.Options
Property used to configure a builder from a Properties object.
PROP_CONNECT_THREAD_FACTORY_CLASS - Static variable in class io.nats.client.Options
Property used to set class name for the Connect Thread Factory connectThreadFactory.
PROP_CONNECTION_CB - Static variable in class io.nats.client.Options
Property used to configure a builder from a Properties object.
PROP_CONNECTION_NAME - Static variable in class io.nats.client.Options
Property used to configure a builder from a Properties object.
PROP_CONNECTION_TIMEOUT - Static variable in class io.nats.client.Options
Property used to configure a builder from a Properties object.
PROP_CREDENTIAL_PATH - Static variable in class io.nats.client.Options
Property used to set the path to a credentials file to be used in a FileAuthHandler
PROP_DATA_PORT_TYPE - Static variable in class io.nats.client.Options
Property used to configure a builder from a Properties object.
PROP_DISCARD_MESSAGES_WHEN_OUTGOING_QUEUE_FULL - Static variable in class io.nats.client.Options
Property used to configure a builder from a Properties object.
PROP_DISPATCHER_FACTORY_CLASS - Static variable in class io.nats.client.Options
Property used to set class name for the Dispatcher Factory dispatcherFactory.
PROP_ERROR_LISTENER - Static variable in class io.nats.client.Options
Property used to configure a builder from a Properties object.
PROP_EXECUTOR_SERVICE_CLASS - Static variable in class io.nats.client.Options
Property used to set class name for the Executor Service (executor) class executor.
PROP_FAST_FALLBACK - Static variable in class io.nats.client.Options
Property used to enable fast fallback algorithm for socket connection.
PROP_FORCE_FLUSH_ON_REQUEST - Static variable in class io.nats.client.Options
Property used to configure a builder from a Properties object.
PROP_IGNORE_DISCOVERED_SERVERS - Static variable in class io.nats.client.Options
Property used to set whether to ignore discovered servers when connecting
PROP_IGNORE_DISCOVERED_SERVERS_PREFERRED - Static variable in class io.nats.client.Options
Preferred property used to set whether to ignore discovered servers when connecting
PROP_INBOX_PREFIX - Static variable in class io.nats.client.Options
Property used to set the inbox prefix
PROP_KEYSTORE - Static variable in class io.nats.client.Options
Property for the keystore path used to create an SSLContext
PROP_KEYSTORE_PASSWORD - Static variable in class io.nats.client.Options
Property for the keystore password used to create an SSLContext
PROP_MAX_CONTROL_LINE - Static variable in class io.nats.client.Options
Property used to configure a builder from a Properties object.
PROP_MAX_MESSAGES_IN_OUTGOING_QUEUE - Static variable in class io.nats.client.Options
Property used to configure a builder from a Properties object.
PROP_MAX_PINGS - Static variable in class io.nats.client.Options
Property used to configure a builder from a Properties object.
PROP_MAX_RECONNECT - Static variable in class io.nats.client.Options
Property used to configure a builder from a Properties object.
PROP_NO_ECHO - Static variable in class io.nats.client.Options
Property used to configure a builder from a Properties object.
PROP_NO_HEADERS - Static variable in class io.nats.client.Options
Property used to configure a builder from a Properties object.
PROP_NO_NORESPONDERS - Static variable in class io.nats.client.Options
Property used to configure a builder from a Properties object.
PROP_NO_RESOLVE_HOSTNAMES - Static variable in class io.nats.client.Options
Property used to configure a builder from a Properties object.
PROP_NORANDOMIZE - Static variable in class io.nats.client.Options
Property used to configure a builder from a Properties object.
PROP_OPENTLS - Static variable in class io.nats.client.Options
Property used to configure a builder from a Properties object.
PROP_PASSWORD - Static variable in class io.nats.client.Options
Property used to configure a builder from a Properties object.
PROP_PEDANTIC - Static variable in class io.nats.client.Options
Property used to configure a builder from a Properties object.
PROP_PING_INTERVAL - Static variable in class io.nats.client.Options
Property used to configure a builder from a Properties object.
PROP_PUBLISH_TIMEOUT - Static variable in class io.nats.client.PublishOptions
Property used to configure a builder from a Properties object..
PROP_READ_LISTENER_CLASS - Static variable in class io.nats.client.Options
Property used to set class name for the ReaderListener implementation readListener.
PROP_RECONNECT_BUF_SIZE - Static variable in class io.nats.client.Options
Property used to configure a builder from a Properties object.
PROP_RECONNECT_JITTER - Static variable in class io.nats.client.Options
Property used to configure a builder from a Properties object.
PROP_RECONNECT_JITTER_TLS - Static variable in class io.nats.client.Options
Property used to configure a builder from a Properties object.
PROP_RECONNECT_WAIT - Static variable in class io.nats.client.Options
Property used to configure a builder from a Properties object.
PROP_REPORT_NO_RESPONDERS - Static variable in class io.nats.client.Options
Property used to configure a builder from a Properties object.
PROP_SCHEDULED_EXECUTOR_SERVICE_CLASS - Static variable in class io.nats.client.Options
Property used to set class name for the Executor Service (executor) class executor.
PROP_SECURE - Static variable in class io.nats.client.Options
Property used to configure a builder from a Properties object.
PROP_SERVERS - Static variable in class io.nats.client.Options
Property used to configure a builder from a Properties object.
PROP_SERVERS_POOL_IMPLEMENTATION_CLASS - Static variable in class io.nats.client.Options
Property used to set class name for ServerPool implementation serverPool.
PROP_SERVERS_POOL_IMPLEMENTATION_CLASS_PREFERRED - Static variable in class io.nats.client.Options
Preferred property used to set class name for ServerPool implementation serverPool.
PROP_SOCKET_READ_TIMEOUT_MS - Static variable in class io.nats.client.Options
Property used to configure a builder from a Properties object.
PROP_SOCKET_RECEIVE_BUFFER_SIZE - Static variable in class io.nats.client.Options
Property used to configure a builder from a Properties object.
PROP_SOCKET_SEND_BUFFER_SIZE - Static variable in class io.nats.client.Options
Property used to configure a builder from a Properties object.
PROP_SOCKET_SO_LINGER - Static variable in class io.nats.client.Options
Property used to configure a builder from a Properties object.
PROP_SOCKET_WRITE_TIMEOUT - Static variable in class io.nats.client.Options
Property used to configure a builder from a Properties object.
PROP_SSL_CONTEXT_FACTORY_CLASS - Static variable in class io.nats.client.Options
Property used to set class name for the SSLContextFactory sslContextFactory.
PROP_STATISTICS_COLLECTOR - Static variable in class io.nats.client.Options
Property used to configure a builder from a Properties object.
PROP_STREAM_NAME - Static variable in class io.nats.client.PublishOptions
Property used to configure a builder from a Properties object.
PROP_TIME_TRACE_LOGGER - Static variable in class io.nats.client.Options
Property used to configure a builder from a Properties object.
PROP_TLS_ALGORITHM - Static variable in class io.nats.client.Options
Property for the algorithm used to create an SSLContext
PROP_TLS_FIRST - Static variable in class io.nats.client.Options
Property used to configure tls first behavior This property is a boolean flag, telling connections whether to do TLS upgrade first, before INFO
PROP_TOKEN - Static variable in class io.nats.client.Options
Property used to configure a builder from a Properties object.
PROP_TOKEN_SUPPLIER - Static variable in class io.nats.client.Options
Property used to configure the token supplier from a Properties object.
PROP_TRUSTSTORE - Static variable in class io.nats.client.Options
Property for the truststore path used to create an SSLContext
PROP_TRUSTSTORE_PASSWORD - Static variable in class io.nats.client.Options
Property for the truststore password used to create an SSLContext
PROP_URL - Static variable in class io.nats.client.Options
Property used to configure a builder from a Properties object.
PROP_USE_DISPATCHER_WITH_EXECUTOR - Static variable in class io.nats.client.Options
Property used to a dispatcher that dispatches messages via the executor service instead of with a blocking call.
PROP_USE_OLD_REQUEST_STYLE - Static variable in class io.nats.client.Options
Property used to configure a builder from a Properties object.
PROP_USE_TIMEOUT_EXCEPTION - Static variable in class io.nats.client.Options
Property used to throw TimeoutException on timeout instead of CancellationException.
PROP_USERNAME - Static variable in class io.nats.client.Options
Property used to configure a builder from a Properties object.
PROP_UTF8_SUBJECTS - Static variable in class io.nats.client.Options
This property is used to enable support for UTF8 subjects.
PROP_VERBOSE - Static variable in class io.nats.client.Options
Property used to configure a builder from a Properties object.
properties(Properties) - Method in class io.nats.client.Options.Builder
Add settings defined in the properties object
protocol(String, String) - Method in interface io.nats.client.ReadListener
Called when the message is specifically a protocol message
proxy(Proxy) - Method in class io.nats.client.Options.Builder
Define a proxy to use when connecting.
publish(String, byte[]) - Method in interface io.nats.client.Connection
Send a message to the specified subject.
publish(String, Headers, byte[]) - Method in interface io.nats.client.Connection
Send a message to the specified subject.
publish(String, String, byte[]) - Method in interface io.nats.client.Connection
Send a request to the specified subject, providing a replyTo subject.
publish(String, String, Headers, byte[]) - Method in interface io.nats.client.Connection
Send a request to the specified subject, providing a replyTo subject.
publish(Message) - Method in interface io.nats.client.Connection
Send a message to the specified subject.
publish(String, byte[]) - Method in interface io.nats.client.JetStream
Send a message to the specified subject and waits for a response from Jetstream.
publish(String, Headers, byte[]) - Method in interface io.nats.client.JetStream
Send a message to the specified subject and waits for a response from Jetstream.
publish(String, byte[], PublishOptions) - Method in interface io.nats.client.JetStream
Send a message to the specified subject and waits for a response from Jetstream.
publish(String, Headers, byte[], PublishOptions) - Method in interface io.nats.client.JetStream
Send a message to the specified subject and waits for a response from Jetstream.
publish(Message) - Method in interface io.nats.client.JetStream
Send a message to the specified subject and waits for a response from Jetstream.
publish(Message, PublishOptions) - Method in interface io.nats.client.JetStream
Send a message to the specified subject and waits for a response from Jetstream.
PublishAck - Class in io.nats.client.api
PublishAck objects represent a JetStream enabled server acknowledgment from a publish call.
PublishAck(Message) - Constructor for class io.nats.client.api.PublishAck
This signature is public for testing purposes and is not intended to be used externally
publishAsync(String, byte[]) - Method in interface io.nats.client.JetStream
Send a message to the specified subject but does not wait for a response from Jetstream.
publishAsync(String, Headers, byte[]) - Method in interface io.nats.client.JetStream
Send a message to the specified subject but does not wait for a response from Jetstream.
publishAsync(String, byte[], PublishOptions) - Method in interface io.nats.client.JetStream
Send a message to the specified subject but does not wait for a response from Jetstream.
publishAsync(String, Headers, byte[], PublishOptions) - Method in interface io.nats.client.JetStream
Send a message to the specified subject but does not wait for a response from Jetstream.
publishAsync(Message) - Method in interface io.nats.client.JetStream
Send a message to the specified subject but does not wait for a response from Jetstream.
publishAsync(Message, PublishOptions) - Method in interface io.nats.client.JetStream
Send a message to the specified subject but does not wait for a response from Jetstream.
publishNoAck(boolean) - Method in class io.nats.client.JetStreamOptions.Builder
Sets whether the streams in use by contexts created with these options are no-ack streams.
PublishOptions - Class in io.nats.client
The PublishOptions class specifies the options for publishing with JetStream enabled servers.
PublishOptions.Builder - Class in io.nats.client
PublishOptions are created using a Builder.
pull(int) - Method in interface io.nats.client.JetStreamSubscription
Initiate pull with the specified batch size.
pull(PullRequestOptions) - Method in interface io.nats.client.JetStreamSubscription
Initiate pull with the specified request options ! Pull subscriptions only.
pullExpiresIn(int, Duration) - Method in interface io.nats.client.JetStreamSubscription
Initiate pull for all messages available before expiration.
pullExpiresIn(int, long) - Method in interface io.nats.client.JetStreamSubscription
Initiate pull for all messages available before expiration.
pullNoWait(int) - Method in interface io.nats.client.JetStreamSubscription
Initiate pull in noWait mode with the specified batch size.
pullNoWait(int, Duration) - Method in interface io.nats.client.JetStreamSubscription
Initiate pull in noWait mode with the specified batch size.
pullNoWait(int, long) - Method in interface io.nats.client.JetStreamSubscription
Initiate pull in noWait mode with the specified batch size.
PullRequestOptions - Class in io.nats.client
The PullRequestOptions class specifies the options for pull requests
PullRequestOptions(PullRequestOptions.Builder) - Constructor for class io.nats.client.PullRequestOptions
Construct PullRequestOptions from the builder
PullRequestOptions.Builder - Class in io.nats.client
The builder for PullRequestOptions
pullStatusError(Connection, JetStreamSubscription, Status) - Method in interface io.nats.client.ErrorListener
Called when a pull subscription receives a status message that indicates either the subscription cannot continue or the pull request cannot be processed.
pullStatusWarning(Connection, JetStreamSubscription, Status) - Method in interface io.nats.client.ErrorListener
Called when a pull subscription receives a status message that indicates either the subscription or pull might be problematic
PullSubscribeOptions - Class in io.nats.client
The PullSubscribeOptions class specifies the options for subscribing with JetStream enabled servers.
PullSubscribeOptions.Builder - Class in io.nats.client
PullSubscribeOptions can be created using a Builder.
purge(String) - Method in interface io.nats.client.KeyValue
Purge all values/history from the specific key
purge(String, long) - Method in interface io.nats.client.KeyValue
Purge all values/history from the specific key iff the key exists and its last revision matches the expected
purge(String, MessageTtl) - Method in interface io.nats.client.KeyValue
Purge all values/history from the specific key
purge(String, long, MessageTtl) - Method in interface io.nats.client.KeyValue
Purge all values/history from the specific key iff the key exists and its last revision matches the expected
purge() - Method in interface io.nats.client.StreamContext
Purge stream messages
purge(PurgeOptions) - Method in interface io.nats.client.StreamContext
Purge messages for a specific subject
purgeDeletes() - Method in interface io.nats.client.KeyValue
Remove history from all keys that currently are deleted or purged with using a default KeyValuePurgeOptions
purgeDeletes(KeyValuePurgeOptions) - Method in interface io.nats.client.KeyValue
Remove history from all keys that currently are deleted or purged, considering options.
PurgeOptions - Class in io.nats.client
The PurgeOptions class specifies the options for purging a stream
PurgeOptions.Builder - Class in io.nats.client
Builder class for PurgeOptions
PurgeResponse - Class in io.nats.client.api
The response to a request to Purge a stream
PurgeResponse(Message) - Constructor for class io.nats.client.api.PurgeResponse
Construct an instance of the PurgeResponse with the message
purgeStream(String) - Method in interface io.nats.client.JetStreamManagement
Purge stream messages
purgeStream(String, PurgeOptions) - Method in interface io.nats.client.JetStreamManagement
Purge messages for a specific subject
PushSubscribeOptions - Class in io.nats.client
The PushSubscribeOptions class specifies the options for subscribing with JetStream enabled servers.
PushSubscribeOptions.Builder - Class in io.nats.client
PushSubscribeOptions can be created using a Builder.
put(String, byte[]) - Method in interface io.nats.client.KeyValue
Put a byte[] as the value for a key
put(String, String) - Method in interface io.nats.client.KeyValue
Put a string as the value for a key
put(String, Number) - Method in interface io.nats.client.KeyValue
Put a long as the value for a key
put(ObjectMeta, InputStream) - Method in interface io.nats.client.ObjectStore
Place the contents of the input stream into a new object.
put(String, InputStream) - Method in interface io.nats.client.ObjectStore
Place the contents of the input stream into a new object.
put(String, byte[]) - Method in interface io.nats.client.ObjectStore
Place the bytes into a new object.
put(File) - Method in interface io.nats.client.ObjectStore
Place the contents of the file into a new object using the file name as the object name.

Q

queueGroup(String) - Method in class io.nats.service.Endpoint.Builder
Set the queueGroup for the Endpoint, overriding the system default queue group Setting to null sets the group to the default qgroup, .

R

raiseStatusWarnings() - Method in class io.nats.client.BaseConsumeOptions
Whether to raise status warnings to the error listener
rateLimit(Long) - Method in class io.nats.client.api.ConsumerConfiguration.Builder
Set the rate limit of the ConsumerConfiguration or null to unset / clear.
rateLimit(long) - Method in class io.nats.client.api.ConsumerConfiguration.Builder
Set the rate limit of the ConsumerConfiguration.
rateLimitWasSet() - Method in class io.nats.client.api.ConsumerConfiguration
Gets whether rate limit for this consumer configuration was set or left unset
reader(int, int) - Method in interface io.nats.client.JetStreamSubscription
Prepares a reader.
readListener(ReadListener) - Method in class io.nats.client.Options.Builder
Sets a listener to be notified on incoming protocol/message
ReadListener - Interface in io.nats.client
A listener that allows the user to track messages as soon as they come in off the wire.
receiveBufferSize(int) - Method in class io.nats.client.Options.Builder
Set the value of the socket SO_RCVBUF property in bytes The SO_RCVBUF option is used by the platform's networking code as a hint for the size to set the underlying network I/O buffers.
reconnectBufferSize(long) - Method in class io.nats.client.Options.Builder
Set the maximum number of bytes to buffer in the client when trying to reconnect.
reconnectDelayHandler(ReconnectDelayHandler) - Method in class io.nats.client.Options.Builder
Set the ReconnectDelayHandler for custom reconnect duration
ReconnectDelayHandler - Interface in io.nats.client
Allows the developer to provide the duration of time to before reconnecting a second or more time through the servers list
reconnectJitter(Duration) - Method in class io.nats.client.Options.Builder
Set the jitter time to wait between reconnect attempts to the same server.
reconnectJitterTls(Duration) - Method in class io.nats.client.Options.Builder
Set the jitter time for a tls/secure connection to wait between reconnect attempts to the same server.
reconnectWait(Duration) - Method in class io.nats.client.Options.Builder
Set the time to wait between reconnect attempts to the same server.
registerRead(long) - Method in interface io.nats.client.StatisticsCollector
Registers a Socket read by this connection.
registerWrite(long) - Method in interface io.nats.client.StatisticsCollector
Registers a Socket write by this connection.
removeConnectionListener(ConnectionListener) - Method in interface io.nats.client.Connection
Detach a ConnectionListioner.
replayPolicy(ReplayPolicy) - Method in class io.nats.client.api.ConsumerConfiguration.Builder
Sets the replay policy of the ConsumerConfiguration.
replayPolicy(ReplayPolicy) - Method in class io.nats.client.api.OrderedConsumerConfiguration
Sets the replay policy of the OrderedConsumerConfiguration.
ReplayPolicy - Enum in io.nats.client.api
Represents the replay policy of a consumer.
replayPolicyWasSet() - Method in class io.nats.client.api.ConsumerConfiguration
Gets whether replay policy for this consumer configuration was set or left unset
Replica - Class in io.nats.client.api
Replica Peer Info
replicas(int) - Method in class io.nats.client.api.KeyValueConfiguration.Builder
Sets the number of replicas a message must be stored on in the KeyValueConfiguration.
replicas(int) - Method in class io.nats.client.api.ObjectStoreConfiguration.Builder
Sets the number of replicas a message must be stored on in the ObjectStoreConfiguration.
replicas(int) - Method in class io.nats.client.api.StreamConfiguration.Builder
Sets the number of replicas a message must be stored on in the StreamConfiguration.
reportNoResponders() - Method in class io.nats.client.Options.Builder
set to report no responders
republish(Republish) - Method in class io.nats.client.api.KeyValueConfiguration.Builder
Sets the Republish options
Republish - Class in io.nats.client.api
Republish Configuration
Republish(String, String, boolean) - Constructor for class io.nats.client.api.Republish
Construct a 'republish' object
republish(Republish) - Method in class io.nats.client.api.StreamConfiguration.Builder
Sets the republish config object
Republish.Builder - Class in io.nats.client.api
Placement can be created using a Builder.
request(String, byte[]) - Method in interface io.nats.client.Connection
Send a request.
request(String, Headers, byte[]) - Method in interface io.nats.client.Connection
Send a request.
request(Message) - Method in interface io.nats.client.Connection
Send a request.
request(String, byte[], Duration) - Method in interface io.nats.client.Connection
Send a request and returns the reply or null.
request(String, Headers, byte[], Duration) - Method in interface io.nats.client.Connection
Send a request and returns the reply or null.
request(Message, Duration) - Method in interface io.nats.client.Connection
Send a request and returns the reply or null.
requestCleanupInterval(Duration) - Method in class io.nats.client.Options.Builder
Set the interval between cleaning passes on outstanding request futures that are cancelled or timeout in the application code.
requestTimeout(Duration) - Method in class io.nats.client.JetStreamOptions.Builder
Sets the request timeout for JetStream API calls.
requestWithTimeout(String, byte[], Duration) - Method in interface io.nats.client.Connection
Send a request.
requestWithTimeout(String, Headers, byte[], Duration) - Method in interface io.nats.client.Connection
Send a request.
requestWithTimeout(Message, Duration) - Method in interface io.nats.client.Connection
Send a request.
reset() - Method in class io.nats.service.Service
Reset the statistics for the endpoints
resolveHostToIps(String) - Method in interface io.nats.client.ServerPool
Resolve a host name to an ip address
respond(Connection, byte[]) - Method in class io.nats.service.ServiceMessage
Respond to a service request message.
respond(Connection, String) - Method in class io.nats.service.ServiceMessage
Respond to a service request message.
respond(Connection, JsonSerializable) - Method in class io.nats.service.ServiceMessage
Respond to a service request message.
respond(Connection, byte[], Headers) - Method in class io.nats.service.ServiceMessage
Respond to a service request message with a response and custom headers.
respond(Connection, String, Headers) - Method in class io.nats.service.ServiceMessage
Respond to a service request message with a response and custom headers.
respond(Connection, JsonSerializable, Headers) - Method in class io.nats.service.ServiceMessage
Respond to a service request message.
respondStandardError(Connection, String, int) - Method in class io.nats.service.ServiceMessage
Respond to a service request message with a standard error.
resumeConsumer(String, String) - Method in interface io.nats.client.JetStreamManagement
Resumes a paused consumer.
RetentionPolicy - Enum in io.nats.client.api
Stream retention policies.
retentionPolicy(RetentionPolicy) - Method in class io.nats.client.api.StreamConfiguration.Builder
Sets the retention policy in the StreamConfiguration.
RTT() - Method in interface io.nats.client.Connection
Calculates the round trip time between this client and the server.

S

sampleFrequency(String) - Method in class io.nats.client.api.ConsumerConfiguration.Builder
Sets the sample frequency of the ConsumerConfiguration.
scheduledExecutor(ScheduledExecutorService) - Method in class io.nats.client.Options.Builder
Set the ScheduledExecutorService used to run scheduled task like heartbeat timers The default is a ScheduledThreadPoolExecutor that does not execute delayed tasks after shutdown and removes tasks on cancel;
scheduledExecutorIsInternal() - Method in class io.nats.client.Options
whether the scheduled executor is the internal one versus a user supplied one
schemaDispatcher(Dispatcher) - Method in class io.nats.service.ServiceBuilder
Deprecated.
seal() - Method in class io.nats.client.api.StreamConfiguration.Builder
Set this stream to be sealed.
seal() - Method in interface io.nats.client.ObjectStore
Close (seal) the bucket to changes.
seconds(int) - Static method in class io.nats.client.MessageTtl
Sets the TTL for this specific message to be published
secure() - Method in class io.nats.client.Options.Builder
Sets the options to use the default SSL Context, if it exists.
sendBufferSize(int) - Method in class io.nats.client.Options.Builder
Set the value of the socket SO_SNDBUF property in bytes The SO_SNDBUF option is used by the platform's networking code as a hint for the size to set the underlying network I/O buffers.
sequence(long) - Method in class io.nats.client.PurgeOptions.Builder
Set upper-bound sequence for messages to be deleted
SequenceInfo - Class in io.nats.client.api
This class holds the sequence numbers for a consumer and stream and .
SequencePair - Class in io.nats.client.api
This class holds the sequence numbers for a consumer and stream.
serialize() - Method in class io.nats.service.ServiceResponse
 
server(String) - Method in class io.nats.client.Options.Builder
Add a server to the list of known servers.
ServerInfo - Class in io.nats.client.api
Class holding information about a server
ServerInfo(String) - Constructor for class io.nats.client.api.ServerInfo
Construct a ServerInfo instance from json
serverPool(ServerPool) - Method in class io.nats.client.Options.Builder
Set the ServerPool implementation for connections to use instead of the default implementation
ServerPool - Interface in io.nats.client
Allows the developer to provide the list of servers to try for connecting/reconnecting
servers(String[]) - Method in class io.nats.client.Options.Builder
Add an array of servers to the list of known servers.
Service - Class in io.nats.service
The Services Framework introduces a higher-level API for implementing services with NATS.
ServiceBuilder - Class in io.nats.service
Build a Service using a fluent builder.
ServiceBuilder() - Constructor for class io.nats.service.ServiceBuilder
Construct an instance of the builder
ServiceEndpoint - Class in io.nats.service
The ServiceEndpoint represents the working Endpoint It allows the endpoint to be grouped. It is where you can define the handler that will respond to incoming requests It allows you to define its dispatcher if desired giving granularity to threads running subscribers It gives you a hook to provide custom data for the EndpointStats
ServiceEndpoint.Builder - Class in io.nats.service
Build an ServiceEndpoint using a fluent builder.
ServiceMessage - Class in io.nats.service
Service Message is service specific object that exposes the service relevant parts of a NATS Message.
ServiceMessageHandler - Interface in io.nats.service
Interface used to receive service request message.
ServiceResponse - Class in io.nats.service
Base class for service responses Info, Ping and Stats
setAdvancedTracking(boolean) - Method in interface io.nats.client.StatisticsCollector
Sets whether advanced stats are/should be tracked.
setInboxSupplier(Supplier<String>) - Method in class io.nats.service.Discovery
Override the normal inbox with a custom inbox to support you security model
setOldRequestStyle(boolean) - Method in class io.nats.client.Options
Deprecated.
Use Builder
setPendingLimits(long, long) - Method in interface io.nats.client.Consumer
Set limits on the maximum number of messages, or maximum size of messages this consumer will hold before it starts to drop new messages waiting for the application to drain the queue.
setProvider(NatsSystemClockProvider) - Static method in class io.nats.client.NatsSystemClock
Set the provider.
sign(byte[]) - Method in interface io.nats.client.AuthHandler
Sign is called by the library when the server sends a nonce.
sign(byte[]) - Method in class io.nats.client.NKey
Sign arbitrary binary input.
size(long) - Method in class io.nats.client.api.ObjectInfo.Builder
set the object's size
slowConsumerDetected(Connection, Consumer) - Method in interface io.nats.client.ErrorListener
Called by the connection when a "slow" consumer is detected.
socketReadTimeoutMillis(int) - Method in class io.nats.client.Options.Builder
Set the timeout to use around socket reads
socketSoLinger(int) - Method in class io.nats.client.Options.Builder
Set the value of the socket SO LINGER property in seconds.
socketWriteTimeout(Connection) - Method in interface io.nats.client.ErrorListener
Called by the connection when a low level socket write timeout occurs.
socketWriteTimeout(long) - Method in class io.nats.client.Options.Builder
Set the timeout to use around socket writes
socketWriteTimeout(Duration) - Method in class io.nats.client.Options.Builder
Set the timeout to use around socket writes
source(String) - Method in class io.nats.client.api.Republish.Builder
Set the Published Subject-matching filter
Source - Class in io.nats.client.api
Source Information
source(String) - Method in class io.nats.client.api.SubjectTransform.Builder
Set the Published Subject-matching filter
Source.Builder - Class in io.nats.client.api
The builder for a Source
SourceBase - Class in io.nats.client.api
A base class for sources
SourceBase.SourceBaseBuilder<T> - Class in io.nats.client.api
A builder base for objects that extend SourceBase
SourceBaseBuilder() - Constructor for class io.nats.client.api.SourceBase.SourceBaseBuilder
Construct an instance of the builder
SourceBaseBuilder(SourceBase) - Constructor for class io.nats.client.api.SourceBase.SourceBaseBuilder
Construct an instance of the builder from a copy of another object that extends SourceBase
SourceInfo - Class in io.nats.client.api
Information about a stream being sourced
sourceName(String) - Method in class io.nats.client.api.SourceBase.SourceBaseBuilder
Set the source name
sources(Source...) - Method in class io.nats.client.api.KeyValueConfiguration.Builder
Sets the sources in the KeyValueConfiguration.
sources(Collection<Source>) - Method in class io.nats.client.api.KeyValueConfiguration.Builder
Sets the sources in the KeyValueConfiguration
sources(Source...) - Method in class io.nats.client.api.StreamConfiguration.Builder
Sets the sources in the StreamConfiguration.
sources(Collection<Source>) - Method in class io.nats.client.api.StreamConfiguration.Builder
Add the sources into the StreamConfiguration.
SRV_INFO - Static variable in class io.nats.service.Service
Constant for the INFO service
SRV_PING - Static variable in class io.nats.service.Service
Constant for the PING service
SRV_STATS - Static variable in class io.nats.service.Service
Constant for the STATS service
sslContext(SSLContext) - Method in class io.nats.client.Options.Builder
Set the SSL context, requires that the server supports TLS connections and the URI specifies TLS.
sslContextFactory(SSLContextFactory) - Method in class io.nats.client.Options.Builder
Set the factory that provides the ssl context.
STANDARD_MIN - Static variable in class io.nats.client.api.ConsumerConfiguration
Constant used to as a standard minimum value
start(String) - Method in interface io.nats.client.Dispatcher
Start the dispatcher with a given id.
startSeq(long) - Method in class io.nats.client.api.SourceBase.SourceBaseBuilder
Set the start sequence
startSequence(Long) - Method in class io.nats.client.api.ConsumerConfiguration.Builder
Sets the start sequence of the ConsumerConfiguration or null to unset / clear.
startSequence(long) - Method in class io.nats.client.api.ConsumerConfiguration.Builder
Sets the start sequence of the ConsumerConfiguration.
startSequence(long) - Method in class io.nats.client.api.OrderedConsumerConfiguration
Sets the start sequence of the OrderedConsumerConfiguration.
startSeqWasSet() - Method in class io.nats.client.api.ConsumerConfiguration
Gets whether start sequence for this consumer configuration was set or left unset
startService() - Method in class io.nats.service.Service
Start the service
startTime(ZonedDateTime) - Method in class io.nats.client.api.ConsumerConfiguration.Builder
Sets the start time of the ConsumerConfiguration.
startTime(ZonedDateTime) - Method in class io.nats.client.api.OrderedConsumerConfiguration
Sets the start time of the OrderedConsumerConfiguration.
startTime(ZonedDateTime) - Method in class io.nats.client.api.SourceBase.SourceBaseBuilder
Set the start time
staticCredentials(byte[]) - Static method in class io.nats.client.Nats
Create an auth handler from the data found in a credsFile.
staticCredentials(char[], char[]) - Static method in class io.nats.client.Nats
Create an auth handler from an nkey and an option JWT.
Statistics - Interface in io.nats.client
Connections can provide an instance of Statistics, getStatistics().
statisticsCollector(StatisticsCollector) - Method in class io.nats.client.Options.Builder
Set the StatisticsCollector to collect connection metrics.
StatisticsCollector - Interface in io.nats.client
A collector for connection metrics.
stats() - Method in class io.nats.service.Discovery
Make a stats request to all services running on the server.
stats(String) - Method in class io.nats.service.Discovery
Make a stats request only to services having the matching service name
stats(String, String) - Method in class io.nats.service.Discovery
Make a stats request to a specific instance of a service having matching service name and id
statsDataSupplier(Supplier<JsonValue>) - Method in class io.nats.service.ServiceEndpoint.Builder
Set the EndpointStats data supplier for this ServiceEndpoint
statsDispatcher(Dispatcher) - Method in class io.nats.service.ServiceBuilder
Optional dispatcher for the stats service
StatsResponse - Class in io.nats.service
Stats response class forms the stats json payload, for example: { "id": "ZP1oVevzLGu4CBORMXKKke", "name": "Service1", "version": "0.0.1", "endpoints": [{ "name": "SortEndpointAscending", "subject": "sort.ascending", "num_requests": 1, "processing_time": 538900, "average_processing_time": 538900, "started": "2023-08-15T13:51:41.318000000Z" }, { "name": "SortEndpointDescending", "subject": "sort.descending", "num_requests": 1, "processing_time": 88400, "average_processing_time": 88400, "started": "2023-08-15T13:51:41.318000000Z" }, { "name": "EchoEndpoint", "subject": "echo", "num_requests": 5, "processing_time": 1931600, "average_processing_time": 386320, "data": { "idata": 2, "sdata": "s-996409223" }, "started": "2023-08-15T13:51:41.318000000Z" }], "started": "2023-08-15T13:51:41.319000000Z", "type": "io.nats.micro.v1.stats_response" }
stop() - Method in interface io.nats.client.BaseMessageConsumer
Stop the MessageConsumer from asking for any more messages from the server.
stop() - Method in interface io.nats.client.JetStreamReader
Stop getting more messages from the server.
stop() - Method in interface io.nats.client.MessageConsumer
Use MessageConsumer.close() to unsubscribe.
stop() - Method in class io.nats.service.Service
Stop the service by draining.
stop(Throwable) - Method in class io.nats.service.Service
Stop the service by draining.
stop(boolean) - Method in class io.nats.service.Service
Stop the service, optionally draining.
stop(boolean, Throwable) - Method in class io.nats.service.Service
Stop the service, optionally draining and optionally with an error cause
storageType(StorageType) - Method in class io.nats.client.api.KeyValueConfiguration.Builder
Sets the storage type in the KeyValueConfiguration.
storageType(StorageType) - Method in class io.nats.client.api.ObjectStoreConfiguration.Builder
Sets the storage type in the ObjectStoreConfiguration.
StorageType - Enum in io.nats.client.api
Stream storage types.
storageType(StorageType) - Method in class io.nats.client.api.StreamConfiguration.Builder
Sets the storage type in the StreamConfiguration.
stream(String) - Method in class io.nats.client.PublishOptions.Builder
Deprecated.
Not a very useful function Sets the stream name to expect the pub ack to have. This really should never be an issue and it does not prevent the message from being published, it's an exception after the fact
stream(String) - Static method in class io.nats.client.PushSubscribeOptions
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.
StreamAlternate - Class in io.nats.client.api
The Stream Alternate
StreamConfiguration - Class in io.nats.client.api
The StreamConfiguration class specifies the configuration for creating a JetStream stream on the server.
StreamConfiguration.Builder - Class in io.nats.client.api
StreamConfiguration is created using a Builder.
StreamContext - Interface in io.nats.client
The Stream Context provide a set of operations for managing the stream and its contents and for managing consumers.
StreamInfo - Class in io.nats.client.api
The StreamInfo class contains information about a JetStream stream.
StreamInfo(Message) - Constructor for class io.nats.client.api.StreamInfo
Construct a StreamInfo instance from a message
StreamInfo(JsonValue) - Constructor for class io.nats.client.api.StreamInfo
Construct a StreamInfo instance from a JsonValue
StreamInfoOptions - Class in io.nats.client.api
Object used to make a request for special stream info requests
StreamInfoOptions.Builder - Class in io.nats.client.api
StreamInfoOptions is created using a Builder.
StreamState - Class in io.nats.client.api
Object representing the state of a stream
streamTimeout(Duration) - Method in class io.nats.client.PublishOptions.Builder
Sets the timeout to wait for a publish acknowledgement from a JetStream enabled NATS server.
Subject - Class in io.nats.client.api
An object representing a stream's subject and the count of it's messages
Subject(String, long) - Constructor for class io.nats.client.api.Subject
Construct a Subject instance
subject(String) - Method in class io.nats.client.PurgeOptions.Builder
Set the subject to filter the purge.
subject(String) - Static method in class io.nats.client.PurgeOptions
Creates a completed Purge Options for just a subject
subject(String) - Method in class io.nats.service.Endpoint.Builder
Set the subject for the Endpoint, replacing any subject already set.
subjectDeleteMarkerTtl(Duration) - Method in class io.nats.client.api.StreamConfiguration.Builder
Set the subject delete marker TTL duration.
subjectDeleteMarkerTtl(long) - Method in class io.nats.client.api.StreamConfiguration.Builder
Set the subject delete marker TTL duration in milliseconds.
subjects(String...) - Method in class io.nats.client.api.StreamConfiguration.Builder
Sets the subjects in the StreamConfiguration.
subjects(Collection<String>) - Method in class io.nats.client.api.StreamConfiguration.Builder
Sets the subjects in the StreamConfiguration.
subjectTransform(SubjectTransform) - Method in class io.nats.client.api.StreamConfiguration.Builder
Sets the subjectTransform config object
SubjectTransform - Class in io.nats.client.api
SubjectTransform
SubjectTransform(String, String) - Constructor for class io.nats.client.api.SubjectTransform
Construct a 'SubjectTransform' object
SubjectTransform.Builder - Class in io.nats.client.api
Placement can be created using a Builder.
subjectTransforms(SubjectTransform...) - Method in class io.nats.client.api.SourceBase.SourceBaseBuilder
Set subjectTransforms
subjectTransforms(List<SubjectTransform>) - Method in class io.nats.client.api.SourceBase.SourceBaseBuilder
Set subjectTransforms
subscribe(String) - Method in interface io.nats.client.Connection
Create a synchronous subscription to the specified subject.
subscribe(String, String) - Method in interface io.nats.client.Connection
Create a synchronous subscription to the specified subject and queue.
subscribe(String) - Method in interface io.nats.client.Dispatcher
Create a subscription to the specified subject under the control of this dispatcher.
subscribe(String, String) - Method in interface io.nats.client.Dispatcher
Create a subscription to the specified subject and queue under the control of this dispatcher.
subscribe(String, MessageHandler) - Method in interface io.nats.client.Dispatcher
Create a subscription to the specified subject under the control of this dispatcher.
subscribe(String, String, MessageHandler) - Method in interface io.nats.client.Dispatcher
Create a subscription to the specified subject under the control of this dispatcher.
subscribe(String) - Method in interface io.nats.client.JetStream
Create a synchronous subscription to the specified subject with default options.
subscribe(String, PushSubscribeOptions) - Method in interface io.nats.client.JetStream
Create a synchronous subscription to the specified subject.
subscribe(String, String, PushSubscribeOptions) - Method in interface io.nats.client.JetStream
Create a synchronous subscription to the specified subject.
subscribe(String, Dispatcher, MessageHandler, boolean) - Method in interface io.nats.client.JetStream
Create an asynchronous subscription to the specified subject under the control of the specified dispatcher.
subscribe(String, Dispatcher, MessageHandler, boolean, PushSubscribeOptions) - Method in interface io.nats.client.JetStream
Create an asynchronous subscription to the specified subject under the control of the specified dispatcher.
subscribe(String, String, Dispatcher, MessageHandler, boolean, PushSubscribeOptions) - Method in interface io.nats.client.JetStream
Create an asynchronous subscription to the specified subject under the control of the specified dispatcher.
subscribe(String, PullSubscribeOptions) - Method in interface io.nats.client.JetStream
Create a subscription to the specified subject in the mode of pull, with additional options
subscribe(String, Dispatcher, MessageHandler, PullSubscribeOptions) - Method in interface io.nats.client.JetStream
Create an asynchronous subscription to the specified subject in the mode of pull, with additional options.
SubscribeOptions - Class in io.nats.client
The SubscribeOptions is the base class for PushSubscribeOptions and PullSubscribeOptions
Subscription - Interface in io.nats.client
A Subscription encapsulates an incoming queue of messages associated with a single subject and optional queue name.
SuccessApiResponse - Class in io.nats.client.api
A response indicating a successful api call
SuccessApiResponse(Message) - Constructor for class io.nats.client.api.SuccessApiResponse
Construct a SuccessApiResponse from a message
supplyMessage(String, Connection, Consumer, Subscription, Object...) - Method in interface io.nats.client.ErrorListener
General message producing function which understands the possible parameters to listener calls.
supportUTF8Subjects() - Method in class io.nats.client.Options.Builder
The client protocol is not clear about the encoding for subject names.
supportUTF8Subjects() - Method in class io.nats.client.Options
whether utf8 subjects are supported, see supportUTF8Subjects() in the builder doc.

T

tags(String...) - Method in class io.nats.client.api.Placement.Builder
Set the tags
tags(List<String>) - Method in class io.nats.client.api.Placement.Builder
Set the tags
templateOwner(String) - Method in class io.nats.client.api.StreamConfiguration.Builder
Sets the template a stream in the form of raw JSON.
term() - Method in interface io.nats.client.Message
term instructs the server to stop redelivery of this message without acknowledging it as successfully processed.
throwOnHasError() - Method in class io.nats.client.api.ApiResponse
throw an Exception if the response had an error
timeTraceLogger(TimeTraceLogger) - Method in class io.nats.client.Options.Builder
Set the TimeTraceLogger to receive trace events related to this connection.
TimeTraceLogger - Interface in io.nats.client
Interface to allow debug logging of some connection time tracing
tlsAlgorithm(String) - Method in class io.nats.client.Options.Builder
The tls algorithm to use Default is
tlsFirst() - Method in class io.nats.client.Options.Builder
Set TLS Handshake First behavior on.
toJson() - Method in class io.nats.client.api.ConsumerConfiguration
Returns a JSON representation of this consumer configuration.
toJson() - Method in class io.nats.client.api.ConsumerLimits
 
toJson() - Method in class io.nats.client.api.ConsumerPauseRequest
 
toJson() - Method in class io.nats.client.api.Error
 
toJson() - Method in class io.nats.client.api.External
Returns a JSON representation of this mirror
toJson() - Method in class io.nats.client.api.FeatureConfiguration
 
toJson() - Method in class io.nats.client.api.ObjectInfo
 
toJson() - Method in class io.nats.client.api.ObjectLink
 
toJson() - Method in class io.nats.client.api.ObjectMeta
 
toJson() - Method in class io.nats.client.api.ObjectMetaOptions
 
toJson() - Method in class io.nats.client.api.OrderedConsumerConfiguration
Returns a JSON representation of this ordered consumer configuration.
toJson() - Method in class io.nats.client.api.Placement
 
toJson() - Method in class io.nats.client.api.Republish
 
toJson() - Method in class io.nats.client.api.SourceBase
Returns a JSON representation of this mirror
toJson() - Method in class io.nats.client.api.StreamConfiguration
Returns a JSON representation of this consumer configuration.
toJson() - Method in class io.nats.client.api.StreamInfoOptions
 
toJson() - Method in class io.nats.client.api.SubjectTransform
 
toJson() - Method in class io.nats.client.BaseConsumeOptions
 
toJson() - Method in class io.nats.client.PullRequestOptions
 
toJson() - Method in class io.nats.client.PurgeOptions
 
toJson() - Method in class io.nats.service.Endpoint
 
toJson() - Method in class io.nats.service.EndpointStats
 
toJson() - Method in class io.nats.service.ServiceResponse
 
toJsonValue() - Method in class io.nats.client.api.Error
 
toJsonValue() - Method in class io.nats.client.api.FeatureConfiguration
 
toJsonValue() - Method in class io.nats.client.api.KeyValueConfiguration
 
token(String) - Method in class io.nats.client.Options.Builder
Deprecated.
use the char[] version instead for better security
token(char[]) - Method in class io.nats.client.Options.Builder
Set the token for token-based authentication.
tokenSupplier(Supplier<char[]>) - Method in class io.nats.client.Options.Builder
Set the token supplier for token-based authentication.
toString() - Method in enum io.nats.client.api.AckPolicy
 
toString() - Method in class io.nats.client.api.ApiResponse
 
toString() - Method in class io.nats.client.api.ClusterInfo
 
toString() - Method in enum io.nats.client.api.CompressionOption
 
toString() - Method in class io.nats.client.api.ConsumerConfiguration
 
toString() - Method in enum io.nats.client.api.DeliverPolicy
 
toString() - Method in enum io.nats.client.api.DiscardPolicy
 
toString() - Method in class io.nats.client.api.Error
 
toString() - Method in class io.nats.client.api.External
 
toString() - Method in class io.nats.client.api.KeyValueConfiguration
 
toString() - Method in class io.nats.client.api.KeyValueEntry
 
toString() - Method in class io.nats.client.api.KeyValueStatus
 
toString() - Method in class io.nats.client.api.LostStreamData
 
toString() - Method in class io.nats.client.api.MessageInfo
 
toString() - Method in class io.nats.client.api.MirrorInfo
 
toString() - Method in class io.nats.client.api.ObjectInfo
 
toString() - Method in class io.nats.client.api.ObjectLink
 
toString() - Method in class io.nats.client.api.ObjectMeta
 
toString() - Method in class io.nats.client.api.ObjectMetaOptions
 
toString() - Method in class io.nats.client.api.ObjectStoreConfiguration
 
toString() - Method in class io.nats.client.api.ObjectStoreStatus
 
toString() - Method in enum io.nats.client.api.PersistMode
 
toString() - Method in class io.nats.client.api.Placement
 
toString() - Method in class io.nats.client.api.PriorityGroupState
 
toString() - Method in enum io.nats.client.api.PriorityPolicy
 
toString() - Method in enum io.nats.client.api.ReplayPolicy
 
toString() - Method in class io.nats.client.api.Replica
 
toString() - Method in enum io.nats.client.api.RetentionPolicy
 
toString() - Method in class io.nats.client.api.SequenceInfo
 
toString() - Method in class io.nats.client.api.ServerInfo
 
toString() - Method in class io.nats.client.api.SourceBase
 
toString() - Method in class io.nats.client.api.SourceInfo
 
toString() - Method in enum io.nats.client.api.StorageType
 
toString() - Method in class io.nats.client.api.StreamConfiguration
 
toString() - Method in class io.nats.client.api.StreamInfo
 
toString() - Method in class io.nats.client.api.StreamState
 
toString() - Method in class io.nats.client.api.Subject
 
toString() - Method in class io.nats.client.api.SubjectTransform
 
toString() - Method in enum io.nats.client.ConnectionListener.Events
 
toString() - Method in class io.nats.client.MessageTtl
 
toString() - Method in class io.nats.client.PublishOptions
 
toString() - Method in class io.nats.client.SubscribeOptions
 
toString() - Method in class io.nats.service.Endpoint
 
toString() - Method in class io.nats.service.EndpointStats
 
toString() - Method in class io.nats.service.Group
 
toString() - Method in class io.nats.service.Service
 
toString() - Method in class io.nats.service.ServiceResponse
 
trace(String, Object...) - Method in interface io.nats.client.TimeTraceLogger
Trace the object
traceConnection() - Method in class io.nats.client.Options.Builder
Enable connection trace messages.
truststorePassword(char[]) - Method in class io.nats.client.Options.Builder
The password for the trust store
truststorePath(String) - Method in class io.nats.client.Options.Builder
the path to the trust store file
ttl(Duration) - Method in class io.nats.client.api.KeyValueConfiguration.Builder
Sets the maximum age for a value in this KeyValueConfiguration.
ttl(Duration) - Method in class io.nats.client.api.ObjectStoreConfiguration.Builder
Sets the maximum age for a value in this ObjectStoreConfiguration.
turnOnAdvancedStats() - Method in class io.nats.client.Options.Builder
Turn on advanced stats, primarily for test/benchmarks.
TYPE - Static variable in class io.nats.service.InfoResponse
The API response type for InfoResponse
TYPE - Static variable in class io.nats.service.PingResponse
The API response type for PingResponse
TYPE - Static variable in class io.nats.service.StatsResponse
The API response type for StatsResponse

U

ULONG_UNSET - Static variable in class io.nats.client.api.ConsumerConfiguration
Constant used to unset a long that represents an unsigned long setting in the builder
unhandledStatus(Connection, JetStreamSubscription, Status) - Method in interface io.nats.client.ErrorListener
Called when an unhandled status is received in a push subscription.
unpin(String) - Method in interface io.nats.client.BaseConsumerContext
Unpins this consumer
unpinConsumer(String, String, String) - Method in interface io.nats.client.JetStreamManagement
Unpins a consumer
UNSET_LAST_SEQUENCE - Static variable in class io.nats.client.PublishOptions
Use this variable to unset a sequence number in publish options.
UNSET_STREAM - Static variable in class io.nats.client.PublishOptions
Deprecated.
Just use null to unset Use this variable to unset a stream in publish options.
unsubscribe(String) - Method in interface io.nats.client.Dispatcher
Unsubscribe from the specified subject, the queue is implicit.
unsubscribe(Subscription) - Method in interface io.nats.client.Dispatcher
Unsubscribe from the specified Subscription.
unsubscribe(String, int) - Method in interface io.nats.client.Dispatcher
Unsubscribe from the specified subject, the queue is implicit, after the specified number of messages.
unsubscribe(Subscription, int) - Method in interface io.nats.client.Dispatcher
Unsubscribe from the specified subject, the queue is implicit, after the specified number of messages.
unsubscribe() - Method in interface io.nats.client.Subscription
Unsubscribe this subscription and stop listening for messages.
unsubscribe(int) - Method in interface io.nats.client.Subscription
Unsubscribe this subscription and stop listening for messages, after the specified number of messages.
update(String, byte[], long) - Method in interface io.nats.client.KeyValue
Put as the value for a key iff the key exists and its last revision matches the expected
update(String, String, long) - Method in interface io.nats.client.KeyValue
Put a string as the value for a key iff the key exists and its last revision matches the expected
update(KeyValueConfiguration) - Method in interface io.nats.client.KeyValueManagement
Update a key value store configuration.
updateConsumer(String, ConsumerConfiguration) - Method in interface io.nats.client.JetStreamManagement
Updates an existing consumer.
updateMeta(String, ObjectMeta) - Method in interface io.nats.client.ObjectStore
Update the metadata of name, description or headers.
updateStream(StreamConfiguration) - Method in interface io.nats.client.JetStreamManagement
Updates an existing stream.
useDispatcherWithExecutor() - Method in class io.nats.client.Options.Builder
Instruct dispatchers to dispatch all messages as a task, instead of directly from dispatcher thread
useDispatcherWithExecutor() - Method in class io.nats.client.Options
Whether the dispatcher should use an executor to async messages to handlers
userInfo(String, String) - Method in class io.nats.client.Options.Builder
Set the username and password for basic authentication.
userInfo(char[], char[]) - Method in class io.nats.client.Options.Builder
Set the username and password for basic authentication.
useTimeoutException() - Method in class io.nats.client.Options.Builder
Throw TimeoutException on timeout instead of CancellationException?
useTimeoutException() - Method in class io.nats.client.Options
Get whether to throw TimeoutException on timeout instead of CancellationException.

V

valueOf(String) - Static method in enum io.nats.client.api.AckPolicy
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.nats.client.api.CompressionOption
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.nats.client.api.DeliverPolicy
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.nats.client.api.DiscardPolicy
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.nats.client.api.KeyValueOperation
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.nats.client.api.KeyValueWatchOption
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.nats.client.api.ObjectStoreWatchOption
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.nats.client.api.PersistMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.nats.client.api.PriorityPolicy
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.nats.client.api.ReplayPolicy
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.nats.client.api.RetentionPolicy
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.nats.client.api.StorageType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.nats.client.Connection.Status
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.nats.client.ConnectionListener.Events
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.nats.client.ErrorListener.FlowControlSource
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.nats.client.NKey.Type
Returns the enum constant of this type with the specified name.
values() - Static method in enum io.nats.client.api.AckPolicy
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.nats.client.api.CompressionOption
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.nats.client.api.DeliverPolicy
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.nats.client.api.DiscardPolicy
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.nats.client.api.KeyValueOperation
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.nats.client.api.KeyValueWatchOption
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.nats.client.api.ObjectStoreWatchOption
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.nats.client.api.PersistMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.nats.client.api.PriorityPolicy
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.nats.client.api.ReplayPolicy
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.nats.client.api.RetentionPolicy
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.nats.client.api.StorageType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.nats.client.Connection.Status
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.nats.client.ConnectionListener.Events
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.nats.client.ErrorListener.FlowControlSource
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.nats.client.NKey.Type
Returns an array containing the constants of this enum type, in the order they are declared.
verbose() - Method in class io.nats.client.Options.Builder
Turn on verbose mode with the server.
verify(byte[], byte[]) - Method in class io.nats.client.NKey
Verify a signature.
version(String) - Method in class io.nats.service.ServiceBuilder
The simple version of the service.

W

watch(T) - Method in interface io.nats.client.api.Watcher
Called when an object has been updated.
watch(String, KeyValueWatcher, KeyValueWatchOption...) - Method in interface io.nats.client.KeyValue
Watch updates for a specific key.
watch(String, KeyValueWatcher, long, KeyValueWatchOption...) - Method in interface io.nats.client.KeyValue
Watch updates for a specific key, starting at a specific revision.
watch(List<String>, KeyValueWatcher, KeyValueWatchOption...) - Method in interface io.nats.client.KeyValue
Watch updates for specific keys.
watch(List<String>, KeyValueWatcher, long, KeyValueWatchOption...) - Method in interface io.nats.client.KeyValue
Watch updates for specific keys, starting at a specific revision.
watch(ObjectStoreWatcher, ObjectStoreWatchOption...) - Method in interface io.nats.client.ObjectStore
Create a watch on the store (bucket).
watchAll(KeyValueWatcher, KeyValueWatchOption...) - Method in interface io.nats.client.KeyValue
Watch updates for all keys.
watchAll(KeyValueWatcher, long, KeyValueWatchOption...) - Method in interface io.nats.client.KeyValue
Watch updates for all keys starting from a specific revision
Watcher<T> - Interface in io.nats.client.api
Use the Watcher interface to watch for updates
A B C D E F G H I J K L M N O P Q R S T U V W 
Skip navigation links