com.vmware.vcenter.vm

Class ToolsTypes.UpgradePolicy

java.lang.Object

com.vmware.vapi.bindings.ApiEnumeration<ToolsTypes.UpgradePolicy>

com.vmware.vcenter.vm.ToolsTypes.UpgradePolicy

All Implemented Interfaces:

java.io.Serializable

Enclosing interface:

ToolsTypes

public static final class ToolsTypes.UpgradePolicy
extends ApiEnumeration<ToolsTypes.UpgradePolicy>

The UpgradePolicy enumeration class defines when Tools are auto-upgraded for a virtual machine. This enumeration was added in vSphere API 7.0.0.0.

See enumerated types description.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static ToolsTypes.UpgradePolicy	MANUAL No auto-upgrades for Tools will be performed for this virtual machine.
static ToolsTypes.UpgradePolicy	UPGRADE_AT_POWER_CYCLE When the virtual machine is power-cycled, the system checks for a newer version of Tools when the virtual machine is powered on.

Method Summary

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

MANUAL

public static final ToolsTypes.UpgradePolicy MANUAL

No auto-upgrades for Tools will be performed for this virtual machine. Users must manually invoke the Tools.upgrade(java.lang.String, java.lang.String) method to update Tools. This constant field was added in vSphere API 7.0.0.0.

UPGRADE_AT_POWER_CYCLE

public static final ToolsTypes.UpgradePolicy UPGRADE_AT_POWER_CYCLE

When the virtual machine is power-cycled, the system checks for a newer version of Tools when the virtual machine is powered on. If it is available, a Tools upgrade is automatically performed on the virtual machine and it is rebooted if necessary. This constant field was added in vSphere API 7.0.0.0.

Method Detail

values

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

Returns:

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

valueOf

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

The native Java enum is ToolsTypes.UpgradePolicy.Values.

Returns:

The Java enum constant. Never null.