com.vmware.vcenter

Class HostTypes.ConnectionState

java.lang.Object

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

com.vmware.vcenter.HostTypes.ConnectionState

All Implemented Interfaces:

Serializable

Enclosing interface:

HostTypes

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

The ConnectionState enumeration class defines the connection status 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.ConnectionState.Values Native Java enum representing this enumeration class.

Field Summary

Fields

Modifier and Type	Field and Description
static HostTypes.ConnectionState	CONNECTED Host is connected to the vCenter Server
static HostTypes.ConnectionState	DISCONNECTED Host is disconnected from the vCenter Server
static HostTypes.ConnectionState	NOT_RESPONDING VirtualCenter is not receiving heartbeats from the server.

Method Summary

Methods

Modifier and Type	Method and Description
HostTypes.ConnectionState.Values	getEnumValue() Returns a native Java enum constant representing this enumeration constant.
boolean	isUnknown() Checks if this enumeration constant is unknown.
static HostTypes.ConnectionState	valueOf(String name) Returns the enumeration constant for the specified name.
static HostTypes.ConnectionState[]	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

CONNECTED

public static final HostTypes.ConnectionState CONNECTED

Host is connected to the vCenter Server

DISCONNECTED

public static final HostTypes.ConnectionState DISCONNECTED

Host is disconnected from the vCenter Server

NOT_RESPONDING

public static final HostTypes.ConnectionState NOT_RESPONDING

VirtualCenter is not receiving heartbeats from the server. The state automatically changes to connected once heartbeats are received again.

Method Detail

values

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

Returns:

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

valueOf

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

The native Java enum is HostTypes.ConnectionState.Values.

Returns:

The Java enum constant. Never null.