com.vmware.esx.settings.clusters.configuration

Class DocumentStructure

java.lang.Object

com.vmware.vapi.bindings.ApiEnumeration<DocumentStructure>

com.vmware.esx.settings.clusters.configuration.DocumentStructure

All Implemented Interfaces:

java.io.Serializable

public final class DocumentStructure
extends ApiEnumeration<DocumentStructure>

The DocumentStructure enumeration class contains the possible structures of the configuration document. Warning: This enumeration is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

See enumerated types description.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static DocumentStructure	HOST_ORIENTED The host-specific portions of the document are stored in the "host-specific" object at the top-level with entries for each host, organized by the host's BIOS UUID.
static DocumentStructure	PROFILE_ORIENTED The host-specific portions of the document are distributed through the "profile" object hierarchy.

Method Summary

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

HOST_ORIENTED

public static final DocumentStructure HOST_ORIENTED

The host-specific portions of the document are stored in the "host-specific" object at the top-level with entries for each host, organized by the host's BIOS UUID. Warning: This constant field is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

PROFILE_ORIENTED

public static final DocumentStructure PROFILE_ORIENTED

The host-specific portions of the document are distributed through the "profile" object hierarchy. Each property that is host-specific will be an object with entries for each host where the property is defined. The hosts in the object are organized by BIOS UUID. Warning: This constant field is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Method Detail

values

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

Returns:

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

valueOf

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

The native Java enum is DocumentStructure.Values.

Returns:

The Java enum constant. Never null.