io.nats.client

Interface KeyValue

public interface KeyValue

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

Method Summary

Modifier and Type	Method and Description
long	delete(java.lang.String key) Deletes a key.
KvEntry	getEntry(java.lang.String key) Get the full entry for a key THIS IS A BETA FEATURE AND SUBJECT TO CHANGE
java.lang.Long	getLongValue(java.lang.String key) Get the number value for a key THIS IS A BETA FEATURE AND SUBJECT TO CHANGE
java.lang.String	getStringValue(java.lang.String key) Get the string value for a key THIS IS A BETA FEATURE AND SUBJECT TO CHANGE
byte[]	getValue(java.lang.String key) Get the byte[] value for a key THIS IS A BETA FEATURE AND SUBJECT TO CHANGE
long	put(java.lang.String key, byte[] value) Put a byte[] as the value for a key THIS IS A BETA FEATURE AND SUBJECT TO CHANGE
long	put(java.lang.String key, long value) Put a long as the value for a key THIS IS A BETA FEATURE AND SUBJECT TO CHANGE
long	put(java.lang.String key, java.lang.String value) Put a string as the value for a key THIS IS A BETA FEATURE AND SUBJECT TO CHANGE

Method Detail

getValue

byte[] getValue(java.lang.String key)
         throws java.io.IOException,
                JetStreamApiException

Get the byte[] value for a key THIS IS A BETA FEATURE AND SUBJECT TO CHANGE

Parameters:

key - the key

Returns:

the value or null if not found or deleted

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

getStringValue

java.lang.String getStringValue(java.lang.String key)
                         throws java.io.IOException,
                                JetStreamApiException

Get the string value for a key THIS IS A BETA FEATURE AND SUBJECT TO CHANGE

Parameters:

key - the key

Returns:

the value as UTF-8 string or null if not found or deleted

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

getLongValue

java.lang.Long getLongValue(java.lang.String key)
                     throws java.io.IOException,
                            JetStreamApiException

Get the number value for a key THIS IS A BETA FEATURE AND SUBJECT TO CHANGE

Parameters:

key - the key

Returns:

the value as number or null if not found or deleted

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

getEntry

KvEntry getEntry(java.lang.String key)
          throws java.io.IOException,
                 JetStreamApiException

Get the full entry for a key THIS IS A BETA FEATURE AND SUBJECT TO CHANGE

Parameters:

key - the key

Returns:

the KvEntry object or null if not found.

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

put

long put(java.lang.String key,
         byte[] value)
  throws java.io.IOException,
         JetStreamApiException

Put a byte[] as the value for a key THIS IS A BETA FEATURE AND SUBJECT TO CHANGE

Parameters:

key - the key

value - the bytes of the value

Returns:

the sequence number for the PUT record

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

put

long put(java.lang.String key,
         java.lang.String value)
  throws java.io.IOException,
         JetStreamApiException

Put a string as the value for a key THIS IS A BETA FEATURE AND SUBJECT TO CHANGE

Parameters:

key - the key

value - the UTF-8 string

Returns:

the sequence number for the PUT record

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

put

long put(java.lang.String key,
         long value)
  throws java.io.IOException,
         JetStreamApiException

Put a long as the value for a key THIS IS A BETA FEATURE AND SUBJECT TO CHANGE

Parameters:

key - the key

value - the number

Returns:

the sequence number for the PUT record

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

delete

long delete(java.lang.String key)
     throws java.io.IOException,
            JetStreamApiException

Deletes a key. THIS IS A BETA FEATURE AND SUBJECT TO CHANGE

Parameters:

key - the key

Returns:

the sequence number for the DEL record

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