io.nats.service

Class Endpoint

java.lang.Object

io.nats.service.Endpoint

All Implemented Interfaces:

JsonSerializable

public class Endpoint
extends java.lang.Object
implements JsonSerializable

Endpoint encapsulates the name, subject and metadata for a ServiceEndpoint.

Endpoints can be used directly or as part of a group. ServiceEndpoint and Group

Endpoint names and subjects are considered 'Restricted Terms' and must only contain A-Z, a-z, 0-9, '-' or '_'

To create an Endpoint, either use a direct constructor or use the Endpoint builder via the static method builder() or new Endpoint.Builder() to get an instance.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Endpoint.Builder Build an Endpoint using a fluent builder.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_QGROUP

Constructor Summary

Constructors

Constructor and Description
Endpoint(java.lang.String name) Directly construct an Endpoint with a name, which becomes the subject
Endpoint(java.lang.String name, java.util.Map<java.lang.String,java.lang.String> metadata) Directly construct an Endpoint with a name, which becomes the subject, and metadata
Endpoint(java.lang.String name, java.lang.String subject) Directly construct an Endpoint with a name and a subject
Endpoint(java.lang.String name, java.lang.String subject, java.util.Map<java.lang.String,java.lang.String> metadata) Directly construct an Endpoint with a name, the subject, and metadata
Endpoint(java.lang.String name, java.lang.String subject, java.lang.String queueGroup, java.util.Map<java.lang.String,java.lang.String> metadata) Directly construct an Endpoint with a name, the subject, queueGroup and metadata

Method Summary

Modifier and Type	Method and Description
static Endpoint.Builder	builder() Get an instance of an Endpoint builder.
boolean	equals(java.lang.Object o)
java.util.Map<java.lang.String,java.lang.String>	getMetadata() Get a copy of the metadata of the Endpoint
java.lang.String	getName() Get the name of the Endpoint
java.lang.String	getQueueGroup() Get the queueGroup for the Endpoint
java.lang.String	getSubject() Get the subject of the Endpoint
int	hashCode()
java.lang.String	toJson()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

serialize, toJsonValue

Field Detail

DEFAULT_QGROUP

public static final java.lang.String DEFAULT_QGROUP

See Also:

Constant Field Values

Constructor Detail

Endpoint

public Endpoint(java.lang.String name)

Directly construct an Endpoint with a name, which becomes the subject

Parameters:

name - the name

Endpoint

public Endpoint(java.lang.String name,
                java.util.Map<java.lang.String,java.lang.String> metadata)

Directly construct an Endpoint with a name, which becomes the subject, and metadata

Parameters:

name - the name

metadata - the metadata

Endpoint

public Endpoint(java.lang.String name,
                java.lang.String subject)

Directly construct an Endpoint with a name and a subject

Parameters:

name - the name

subject - the subject

Endpoint

public Endpoint(java.lang.String name,
                java.lang.String subject,
                java.util.Map<java.lang.String,java.lang.String> metadata)

Directly construct an Endpoint with a name, the subject, and metadata

Parameters:

name - the name

subject - the subject

metadata - the metadata

Endpoint

public Endpoint(java.lang.String name,
                java.lang.String subject,
                java.lang.String queueGroup,
                java.util.Map<java.lang.String,java.lang.String> metadata)

Directly construct an Endpoint with a name, the subject, queueGroup and metadata

Parameters:

name - the name

subject - the subject

queueGroup - the queueGroup

metadata - the metadata

Method Detail

toJson

public java.lang.String toJson()

Specified by:

toJson in interface JsonSerializable

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getName

public java.lang.String getName()

Get the name of the Endpoint

Returns:

the name

getSubject

public java.lang.String getSubject()

Get the subject of the Endpoint

Returns:

the subject

getQueueGroup

public java.lang.String getQueueGroup()

Get the queueGroup for the Endpoint

Returns:

the queueGroup

getMetadata

public java.util.Map<java.lang.String,java.lang.String> getMetadata()

Get a copy of the metadata of the Endpoint

Returns:

the copy of metadata

builder

public static Endpoint.Builder builder()

Get an instance of an Endpoint builder.

Returns:

the instance

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