io.nats.client

Interface ObjectStoreManagement

public interface ObjectStoreManagement

Object Store Management context for creation and access to object stores. OBJECT STORE IMPLEMENTATION IS EXPERIMENTAL AND SUBJECT TO CHANGE.

Method Summary

Modifier and Type	Method and Description
ObjectStoreStatus	create(ObjectStoreConfiguration config) Create an object store.
void	delete(java.lang.String bucketName) Deletes an existing object store.
java.util.List<java.lang.String>	getBucketNames() Get the list of object stores bucket names THIS IS A BETA FEATURE AND SUBJECT TO CHANGE
ObjectStoreStatus	getStatus(java.lang.String bucketName) Gets the status for an existing object store bucket.
java.util.List<ObjectStoreStatus>	getStatuses() Gets the status for all object store buckets.

Method Detail

create

ObjectStoreStatus create(ObjectStoreConfiguration config)
                  throws java.io.IOException,
                         JetStreamApiException

Create an object store. THIS IS A BETA FEATURE AND SUBJECT TO CHANGE

Parameters:

config - the object store 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 object stores bucket names THIS IS A BETA FEATURE AND SUBJECT TO CHANGE

Returns:

list of object stores 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

getStatus

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

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

Parameters:

bucketName - the object store bucket name to get info for

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<ObjectStoreStatus> getStatuses()
                                       throws java.io.IOException,
                                              JetStreamApiException

Gets the status for all object store buckets. THIS IS A BETA FEATURE AND SUBJECT TO CHANGE

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 object store. Will throw a JetStreamApiException if the delete fails. THIS IS A BETA FEATURE AND SUBJECT TO CHANGE

Parameters:

bucketName - the object store bucket name to delete

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