org.apache.dubbo.registry.client

Interface ServiceInstance

All Superinterfaces:

Serializable

All Known Implementing Classes:

DefaultServiceInstance

public interface ServiceInstance
extends Serializable

The model class of an instance of a service, which is used for service registration and discovery.

Since:

2.7.5

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object another)
String	getHost() The hostname of the registered service instance.
String	getId() The id of the registered service instance.
Map<String,String>	getMetadata() The key / value pair metadata associated with the service instance.
Integer	getPort() The port of the registered service instance.
String	getServiceName() The name of service that current instance belongs to.
int	hashCode()
default boolean	isEnabled() The enable status of the registered service instance.
default boolean	isHealthy() The registered service instance is health or not.

Method Detail

getId

String getId()

The id of the registered service instance.

Returns:

nullable

getServiceName

String getServiceName()

The name of service that current instance belongs to.

Returns:

non-null

getHost

String getHost()

The hostname of the registered service instance.

Returns:

non-null

getPort

Integer getPort()

The port of the registered service instance.

Returns:

the positive integer if present

isEnabled

default boolean isEnabled()

The enable status of the registered service instance.

Returns:

if true, indicates current instance is enabled, or disable, the client should remove this one. The default value is true

isHealthy

default boolean isHealthy()

The registered service instance is health or not.

Returns:

if true, indicates current instance is enabled, or disable, the client may ignore this one. The default value is true

getMetadata

Map<String,String> getMetadata()

The key / value pair metadata associated with the service instance.

Returns:

non-null, mutable and unsorted Map

hashCode

int hashCode()

Overrides:

hashCode in class Object

Returns:

the hash code of current instance.

equals

boolean equals(Object another)

Overrides:

equals in class Object

Parameters:

another - another ServiceInstance

Returns:

if equals , return true, or false