io.micronaut.health

Class HeartbeatConfiguration

java.lang.Object

io.micronaut.health.HeartbeatConfiguration

All Implemented Interfaces:

Toggleable

@ConfigurationProperties(value="micronaut.heartbeat")
public class HeartbeatConfiguration
extends Object
implements Toggleable

Configuration for heart beat.

Since:

1.0

Author:

Graeme Rocher

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_ENABLED The default enable value.
static int	DEFAULT_INTERVAL_SECONDS The default interval seconds.
static String	ENABLED Whether the heartbeat is enabled.
static String	PREFIX The prefix used for the heart beat configuration.

Constructor Summary

Constructors

Constructor and Description
HeartbeatConfiguration()

Method Summary

Modifier and Type	Method and Description
Duration	getInterval()
boolean	isEnabled()
void	setEnabled(boolean enabled) Default value (true).
void	setInterval(Duration interval) Default value (15 seconds).

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ENABLED

public static final boolean DEFAULT_ENABLED

The default enable value.

See Also:

Constant Field Values

DEFAULT_INTERVAL_SECONDS

public static final int DEFAULT_INTERVAL_SECONDS

The default interval seconds.

See Also:

Constant Field Values

PREFIX

public static final String PREFIX

The prefix used for the heart beat configuration.

See Also:

Constant Field Values

ENABLED

public static final String ENABLED

Whether the heartbeat is enabled.

See Also:

Constant Field Values

Constructor Detail

HeartbeatConfiguration

public HeartbeatConfiguration()

Method Detail

getInterval

public Duration getInterval()

Returns:

The interval with which to publish HeartbeatEvent instances

setInterval

public void setInterval(Duration interval)

Default value (15 seconds).

Parameters:

interval - The interval to publish HeartbeatEvent instances

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface Toggleable

Returns:

Whether HeartbeatEvent event instances should be published by the server

setEnabled

public void setEnabled(boolean enabled)

Default value (true).

Parameters:

enabled - Enable the publish of HeartbeatEvent event instances