io.nats.client.api

Class KeyValueEntry

java.lang.Object

io.nats.client.api.KeyValueEntry

public class KeyValueEntry
extends java.lang.Object

The KeyValueEntry represents a record in the Key Value history

Constructor Summary

Constructors

Constructor and Description
KeyValueEntry(Message m) Construct KeyValueEntry from a message
KeyValueEntry(MessageInfo mi) Construct KeyValueEntry from message info

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
@NonNull java.lang.String	getBucket() Get the key value bucket this key in.
@NonNull java.time.ZonedDateTime	getCreated() Get the creation time of the current version of the key
long	getDataLen() Get the number of bytes in the data.
long	getDelta() Internal reference to pending message from the entry request
@NonNull java.lang.String	getKey() Get the key
@NonNull KeyValueOperation	getOperation() The KeyValueOperation of this entry
long	getRevision() Get the revision number of the string.
byte[]	getValue() Get the value.
@Nullable java.lang.Long	getValueAsLong() Get the value as a long
@Nullable java.lang.String	getValueAsString() Get the value as a string using UTF-8 encoding
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

KeyValueEntry

public KeyValueEntry(MessageInfo mi)

Construct KeyValueEntry from message info

Parameters:

mi - the message info

KeyValueEntry

public KeyValueEntry(Message m)

Construct KeyValueEntry from a message

Parameters:

m - the message

Method Detail

getBucket

public @NonNull java.lang.String getBucket()

Get the key value bucket this key in.

Returns:

the bucket

getKey

public @NonNull java.lang.String getKey()

Get the key

Returns:

the key

getValue

public byte[] getValue()

Get the value. May be null

Returns:

the value

getValueAsString

public @Nullable java.lang.String getValueAsString()

Get the value as a string using UTF-8 encoding

Returns:

the value as a string or null if there is no value

getValueAsLong

public @Nullable java.lang.Long getValueAsLong()

Get the value as a long

Returns:

the value or null if there is no value

Throws:

java.lang.NumberFormatException - if the string does not contain a parsable long.

getDataLen

public long getDataLen()

Get the number of bytes in the data. May be zero

Returns:

the number of bytes

getCreated

public @NonNull java.time.ZonedDateTime getCreated()

Get the creation time of the current version of the key

Returns:

the creation time

getRevision

public long getRevision()

Get the revision number of the string. Not a version, but an internally strictly monotonical value

Returns:

the revision

getDelta

public long getDelta()

Internal reference to pending message from the entry request

Returns:

the delta

getOperation

public @NonNull KeyValueOperation getOperation()

The KeyValueOperation of this entry

Returns:

the operation

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object