Package com.structurizr.model

Class HttpHealthCheck

java.lang.Object
com.structurizr.model.HttpHealthCheck
public final class HttpHealthCheck
extends java.lang.Object
Describes a HTTP based health check.

  • Method Summary

    Modifier and Type Method Description
    void addHeader​(java.lang.String name, java.lang.String value)
    Adds a HTTP header, which will be sent with the HTTP request to the health check URL.
    boolean equals​(java.lang.Object o)  
    java.util.Map<java.lang.String,​java.lang.String> getHeaders()
    Gets a the HTTP headers associated with this health check.
    int getInterval()
    Gets the polling interval of this health check.
    java.lang.String getName()
    Gets the name of this health check.
    long getTimeout()
    Gets the timeout associated with this health check.
    java.lang.String getUrl()
    Gets the URL for this health check.
    int hashCode()  

    Methods inherited from class java.lang.Object

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

  • Method Details

    • getName

      public java.lang.String getName()
      Gets the name of this health check.
      Returns:
      the name, as a String

    • getUrl

      public java.lang.String getUrl()
      Gets the URL for this health check.
      Returns:
      the URL, as a String

    • addHeader

      public void addHeader​(java.lang.String name, java.lang.String value)
      Adds a HTTP header, which will be sent with the HTTP request to the health check URL.
      Parameters:
      name - the name of the header
      value - the value of the header

    • getHeaders

      public java.util.Map<java.lang.String,​java.lang.String> getHeaders()
      Gets a the HTTP headers associated with this health check.
      Returns:
      a Map (name=value)

    • getInterval

      public int getInterval()
      Gets the polling interval of this health check.
      Returns:
      the polling interval (in seconds), as an integer

    • getTimeout

      public long getTimeout()
      Gets the timeout associated with this health check.
      Returns:
      the timeout (in milliseconds)

    • equals

      public boolean equals​(java.lang.Object o)
      Overrides:
      equals in class java.lang.Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class java.lang.Object