Package com.oracle.bmc.networkloadbalancer.model

Class HealthCheckerDetails

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.networkloadbalancer.model.HealthCheckerDetails

@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 Network Load Balancer 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).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HealthCheckerDetails.Builder

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	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.

Method Summary

Modifier and Type	Method	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.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

HealthCheckerDetails

@Deprecated
@ConstructorProperties({"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)

Deprecated.

Method Detail

builder

public static HealthCheckerDetails.Builder builder()

Create a new builder.

toBuilder

public HealthCheckerDetails.Builder toBuilder()

getProtocol

public HealthCheckProtocols getProtocol()

The protocol the health check must use; either HTTP or HTTPS, or UDP or TCP.

Example: HTTP

Returns:

the value

getPort

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

Returns:

the value

getRetries

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

Returns:

the value

getTimeoutInMillis

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

Returns:

the value

getIntervalInMillis

public Integer getIntervalInMillis()

The interval between health checks, in milliseconds.

The default value is 10000 (10 seconds).

Example: 10000

Returns:

the value

getUrlPath

public String getUrlPath()

The path against which to run the health check.

Example: /healthcheck

Returns:

the value

getResponseBodyRegex

public String getResponseBodyRegex()

A regular expression for parsing the response body from the backend server.

Example: ^((?!false).|\\s)*$

Returns:

the value

getReturnCode

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

Returns:

the value

getRequestData

public byte[] getRequestData()

Base64 encoded pattern to be sent as UDP or TCP health check probe.

Returns:

the value

getResponseData

public byte[] getResponseData()

Base64 encoded pattern to be validated as UDP or TCP health check probe response.

Returns:

the value

getDns

public DnsHealthCheckerDetails getDns()

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel