Package com.oracle.bmc.networkloadbalancer.model

Class NetworkLoadBalancerHealth

java.lang.Object

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

com.oracle.bmc.networkloadbalancer.model.NetworkLoadBalancerHealth

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

The health status details for the specified network load balancer.

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

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
NetworkLoadBalancerHealth(NetworkLoadBalancerHealth.Status status, List<String> warningStateBackendSetNames, List<String> criticalStateBackendSetNames, List<String> unknownStateBackendSetNames, Integer totalBackendSetCount)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static NetworkLoadBalancerHealth.Builder	builder()	Create a new builder.
boolean	equals(Object o)
List<String>	getCriticalStateBackendSetNames()	A list of backend sets that are currently in the CRITICAL health state.
NetworkLoadBalancerHealth.Status	getStatus()	The overall health status of the network load balancer.
Integer	getTotalBackendSetCount()	The total number of backend sets associated with this network load balancer.
List<String>	getUnknownStateBackendSetNames()	A list of backend sets that are currently in the UNKNOWN health state.
List<String>	getWarningStateBackendSetNames()	A list of backend sets that are currently in the WARNING health state.
int	hashCode()
NetworkLoadBalancerHealth.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

NetworkLoadBalancerHealth

@Deprecated
@ConstructorProperties({"status","warningStateBackendSetNames","criticalStateBackendSetNames","unknownStateBackendSetNames","totalBackendSetCount"})
public NetworkLoadBalancerHealth(NetworkLoadBalancerHealth.Status status,
                                 List<String> warningStateBackendSetNames,
                                 List<String> criticalStateBackendSetNames,
                                 List<String> unknownStateBackendSetNames,
                                 Integer totalBackendSetCount)

Deprecated.

Method Detail

builder

public static NetworkLoadBalancerHealth.Builder builder()

Create a new builder.

toBuilder

public NetworkLoadBalancerHealth.Builder toBuilder()

getStatus

public NetworkLoadBalancerHealth.Status getStatus()

The overall health status of the network load balancer.

**OK:** All backend sets associated with the network load balancer return a status of OK.

**WARNING:** At least one of the backend sets associated with the network load balancer returns a status of WARNING, no backend sets return a status of CRITICAL, and the network load balancer life cycle state is ACTIVE.

**CRITICAL:** One or more of the backend sets associated with the network load balancer return a status of CRITICAL.

**UNKNOWN:** If any one of the following conditions is true:

The network load balancer life cycle state is not ACTIVE.

No backend sets are defined for the network load balancer.

More than half of the backend sets associated with the network load balancer return a status of UNKNOWN, none of the backend sets return a status of WARNING or CRITICAL, and the network load balancer life cycle state is ACTIVE.

The system could not retrieve metrics for any reason.

Returns:

the value

getWarningStateBackendSetNames

public List<String> getWarningStateBackendSetNames()

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

The list identifies each backend set by the user-friendly name you assigned when you created the backend set.

Example: example_backend_set3

Returns:

the value

getCriticalStateBackendSetNames

public List<String> getCriticalStateBackendSetNames()

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

The list identifies each backend set by the user-friendly name you assigned when you created the backend set.

Example: example_backend_set

Returns:

the value

getUnknownStateBackendSetNames

public List<String> getUnknownStateBackendSetNames()

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

The list identifies each backend set by the user-friendly name you assigned when you created the backend set.

Example: example_backend_set2

Returns:

the value

getTotalBackendSetCount

public Integer getTotalBackendSetCount()

The total number of backend sets associated with this network load balancer.

Example: 4

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