com.vmware.vcenter

Class HostTypes.PowerState

java.lang.Object

com.vmware.vapi.bindings.ApiEnumeration<HostTypes.PowerState>

com.vmware.vcenter.HostTypes.PowerState

All Implemented Interfaces:

java.io.Serializable

Enclosing interface:

HostTypes

public static final class HostTypes.PowerState
extends ApiEnumeration<HostTypes.PowerState>

The PowerState enumeration class defines the power states of a host.

See enumerated types description.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HostTypes.PowerState.Values Native Java enum representing this enumeration class.

Field Summary

Fields

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.

Method Summary

Methods

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.

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

POWERED_ON

public static final HostTypes.PowerState POWERED_ON

The host is powered on. A host that is entering standby mode is also in this state.

POWERED_OFF

public static final HostTypes.PowerState POWERED_OFF

The host was specifically powered off by the user through vCenter server. This state is not a cetain state, because after vCenter server issues the command to power off the host, the host might crash, or kill all the processes but fail to power off.

STANDBY

public static final HostTypes.PowerState STANDBY

The host was specifically put in standby mode, either explicitly by the user, or automatically by DPM. This state is not a cetain state, because after VirtualCenter issues the command to put the host in standby state, the host might crash, or kill all the processes but fail to enter standby mode. A host that is exiting standby mode is also in this state.

Method Detail

values

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

Returns:

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

valueOf

public static HostTypes.PowerState 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 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.

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 HostTypes.PowerState.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 HostTypes.PowerState.Values._UNKNOWN enum constant is returned.

The native Java enum is HostTypes.PowerState.Values.

Returns:

The Java enum constant. Never null.