com.vmware.vcenter.ovf

Class IpAllocationParams.IpAllocationPolicy

java.lang.Object

com.vmware.vapi.bindings.ApiEnumeration<IpAllocationParams.IpAllocationPolicy>

com.vmware.vcenter.ovf.IpAllocationParams.IpAllocationPolicy

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

IpAllocationParams

public static final class IpAllocationParams.IpAllocationPolicy
extends ApiEnumeration<IpAllocationParams.IpAllocationPolicy>

The IpAllocationPolicy enumeration class defines the possible IP allocation policy for a deployment.

See enumerated types description.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static IpAllocationParams.IpAllocationPolicy	DHCP Specifies that DHCP will be used to allocate IP addresses.
static IpAllocationParams.IpAllocationPolicy	STATIC_IPPOOL Specifies that IP addresses are allocated from the range managed by an IP pool.
static IpAllocationParams.IpAllocationPolicy	STATIC_MANUAL Specifies that IP addresses are configured manually upon deployment, and will be kept until reconfigured or the virtual appliance destroyed.
static IpAllocationParams.IpAllocationPolicy	TRANSIENT_IPPOOL Specifies that IP addresses are allocated from an IP pool.

Method Summary

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

DHCP

public static final IpAllocationParams.IpAllocationPolicy DHCP

Specifies that DHCP will be used to allocate IP addresses.

TRANSIENT_IPPOOL

public static final IpAllocationParams.IpAllocationPolicy TRANSIENT_IPPOOL

Specifies that IP addresses are allocated from an IP pool. The IP addresses are allocated when needed, typically at power-on, and deallocated during power-off. There is no guarantee that a property will receive same IP address when restarted.

STATIC_MANUAL

public static final IpAllocationParams.IpAllocationPolicy STATIC_MANUAL

Specifies that IP addresses are configured manually upon deployment, and will be kept until reconfigured or the virtual appliance destroyed. This ensures that a property gets a consistent IP for its lifetime.

STATIC_IPPOOL

public static final IpAllocationParams.IpAllocationPolicy STATIC_IPPOOL

Specifies that IP addresses are allocated from the range managed by an IP pool. The IP addresses are allocated at first power-on, and remain allocated at power-off. This ensures that a virtual appliance gets a consistent IP for its life-time.

Method Detail

values

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

Returns:

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

valueOf

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

The native Java enum is IpAllocationParams.IpAllocationPolicy.Values.

Returns:

The Java enum constant. Never null.