com.vmware.vcenter.ovf

Class ExtraConfigParams

java.lang.Object

com.vmware.vcenter.ovf.ExtraConfigParams

All Implemented Interfaces:

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

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

The ExtraConfigParams class contains the parameters with information about the vmw:ExtraConfig elements in an OVF package.

vmw:ExtraConfig elements can be used to specify configuration settings that are transferred directly to the .vmx file.

The behavior of the vmw:ExtraConfig element is similar to the extraConfig property of the VirtualMachineConfigSpec object in the VMware vSphere API. Thus, the same restrictions apply, such as you cannot set values that could otherwise be set with other properties in the VirtualMachineConfigSpec object. See the VMware vSphere API reference for details on this.

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

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	ExtraConfigParams() Default constructor.
protected	ExtraConfigParams(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 ExtraConfigParams	_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 ExtraConfigParams	_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<java.lang.String>	getExcludeKeys() Specifies which extra configuration items in the List in the getExtraConfigs() field should be ignored during deployment.
java.util.List<ExtraConfig>	getExtraConfigs() List of vmw:ExtraConfig elements in the OVF package.
java.util.List<java.lang.String>	getIncludeKeys() Specifies which extra configuration items in the List in the getExtraConfigs() field should be included during deployment.
java.lang.String	getType() Unique identifier describing the type of the OVF parameters.
int	hashCode()
void	setExcludeKeys(java.util.List<java.lang.String> excludeKeys) Specifies which extra configuration items in the List in the getExtraConfigs() field should be ignored during deployment.
void	setExtraConfigs(java.util.List<ExtraConfig> extraConfigs) List of vmw:ExtraConfig elements in the OVF package.
void	setIncludeKeys(java.util.List<java.lang.String> includeKeys) Specifies which extra configuration items in the List in the getExtraConfigs() field should be included during deployment.
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

ExtraConfigParams

public ExtraConfigParams()

Default constructor.

ExtraConfigParams

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

Method Detail

getExtraConfigs

public java.util.List<ExtraConfig> getExtraConfigs()

List of vmw:ExtraConfig elements in the OVF package. This property is optional in the input parameters when deploying an OVF package. If null there are no extra configuration elements to use for this OVF package deployment. This property will always be present in the result when retrieving information about an OVF package. It will be an empty List if there are no extra configuration elements in the OVF package.

Returns:

The current value of the property.

setExtraConfigs

public void setExtraConfigs(java.util.List<ExtraConfig> extraConfigs)

List of vmw:ExtraConfig elements in the OVF package. This property is optional in the input parameters when deploying an OVF package. If null there are no extra configuration elements to use for this OVF package deployment. This property will always be present in the result when retrieving information about an OVF package. It will be an empty List if there are no extra configuration elements in the OVF package.

Parameters:

extraConfigs - New value for the property.

getExcludeKeys

public java.util.List<java.lang.String> getExcludeKeys()

Specifies which extra configuration items in the List in the getExtraConfigs() field should be ignored during deployment.

If set, the given keys for extra configurations will be ignored during deployment. The key is defined in the ExtraConfig.getKey() property.

This property is optional in the input parameters when deploying an OVF package. It is an error to set both this and getIncludeKeys(). This property is optional in the result when retrieving information about an OVF package. It is an error to set both this and getIncludeKeys().

Returns:

The current value of the property.

setExcludeKeys

public void setExcludeKeys(java.util.List<java.lang.String> excludeKeys)

Specifies which extra configuration items in the List in the getExtraConfigs() field should be ignored during deployment.

If set, the given keys for extra configurations will be ignored during deployment. The key is defined in the ExtraConfig.getKey() property.

This property is optional in the input parameters when deploying an OVF package. It is an error to set both this and getIncludeKeys(). This property is optional in the result when retrieving information about an OVF package. It is an error to set both this and getIncludeKeys().

Parameters:

excludeKeys - New value for the property.

getIncludeKeys

public java.util.List<java.lang.String> getIncludeKeys()

Specifies which extra configuration items in the List in the getExtraConfigs() field should be included during deployment.

If set, all but the given keys for extra configurations will be ignored during deployment. The key is defined in the ExtraConfig.getKey() property.

This property is optional in the input parameters when deploying an OVF package. It is an error to set both this and getExcludeKeys(). This property is optional in the result when retrieving information about an OVF package. It is an error to set both this and getExcludeKeys().

Returns:

The current value of the property.

setIncludeKeys

public void setIncludeKeys(java.util.List<java.lang.String> includeKeys)

Specifies which extra configuration items in the List in the getExtraConfigs() field should be included during deployment.

If set, all but the given keys for extra configurations will be ignored during deployment. The key is defined in the ExtraConfig.getKey() property.

This property is optional in the input parameters when deploying an OVF package. It is an error to set both this and getExcludeKeys(). This property is optional in the result when retrieving information about an OVF package. It is an error to set both this and getExcludeKeys().

Parameters:

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

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