io.micronaut.discovery.consul

Class ConsulConfiguration.ConsulRegistrationConfiguration.CheckConfiguration

java.lang.Object

io.micronaut.discovery.consul.ConsulConfiguration.ConsulRegistrationConfiguration.CheckConfiguration

All Implemented Interfaces:

Toggleable

Enclosing class:

ConsulConfiguration.ConsulRegistrationConfiguration

@ConfigurationProperties(value="check")
public static class ConsulConfiguration.ConsulRegistrationConfiguration.CheckConfiguration
extends Object
implements Toggleable

Configuration for the HTTP check. See https://www.consul.io/api/agent/check.html.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_ENABLED The default enable value.
static boolean	DEFAULT_HTTP The default http value.
static int	DEFAULT_INTERVAL_SECONDS The default interval seconds.

Constructor Summary

Constructors

Constructor and Description
CheckConfiguration()

Method Summary

Modifier and Type	Method and Description
Optional<Duration>	getDeregisterCriticalServiceAfter()
Map<CharSequence,List<String>>	getHeaders()
Optional<String>	getId()
Duration	getInterval()
HttpMethod	getMethod()
Optional<String>	getNotes()
Optional<Boolean>	getTlsSkipVerify()
boolean	isEnabled()
boolean	isHttp()
void	setDeregisterCriticalServiceAfter(Duration deregisterCriticalServiceAfter)
void	setEnabled(boolean enabled) Default value (true).
void	setHeaders(Map<CharSequence,List<String>> headers)
void	setHttp(boolean http) Default value (false).
void	setId(String id)
void	setInterval(Duration interval) Default value (15).
void	setMethod(HttpMethod method)
void	setNotes(String notes)
void	setTlsSkipVerify(Boolean tlsSkipVerify)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ENABLED

public static final boolean DEFAULT_ENABLED

The default enable value.

See Also:

Constant Field Values

DEFAULT_HTTP

public static final boolean DEFAULT_HTTP

The default http 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

Constructor Detail

CheckConfiguration

public CheckConfiguration()

Method Detail

getInterval

public Duration getInterval()

Returns:

The interval for the checks

setInterval

public void setInterval(Duration interval)

Default value (15).

Parameters:

interval - The interval for the checks

isHttp

public boolean isHttp()

Returns:

Whether to perform an HTTP check

setHttp

public void setHttp(boolean http)

Default value (false).

Parameters:

http - Whether to perform an HTTP check

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface Toggleable

Returns:

Whether the check module is enabled

setEnabled

public void setEnabled(boolean enabled)

Default value (true).

Parameters:

enabled - Whether the check module is enabled

getDeregisterCriticalServiceAfter

public Optional<Duration> getDeregisterCriticalServiceAfter()

Returns:

Specifies that checks associated with a service should deregister after this time

setDeregisterCriticalServiceAfter

public void setDeregisterCriticalServiceAfter(Duration deregisterCriticalServiceAfter)

Parameters:

deregisterCriticalServiceAfter - Specifies that checks associated with a service should deregister after this time

getId

public Optional<String> getId()

Returns:

Specifies a unique ID for this check on the node

setId

public void setId(String id)

Parameters:

id - The unique ID for this check on the node

getNotes

public Optional<String> getNotes()

Returns:

Arbitrary information for humans. Not used by Consult

setNotes

public void setNotes(String notes)

Parameters:

notes - Arbitrary information for humans

getTlsSkipVerify

public Optional<Boolean> getTlsSkipVerify()

Returns:

Specifies if the certificate for an HTTPS check should not be verified

setTlsSkipVerify

public void setTlsSkipVerify(Boolean tlsSkipVerify)

Parameters:

tlsSkipVerify - Specifies if the certificate for an HTTPS check should not be verified.

getMethod

public HttpMethod getMethod()

Returns:

Specifies a different HTTP method to be used for an HTTP check.

setMethod

public void setMethod(HttpMethod method)

Parameters:

method - The HTTP method to be used for an HTTP check.

getHeaders

public Map<CharSequence,List<String>> getHeaders()

Returns:

Specifies a set of headers that should be set for HTTP checks

setHeaders

public void setHeaders(Map<CharSequence,List<String>> headers)

Parameters:

headers - Headers for the HTTP checks

toString

public String toString()

Overrides:

toString in class Object