Package com.structurizr.model
Class HttpHealthCheck
java.lang.Object
com.structurizr.model.HttpHealthCheck
Describes a HTTP based health check.
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds a HTTP header, which will be sent with the HTTP request to the health check URL.boolean
Gets a the HTTP headers associated with this health check.int
Gets the polling interval of this health check.getName()
Gets the name of this health check.long
Gets the timeout associated with this health check.getUrl()
Gets the URL for this health check.int
hashCode()
-
Method Details
-
getName
Gets the name of this health check.- Returns:
- the name, as a String
-
getUrl
Gets the URL for this health check.- Returns:
- the URL, as a String
-
addHeader
Adds a HTTP header, which will be sent with the HTTP request to the health check URL.- Parameters:
name
- the name of the headervalue
- the value of the header
-
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
-
hashCode
public int hashCode()
-