com.vmware.appliance.health

Class SystemTypes.HealthLevel

java.lang.Object

com.vmware.vapi.bindings.ApiEnumeration<SystemTypes.HealthLevel>

com.vmware.appliance.health.SystemTypes.HealthLevel

All Implemented Interfaces:

java.io.Serializable

Enclosing interface:

SystemTypes

public static final class SystemTypes.HealthLevel
extends ApiEnumeration<SystemTypes.HealthLevel>

HealthLevel enumeration class Defines health levels.

See enumerated types description.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SystemTypes.HealthLevel.Values Native Java enum representing this enumeration class.

Field Summary

Fields

Modifier and Type	Field and Description
static SystemTypes.HealthLevel	gray No health data is available for this service.
static SystemTypes.HealthLevel	green Service is healthy.
static SystemTypes.HealthLevel	orange The service health is degraded.
static SystemTypes.HealthLevel	red The service is unavaiable, not functioning properly, or will stop functioning soon.
static SystemTypes.HealthLevel	yellow The service is healthy state, but experiencing some levels of problems.

Method Summary

Modifier and Type	Method and Description
SystemTypes.HealthLevel.Values	getEnumValue() Returns a native Java enum constant representing this enumeration constant.
boolean	isUnknown() Checks if this enumeration constant is unknown.
static SystemTypes.HealthLevel	valueOf(java.lang.String name) Returns the enumeration constant for the specified name.
static SystemTypes.HealthLevel[]	values() Retrieve all enumeration constants pre-defined by this enumeration class.

Methods inherited from class com.vmware.vapi.bindings.ApiEnumeration

buildNameMap, equals, hashCode, name, toString

Methods inherited from class java.lang.Object

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

Field Detail

orange

public static final SystemTypes.HealthLevel orange

The service health is degraded. The service might have serious problems.

gray

public static final SystemTypes.HealthLevel gray

No health data is available for this service.

green

public static final SystemTypes.HealthLevel green

Service is healthy.

red

public static final SystemTypes.HealthLevel red

The service is unavaiable, not functioning properly, or will stop functioning soon.

yellow

public static final SystemTypes.HealthLevel yellow

The service is healthy state, but experiencing some levels of problems.

Method Detail

values

public static SystemTypes.HealthLevel[] values()

Retrieve all enumeration constants pre-defined by this enumeration class.

Additional instances might exist at runtime, for example to represent a new constant added to this enumeration class in subsequent version of the API. Such new constant is represented as instance of SystemTypes.HealthLevel but is not pre-defined.

Returns:

Array of all pre-defined enumeration constants. Never null.

valueOf

public static SystemTypes.HealthLevel valueOf(java.lang.String name)

Returns the enumeration constant for the specified name.

If the name matches exactly the identifier used to declare an enumeration constant from this enumeration class, the constant in question will be returned.

Otherwise, a new instance of SystemTypes.HealthLevel will be returned for the specified name, which will not be one of the pre-defined constant instances. Such new instance maps to the SystemTypes.HealthLevel.Values._UNKNOWN enum constant from the native Java enum.

Parameters:

name - The name of the constant to return. Must not be null.

Returns:

Enumeration constant for the specified name. Never null.

isUnknown

public boolean isUnknown()

Checks if this enumeration constant is unknown. Unknown is a constant that is not one of the pre-defined ones for this enumeration class. Also see valueOf(java.lang.String) and values().

Returns:

true if this constant is unknown, and false otherwise.

getEnumValue

public SystemTypes.HealthLevel.Values getEnumValue()

Returns a native Java enum constant representing this enumeration constant. The result is useful for usual handling of Java enum, for example it can be used in switch statements.

If this enumeration constant is unknown, then SystemTypes.HealthLevel.Values._UNKNOWN enum constant is returned.

The native Java enum is SystemTypes.HealthLevel.Values.

Returns:

The Java enum constant. Never null.