io.micronaut.health

Class HeartbeatEvent

java.lang.Object

java.util.EventObject

io.micronaut.context.event.ApplicationEvent

io.micronaut.discovery.event.AbstractServiceInstanceEvent

io.micronaut.health.HeartbeatEvent

All Implemented Interfaces:

java.io.Serializable

public class HeartbeatEvent
extends AbstractServiceInstanceEvent

A heartbeat event is an event fired periodically and configured by HeartbeatConfiguration.

Since:

1.0

Author:

Graeme Rocher

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
HeartbeatEvent(ServiceInstance source, HealthStatus status)

Method Summary

Modifier and Type	Method and Description
HealthStatus	getStatus() This method will return the HealthStatus if the server is configured to calculate the status.

Methods inherited from class io.micronaut.discovery.event.AbstractServiceInstanceEvent

getSource

Methods inherited from class java.util.EventObject

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

HeartbeatEvent

public HeartbeatEvent(ServiceInstance source,
                      HealthStatus status)

Parameters:

source - The service instance

status - The status of health indicator

Method Detail

getStatus

public HealthStatus getStatus()

This method will return the HealthStatus if the server is configured to calculate the status.

Returns:

The current health status