Package com.oracle.bmc.networkloadbalancer.model

Class BackendSetHealth

java.lang.Object

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

com.oracle.bmc.networkloadbalancer.model.BackendSetHealth

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200501")
public final class BackendSetHealth
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

The health status details for a backend set.

This object does not explicitly enumerate backend servers with a status of OK. However, the backend sets are included in the totalBackendCount sum.
Note: Objects should always be created or deserialized using the BackendSetHealth.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 BackendSetHealth.Builder, which maintain a set of all explicitly set fields called BackendSetHealth.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	BackendSetHealth.Builder
static class	BackendSetHealth.Status	Overall health status of the backend set.

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
BackendSetHealth(BackendSetHealth.Status status, List<String> warningStateBackendNames, List<String> criticalStateBackendNames, List<String> unknownStateBackendNames, Integer totalBackendCount)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static BackendSetHealth.Builder	builder()	Create a new builder.
boolean	equals(Object o)
List<String>	getCriticalStateBackendNames()	A list of backend servers that are currently in the CRITICAL health state.
BackendSetHealth.Status	getStatus()	Overall health status of the backend set.
Integer	getTotalBackendCount()	The total number of backend servers in this backend set.
List<String>	getUnknownStateBackendNames()	A list of backend servers that are currently in the UNKNOWN health state.
List<String>	getWarningStateBackendNames()	A list of backend servers that are currently in the WARNING health state.
int	hashCode()
BackendSetHealth.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

BackendSetHealth

@Deprecated
@ConstructorProperties({"status","warningStateBackendNames","criticalStateBackendNames","unknownStateBackendNames","totalBackendCount"})
public BackendSetHealth(BackendSetHealth.Status status,
                        List<String> warningStateBackendNames,
                        List<String> criticalStateBackendNames,
                        List<String> unknownStateBackendNames,
                        Integer totalBackendCount)

Deprecated.

Method Detail

builder

public static BackendSetHealth.Builder builder()

Create a new builder.

toBuilder

public BackendSetHealth.Builder toBuilder()

getStatus

public BackendSetHealth.Status getStatus()

Overall health status of the backend set.

**OK:** All backend servers in the backend set return a status of OK.

**WARNING:** Half or more of the backend servers in a backend set return a status of OK and at least one backend server returns a status of WARNING, CRITICAL, or UNKNOWN.

**CRITICAL:** Fewer than half of the backend servers in a backend set return a status of OK.

**UNKNOWN:** If no probes have yet been sent to the backends, or the system is unable to retrieve metrics from the backends.

Returns:

the value

getWarningStateBackendNames

public List<String> getWarningStateBackendNames()

A list of backend servers that are currently in the WARNING health state.

The list identifies each backend server by IP address or OCID and port.

Example: 10.0.0.3:8080 or ocid1.privateip..oc1.<unique_ID>:8080

Returns:

the value

getCriticalStateBackendNames

public List<String> getCriticalStateBackendNames()

A list of backend servers that are currently in the CRITICAL health state.

The list identifies each backend server by IP address and port.

Example: 10.0.0.4:8080

Returns:

the value

getUnknownStateBackendNames

public List<String> getUnknownStateBackendNames()

A list of backend servers that are currently in the UNKNOWN health state.

The list identifies each backend server by IP address and port.

Example: 10.0.0.5:8080

Returns:

the value

getTotalBackendCount

public Integer getTotalBackendCount()

The total number of backend servers in this backend set.

Example: 7

Returns:

the value

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