com.vmware.appliance

Class ServicesTypes.State

java.lang.Object

com.vmware.vapi.bindings.ApiEnumeration<ServicesTypes.State>

com.vmware.appliance.ServicesTypes.State

All Implemented Interfaces:

java.io.Serializable

Enclosing interface:

ServicesTypes

public static final class ServicesTypes.State
extends ApiEnumeration<ServicesTypes.State>

The State enumeration class defines valid Run State for services. This enumeration was added in vSphere API 6.7.

See enumerated types description.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ServicesTypes.State.Values Native Java enum representing this enumeration class.

Field Summary

Fields

Modifier and Type	Field and Description
static ServicesTypes.State	STARTED Service Run State is Started, it is fully functional.
static ServicesTypes.State	STARTING Service Run State is Starting, it is still not functional.
static ServicesTypes.State	STOPPED Service Run State is Stopped.
static ServicesTypes.State	STOPPING Service Run State is Stopping, it is not functional.

Method Summary

Methods

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

STARTING

public static final ServicesTypes.State STARTING

Service Run State is Starting, it is still not functional. This constant field was added in vSphere API 6.7.

STOPPING

public static final ServicesTypes.State STOPPING

Service Run State is Stopping, it is not functional. This constant field was added in vSphere API 6.7.

STARTED

public static final ServicesTypes.State STARTED

Service Run State is Started, it is fully functional. This constant field was added in vSphere API 6.7.

STOPPED

public static final ServicesTypes.State STOPPED

Service Run State is Stopped. This constant field was added in vSphere API 6.7.

Method Detail

values

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

Returns:

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

valueOf

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

The native Java enum is ServicesTypes.State.Values.

Returns:

The Java enum constant. Never null.