@Generated(value="OracleSDKGenerator",
comments="API Version: 20170115")
public final class HealthCheckerDetails
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
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 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(String protocol,
String urlPath,
Integer port,
Integer returnCode,
Integer retries,
Integer timeoutInMillis,
Integer intervalInMillis,
String responseBodyRegex,
Boolean isForcePlainText)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static HealthCheckerDetails.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
Integer |
getIntervalInMillis()
The interval between health checks, in milliseconds.
|
Boolean |
getIsForcePlainText()
Specifies if health checks should always be done using plain text instead of depending on
whether or not the associated backend set is using SSL.
|
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() |
HealthCheckerDetails.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"protocol","urlPath","port","returnCode","retries","timeoutInMillis","intervalInMillis","responseBodyRegex","isForcePlainText"}) public HealthCheckerDetails(String protocol, String urlPath, Integer port, Integer returnCode, Integer retries, Integer timeoutInMillis, Integer intervalInMillis, String responseBodyRegex, Boolean isForcePlainText)
public static HealthCheckerDetails.Builder builder()
Create a new builder.
public HealthCheckerDetails.Builder toBuilder()
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”. This number also applies when recovering a server to the “healthy” state.
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)*$
public Boolean getIsForcePlainText()
Specifies if health checks should always be done using plain text instead of depending on whether or not the associated backend set is using SSL.
If "true", health checks will be done using plain text even if the associated backend set is configured to use SSL.
If "false", health checks will be done using SSL encryption if the associated backend set is configured to use SSL. If the backend set is not so configured the health checks will be done using plain text.
Example: false
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.