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
KeyValueStatus	create(KeyValueConfiguration config) Create a key value store.
void	delete(java.lang.String bucketName) Deletes an existing bucket.
KeyValueStatus	getBucketInfo(java.lang.String bucketName) Deprecated. Use getStatus(String) instead.
java.util.List<java.lang.String>	getBucketNames() Get the list of bucket names.
KeyValueStatus	getStatus(java.lang.String bucketName) Gets the status for an existing bucket.
java.util.List<KeyValueStatus>	getStatuses() Get the statuses for all buckets
KeyValueStatus	update(KeyValueConfiguration config) Update a key value store configuration.

Method Detail

create

KeyValueStatus create(KeyValueConfiguration config)
               throws java.io.IOException,
                      JetStreamApiException

Create a key value store.

Parameters:

config - the key value 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

update

KeyValueStatus update(KeyValueConfiguration config)
               throws java.io.IOException,
                      JetStreamApiException

Update a key value store configuration. Storage type cannot change.

Parameters:

config - the key value 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

getBucketNames

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

Get the list of bucket names.

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

getBucketInfo

@Deprecated
KeyValueStatus getBucketInfo(java.lang.String bucketName)
                                  throws java.io.IOException,
                                         JetStreamApiException

Deprecated. Use getStatus(String) instead.

Gets the status for an existing bucket.

Parameters:

bucketName - the bucket name to use

Returns:

the bucket status object

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

getStatus

KeyValueStatus getStatus(java.lang.String bucketName)
                  throws java.io.IOException,
                         JetStreamApiException

Gets the status for an existing bucket.

Parameters:

bucketName - the bucket name to use

Returns:

the bucket status object

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

getStatuses

java.util.List<KeyValueStatus> getStatuses()
                                    throws java.io.IOException,
                                           JetStreamApiException

Get the statuses for all buckets

Returns:

list of statuses

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

delete

void delete(java.lang.String bucketName)
     throws java.io.IOException,
            JetStreamApiException

Deletes an existing bucket. Will throw a JetStreamApiException if the delete fails.

Parameters:

bucketName - the stream name to use.

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