@Generated(value="OracleSDKGenerator",
comments="API Version: 20200501")
public final class HealthCheckerDetails
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
The health check policy configuration. For more information, see Editing Health Check
Policies.
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 HealthCheckerDetails.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set
fields into account. The constructor, on the other hand, does not take the explicitly set fields
into account (since the constructor cannot distinguish explicit null from unset null).
| Modifier and Type | Class and Description |
|---|---|
static class |
HealthCheckerDetails.Builder |
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and Description |
|---|
HealthCheckerDetails(HealthCheckProtocols protocol,
Integer port,
Integer retries,
Integer timeoutInMillis,
Integer intervalInMillis,
String urlPath,
String responseBodyRegex,
Integer returnCode,
byte[] requestData,
byte[] responseData,
DnsHealthCheckerDetails dns)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static HealthCheckerDetails.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
DnsHealthCheckerDetails |
getDns() |
Integer |
getIntervalInMillis()
The interval between health checks, in milliseconds.
|
Integer |
getPort()
The backend server port against which to run the health check.
|
HealthCheckProtocols |
getProtocol()
The protocol the health check must use; either HTTP or HTTPS, or UDP or TCP.
|
byte[] |
getRequestData()
Base64 encoded pattern to be sent as UDP or TCP health check probe.
|
String |
getResponseBodyRegex()
A regular expression for parsing the response body from the backend server.
|
byte[] |
getResponseData()
Base64 encoded pattern to be validated as UDP or TCP health check probe response.
|
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() |
HealthCheckerDetails.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"protocol","port","retries","timeoutInMillis","intervalInMillis","urlPath","responseBodyRegex","returnCode","requestData","responseData","dns"}) public HealthCheckerDetails(HealthCheckProtocols protocol, Integer port, Integer retries, Integer timeoutInMillis, Integer intervalInMillis, String urlPath, String responseBodyRegex, Integer returnCode, byte[] requestData, byte[] responseData, DnsHealthCheckerDetails dns)
public static HealthCheckerDetails.Builder builder()
Create a new builder.
public HealthCheckerDetails.Builder toBuilder()
public HealthCheckProtocols getProtocol()
The protocol the health check must use; either HTTP or HTTPS, or UDP or TCP.
Example: HTTP
public Integer getPort()
The backend server port against which to run the health check. If the port is not specified,
then the network load balancer uses the port information from the Backend object. The
port must be specified if the backend port is 0.
Example: 8080
public Integer getRetries()
The number of retries to attempt before a backend server is considered “unhealthy”. This number also applies when recovering a server to the “healthy” state. The default value is 3.
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. The default value is 3000 (3 seconds).
Example: 3000
public Integer getIntervalInMillis()
The interval between health checks, in milliseconds. The default value is 10000 (10 seconds).
Example: 10000
public String getUrlPath()
The path against which to run the health check.
Example: /healthcheck
public String getResponseBodyRegex()
A regular expression for parsing the response body from the backend server.
Example: ^((?!false).|\\s)*$
public Integer getReturnCode()
The status code a healthy backend server should return. If you configure the health check policy to use the HTTP protocol, then you can use common HTTP status codes such as “200”.
Example: 200
public byte[] getRequestData()
Base64 encoded pattern to be sent as UDP or TCP health check probe.
public byte[] getResponseData()
Base64 encoded pattern to be validated as UDP or TCP health check probe response.
public DnsHealthCheckerDetails getDns()
public String toString()
toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents - true to include the full contents of byte arrayspublic boolean equals(Object o)
equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic int hashCode()
hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelCopyright © 2016–2024. All rights reserved.