com.vmware.vcenter.ovf

Class DeploymentOption

java.lang.Object

com.vmware.vcenter.ovf.DeploymentOption

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable

public final class DeploymentOption
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure

The DeploymentOption class contains the information about a deployment option as defined in the OVF specification.

This corresponds to the ovf:Configuration element of the ovf:DeploymentOptionSection in the specification. The ovf:DeploymentOptionSection specifies a discrete set of intended resource allocation configurations. This class represents one item from that set.

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	DeploymentOption.Builder Builder class for DeploymentOption.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.vmware.vapi.data.StructValue	__dynamicStructureFields

Constructor Summary

Constructors

Modifier	Constructor and Description
	DeploymentOption() Default constructor.
protected	DeploymentOption(com.vmware.vapi.data.StructValue __dynamicStructureFields)

Method Summary

Modifier and Type	Method and Description
<T extends com.vmware.vapi.bindings.Structure> T	_convertTo(java.lang.Class<T> clazz)
java.lang.String	_getCanonicalName()
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.
com.vmware.vapi.data.StructValue	_getDataValue()
com.vmware.vapi.data.DataValue	_getDynamicField(java.lang.String fieldName)
java.util.Set<java.lang.String>	_getDynamicFieldNames()
com.vmware.vapi.bindings.type.StructType	_getType()
boolean	_hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)
static DeploymentOption	_newInstance(com.vmware.vapi.data.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 DeploymentOption	_newInstance2(com.vmware.vapi.data.StructValue structValue) WARNING: Internal method, subject to change in future versions. Serves as a versioning mechanism.
void	_setDynamicField(java.lang.String fieldName, com.vmware.vapi.data.DataValue fieldValue)
protected void	_updateDataValue(com.vmware.vapi.data.StructValue structValue)
void	_validate()
boolean	equals(java.lang.Object obj)
java.lang.Boolean	getDefaultChoice() A boolean flag indicates whether this deployment option is the default choice.
java.lang.String	getDescription() A localizable description for the deployment option.
java.lang.String	getKey() The key of the deployment option, corresponding to the ovf:id attribute in the OVF descriptor.
java.lang.String	getLabel() A localizable label for the deployment option.
int	hashCode()
void	setDefaultChoice(java.lang.Boolean defaultChoice) A boolean flag indicates whether this deployment option is the default choice.
void	setDescription(java.lang.String description) A localizable description for the deployment option.
void	setKey(java.lang.String key) The key of the deployment option, corresponding to the ovf:id attribute in the OVF descriptor.
void	setLabel(java.lang.String label) A localizable label for the deployment option.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

__dynamicStructureFields

protected com.vmware.vapi.data.StructValue __dynamicStructureFields

Constructor Detail

DeploymentOption

public DeploymentOption()

Default constructor.

DeploymentOption

protected DeploymentOption(com.vmware.vapi.data.StructValue __dynamicStructureFields)

Method Detail

getKey

public java.lang.String getKey()

The key of the deployment option, corresponding to the ovf:id attribute in the OVF descriptor. 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.

setKey

public void setKey(java.lang.String key)

The key of the deployment option, corresponding to the ovf:id attribute in the OVF descriptor. 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:

key - New value for the property.

getLabel

public java.lang.String getLabel()

A localizable label for the deployment option. 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.

setLabel

public void setLabel(java.lang.String label)

A localizable label for the deployment option. 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:

label - New value for the property.

getDescription

public java.lang.String getDescription()

A localizable description for the deployment option. 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.

setDescription

public void setDescription(java.lang.String description)

A localizable description for the deployment option. 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:

description - New value for the property.

getDefaultChoice

public java.lang.Boolean getDefaultChoice()

A boolean flag indicates whether this deployment option is the default choice. This property is not used in the input parameters when deploying an OVF package. This property is optional in the result when retrieving information about an OVF package. If null or false, it is not the default.

Returns:

The current value of the property.

setDefaultChoice

public void setDefaultChoice(java.lang.Boolean defaultChoice)

A boolean flag indicates whether this deployment option is the default choice. This property is not used in the input parameters when deploying an OVF package. This property is optional in the result when retrieving information about an OVF package. If null or false, it is not the default.

Parameters:

defaultChoice - New value for the property.

_getType

public com.vmware.vapi.bindings.type.StructType _getType()

Specified by:

_getType in interface com.vmware.vapi.bindings.StaticStructure

_getDataValue

public com.vmware.vapi.data.StructValue _getDataValue()

Specified by:

_getDataValue in interface com.vmware.vapi.bindings.Structure

_updateDataValue

protected void _updateDataValue(com.vmware.vapi.data.StructValue structValue)

_validate

public void _validate()

Specified by:

_validate in interface com.vmware.vapi.bindings.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()

Specified by:

toString in interface com.vmware.vapi.bindings.StaticStructure

Overrides:

toString in class java.lang.Object

_hasTypeNameOf

public boolean _hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)

Specified by:

_hasTypeNameOf in interface com.vmware.vapi.bindings.Structure

_convertTo

public <T extends com.vmware.vapi.bindings.Structure> T _convertTo(java.lang.Class<T> clazz)

Specified by:

_convertTo in interface com.vmware.vapi.bindings.Structure

_setDynamicField

public void _setDynamicField(java.lang.String fieldName,
                             com.vmware.vapi.data.DataValue fieldValue)

Specified by:

_setDynamicField in interface com.vmware.vapi.bindings.StaticStructure

_getDynamicField

public com.vmware.vapi.data.DataValue _getDynamicField(java.lang.String fieldName)

Specified by:

_getDynamicField in interface com.vmware.vapi.bindings.StaticStructure

_getDynamicFieldNames

public java.util.Set<java.lang.String> _getDynamicFieldNames()

Specified by:

_getDynamicFieldNames in interface com.vmware.vapi.bindings.StaticStructure

_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()

Specified by:

_getCanonicalName in interface com.vmware.vapi.bindings.Structure

_getCanonicalTypeName

public static java.lang.String _getCanonicalTypeName()

Returns the canonical type name. See _getCanonicalName().

Returns:

canonical type name

_newInstance

public static DeploymentOption _newInstance(com.vmware.vapi.data.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 DeploymentOption _newInstance2(com.vmware.vapi.data.StructValue structValue)

WARNING: Internal method, subject to change in future versions.
Serves as a versioning mechanism.