io.micronaut.discovery.consul.client.v1

Class HTTPCheck

java.lang.Object

io.micronaut.discovery.consul.client.v1.NewCheck

io.micronaut.discovery.consul.client.v1.HTTPCheck

All Implemented Interfaces:

Check

public class HTTPCheck
extends NewCheck

A class representing an HTTP check. See https://www.consul.io/api/agent/check.html.

Since:

1.0

Author:

Graeme Rocher

Nested Class Summary

Nested classes/interfaces inherited from interface io.micronaut.discovery.consul.client.v1.Check

Check.Status

Constructor Summary

Constructors

Constructor and Description
HTTPCheck(java.lang.String name, java.net.URL url)
HTTPCheck(java.net.URL url)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
io.micronaut.core.convert.value.ConvertibleMultiValues<java.lang.String>	getHeader() See https://www.consul.io/api/agent/service.html#header.
java.net.URL	getHTTP() See https://www.consul.io/api/agent/service.html#http.
java.util.Optional<java.lang.String>	getInterval()
java.util.Optional<io.micronaut.http.HttpMethod>	getMethod() See https://www.consul.io/api/agent/service.html#method.
int	hashCode()
HTTPCheck	headers(io.micronaut.core.convert.value.ConvertibleMultiValues<java.lang.String> headers)
HTTPCheck	id(java.lang.String ID)
java.time.Duration	interval()
HTTPCheck	interval(java.time.Duration interval)
HTTPCheck	interval(java.lang.String interval)
boolean	isTLSSkipVerify()
HTTPCheck	method(io.micronaut.http.HttpMethod method)
HTTPCheck	notes(java.lang.String notes)
void	setHeaders(java.util.Map<java.lang.CharSequence,java.util.List<java.lang.String>> headers)
protected void	setInterval(java.lang.String interval) Sets the interval.
void	setMethod(io.micronaut.http.HttpMethod method)
void	setTLSSkipVerify(boolean TLSSkipVerify)
HTTPCheck	status(Check.Status status)
HTTPCheck	tlsSkipVerify(boolean TLSSkipVerify)

Methods inherited from class io.micronaut.discovery.consul.client.v1.NewCheck

deregisterCriticalServiceAfter, deregisterCriticalServiceAfter, deregisterCriticalServiceAfter, getDeregisterCriticalServiceAfter, getID, getName, getNotes, getStatus, setDeregisterCriticalServiceAfter, setName, setNotes, setStatus, status

Methods inherited from class java.lang.Object

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

Constructor Detail

HTTPCheck

public HTTPCheck(@Nullable
                 java.lang.String name,
                 @Nullable
                 java.net.URL url)

Parameters:

name - The name

url - The URL

HTTPCheck

public HTTPCheck(java.net.URL url)

Parameters:

url - The URL

Method Detail

interval

public java.time.Duration interval()

Returns:

The interval as a Duration

setInterval

protected void setInterval(java.lang.String interval)

Sets the interval.

Parameters:

interval - The interval

interval

public HTTPCheck interval(java.time.Duration interval)

Parameters:

interval - The interval as a Duration

Returns:

The HTTPCheck instance

interval

public HTTPCheck interval(java.lang.String interval)

Parameters:

interval - The interval as a string

Returns:

The HTTPCheck instance

getInterval

public java.util.Optional<java.lang.String> getInterval()

Returns:

The check interval

getHTTP

public java.net.URL getHTTP()

See https://www.consul.io/api/agent/service.html#http.

Returns:

The HTTP URL to check

getMethod

public java.util.Optional<io.micronaut.http.HttpMethod> getMethod()

See https://www.consul.io/api/agent/service.html#method.

Returns:

The HTTP method to use for the check

getHeader

public io.micronaut.core.convert.value.ConvertibleMultiValues<java.lang.String> getHeader()

See https://www.consul.io/api/agent/service.html#header.

Returns:

The HTTP headers to use for the check

setHeaders

public void setHeaders(java.util.Map<java.lang.CharSequence,java.util.List<java.lang.String>> headers)

Parameters:

headers - The headers

isTLSSkipVerify

public boolean isTLSSkipVerify()

Returns:

Whether skip TLS verification

setTLSSkipVerify

public void setTLSSkipVerify(boolean TLSSkipVerify)

Parameters:

TLSSkipVerify - Skip the TLS verification

setMethod

public void setMethod(io.micronaut.http.HttpMethod method)

Parameters:

method - The HttpMethod

headers

public HTTPCheck headers(io.micronaut.core.convert.value.ConvertibleMultiValues<java.lang.String> headers)

Parameters:

headers - The headers

Returns:

The HTTPCheck instance

tlsSkipVerify

public HTTPCheck tlsSkipVerify(boolean TLSSkipVerify)

Parameters:

TLSSkipVerify - Skip the TLS verification

Returns:

The HTTPCheck instance

method

public HTTPCheck method(io.micronaut.http.HttpMethod method)

Parameters:

method - The HttpMethod

Returns:

The HTTPCheck instance

id

public HTTPCheck id(java.lang.String ID)

Overrides:

id in class NewCheck

Parameters:

ID - The ID of the check

Returns:

The deregisterCriticalServiceAfter as a Duration

status

public HTTPCheck status(Check.Status status)

Overrides:

status in class NewCheck

Parameters:

status - The Check.Status of the check

Returns:

The deregisterCriticalServiceAfter as a Duration

notes

public HTTPCheck notes(java.lang.String notes)

Overrides:

notes in class NewCheck

Parameters:

notes - The human readable notes

Returns:

The deregisterCriticalServiceAfter as a Duration

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class NewCheck

hashCode

public int hashCode()

Overrides:

hashCode in class NewCheck