public static final class HostTypes.PowerState extends ApiEnumeration<HostTypes.PowerState>
PowerState
enumeration class defines the power states of a host.
Modifier and Type | Class and Description |
---|---|
static class |
HostTypes.PowerState.Values
Native Java
enum representing this enumeration class. |
Modifier and Type | Field and Description |
---|---|
static HostTypes.PowerState |
POWERED_OFF
The host was specifically powered off by the user through vCenter server.
|
static HostTypes.PowerState |
POWERED_ON
The host is powered on.
|
static HostTypes.PowerState |
STANDBY
The host was specifically put in standby mode, either explicitly by the user, or
automatically by DPM.
|
Modifier and Type | Method and Description |
---|---|
HostTypes.PowerState.Values |
getEnumValue()
Returns a native Java
enum constant representing this enumeration
constant. |
boolean |
isUnknown()
Checks if this enumeration constant is unknown.
|
static HostTypes.PowerState |
valueOf(java.lang.String name)
Returns the enumeration constant for the specified name.
|
static HostTypes.PowerState[] |
values()
Retrieve all enumeration constants pre-defined by this enumeration class.
|
buildNameMap, equals, hashCode, name, toString
public static final HostTypes.PowerState POWERED_ON
public static final HostTypes.PowerState POWERED_OFF
public static final HostTypes.PowerState STANDBY
public static HostTypes.PowerState[] values()
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 HostTypes.PowerState
but is not pre-defined.
null
.public static HostTypes.PowerState valueOf(java.lang.String 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 HostTypes.PowerState
will be returned for the
specified name, which will not be one of the pre-defined constant
instances. Such new instance maps to the HostTypes.PowerState.Values._UNKNOWN
enum
constant from the native Java enum
.
name
- The name of the constant to return. Must not be null
.null
.public boolean isUnknown()
valueOf(java.lang.String)
and values()
.true
if this constant is unknown, and false
otherwise.public HostTypes.PowerState.Values getEnumValue()
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 HostTypes.PowerState.Values._UNKNOWN
enum
constant is returned.
The native Java enum
is HostTypes.PowerState.Values
.
enum
constant. Never null
.