com.vmware.vcenter.ovf

Class ExtraConfigParams

java.lang.Object

com.vmware.vcenter.ovf.ExtraConfigParams

All Implemented Interfaces:

StaticStructure, Structure, Serializable

public final class ExtraConfigParams
extends Object
implements Serializable, 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

Constructor Summary

Constructors

Constructor and Description
ExtraConfigParams() Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
<T extends Structure> T	_convertTo(Class<T> clazz) Converts this structure into an instance of the provided class structure if possible.
String	_getCanonicalName() Returns the canonical name of the structure.
static String	_getCanonicalTypeName() Returns the canonical type name.
static StructType	_getClassType() WARNING: Internal API, subject to change in future versions.
StructValue	_getDataValue() Returns this Structure represented in the dynamic DataValue model.
DataValue	_getDynamicField(String fieldName) Get dynamic filed value.
Set<String>	_getDynamicFieldNames() Get the names of the dynamic fields in the structure.
StructType	_getType() WARNING: Internal API, subject to change in future versions.
boolean	_hasTypeNameOf(Class<? extends Structure> clazz) Checks that the runtime type name matches the type name from the binding class.
static ExtraConfigParams	_newInstance(StructValue structValue) WARNING: Internal API, 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.
void	_setDynamicField(String fieldName, DataValue fieldValue) Sets a dynamic field value.
void	_validate() Validates the state of the discriminated unions and HasFieldsOf restrictions (if any) in this Java language binding Structure.
boolean	equals(Object obj)
List<String>	getExcludeKeys() Specifies which extra configuration items in the List in the getExtraConfigs() field should be ignored during deployment.
List<ExtraConfig>	getExtraConfigs() List of vmw:ExtraConfig elements in the OVF package.
List<String>	getIncludeKeys() Specifies which extra configuration items in the List in the getExtraConfigs() field should be included during deployment.
String	getType() Unique identifier describing the type of the OVF parameters.
int	hashCode()
void	setExcludeKeys(List<String> excludeKeys) Specifies which extra configuration items in the List in the getExtraConfigs() field should be ignored during deployment.
void	setExtraConfigs(List<ExtraConfig> extraConfigs) List of vmw:ExtraConfig elements in the OVF package.
void	setIncludeKeys(List<String> includeKeys) Specifies which extra configuration items in the List in the getExtraConfigs() field should be included during deployment.
void	setType(String type) Unique identifier describing the type of the OVF parameters.
String	toString() Returns a string representation of this structure.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ExtraConfigParams

public ExtraConfigParams()

Default constructor.

Method Detail

getExtraConfigs

public 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(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 List<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(List<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 List<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(List<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 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(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 StructType _getType()

Description copied from interface: StaticStructure

WARNING: Internal API, 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

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

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public 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 Object

Returns:

a string representation of this static structure instance

_hasTypeNameOf

public boolean _hasTypeNameOf(Class<? extends Structure> clazz)

Description copied from interface: Structure

Checks that the runtime type name matches the type name from the binding class.

Specified by:

_hasTypeNameOf in interface Structure

Parameters:

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

Returns:

true if this structures type name matches exactly the provided class type name.

_convertTo

public <T extends Structure> T _convertTo(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(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(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 Set<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 StructType _getClassType()

WARNING: Internal API, subject to change in future versions.

Returns:

StructType instance representing the static bindings type for this Structure.

_getCanonicalName

public 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 String _getCanonicalTypeName()

Returns the canonical type name. See _getCanonicalName().

Returns:

canonical type name

_newInstance

public static ExtraConfigParams _newInstance(StructValue structValue)

WARNING: Internal API, 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