io.nats.client.api

Class ObjectMeta

java.lang.Object

io.nats.client.api.ObjectMeta

All Implemented Interfaces:

io.nats.client.support.JsonSerializable

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

The ObjectMeta is Object Meta is high level information about an object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ObjectMeta.Builder The builder for ObjectMeta

Method Summary

Modifier and Type	Method and Description
static ObjectMeta.Builder	builder(ObjectMeta om) Get an instance of the ObjectMeta.Builder as a copy of existing meta
static ObjectMeta.Builder	builder(java.lang.String objectName) Get an instance of the ObjectMeta.Builder starting with the object name
boolean	equals(java.lang.Object o)
@Nullable java.lang.String	getDescription() The description
@NonNull io.nats.client.impl.Headers	getHeaders() Headers may be empty but will not be null.
@NonNull java.util.Map<java.lang.String,java.lang.String>	getMetadata() Metadata may be empty but will not be null.
@Nullable ObjectMetaOptions	getObjectMetaOptions() The ObjectMetaOptions are additional options describing the object
@NonNull java.lang.String	getObjectName() The object name
int	hashCode()
static ObjectMeta	objectName(java.lang.String objectName) Create object meta that only has the object name.
@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

Method Detail

toJson

public @NonNull java.lang.String toJson()

Specified by:

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

getObjectName

public @NonNull java.lang.String getObjectName()

The object name

Returns:

the object name

getDescription

public @Nullable java.lang.String getDescription()

The description

Returns:

the description text or null

getHeaders

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

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()

Metadata may be empty but will not be null. In all cases it will be unmodifiable

Returns:

the map

getObjectMetaOptions

public @Nullable ObjectMetaOptions getObjectMetaOptions()

The ObjectMetaOptions are additional options describing the object

Returns:

the object meta data

builder

public static ObjectMeta.Builder builder(java.lang.String objectName)

Get an instance of the ObjectMeta.Builder starting with the object name

Parameters:

objectName - the object name

Returns:

the builder

builder

public static ObjectMeta.Builder builder(ObjectMeta om)

Get an instance of the ObjectMeta.Builder as a copy of existing meta

Parameters:

om - the existing meta

Returns:

the builder

objectName

public static ObjectMeta objectName(java.lang.String objectName)

Create object meta that only has the object name. Fairly common use case

Parameters:

objectName - the object name

Returns:

the ObjectMeta

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