@Generated(value="OracleSDKGenerator",
comments="API Version: 20200501")
public final class UpdateHealthCheckerDetails
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
The configuration details of the health checker.
Note: Objects should always be created or deserialized using the UpdateHealthCheckerDetails.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 UpdateHealthCheckerDetails.Builder, which maintain a
set of all explicitly set fields called ExplicitlySetBmcModel.__explicitlySet__. The hashCode() and
equals(Object) methods are implemented to take ExplicitlySetBmcModel.__explicitlySet__ into account.
The constructor, on the other hand, does not set ExplicitlySetBmcModel.__explicitlySet__ (since the
constructor cannot distinguish explicit null from unset null).
| Modifier and Type | Class and Description |
|---|---|
static class |
UpdateHealthCheckerDetails.Builder |
| Constructor and Description |
|---|
UpdateHealthCheckerDetails(HealthCheckProtocols protocol,
Integer port,
Integer retries,
Integer timeoutInMillis,
Integer intervalInMillis,
String urlPath,
String responseBodyRegex,
Integer returnCode,
byte[] requestData,
byte[] responseData)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static UpdateHealthCheckerDetails.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
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 that the health check must use; either HTTP, 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() |
UpdateHealthCheckerDetails.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"}) public UpdateHealthCheckerDetails(HealthCheckProtocols protocol, Integer port, Integer retries, Integer timeoutInMillis, Integer intervalInMillis, String urlPath, String responseBodyRegex, Integer returnCode, byte[] requestData, byte[] responseData)
public static UpdateHealthCheckerDetails.Builder builder()
Create a new builder.
public UpdateHealthCheckerDetails.Builder toBuilder()
public HealthCheckProtocols getProtocol()
The protocol that the health check must use; either HTTP, UDP, or TCP.
Example: HTTP
public Integer getPort()
The backend server port against which to run the health check.
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.
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 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 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–2023. All rights reserved.