Package io.micronaut.discovery.consul.client.v1

Class ConsulCheck

java.lang.Object
io.micronaut.discovery.consul.client.v1.ConsulCheck
public class ConsulCheck extends Object
Represents a Consul check. Check definition
Since:
4.1.0
Author:
Sergio del Amo

  • Constructor Details

    • ConsulCheck

      public ConsulCheck()

  • Method Details

    • getName

      public String getName()
      Returns:
      Specifies the name of the check.

    • setName

      public void setName(String name)
      Parameters:
      name - Specifies the name of the check.

    • getId

      public String getId()
      Returns:
      Specifies a unique ID for this check on the node.

    • setId

      public void setId(String id)
      Parameters:
      id - Specifies a unique ID for this check on the node.

    • getInterval

      public String getInterval()
      Returns:
      Specifies the frequency at which to run this check. This is required for HTTP, TCP, and UDP checks.

    • setInterval

      public void setInterval(String interval)
      Parameters:
      interval - Specifies the frequency at which to run this check. This is required for HTTP, TCP, and UDP checks.

    • getNotes

      public String getNotes()
      Returns:
      Specifies arbitrary information for humans. This is not used by Consul internally.

    • setNotes

      public void setNotes(String notes)
      Parameters:
      notes - Specifies arbitrary information for humans. This is not used by Consul internally.

    • getDeregisterCriticalServiceAfter

      public String getDeregisterCriticalServiceAfter()
      Returns:
      Specifies that checks associated with a service should deregister after this time.

    • setDeregisterCriticalServiceAfter

      public void setDeregisterCriticalServiceAfter(String deregisterCriticalServiceAfter)
      Parameters:
      deregisterCriticalServiceAfter - Specifies that checks associated with a service should deregister after this time.

    • getHttp

      public URL getHttp()
      Returns:
      Specifies an HTTP check to perform a GET request against the value of HTTP (expected to be a URL) every Interval.

    • setHttp

      public void setHttp(URL http)
      Parameters:
      http - Specifies an HTTP check to perform a GET request against the value of HTTP (expected to be a URL) every Interval.

    • getMethod

      public io.micronaut.http.HttpMethod getMethod()
      Returns:
      Specifies a different HTTP method to be used for an HTTP check. When no value is specified, GET is used.

    • setMethod

      public void setMethod(io.micronaut.http.HttpMethod method)
      Parameters:
      method - Specifies a different HTTP method to be used for an HTTP check. When no value is specified, GET is used.

    • getHeader

      public Map<CharSequence,List<String>> getHeader()
      Returns:
      Specifies a set of headers that should be set for HTTP checks. Each header can have multiple values.

    • setHeader

      public void setHeader(Map<CharSequence,List<String>> header)
      Parameters:
      header - Specifies a set of headers that should be set for HTTP checks. Each header can have multiple values.

    • getTlsSkipVerify

      public 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.

    • getTtl

      public String getTtl()
      Returns:
      Specifies this is a TTL check, and the TTL endpoint must be used periodically to update the state of the check. If the check is not set to passing within the specified duration, then the check will be set to the failed state.

    • setTtl

      public void setTtl(String ttl)
      Parameters:
      ttl - Specifies this is a TTL check, and the TTL endpoint must be used periodically to update the state of the check. If the check is not set to passing within the specified duration, then the check will be set to the failed state.

    • getStatus

      public String getStatus()
      Returns:
      Specifies the initial status of the health check.

    • setStatus

      public void setStatus(String status)
      Parameters:
      status - Specifies the initial status of the health check.