Record Class ConsulCatalogEntry

java.lang.Object

java.lang.Record

io.micronaut.discovery.consul.client.v1.ConsulCatalogEntry

Record Components:

node - Node ID

address - Address as sent by Consul, a host name or an IP literal. It is not resolved.

datacenter - Datacenter

taggedAddresses - Tagged addresses

nodeMetadata - Node metadata

service - Service

public record ConsulCatalogEntry(@Nullable String node, @Nullable String address, @Nullable String datacenter, @Nullable Map<String,String> taggedAddresses, @Nullable Map<String,String> nodeMetadata, @Nullable ConsulNewServiceEntry service)
extends Record

A catalog entry in Consul.

Since:

4.1.0

Author:

Sergio del Amo

See Also:

• Catalog Sample Payload.

Constructor Summary

Constructors

Constructor	Description
ConsulCatalogEntry(@Nullable String node, @Nullable String address, @Nullable String datacenter, @Nullable Map<String,String> taggedAddresses, @Nullable Map<String,String> nodeMetadata, @Nullable ConsulNewServiceEntry service)	Creates an instance of a ConsulCatalogEntry record class.
ConsulCatalogEntry(@Nullable String node, @Nullable InetAddress address, @Nullable String datacenter, @Nullable Map<String,String> taggedAddresses, @Nullable Map<String,String> nodeMetadata, @Nullable ConsulNewServiceEntry service)	Deprecated, for removal: This API element is subject to removal in a future version. Use the canonical constructor, which takes the address as a string.

Method Summary

Modifier and Type	Method	Description
@Nullable String	address()	Returns the value of the address record component.
@Nullable String	datacenter()	Returns the value of the datacenter record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
@Nullable String	node()	Returns the value of the node record component.
@Nullable Map<String,String>	nodeMetadata()	Returns the value of the nodeMetadata record component.
@Nullable ConsulNewServiceEntry	service()	Returns the value of the service record component.
@Nullable Map<String,String>	taggedAddresses()	Returns the value of the taggedAddresses record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Constructor Details

ConsulCatalogEntry

@Deprecated(since="5.2.0",
            forRemoval=true)
public ConsulCatalogEntry(@Nullable String node,
 @Nullable InetAddress address,
 @Nullable String datacenter,
 @Nullable Map<String,String> taggedAddresses,
 @Nullable Map<String,String> nodeMetadata,
 @Nullable ConsulNewServiceEntry service)

Deprecated, for removal: This API element is subject to removal in a future version.

Use the canonical constructor, which takes the address as a string.

Creates a catalog entry from an InetAddress. The address is stored as its host name, or as its IP literal when it has no host name.

Parameters:

node - Node ID

address - Address

datacenter - Datacenter

taggedAddresses - Tagged addresses

nodeMetadata - Node metadata

service - Service

ConsulCatalogEntry

public ConsulCatalogEntry(@Nullable String node,
 @Nullable String address,
 @Nullable String datacenter,
 @Nullable Map<String,String> taggedAddresses,
 @Nullable Map<String,String> nodeMetadata,
 @Nullable ConsulNewServiceEntry service)

Creates an instance of a ConsulCatalogEntry record class.

Parameters:

node - the value for the node record component

address - the value for the address record component

datacenter - the value for the datacenter record component

taggedAddresses - the value for the taggedAddresses record component

nodeMetadata - the value for the nodeMetadata record component

service - the value for the service record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

node

public @Nullable String node()

Returns the value of the node record component.

Returns:

the value of the node record component

address

public @Nullable String address()

Returns the value of the address record component.

Returns:

the value of the address record component

datacenter

public @Nullable String datacenter()

Returns the value of the datacenter record component.

Returns:

the value of the datacenter record component

taggedAddresses

public @Nullable Map<String,String> taggedAddresses()

Returns the value of the taggedAddresses record component.

Returns:

the value of the taggedAddresses record component

nodeMetadata

public @Nullable Map<String,String> nodeMetadata()

Returns the value of the nodeMetadata record component.

Returns:

the value of the nodeMetadata record component

service

public @Nullable ConsulNewServiceEntry service()

Returns the value of the service record component.

Returns:

the value of the service record component