@Generated(value="OracleSDKGenerator", comments="API Version: 20170115") public final class HealthCheckerDetails extends Object
The health check policy’s configuration details.
Note: Objects should always be created or deserialized using the HealthCheckerDetails.Builder
. This model distinguishes fields that are null
because they are unset from fields that are explicitly set to null
. This is done in the setter methods of the HealthCheckerDetails.Builder
, which maintain a set of all explicitly set fields called __explicitlySet__
. The hashCode()
and equals(Object)
methods are implemented to take __explicitlySet__
into account. The constructor, on the other hand, does not set __explicitlySet__
(since the constructor cannot distinguish explicit null
from unset null
).
Modifier and Type | Class and Description |
---|---|
static class |
HealthCheckerDetails.Builder |
Constructor and Description |
---|
HealthCheckerDetails(String protocol,
String urlPath,
Integer port,
Integer returnCode,
Integer retries,
Integer timeoutInMillis,
Integer intervalInMillis,
String responseBodyRegex)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
static HealthCheckerDetails.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
Set<String> |
get__explicitlySet__() |
Integer |
getIntervalInMillis()
The interval between health checks, in milliseconds.
|
Integer |
getPort()
The backend server port against which to run the health check.
|
String |
getProtocol()
The protocol the health check must use; either HTTP or TCP.
|
String |
getResponseBodyRegex()
A regular expression for parsing the response body from the backend server.
|
Integer |
getRetries()
The number of retries to attempt before a backend server is considered "unhealthy".
|
Integer |
getReturnCode()
The status code a healthy backend server should return.
|
Integer |
getTimeoutInMillis()
The maximum time, in milliseconds, to wait for a reply to a health check.
|
String |
getUrlPath()
The path against which to run the health check.
|
int |
hashCode() |
String |
toString() |
@ConstructorProperties(value={"protocol","urlPath","port","returnCode","retries","timeoutInMillis","intervalInMillis","responseBodyRegex"}) @Deprecated public HealthCheckerDetails(String protocol, String urlPath, Integer port, Integer returnCode, Integer retries, Integer timeoutInMillis, Integer intervalInMillis, String responseBodyRegex)
public static HealthCheckerDetails.Builder builder()
Create a new builder.
public String getProtocol()
The protocol the health check must use; either HTTP or TCP.
Example: HTTP
public String getUrlPath()
The path against which to run the health check.
Example: /healthcheck
public Integer getPort()
The backend server port against which to run the health check. If the port is not specified, the load balancer uses the port information from the Backend
object.
Example: 8080
public Integer getReturnCode()
The status code a healthy backend server should return.
Example: 200
public Integer getRetries()
The number of retries to attempt before a backend server is considered "unhealthy".
Example: 3
public Integer getTimeoutInMillis()
The maximum time, in milliseconds, to wait for a reply to a health check. A health check is successful only if a reply returns within this timeout period.
Example: 3000
public Integer getIntervalInMillis()
The interval between health checks, in milliseconds.
Example: 10000
public String getResponseBodyRegex()
A regular expression for parsing the response body from the backend server.
Example: ^((?!false).|\\s)*$
Copyright © 2016–2019. All rights reserved.