IpAllocationParams (vSphere Automation SDK for Java 7.0.1.0)

java.lang.Object
- com.vmware.vcenter.ovf.IpAllocationParams

All Implemented Interfaces:

StaticStructure, Structure, java.io.Serializable
```
public final class IpAllocationParams
extends java.lang.Object
implements java.io.Serializable, StaticStructure
```
The IpAllocationParams class specifies how IP addresses are allocated to OVF properties. In particular, it informs the deployment platform whether the guest supports IPv4, IPv6, or both. It also specifies whether the IP addresses can be obtained through DHCP or through the properties provided in the OVF environment.
Ovf Property elements are exposed to the guest software through the OVF environment. Each Property element exposed in the OVF environment shall be constructed from the value of the ovf:key attribute. A Property element contains a key/value pair, it may optionally specify type qualifiers using the ovf:qualifiers attribute with multiple qualifiers separated by commas.

The settings in IpAllocationParams class are global to a deployment. Thus, if a virtual machine is part of a virtual appliance, then its settings are ignored and the settings for the virtual appliance is used.

This information is based on the vmw:IpAssignmentSection in OVF package.

See LibraryItem.deploy(java.lang.String, java.lang.String, com.vmware.vcenter.ovf.LibraryItemTypes.DeploymentTarget, com.vmware.vcenter.ovf.LibraryItemTypes.ResourcePoolDeploymentSpec) and LibraryItem.filter(java.lang.String, com.vmware.vcenter.ovf.LibraryItemTypes.DeploymentTarget).

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`IpAllocationParams.Builder` Builder class for `IpAllocationParams`.
`static class`	`IpAllocationParams.IpAllocationPolicy` The `IpAllocationPolicy` enumeration class defines the possible IP allocation policy for a deployment.
`static class`	`IpAllocationParams.IpAllocationScheme` The `IpAllocationScheme` enumeration class defines the possible IP allocation schemes that can be supported by the guest software.
`static class`	`IpAllocationParams.IpProtocol` The `IpProtocol` enumeration class defines the IP protocols supported by the guest software.

Field Summary

Fields
Modifier and Type Field and Description

protected StructValue __dynamicStructureFields

Fields
Modifier and Type	Field and Description
`protected StructValue`	`__dynamicStructureFields`

Constructor Summary

Constructors
Modifier Constructor and Description

IpAllocationParams()
Default constructor.

protected IpAllocationParams(StructValue __dynamicStructureFields)

Constructors
Modifier	Constructor and Description
	`IpAllocationParams()` Default constructor.
`protected`	`IpAllocationParams(StructValue __dynamicStructureFields)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T extends Structure> T`	`_convertTo(java.lang.Class<T> clazz)` Converts this structure into an instance of the provided class structure if possible.
`java.lang.String`	`_getCanonicalName()` Returns the canonical name of the structure.
`static java.lang.String`	`_getCanonicalTypeName()` Returns the canonical type name.
`static com.vmware.vapi.bindings.type.StructType`	`_getClassType()` WARNING: Internal method, subject to change in future versions.
`StructValue`	`_getDataValue()` Returns this `Structure` represented in the dynamic `DataValue` model.
`DataValue`	`_getDynamicField(java.lang.String fieldName)` Get dynamic filed value.
`java.util.Set<java.lang.String>`	`_getDynamicFieldNames()` Get the names of the dynamic fields in the structure.
`com.vmware.vapi.bindings.type.StructType`	`_getType()` WARNING: Internal method, subject to change in future versions.
`boolean`	`_hasTypeNameOf(java.lang.Class<? extends Structure> clazz)` Checks if the runtime type name of this structure matches the type represented by the specified binding class.
`static IpAllocationParams`	`_newInstance(StructValue structValue)` WARNING: Internal method, subject to change in future versions. Returns new instance of this binding class and injects the provided data value. WARNING: The returned object is not fully initialized.
`static IpAllocationParams`	`_newInstance2(StructValue structValue)` WARNING: Internal method, subject to change in future versions. Serves as a versioning mechanism.
`void`	`_setDynamicField(java.lang.String fieldName, DataValue fieldValue)` Sets a dynamic field value.
`protected void`	`_updateDataValue(StructValue structValue)`
`void`	`_validate()` Validates the state of the discriminated unions and HasFieldsOf restrictions (if any) in this Java language binding `Structure`.
`boolean`	`equals(java.lang.Object obj)`
`IpAllocationParams.IpAllocationPolicy`	`getIpAllocationPolicy()` Specifies how IP allocation is done through an IP Pool.
`IpAllocationParams.IpProtocol`	`getIpProtocol()` Specifies the chosen IP protocol for this deployment.
`java.util.List<IpAllocationParams.IpAllocationScheme>`	`getSupportedAllocationScheme()` Specifies the IP allocation schemes supported by the guest software.
`java.util.List<IpAllocationParams.IpAllocationPolicy>`	`getSupportedIpAllocationPolicy()` Specifies the IP allocation policies supported.
`java.util.List<IpAllocationParams.IpProtocol>`	`getSupportedIpProtocol()` Specifies the IP protocols supported by the guest.
`java.lang.String`	`getType()` Unique identifier describing the type of the OVF parameters.
`int`	`hashCode()`
`void`	`setIpAllocationPolicy(IpAllocationParams.IpAllocationPolicy ipAllocationPolicy)` Specifies how IP allocation is done through an IP Pool.
`void`	`setIpProtocol(IpAllocationParams.IpProtocol ipProtocol)` Specifies the chosen IP protocol for this deployment.
`void`	`setSupportedAllocationScheme(java.util.List<IpAllocationParams.IpAllocationScheme> supportedAllocationScheme)` Specifies the IP allocation schemes supported by the guest software.
`void`	`setSupportedIpAllocationPolicy(java.util.List<IpAllocationParams.IpAllocationPolicy> supportedIpAllocationPolicy)` Specifies the IP allocation policies supported.
`void`	`setSupportedIpProtocol(java.util.List<IpAllocationParams.IpProtocol> supportedIpProtocol)` Specifies the IP protocols supported by the guest.
`void`	`setType(java.lang.String type)` Unique identifier describing the type of the OVF parameters.
`java.lang.String`	`toString()` Returns a string representation of this structure.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - __dynamicStructureFields
```
protected StructValue __dynamicStructureFields
```
- Constructor Detail
  - IpAllocationParams
```
public IpAllocationParams()
```
    Default constructor.
  - IpAllocationParams
```
protected IpAllocationParams(StructValue __dynamicStructureFields)
```
- Method Detail
  - getSupportedAllocationScheme
```
public java.util.List<IpAllocationParams.IpAllocationScheme> getSupportedAllocationScheme()
```
    Specifies the IP allocation schemes supported by the guest software. This property defines the valid values for the IP allocation policy. This setting is often configured by the virtual appliance template author or OVF package author to reflect what the guest software supports, and the IP allocation policy is configured at deployment time. See getIpAllocationPolicy(). This property is not used in the input parameters when deploying an OVF package. This property will always be present in the result when retrieving information about an OVF package.
    
    Returns:
    
    The current value of the property.
  - setSupportedAllocationScheme
```
public void setSupportedAllocationScheme(java.util.List<IpAllocationParams.IpAllocationScheme> supportedAllocationScheme)
```
    Specifies the IP allocation schemes supported by the guest software. This property defines the valid values for the IP allocation policy. This setting is often configured by the virtual appliance template author or OVF package author to reflect what the guest software supports, and the IP allocation policy is configured at deployment time. See getIpAllocationPolicy(). This property is not used in the input parameters when deploying an OVF package. This property will always be present in the result when retrieving information about an OVF package.
    
    Parameters:
    
    supportedAllocationScheme - New value for the property.
  - getSupportedIpAllocationPolicy
```
public java.util.List<IpAllocationParams.IpAllocationPolicy> getSupportedIpAllocationPolicy()
```
    Specifies the IP allocation policies supported. The set of valid options for the policy is based on the capabilities of the virtual appliance software, as specified by the getSupportedAllocationScheme() property. This property is not used in the input parameters when deploying an OVF package. This property will always be present in the result when retrieving information about an OVF package.
    
    Returns:
    
    The current value of the property.
  - setSupportedIpAllocationPolicy
```
public void setSupportedIpAllocationPolicy(java.util.List<IpAllocationParams.IpAllocationPolicy> supportedIpAllocationPolicy)
```
    Specifies the IP allocation policies supported. The set of valid options for the policy is based on the capabilities of the virtual appliance software, as specified by the getSupportedAllocationScheme() property. This property is not used in the input parameters when deploying an OVF package. This property will always be present in the result when retrieving information about an OVF package.
    
    Parameters:
    
    supportedIpAllocationPolicy - New value for the property.
  - getIpAllocationPolicy
```
public IpAllocationParams.IpAllocationPolicy getIpAllocationPolicy()
```
    Specifies how IP allocation is done through an IP Pool. This is typically specified by the deployer. This property is optional in the input parameters when deploying an OVF package. If null there is no IP allocation policy. This property will always be present in the result when retrieving information about an OVF package.
    
    Returns:
    
    The current value of the property.
  - setIpAllocationPolicy
```
public void setIpAllocationPolicy(IpAllocationParams.IpAllocationPolicy ipAllocationPolicy)
```
    Specifies how IP allocation is done through an IP Pool. This is typically specified by the deployer. This property is optional in the input parameters when deploying an OVF package. If null there is no IP allocation policy. This property will always be present in the result when retrieving information about an OVF package.
    
    Parameters:
    
    ipAllocationPolicy - New value for the property.
  - getSupportedIpProtocol
```
public java.util.List<IpAllocationParams.IpProtocol> getSupportedIpProtocol()
```
    Specifies the IP protocols supported by the guest. This property is not used in the input parameters when deploying an OVF package. This property will always be present in the result when retrieving information about an OVF package.
    
    Returns:
    
    The current value of the property.
  - setSupportedIpProtocol
```
public void setSupportedIpProtocol(java.util.List<IpAllocationParams.IpProtocol> supportedIpProtocol)
```
    Specifies the IP protocols supported by the guest. This property is not used in the input parameters when deploying an OVF package. This property will always be present in the result when retrieving information about an OVF package.
    
    Parameters:
    
    supportedIpProtocol - New value for the property.
  - getIpProtocol
```
public IpAllocationParams.IpProtocol getIpProtocol()
```
    Specifies the chosen IP protocol for this deployment. This must be one of the IP protocols supported by the guest software. See getSupportedIpProtocol(). This property is optional in the input parameters when deploying an OVF package. If null there is no IP protocol chosen. This property will always be present in the result when retrieving information about an OVF package.
    
    Returns:
    
    The current value of the property.
  - setIpProtocol
```
public void setIpProtocol(IpAllocationParams.IpProtocol ipProtocol)
```
    Specifies the chosen IP protocol for this deployment. This must be one of the IP protocols supported by the guest software. See getSupportedIpProtocol(). This property is optional in the input parameters when deploying an OVF package. If null there is no IP protocol chosen. This property will always be present in the result when retrieving information about an OVF package.
    
    Parameters:
    
    ipProtocol - New value for the property.
  - getType
```
public java.lang.String getType()
```
    Unique identifier describing the type of the OVF parameters. The value is the name of the OVF parameters class. This property must be provided in the input parameters when deploying an OVF package. This property will always be present in the result when retrieving information about an OVF package.
    
    Returns:
    
    The current value of the property.
  - setType
```
public void setType(java.lang.String type)
```
    Unique identifier describing the type of the OVF parameters. The value is the name of the OVF parameters class. This property must be provided in the input parameters when deploying an OVF package. This property will always be present in the result when retrieving information about an OVF package.
    
    Parameters:
    
    type - New value for the property.
  - _getType
```
public com.vmware.vapi.bindings.type.StructType _getType()
```
    Description copied from interface: StaticStructure
    
    WARNING: Internal method, subject to change in future versions. Returns StructType instance representing the static bindings type for this Structure.
    
    Specified by:
    
    _getType in interface StaticStructure
    
    Returns:
    
    the static bindings StructType
  - _getDataValue
```
public StructValue _getDataValue()
```
    Description copied from interface: Structure
    
    Returns this Structure represented in the dynamic DataValue model.
    Attempts to change the returned StructValue representation are not required to change the state of this structure. Actually the behavior is implementation dependent and is unspecified. In general the returned value shouldn't be changed.
    
    Specified by:
    
    _getDataValue in interface Structure
    
    Returns:
    
    StructValue representing this structure
  - _updateDataValue
```
protected void _updateDataValue(StructValue structValue)
```
  - _validate
```
public void _validate()
```
    Description copied from interface: StaticStructure
    
    Validates the state of the discriminated unions and HasFieldsOf restrictions (if any) in this Java language binding Structure.
    More precisely, for each union: given value of the discriminant/tag field (@UnionTag in the IDL) of an union in this structure, validates that:
  - all fields of the union required for that value of the discriminant are set
  - fields of the union that are not allowed for that value of the discriminant are not set
  - any other fields of the structure (not participating in the union) do not affect the validation result

Specified by:: _validate in interface StaticStructure

equals

public boolean equals(java.lang.Object obj)

Overrides:: equals in class java.lang.Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class java.lang.Object

toString
```
public java.lang.String toString()
```
Description copied from interface: StaticStructure

Returns a string representation of this structure. The result is pretty printed in order to be easy to read. It is intended to be used for different debugging/tracing purposes, e.g. dumping structures into logging traces.
In general no code should depend on the format of the resulting string. E.g. there must be no attempts to parse for re-creation of the original instance.

Specified by:

toString in interface StaticStructure

Overrides:

toString in class java.lang.Object

Returns:

a string representation of this static structure instance

_hasTypeNameOf
```
public boolean _hasTypeNameOf(java.lang.Class<? extends Structure> clazz)
```
Description copied from interface: Structure

Checks if the runtime type name of this structure matches the type represented by the specified binding class.
This can be used as efficient check to determine if this instance can be successfully converted to the target type.

Specified by:

_hasTypeNameOf in interface Structure

Parameters:

clazz - bindings class for the target structure; must not be null

Returns:

true if this structures type name matches exactly the specified class' type name.

_convertTo
```
public <T extends Structure> T _convertTo(java.lang.Class<T> clazz)
```
Description copied from interface: Structure

Converts this structure into an instance of the provided class structure if possible. A conversion will be possible if the requested structure's fields are all present in this structure.

Specified by:

_convertTo in interface Structure

Parameters:

clazz - type of the result structure. cannot be null.

Returns:

an instance of the requested type if conversion is possible. CoreException is thrown otherwise.

_setDynamicField
```
public void _setDynamicField(java.lang.String fieldName,
                             DataValue fieldValue)
```
Description copied from interface: StaticStructure

Sets a dynamic field value. The dynamic filed is extra filed that is not part of the static fields of the structure.

Specified by:

_setDynamicField in interface StaticStructure

Parameters:

fieldName - canonical name of the dynamic field to set

fieldValue - the value of the field

_getDynamicField
```
public DataValue _getDynamicField(java.lang.String fieldName)
```
Description copied from interface: StaticStructure

Get dynamic filed value. Works only on dynamic fields.

Specified by:

_getDynamicField in interface StaticStructure

Parameters:

fieldName - the canonical name of the dynamic field

Returns:

the DataValue of the dynamic field

_getDynamicFieldNames
```
public java.util.Set<java.lang.String> _getDynamicFieldNames()
```
Description copied from interface: StaticStructure

Get the names of the dynamic fields in the structure.

Specified by:

_getDynamicFieldNames in interface StaticStructure

Returns:

set of the canonical field names for the dynamic fields

_getClassType
```
public static com.vmware.vapi.bindings.type.StructType _getClassType()
```
WARNING: Internal method, subject to change in future versions.

Returns:

StructType instance representing the static bindings type for this Structure.

_getCanonicalName
```
public java.lang.String _getCanonicalName()
```
Description copied from interface: Structure

Returns the canonical name of the structure. By default the canonical name is derived from the fully-qualified IDL name by converting to lower case and inserting underscores between words. For example org.example.FooBar would turn into org.example.foo_bar.

Specified by:

_getCanonicalName in interface Structure

Returns:

canonical name

_getCanonicalTypeName
```
public static java.lang.String _getCanonicalTypeName()
```
Returns the canonical type name. See _getCanonicalName().

Returns:

canonical type name

_newInstance
```
public static IpAllocationParams _newInstance(StructValue structValue)
```
WARNING: Internal method, subject to change in future versions.
Returns new instance of this binding class and injects the provided data value.
WARNING: The returned object is not fully initialized.

Parameters:

structValue - the source of the data contained in the binding object. Could contain more data than fields of this class can describe i.e. newer version of the binding object. Could be null.

Returns:

the static bindings StructType

_newInstance2
```
public static IpAllocationParams _newInstance2(StructValue structValue)
```
WARNING: Internal method, subject to change in future versions.
Serves as a versioning mechanism.

Class IpAllocationParams

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

__dynamicStructureFields

Constructor Detail

IpAllocationParams

IpAllocationParams

Method Detail

getSupportedAllocationScheme

setSupportedAllocationScheme

getSupportedIpAllocationPolicy

setSupportedIpAllocationPolicy

getIpAllocationPolicy

setIpAllocationPolicy

getSupportedIpProtocol

setSupportedIpProtocol

getIpProtocol

setIpProtocol

getType

setType

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2