Class HealthCheck
- All Implemented Interfaces:
Serializable
,Cloneable
Information about a health check.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
The number of consecutive health checks successes required before moving the instance to theHealthy
state.The approximate interval, in seconds, between health checks of an individual instance.The instance being checked.The amount of time, in seconds, during which no response means a failed health check.The number of consecutive health check failures required before moving the instance to theUnhealthy
state.int
hashCode()
void
setHealthyThreshold
(Integer healthyThreshold) The number of consecutive health checks successes required before moving the instance to theHealthy
state.void
setInterval
(Integer interval) The approximate interval, in seconds, between health checks of an individual instance.void
The instance being checked.void
setTimeout
(Integer timeout) The amount of time, in seconds, during which no response means a failed health check.void
setUnhealthyThreshold
(Integer unhealthyThreshold) The number of consecutive health check failures required before moving the instance to theUnhealthy
state.toString()
Returns a string representation of this object; useful for testing and debugging.withHealthyThreshold
(Integer healthyThreshold) The number of consecutive health checks successes required before moving the instance to theHealthy
state.withInterval
(Integer interval) The approximate interval, in seconds, between health checks of an individual instance.withTarget
(String target) The instance being checked.withTimeout
(Integer timeout) The amount of time, in seconds, during which no response means a failed health check.withUnhealthyThreshold
(Integer unhealthyThreshold) The number of consecutive health check failures required before moving the instance to theUnhealthy
state.
-
Constructor Details
-
HealthCheck
public HealthCheck()Default constructor for HealthCheck object. Callers should use the setter or fluent setter (with...) methods to initialize the object after creating it. -
HealthCheck
public HealthCheck(String target, Integer interval, Integer timeout, Integer unhealthyThreshold, Integer healthyThreshold) Constructs a new HealthCheck object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.- Parameters:
target
- The instance being checked. The protocol is either TCP, HTTP, HTTPS, or SSL. The range of valid ports is one (1) through 65535.TCP is the default, specified as a TCP: port pair, for example "TCP:5000". In this case, a health check simply attempts to open a TCP connection to the instance on the specified port. Failure to connect within the configured timeout is considered unhealthy.
SSL is also specified as SSL: port pair, for example, SSL:5000.
For HTTP/HTTPS, you must include a ping path in the string. HTTP is specified as a HTTP:port;/;PathToPing; grouping, for example "HTTP:80/weather/us/wa/seattle". In this case, a HTTP GET request is issued to the instance on the given port and path. Any answer other than "200 OK" within the timeout period is considered unhealthy.
The total length of the HTTP ping target must be 1024 16-bit Unicode characters or less.
interval
- The approximate interval, in seconds, between health checks of an individual instance.timeout
- The amount of time, in seconds, during which no response means a failed health check.This value must be less than the
Interval
value.unhealthyThreshold
- The number of consecutive health check failures required before moving the instance to theUnhealthy
state.healthyThreshold
- The number of consecutive health checks successes required before moving the instance to theHealthy
state.
-
-
Method Details
-
setTarget
The instance being checked. The protocol is either TCP, HTTP, HTTPS, or SSL. The range of valid ports is one (1) through 65535.
TCP is the default, specified as a TCP: port pair, for example "TCP:5000". In this case, a health check simply attempts to open a TCP connection to the instance on the specified port. Failure to connect within the configured timeout is considered unhealthy.
SSL is also specified as SSL: port pair, for example, SSL:5000.
For HTTP/HTTPS, you must include a ping path in the string. HTTP is specified as a HTTP:port;/;PathToPing; grouping, for example "HTTP:80/weather/us/wa/seattle". In this case, a HTTP GET request is issued to the instance on the given port and path. Any answer other than "200 OK" within the timeout period is considered unhealthy.
The total length of the HTTP ping target must be 1024 16-bit Unicode characters or less.
- Parameters:
target
- The instance being checked. The protocol is either TCP, HTTP, HTTPS, or SSL. The range of valid ports is one (1) through 65535.TCP is the default, specified as a TCP: port pair, for example "TCP:5000". In this case, a health check simply attempts to open a TCP connection to the instance on the specified port. Failure to connect within the configured timeout is considered unhealthy.
SSL is also specified as SSL: port pair, for example, SSL:5000.
For HTTP/HTTPS, you must include a ping path in the string. HTTP is specified as a HTTP:port;/;PathToPing; grouping, for example "HTTP:80/weather/us/wa/seattle". In this case, a HTTP GET request is issued to the instance on the given port and path. Any answer other than "200 OK" within the timeout period is considered unhealthy.
The total length of the HTTP ping target must be 1024 16-bit Unicode characters or less.
-
getTarget
The instance being checked. The protocol is either TCP, HTTP, HTTPS, or SSL. The range of valid ports is one (1) through 65535.
TCP is the default, specified as a TCP: port pair, for example "TCP:5000". In this case, a health check simply attempts to open a TCP connection to the instance on the specified port. Failure to connect within the configured timeout is considered unhealthy.
SSL is also specified as SSL: port pair, for example, SSL:5000.
For HTTP/HTTPS, you must include a ping path in the string. HTTP is specified as a HTTP:port;/;PathToPing; grouping, for example "HTTP:80/weather/us/wa/seattle". In this case, a HTTP GET request is issued to the instance on the given port and path. Any answer other than "200 OK" within the timeout period is considered unhealthy.
The total length of the HTTP ping target must be 1024 16-bit Unicode characters or less.
- Returns:
- The instance being checked. The protocol is either TCP, HTTP,
HTTPS, or SSL. The range of valid ports is one (1) through
65535.
TCP is the default, specified as a TCP: port pair, for example "TCP:5000". In this case, a health check simply attempts to open a TCP connection to the instance on the specified port. Failure to connect within the configured timeout is considered unhealthy.
SSL is also specified as SSL: port pair, for example, SSL:5000.
For HTTP/HTTPS, you must include a ping path in the string. HTTP is specified as a HTTP:port;/;PathToPing; grouping, for example "HTTP:80/weather/us/wa/seattle". In this case, a HTTP GET request is issued to the instance on the given port and path. Any answer other than "200 OK" within the timeout period is considered unhealthy.
The total length of the HTTP ping target must be 1024 16-bit Unicode characters or less.
-
withTarget
The instance being checked. The protocol is either TCP, HTTP, HTTPS, or SSL. The range of valid ports is one (1) through 65535.
TCP is the default, specified as a TCP: port pair, for example "TCP:5000". In this case, a health check simply attempts to open a TCP connection to the instance on the specified port. Failure to connect within the configured timeout is considered unhealthy.
SSL is also specified as SSL: port pair, for example, SSL:5000.
For HTTP/HTTPS, you must include a ping path in the string. HTTP is specified as a HTTP:port;/;PathToPing; grouping, for example "HTTP:80/weather/us/wa/seattle". In this case, a HTTP GET request is issued to the instance on the given port and path. Any answer other than "200 OK" within the timeout period is considered unhealthy.
The total length of the HTTP ping target must be 1024 16-bit Unicode characters or less.
- Parameters:
target
- The instance being checked. The protocol is either TCP, HTTP, HTTPS, or SSL. The range of valid ports is one (1) through 65535.TCP is the default, specified as a TCP: port pair, for example "TCP:5000". In this case, a health check simply attempts to open a TCP connection to the instance on the specified port. Failure to connect within the configured timeout is considered unhealthy.
SSL is also specified as SSL: port pair, for example, SSL:5000.
For HTTP/HTTPS, you must include a ping path in the string. HTTP is specified as a HTTP:port;/;PathToPing; grouping, for example "HTTP:80/weather/us/wa/seattle". In this case, a HTTP GET request is issued to the instance on the given port and path. Any answer other than "200 OK" within the timeout period is considered unhealthy.
The total length of the HTTP ping target must be 1024 16-bit Unicode characters or less.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setInterval
The approximate interval, in seconds, between health checks of an individual instance.
- Parameters:
interval
- The approximate interval, in seconds, between health checks of an individual instance.
-
getInterval
The approximate interval, in seconds, between health checks of an individual instance.
- Returns:
- The approximate interval, in seconds, between health checks of an individual instance.
-
withInterval
The approximate interval, in seconds, between health checks of an individual instance.
- Parameters:
interval
- The approximate interval, in seconds, between health checks of an individual instance.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setTimeout
The amount of time, in seconds, during which no response means a failed health check.
This value must be less than the
Interval
value.- Parameters:
timeout
- The amount of time, in seconds, during which no response means a failed health check.This value must be less than the
Interval
value.
-
getTimeout
The amount of time, in seconds, during which no response means a failed health check.
This value must be less than the
Interval
value.- Returns:
- The amount of time, in seconds, during which no response means a
failed health check.
This value must be less than the
Interval
value.
-
withTimeout
The amount of time, in seconds, during which no response means a failed health check.
This value must be less than the
Interval
value.- Parameters:
timeout
- The amount of time, in seconds, during which no response means a failed health check.This value must be less than the
Interval
value.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setUnhealthyThreshold
The number of consecutive health check failures required before moving the instance to the
Unhealthy
state.- Parameters:
unhealthyThreshold
- The number of consecutive health check failures required before moving the instance to theUnhealthy
state.
-
getUnhealthyThreshold
The number of consecutive health check failures required before moving the instance to the
Unhealthy
state.- Returns:
- The number of consecutive health check failures required before
moving the instance to the
Unhealthy
state.
-
withUnhealthyThreshold
The number of consecutive health check failures required before moving the instance to the
Unhealthy
state.- Parameters:
unhealthyThreshold
- The number of consecutive health check failures required before moving the instance to theUnhealthy
state.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setHealthyThreshold
The number of consecutive health checks successes required before moving the instance to the
Healthy
state.- Parameters:
healthyThreshold
- The number of consecutive health checks successes required before moving the instance to theHealthy
state.
-
getHealthyThreshold
The number of consecutive health checks successes required before moving the instance to the
Healthy
state.- Returns:
- The number of consecutive health checks successes required before
moving the instance to the
Healthy
state.
-
withHealthyThreshold
The number of consecutive health checks successes required before moving the instance to the
Healthy
state.- Parameters:
healthyThreshold
- The number of consecutive health checks successes required before moving the instance to theHealthy
state.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-