- 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
-
- 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
-
- 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.
- 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
-
- 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
-
- 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
-
- 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
-
- 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
-
- getConnectionName() - Method in class io.nats.client.Options
-
- getConnectionTimeout() - Method in class io.nats.client.Options
-
- 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
-
- getEndpointStatsList() - Method in class io.nats.service.StatsResponse
-
- 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
-
- 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
-
- 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
-
- 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
-
- 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
-
- getMaxValueSize() - Method in class io.nats.client.api.KeyValueStatus
-
- 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
-
- 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
-
- 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
-
- 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
-
- getPendingByteLimit() - Method in class io.nats.client.SubscribeOptions
-
Gets the pending byte limit.
- getPendingMessageCount() - Method in interface io.nats.client.Consumer
-
- getPendingMessageLimit() - Method in interface io.nats.client.Consumer
-
- 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
-
- 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
-
- 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
-
- 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
-
- 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
-
- 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
-
- getSocketSoLinger() - Method in class io.nats.client.Options
-
- getSocketWriteTimeout() - Method in class io.nats.client.Options
-
- 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
-
- 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
-
- 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
-
- 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
-
- 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
-
- 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
-
- 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
- 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
-
- incrementInMsgs() - Method in interface io.nats.client.StatisticsCollector
-
- 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
-
- incrementOutMsgs() - Method in interface io.nats.client.StatisticsCollector
-
- 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
-
- 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
-
- 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
-
- 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
-
- 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
-
- isUtf8mode() - Method in interface io.nats.client.Message
-
- 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.
- 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
-
- 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
-
- 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
-
- 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
-
- 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.
- 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
-
- 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
-
- 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
-
- statisticsCollector(StatisticsCollector) - Method in class io.nats.client.Options.Builder
-
- 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
-
- 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
-
- 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
-
- 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
-