com.vmware.vcenter.ovf

Class DeploymentOptionParams

java.lang.Object

com.vmware.vcenter.ovf.DeploymentOptionParams

All Implemented Interfaces:

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

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

The DeploymentOptionParams class describes the possible deployment options as well as the choice provided by the user.

This information based on the ovf:DeploymentOptionSection.

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

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	DeploymentOptionParams() Default constructor.
protected	DeploymentOptionParams(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 DeploymentOptionParams	_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 DeploymentOptionParams	_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.util.List<DeploymentOption>	getDeploymentOptions() List of deployment options.
java.lang.String	getSelectedKey() The selected deployment option.
java.lang.String	getType() Unique identifier describing the type of the OVF parameters.
int	hashCode()
void	setDeploymentOptions(java.util.List<DeploymentOption> deploymentOptions) List of deployment options.
void	setSelectedKey(java.lang.String selectedKey) The selected deployment option.
void	setType(java.lang.String type) Unique identifier describing the type of the OVF parameters.
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

DeploymentOptionParams

public DeploymentOptionParams()

Default constructor.

DeploymentOptionParams

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

Method Detail

getDeploymentOptions

public java.util.List<DeploymentOption> getDeploymentOptions()

List of deployment options. This property corresponds to the ovf:Configuration elements of the ovf:DeploymentOptionSection in the specification. It is a discrete set of intended resource allocation configurations from which one can be selected. 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.

setDeploymentOptions

public void setDeploymentOptions(java.util.List<DeploymentOption> deploymentOptions)

List of deployment options. This property corresponds to the ovf:Configuration elements of the ovf:DeploymentOptionSection in the specification. It is a discrete set of intended resource allocation configurations from which one can be selected. 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:

deploymentOptions - New value for the property.

getSelectedKey

public java.lang.String getSelectedKey()

The selected deployment option. Identifies the DeploymentOption in the list in the getDeploymentOptions() property with a matching value in the DeploymentOption.getKey() property. This property is optional in the input parameters when deploying an OVF package. If null the server will use the default deployment configuration, usually it's the first one in getDeploymentOptions() List. This property is optional in the result when retrieving information about an OVF package. The value will be set only if it is specified with the optional ovf:default attribute.

Returns:

The current value of the property.

setSelectedKey

public void setSelectedKey(java.lang.String selectedKey)

The selected deployment option. Identifies the DeploymentOption in the list in the getDeploymentOptions() property with a matching value in the DeploymentOption.getKey() property. This property is optional in the input parameters when deploying an OVF package. If null the server will use the default deployment configuration, usually it's the first one in getDeploymentOptions() List. This property is optional in the result when retrieving information about an OVF package. The value will be set only if it is specified with the optional ovf:default attribute.

Parameters:

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

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 DeploymentOptionParams _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 DeploymentOptionParams _newInstance2(com.vmware.vapi.data.StructValue structValue)

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