com.vmware.vcenter.ovf

Class LibraryItemTypes.OvfSummary

java.lang.Object

com.vmware.vcenter.ovf.LibraryItemTypes.OvfSummary

All Implemented Interfaces:

StaticStructure, Structure, Serializable

Enclosing interface:

LibraryItemTypes

public static final class LibraryItemTypes.OvfSummary
extends Object
implements Serializable, StaticStructure

The OvfSummary class defines the result of the filter() method. See LibraryItem.filter(java.lang.String, com.vmware.vcenter.ovf.LibraryItemTypes.DeploymentTarget). The properties in the class describe parameterizable information in the OVF descriptor, with respect to a deployment target, for the deploy() method. See LibraryItem.deploy(java.lang.String, java.lang.String, com.vmware.vcenter.ovf.LibraryItemTypes.DeploymentTarget, com.vmware.vcenter.ovf.LibraryItemTypes.ResourcePoolDeploymentSpec).

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LibraryItemTypes.OvfSummary.Builder Builder class for LibraryItemTypes.OvfSummary.

Constructor Summary

Constructors

Constructor and Description
LibraryItemTypes.OvfSummary() 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 com.vmware.vapi.bindings.type.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.
com.vmware.vapi.bindings.type.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 LibraryItemTypes.OvfSummary	_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<Structure>	getAdditionalParams() Additional OVF parameters which can be specified for the deployment target.
String	getAnnotation() Default annotation for the virtual machine or virtual appliance.
List<String>	getEULAs() End User License Agreements specified in the OVF descriptor.
String	getName() Default name for the virtual machine or virtual appliance.
List<String>	getNetworks() Section identifiers for sections of type ovf:NetworkSection in the OVF descriptor.
List<String>	getStorageGroups() Section identifiers for sections of type vmw:StorageGroupSection in the OVF descriptor.
int	hashCode()
void	setAdditionalParams(List<Structure> additionalParams) Additional OVF parameters which can be specified for the deployment target.
void	setAnnotation(String annotation) Default annotation for the virtual machine or virtual appliance.
void	setEULAs(List<String> eULAs) End User License Agreements specified in the OVF descriptor.
void	setName(String name) Default name for the virtual machine or virtual appliance.
void	setNetworks(List<String> networks) Section identifiers for sections of type ovf:NetworkSection in the OVF descriptor.
void	setStorageGroups(List<String> storageGroups) Section identifiers for sections of type vmw:StorageGroupSection in the OVF descriptor.
String	toString() Returns a string representation of this structure.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

LibraryItemTypes.OvfSummary

public LibraryItemTypes.OvfSummary()

Default constructor.

Method Detail

getName

public String getName()

Default name for the virtual machine or virtual appliance. If null, the OVF descriptor did not specify a name.

Returns:

The current value of the property.

setName

public void setName(String name)

Default name for the virtual machine or virtual appliance. If null, the OVF descriptor did not specify a name.

Parameters:

name - New value for the property.

getAnnotation

public String getAnnotation()

Default annotation for the virtual machine or virtual appliance. If null, the OVF descriptor did not specify an annotation.

Returns:

The current value of the property.

setAnnotation

public void setAnnotation(String annotation)

Default annotation for the virtual machine or virtual appliance. If null, the OVF descriptor did not specify an annotation.

Parameters:

annotation - New value for the property.

getEULAs

public List<String> getEULAs()

End User License Agreements specified in the OVF descriptor. All end user license agreements must be accepted in order for the deploy() method to succeed. See LibraryItemTypes.ResourcePoolDeploymentSpec.getAcceptAllEULA().

Returns:

The current value of the property.

setEULAs

public void setEULAs(List<String> eULAs)

End User License Agreements specified in the OVF descriptor. All end user license agreements must be accepted in order for the deploy() method to succeed. See LibraryItemTypes.ResourcePoolDeploymentSpec.getAcceptAllEULA().

Parameters:

eULAs - New value for the property.

getNetworks

public List<String> getNetworks()

Section identifiers for sections of type ovf:NetworkSection in the OVF descriptor. These identifiers can be used as keys in LibraryItemTypes.ResourcePoolDeploymentSpec.getNetworkMappings(). If null, the OVF descriptor did not specify any networks.

Returns:

The current value of the property.

setNetworks

public void setNetworks(List<String> networks)

Section identifiers for sections of type ovf:NetworkSection in the OVF descriptor. These identifiers can be used as keys in LibraryItemTypes.ResourcePoolDeploymentSpec.getNetworkMappings(). If null, the OVF descriptor did not specify any networks.

Parameters:

networks - New value for the property.

getStorageGroups

public List<String> getStorageGroups()

Section identifiers for sections of type vmw:StorageGroupSection in the OVF descriptor. These identifiers can be used as keys in LibraryItemTypes.ResourcePoolDeploymentSpec.getStorageMappings(). If null, the OVF descriptor did not specify any storage groups.

Returns:

The current value of the property.

setStorageGroups

public void setStorageGroups(List<String> storageGroups)

Section identifiers for sections of type vmw:StorageGroupSection in the OVF descriptor. These identifiers can be used as keys in LibraryItemTypes.ResourcePoolDeploymentSpec.getStorageMappings(). If null, the OVF descriptor did not specify any storage groups.

Parameters:

storageGroups - New value for the property.

getAdditionalParams

public List<Structure> getAdditionalParams()

Additional OVF parameters which can be specified for the deployment target. These OVF parameters can be inspected, optionally modified, and used as values in LibraryItemTypes.ResourcePoolDeploymentSpec.getAdditionalParameters() for the deploy() method. If null, the OVF descriptor does not require addtional parameters or does not have additional parameters suitable for the deployment target.

Returns:

The current value of the property. When clients pass a value of this class as a parameter, the property must contain all the properties defined in OvfParams. When methods return a value of this class as a return value, the property will contain all the properties defined in OvfParams.

setAdditionalParams

public void setAdditionalParams(List<Structure> additionalParams)

Additional OVF parameters which can be specified for the deployment target. These OVF parameters can be inspected, optionally modified, and used as values in LibraryItemTypes.ResourcePoolDeploymentSpec.getAdditionalParameters() for the deploy() method. If null, the OVF descriptor does not require addtional parameters or does not have additional parameters suitable for the deployment target.

Parameters:

additionalParams - New value for the property. When clients pass a value of this class as a parameter, the property must contain all the properties defined in OvfParams. When methods return a value of this class as a return value, the property will contain all the properties defined in OvfParams.

_getType

public com.vmware.vapi.bindings.type.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 com.vmware.vapi.bindings.type.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 LibraryItemTypes.OvfSummary _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