io.nats.client.api

Class ObjectInfo

java.lang.Object

io.nats.client.api.ObjectInfo

All Implemented Interfaces:

io.nats.client.support.JsonSerializable

public class ObjectInfo
extends java.lang.Object
implements io.nats.client.support.JsonSerializable

The ObjectInfo is Object Meta Information plus instance information

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ObjectInfo.Builder A builder for ObjectInfo

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static ObjectInfo.Builder	builder(ObjectInfo info) Get an instance of the builder initialized from existing ObjectInfo
static ObjectInfo.Builder	builder(java.lang.String bucket, ObjectMeta meta) Get an instance of the builder initialized with a bucket and object meta
static ObjectInfo.Builder	builder(java.lang.String bucket, java.lang.String objectName) Get an instance of the builder initialized with a bucket and object meta
boolean	equals(java.lang.Object o)
@NonNull java.lang.String	getBucket() the bucket name
long	getChunks() The total number of chunks in the object
@Nullable java.lang.String	getDescription() The object meta description
@Nullable java.lang.String	getDigest() The digest string for the object
@NonNull io.nats.client.impl.Headers	getHeaders() The object meta Headers.
@Nullable ObjectLink	getLink() If this is a link to an object, get the ObjectLink instance, otherwise this will be null
@NonNull java.util.Map<java.lang.String,java.lang.String>	getMetaData() The object meta metadata.
@Nullable java.time.ZonedDateTime	getModified() When the object was last modified
@Nullable java.lang.String	getNuid() the bucket nuid
@NonNull ObjectMeta	getObjectMeta() The full object meta object
@Nullable java.lang.String	getObjectName() The object name
long	getSize() The size of the object
int	hashCode()
boolean	isDeleted() Whether the object is deleted
boolean	isLink() Whether the object is actually a link
@NonNull java.lang.String	toJson()
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.nats.client.support.JsonSerializable

serialize, toJsonValue

Constructor Detail

ObjectInfo

public ObjectInfo(MessageInfo mi)

Construct ObjectInfo from message info

Parameters:

mi - the message info

ObjectInfo

public ObjectInfo(Message m)

Construct ObjectInfo from a message

Parameters:

m - the message

Method Detail

toJson

public @NonNull java.lang.String toJson()

Specified by:

toJson in interface io.nats.client.support.JsonSerializable

getBucket

public @NonNull java.lang.String getBucket()

the bucket name

Returns:

the name

getNuid

public @Nullable java.lang.String getNuid()

the bucket nuid

Returns:

the nuid

getSize

public long getSize()

The size of the object

Returns:

the size in bytes

getModified

public @Nullable java.time.ZonedDateTime getModified()

When the object was last modified

Returns:

the last modified date

getChunks

public long getChunks()

The total number of chunks in the object

Returns:

the number of chunks

getDigest

public @Nullable java.lang.String getDigest()

The digest string for the object

Returns:

the digest

isDeleted

public boolean isDeleted()

Whether the object is deleted

Returns:

the deleted state

getObjectMeta

public @NonNull ObjectMeta getObjectMeta()

The full object meta object

Returns:

the ObjectMeta

getObjectName

public @Nullable java.lang.String getObjectName()

The object name

Returns:

the object name

getDescription

public @Nullable java.lang.String getDescription()

The object meta description

Returns:

the description text or null

getHeaders

public @NonNull io.nats.client.impl.Headers getHeaders()

The object meta Headers. May be empty but will not be null. In all cases it will be unmodifiable

Returns:

the headers object

getMetaData

public @NonNull java.util.Map<java.lang.String,java.lang.String> getMetaData()

The object meta metadata. May be empty but will not be null. In all cases it will be unmodifiable

Returns:

the map

isLink

public boolean isLink()

Whether the object is actually a link

Returns:

true if the object is a link instead of a direct object

getLink

public @Nullable ObjectLink getLink()

If this is a link to an object, get the ObjectLink instance, otherwise this will be null

Returns:

the ObjectLink or null

builder

public static ObjectInfo.Builder builder(java.lang.String bucket,
                                         java.lang.String objectName)

Get an instance of the builder initialized with a bucket and object meta

Parameters:

bucket - the bucket name

objectName - the object name

Returns:

the builder

builder

public static ObjectInfo.Builder builder(java.lang.String bucket,
                                         ObjectMeta meta)

Get an instance of the builder initialized with a bucket and object meta

Parameters:

bucket - the bucket

meta - the object meta

Returns:

the builder

builder

public static ObjectInfo.Builder builder(ObjectInfo info)

Get an instance of the builder initialized from existing ObjectInfo

Parameters:

info - the info

Returns:

the builder

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object