com.vmware.content.type.ovf

Class OvfTemplate

java.lang.Object

com.vmware.content.type.ovf.OvfTemplate

All Implemented Interfaces:

StaticStructure, Structure, java.io.Serializable

public final class OvfTemplate
extends java.lang.Object
implements java.io.Serializable, StaticStructure

Provides extra information about a library item of type "ovf".

An OVF library item is the basic building block for instantiating virtual machines from content library. It may contain one or multiple virtual machine templates. This structure provides a rich view of the virtual machines within the ovf container as well as information about to the ovf descriptor associated with the library item

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OvfTemplate.Builder Builder class for OvfTemplate.

Field Summary

Fields

Modifier and Type	Field and Description
protected StructValue	__dynamicStructureFields

Constructor Summary

Constructors

Modifier	Constructor and Description
	OvfTemplate() Default constructor.
protected	OvfTemplate(StructValue __dynamicStructureFields)

Method Summary

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 OvfTemplate	_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 OvfTemplate	_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)
java.lang.String	getId() Library item id.
boolean	getIsVappTemplate() True if this is a vApp template, otherwise this is a VM template.
java.lang.String	getLibraryIdParent() The identifier of the LibraryModel to which this item belongs.
java.util.List<Network>	getNetworks() networks in this OVF template
java.util.List<StoragePolicyGroup>	getStoragePolicyGroups() Storage policy groups for disks, virtual machines and/or virtual machine collections.
VAppTemplate	getVappTemplate() The root VApp template in this OVF template if this is a vApp template An OVF template does not require a vApp template.
java.lang.String	getVersion() A version number indicating the generation of the OvfTemplate
long	getVmCount() Number of virtual machines in the the ovf template.
VmTemplate	getVmTemplate() The Vitrual Machine if this is a VM template An OVF template does not require a VM template.
int	hashCode()
void	setId(java.lang.String id) Library item id.
void	setIsVappTemplate(boolean isVappTemplate) True if this is a vApp template, otherwise this is a VM template.
void	setLibraryIdParent(java.lang.String libraryIdParent) The identifier of the LibraryModel to which this item belongs.
void	setNetworks(java.util.List<Network> networks) networks in this OVF template
void	setStoragePolicyGroups(java.util.List<StoragePolicyGroup> storagePolicyGroups) Storage policy groups for disks, virtual machines and/or virtual machine collections.
void	setVappTemplate(VAppTemplate vappTemplate) The root VApp template in this OVF template if this is a vApp template An OVF template does not require a vApp template.
void	setVersion(java.lang.String version) A version number indicating the generation of the OvfTemplate
void	setVmCount(long vmCount) Number of virtual machines in the the ovf template.
void	setVmTemplate(VmTemplate vmTemplate) The Vitrual Machine if this is a VM template An OVF template does not require a VM template.
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

OvfTemplate

public OvfTemplate()

Default constructor.

OvfTemplate

protected OvfTemplate(StructValue __dynamicStructureFields)

Method Detail

getId

public java.lang.String getId()

Library item id.

Returns:

The current value of the property. When clients pass a value of this class as a parameter, the property must be an identifier for the resource type: com.vmware.content.library.Item. When methods return a value of this class as a return value, the property will be an identifier for the resource type: com.vmware.content.library.Item.

setId

public void setId(java.lang.String id)

Library item id.

Parameters:

id - New value for the property. When clients pass a value of this class as a parameter, the property must be an identifier for the resource type: com.vmware.content.library.Item. When methods return a value of this class as a return value, the property will be an identifier for the resource type: com.vmware.content.library.Item.

getVmCount

public long getVmCount()

Number of virtual machines in the the ovf template.

Returns:

The current value of the property.

setVmCount

public void setVmCount(long vmCount)

Number of virtual machines in the the ovf template.

Parameters:

vmCount - New value for the property.

getVersion

public java.lang.String getVersion()

A version number indicating the generation of the OvfTemplate

This value is incremented every time OvfTemplate changes.

Returns:

The current value of the property.

setVersion

public void setVersion(java.lang.String version)

A version number indicating the generation of the OvfTemplate

This value is incremented every time OvfTemplate changes.

Parameters:

version - New value for the property.

getLibraryIdParent

public java.lang.String getLibraryIdParent()

The identifier of the LibraryModel to which this item belongs. This is used to set the parent of the ovf template for permission propagation.

Returns:

The current value of the property. When clients pass a value of this class as a parameter, the property must be an identifier for the resource type: com.vmware.content.Library. When methods return a value of this class as a return value, the property will be an identifier for the resource type: com.vmware.content.Library.

setLibraryIdParent

public void setLibraryIdParent(java.lang.String libraryIdParent)

The identifier of the LibraryModel to which this item belongs. This is used to set the parent of the ovf template for permission propagation.

Parameters:

libraryIdParent - New value for the property. When clients pass a value of this class as a parameter, the property must be an identifier for the resource type: com.vmware.content.Library. When methods return a value of this class as a return value, the property will be an identifier for the resource type: com.vmware.content.Library.

getIsVappTemplate

public boolean getIsVappTemplate()

True if this is a vApp template, otherwise this is a VM template.

Returns:

The current value of the property.

setIsVappTemplate

public void setIsVappTemplate(boolean isVappTemplate)

True if this is a vApp template, otherwise this is a VM template.

Parameters:

isVappTemplate - New value for the property.

getVmTemplate

public VmTemplate getVmTemplate()

The Vitrual Machine if this is a VM template An OVF template does not require a VM template.

Returns:

The current value of the property.

setVmTemplate

public void setVmTemplate(VmTemplate vmTemplate)

The Vitrual Machine if this is a VM template An OVF template does not require a VM template.

Parameters:

vmTemplate - New value for the property.

getVappTemplate

public VAppTemplate getVappTemplate()

The root VApp template in this OVF template if this is a vApp template An OVF template does not require a vApp template.

Returns:

The current value of the property.

setVappTemplate

public void setVappTemplate(VAppTemplate vappTemplate)

The root VApp template in this OVF template if this is a vApp template An OVF template does not require a vApp template.

Parameters:

vappTemplate - New value for the property.

getNetworks

public java.util.List<Network> getNetworks()

networks in this OVF template

Returns:

The current value of the property.

setNetworks

public void setNetworks(java.util.List<Network> networks)

networks in this OVF template

Parameters:

networks - New value for the property.

getStoragePolicyGroups

public java.util.List<StoragePolicyGroup> getStoragePolicyGroups()

Storage policy groups for disks, virtual machines and/or virtual machine collections. An OVF template does not require policies.

Returns:

The current value of the property.

setStoragePolicyGroups

public void setStoragePolicyGroups(java.util.List<StoragePolicyGroup> storagePolicyGroups)

Storage policy groups for disks, virtual machines and/or virtual machine collections. An OVF template does not require policies.

Parameters:

storagePolicyGroups - 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 OvfTemplate _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 OvfTemplate _newInstance2(StructValue structValue)

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