io.micronaut.discovery

Interface ServiceInstance

All Known Subinterfaces:

EmbeddedServerInstance

public interface ServiceInstance

Represents a remote service discovered by the underlying discovery implementation.

Since:

1.0

Author:

Graeme Rocher

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ServiceInstance.Builder A builder for building ServiceInstance references.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	GROUP Constant to represent the group of the service contained with getMetadata().
static java.lang.String	REGION Constant to represent the region of the service contained with getMetadata().
static java.lang.String	ZONE Constant to represent the zone of the service contained with getMetadata().

Method Summary

Modifier and Type	Method and Description
static ServiceInstance.Builder	builder(java.lang.String id, java.net.URI uri) A builder to builder a ServiceInstance.
default java.util.Optional<java.lang.String>	getGroup() Returns the application group.
default HealthStatus	getHealthStatus()
default java.lang.String	getHost()
java.lang.String	getId()
default java.util.Optional<java.lang.String>	getInstanceId()
default ConvertibleValues<java.lang.String>	getMetadata()
default int	getPort()
default java.util.Optional<java.lang.String>	getRegion() Returns the region to use.
java.net.URI	getURI()
default java.util.Optional<java.lang.String>	getZone() Returns the availability zone to use.
default boolean	isSecure()
static ServiceInstance	of(java.lang.String id, java.lang.String host, int port) Construct a new ServiceInstance for the given ID, host and port using the HTTP scheme.
static ServiceInstance	of(java.lang.String id, java.net.URI uri) Construct a new ServiceInstance for the given ID and URL.
static ServiceInstance	of(java.lang.String id, java.net.URL url) Construct a new ServiceInstance for the given ID and URL.
default java.net.URI	resolve(java.net.URI relativeURI) Resolve a URI relative to this service instance.

Field Detail

GROUP

static final java.lang.String GROUP

Constant to represent the group of the service contained with getMetadata().

See Also:

Constant Field Values

ZONE

static final java.lang.String ZONE

Constant to represent the zone of the service contained with getMetadata().

See Also:

Constant Field Values

REGION

static final java.lang.String REGION

Constant to represent the region of the service contained with getMetadata().

See Also:

Constant Field Values

Method Detail

getId

java.lang.String getId()

Returns:

The identifier of the service used for purposes of service discovery

getURI

java.net.URI getURI()

Returns:

The service URI

getHealthStatus

default HealthStatus getHealthStatus()

Returns:

The HealthStatus of the instance

getInstanceId

default java.util.Optional<java.lang.String> getInstanceId()

Returns:

The ID of the instance

getZone

default java.util.Optional<java.lang.String> getZone()

Returns the availability zone to use. A zone is, for example, the AWS availability zone.

Returns:

The zone to use

getRegion

default java.util.Optional<java.lang.String> getRegion()

Returns the region to use. A region is, for example, the AWS region

Returns:

The region

getGroup

default java.util.Optional<java.lang.String> getGroup()

Returns the application group. For example, the AWS auto-scaling group.

Returns:

The group to use

getMetadata

default ConvertibleValues<java.lang.String> getMetadata()

Returns:

The service metadata

getHost

default java.lang.String getHost()

Returns:

The service host

isSecure

default boolean isSecure()

Returns:

Is the service instance available over a secure connection

getPort

default int getPort()

Returns:

The service port

resolve

default java.net.URI resolve(java.net.URI relativeURI)

Resolve a URI relative to this service instance.

Parameters:

relativeURI - The relative URI

Returns:

The relative URI

of

static ServiceInstance of(java.lang.String id,
                          java.net.URL url)

Construct a new ServiceInstance for the given ID and URL.

Parameters:

id - The ID

url - The URL

Returns:

The instance

of

static ServiceInstance of(java.lang.String id,
                          java.net.URI uri)

Construct a new ServiceInstance for the given ID and URL.

Parameters:

id - The ID

uri - The URI

Returns:

The instance

of

static ServiceInstance of(java.lang.String id,
                          java.lang.String host,
                          int port)

Construct a new ServiceInstance for the given ID, host and port using the HTTP scheme.

Parameters:

id - The ID

host - The host

port - The port

Returns:

The instance

builder

static ServiceInstance.Builder builder(java.lang.String id,
                                       java.net.URI uri)

A builder to builder a ServiceInstance.

Parameters:

id - The id

uri - The URI

Returns:

The builder