io.nats.client

Interface KeyValueManagement

public interface KeyValueManagement

Key Value Store Management context for creation and access to key value buckets.

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	bucketsNames() Get the list of bucket names THIS IS A BETA FEATURE AND SUBJECT TO CHANGE
BucketInfo	createBucket(BucketConfiguration config) Create a bucket.
boolean	deleteBucket(java.lang.String bucketName) Deletes an existing bucket.
BucketInfo	getBucketInfo(java.lang.String bucketName) Gets the info for an existing bucket.
java.util.List<KvEntry>	getHistory(java.lang.String bucketName, java.lang.String key) Get the history (list of KvEntry) for a key THIS IS A BETA FEATURE AND SUBJECT TO CHANGE
java.util.Set<java.lang.String>	keys(java.lang.String bucketName) Get the set of the keys in a bucket.
PurgeResponse	purgeBucket(java.lang.String bucketName) Purge all keys/values/history from the bucket.
PurgeResponse	purgeKey(java.lang.String bucketName, java.lang.String key) Purge all values/history from the specific key THIS IS A BETA FEATURE AND SUBJECT TO CHANGE

Method Detail

createBucket

BucketInfo createBucket(BucketConfiguration config)
                 throws java.io.IOException,
                        JetStreamApiException

Create a bucket. THIS IS A BETA FEATURE AND SUBJECT TO CHANGE

Parameters:

config - the bucket configuration

Returns:

bucket info

Throws:

java.io.IOException - covers various communication issues with the NATS server such as timeout or interruption

JetStreamApiException - the request had an error related to the data

java.lang.IllegalArgumentException - the server is not JetStream enabled

deleteBucket

boolean deleteBucket(java.lang.String bucketName)
              throws java.io.IOException,
                     JetStreamApiException

Deletes an existing bucket. THIS IS A BETA FEATURE AND SUBJECT TO CHANGE

Parameters:

bucketName - the stream name to use.

Returns:

true if the delete succeeded

Throws:

java.io.IOException - covers various communication issues with the NATS server such as timeout or interruption

JetStreamApiException - the request had an error related to the data

getBucketInfo

BucketInfo getBucketInfo(java.lang.String bucketName)
                  throws java.io.IOException,
                         JetStreamApiException

Gets the info for an existing bucket. THIS IS A BETA FEATURE AND SUBJECT TO CHANGE

Parameters:

bucketName - the stream name to use.

Returns:

stream information

Throws:

java.io.IOException - covers various communication issues with the NATS server such as timeout or interruption

JetStreamApiException - the request had an error related to the data

purgeBucket

PurgeResponse purgeBucket(java.lang.String bucketName)
                   throws java.io.IOException,
                          JetStreamApiException

Purge all keys/values/history from the bucket. THIS IS A BETA FEATURE AND SUBJECT TO CHANGE

Parameters:

bucketName - the bucket name

Returns:

PurgeResponse the purge response

Throws:

java.io.IOException - covers various communication issues with the NATS server such as timeout or interruption

JetStreamApiException - the request had an error related to the data

purgeKey

PurgeResponse purgeKey(java.lang.String bucketName,
                       java.lang.String key)
                throws java.io.IOException,
                       JetStreamApiException

Purge all values/history from the specific key THIS IS A BETA FEATURE AND SUBJECT TO CHANGE

Parameters:

bucketName - the bucket name

key - the key

Returns:

PurgeResponse the purge response

Throws:

java.io.IOException - covers various communication issues with the NATS server such as timeout or interruption

JetStreamApiException - the request had an error related to the data

getHistory

java.util.List<KvEntry> getHistory(java.lang.String bucketName,
                                   java.lang.String key)
                            throws java.io.IOException,
                                   JetStreamApiException,
                                   java.lang.InterruptedException

Get the history (list of KvEntry) for a key THIS IS A BETA FEATURE AND SUBJECT TO CHANGE

Parameters:

bucketName - the bucket name

key - the key

Returns:

List of KvEntry

Throws:

java.io.IOException - covers various communication issues with the NATS server such as timeout or interruption

JetStreamApiException - the request had an error related to the data

java.lang.InterruptedException - if the thread is interrupted

keys

java.util.Set<java.lang.String> keys(java.lang.String bucketName)
                              throws java.io.IOException,
                                     JetStreamApiException,
                                     java.lang.InterruptedException

Get the set of the keys in a bucket. THIS IS A BETA FEATURE AND SUBJECT TO CHANGE

Parameters:

bucketName - the bucket name

Returns:

Set of keys

Throws:

java.io.IOException - covers various communication issues with the NATS server such as timeout or interruption

JetStreamApiException - the request had an error related to the data

java.lang.InterruptedException - if the thread is interrupted

bucketsNames

java.util.List<java.lang.String> bucketsNames()
                                       throws java.io.IOException,
                                              JetStreamApiException,
                                              java.lang.InterruptedException

Get the list of bucket names THIS IS A BETA FEATURE AND SUBJECT TO CHANGE

Returns:

list of bucket names

Throws:

java.io.IOException - covers various communication issues with the NATS server such as timeout or interruption

JetStreamApiException - the request had an error related to the data

java.lang.InterruptedException - if the thread is interrupted