com.vmware.appliance.vmon

Class ServiceTypes.Health

java.lang.Object

com.vmware.vapi.bindings.ApiEnumeration<ServiceTypes.Health>

com.vmware.appliance.vmon.ServiceTypes.Health

All Implemented Interfaces:

Serializable

Enclosing interface:

ServiceTypes

public static final class ServiceTypes.Health
extends ApiEnumeration<ServiceTypes.Health>

The Health enumeration class defines the possible values for health of a service.

See enumerated types description.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ServiceTypes.Health.Values Native Java enum representing this enumeration class.

Field Summary

Fields

Modifier and Type	Field and Description
static ServiceTypes.Health	DEGRADED Service is in degraded state, it is not functional.
static ServiceTypes.Health	HEALTHY Service is in a healthy state and is fully functional.
static ServiceTypes.Health	HEALTHY_WITH_WARNINGS Service is healthy with warnings.

Method Summary

Methods

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

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

equals, hashCode, name, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

DEGRADED

public static final ServiceTypes.Health DEGRADED

Service is in degraded state, it is not functional.

HEALTHY

public static final ServiceTypes.Health HEALTHY

Service is in a healthy state and is fully functional.

HEALTHY_WITH_WARNINGS

public static final ServiceTypes.Health HEALTHY_WITH_WARNINGS

Service is healthy with warnings.

Method Detail

values

public static ServiceTypes.Health[] 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 ServiceTypes.Health but is not pre-defined.

Returns:

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

valueOf

public static ServiceTypes.Health valueOf(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 ServiceTypes.Health will be returned for the specified name, which will not be one of the pre-defined constant instances. Such new instance maps to the ServiceTypes.Health.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 ServiceTypes.Health.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 ServiceTypes.Health.Values._UNKNOWN enum constant is returned.

The native Java enum is ServiceTypes.Health.Values.

Returns:

The Java enum constant. Never null.