com.vmware.vcenter

Class VMTypes.Info

java.lang.Object

com.vmware.vcenter.VMTypes.Info

All Implemented Interfaces:

StaticStructure, Structure, java.io.Serializable

Enclosing interface:

VMTypes

public static final class VMTypes.Info
extends java.lang.Object
implements java.io.Serializable, StaticStructure

Document-based info.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VMTypes.Info.Builder Builder class for VMTypes.Info.

Field Summary

Fields

Modifier and Type	Field and Description
protected StructValue	__dynamicStructureFields

Constructor Summary

Constructors

Modifier	Constructor and Description
	Info() Default constructor.
protected	Info(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 VMTypes.Info	_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 VMTypes.Info	_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)
BootTypes.Info	getBoot() Boot configuration.
java.util.List<DeviceTypes.Entry>	getBootDevices() Boot device configuration.
java.util.Map<java.lang.String,CdromTypes.Info>	getCdroms() List of CD-ROMs.
CpuTypes.Info	getCpu() CPU configuration.
java.util.Map<java.lang.String,DiskTypes.Info>	getDisks() List of disks.
java.util.Map<java.lang.String,FloppyTypes.Info>	getFloppies() List of floppy drives.
GuestOS	getGuestOS() Guest OS.
HardwareTypes.Info	getHardware() Virtual hardware version information.
IdentityTypes.Info	getIdentity() Identity of the virtual machine.
java.lang.Boolean	getInstantCloneFrozen() Indicates whether the virtual machine is frozen for instant clone, or not.
MemoryTypes.Info	getMemory() Memory configuration.
java.lang.String	getName() Virtual machine name.
java.util.Map<java.lang.String,EthernetTypes.Info>	getNics() List of Ethernet adapters.
java.util.Map<java.lang.String,ParallelTypes.Info>	getParallelPorts() List of parallel ports.
PowerTypes.State	getPowerState() Power state of the virtual machine.
java.util.Map<java.lang.String,SataTypes.Info>	getSataAdapters() List of SATA adapters.
java.util.Map<java.lang.String,ScsiTypes.Info>	getScsiAdapters() List of SCSI adapters.
java.util.Map<java.lang.String,SerialTypes.Info>	getSerialPorts() List of serial ports.
int	hashCode()
void	setBoot(BootTypes.Info boot) Boot configuration.
void	setBootDevices(java.util.List<DeviceTypes.Entry> bootDevices) Boot device configuration.
void	setCdroms(java.util.Map<java.lang.String,CdromTypes.Info> cdroms) List of CD-ROMs.
void	setCpu(CpuTypes.Info cpu) CPU configuration.
void	setDisks(java.util.Map<java.lang.String,DiskTypes.Info> disks) List of disks.
void	setFloppies(java.util.Map<java.lang.String,FloppyTypes.Info> floppies) List of floppy drives.
void	setGuestOS(GuestOS guestOS) Guest OS.
void	setHardware(HardwareTypes.Info hardware) Virtual hardware version information.
void	setIdentity(IdentityTypes.Info identity) Identity of the virtual machine.
void	setInstantCloneFrozen(java.lang.Boolean instantCloneFrozen) Indicates whether the virtual machine is frozen for instant clone, or not.
void	setMemory(MemoryTypes.Info memory) Memory configuration.
void	setName(java.lang.String name) Virtual machine name.
void	setNics(java.util.Map<java.lang.String,EthernetTypes.Info> nics) List of Ethernet adapters.
void	setParallelPorts(java.util.Map<java.lang.String,ParallelTypes.Info> parallelPorts) List of parallel ports.
void	setPowerState(PowerTypes.State powerState) Power state of the virtual machine.
void	setSataAdapters(java.util.Map<java.lang.String,SataTypes.Info> sataAdapters) List of SATA adapters.
void	setScsiAdapters(java.util.Map<java.lang.String,ScsiTypes.Info> scsiAdapters) List of SCSI adapters.
void	setSerialPorts(java.util.Map<java.lang.String,SerialTypes.Info> serialPorts) List of serial ports.
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

Info

public Info()

Default constructor.

Info

protected Info(StructValue __dynamicStructureFields)

Method Detail

getGuestOS

public GuestOS getGuestOS()

Guest OS.

Returns:

The current value of the property.

setGuestOS

public void setGuestOS(GuestOS guestOS)

Guest OS.

Parameters:

guestOS - New value for the property.

getName

public java.lang.String getName()

Virtual machine name.

Returns:

The current value of the property.

setName

public void setName(java.lang.String name)

Virtual machine name.

Parameters:

name - New value for the property.

getIdentity

public IdentityTypes.Info getIdentity()

Identity of the virtual machine. This property was added in vSphere API 6.7.1. This property is optional because it was added in a newer version than its parent node.

Returns:

The current value of the property.

setIdentity

public void setIdentity(IdentityTypes.Info identity)

Identity of the virtual machine. This property was added in vSphere API 6.7.1. This property is optional because it was added in a newer version than its parent node.

Parameters:

identity - New value for the property.

getPowerState

public PowerTypes.State getPowerState()

Power state of the virtual machine.

Returns:

The current value of the property.

setPowerState

public void setPowerState(PowerTypes.State powerState)

Power state of the virtual machine.

Parameters:

powerState - New value for the property.

getInstantCloneFrozen

public java.lang.Boolean getInstantCloneFrozen()

Indicates whether the virtual machine is frozen for instant clone, or not. This property was added in vSphere API 6.7.1. This property is optional because it was added in a newer version than its parent node.

Returns:

The current value of the property.

setInstantCloneFrozen

public void setInstantCloneFrozen(java.lang.Boolean instantCloneFrozen)

Indicates whether the virtual machine is frozen for instant clone, or not. This property was added in vSphere API 6.7.1. This property is optional because it was added in a newer version than its parent node.

Parameters:

instantCloneFrozen - New value for the property.

getHardware

public HardwareTypes.Info getHardware()

Virtual hardware version information.

Returns:

The current value of the property.

setHardware

public void setHardware(HardwareTypes.Info hardware)

Virtual hardware version information.

Parameters:

hardware - New value for the property.

getBoot

public BootTypes.Info getBoot()

Boot configuration.

Returns:

The current value of the property.

setBoot

public void setBoot(BootTypes.Info boot)

Boot configuration.

Parameters:

boot - New value for the property.

getBootDevices

public java.util.List<DeviceTypes.Entry> getBootDevices()

Boot device configuration. If the List has no entries, a server-specific default boot sequence is used.

Returns:

The current value of the property.

setBootDevices

public void setBootDevices(java.util.List<DeviceTypes.Entry> bootDevices)

Boot device configuration. If the List has no entries, a server-specific default boot sequence is used.

Parameters:

bootDevices - New value for the property.

getCpu

public CpuTypes.Info getCpu()

CPU configuration.

Returns:

The current value of the property.

setCpu

public void setCpu(CpuTypes.Info cpu)

CPU configuration.

Parameters:

cpu - New value for the property.

getMemory

public MemoryTypes.Info getMemory()

Memory configuration.

Returns:

The current value of the property.

setMemory

public void setMemory(MemoryTypes.Info memory)

Memory configuration.

Parameters:

memory - New value for the property.

getDisks

public java.util.Map<java.lang.String,DiskTypes.Info> getDisks()

List of disks.

Returns:

The current value of the property. When clients pass a value of this class as a parameter, the key in the property Map must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk. When methods return a value of this class as a return value, the key in the property Map will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk.

setDisks

public void setDisks(java.util.Map<java.lang.String,DiskTypes.Info> disks)

List of disks.

Parameters:

disks - New value for the property. When clients pass a value of this class as a parameter, the key in the property Map must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk. When methods return a value of this class as a return value, the key in the property Map will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk.

getNics

public java.util.Map<java.lang.String,EthernetTypes.Info> getNics()

List of Ethernet adapters.

Returns:

The current value of the property. When clients pass a value of this class as a parameter, the key in the property Map must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Ethernet. When methods return a value of this class as a return value, the key in the property Map will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Ethernet.

setNics

public void setNics(java.util.Map<java.lang.String,EthernetTypes.Info> nics)

List of Ethernet adapters.

Parameters:

nics - New value for the property. When clients pass a value of this class as a parameter, the key in the property Map must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Ethernet. When methods return a value of this class as a return value, the key in the property Map will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Ethernet.

getCdroms

public java.util.Map<java.lang.String,CdromTypes.Info> getCdroms()

List of CD-ROMs.

Returns:

The current value of the property. When clients pass a value of this class as a parameter, the key in the property Map must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Cdrom. When methods return a value of this class as a return value, the key in the property Map will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Cdrom.

setCdroms

public void setCdroms(java.util.Map<java.lang.String,CdromTypes.Info> cdroms)

List of CD-ROMs.

Parameters:

cdroms - New value for the property. When clients pass a value of this class as a parameter, the key in the property Map must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Cdrom. When methods return a value of this class as a return value, the key in the property Map will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Cdrom.

getFloppies

public java.util.Map<java.lang.String,FloppyTypes.Info> getFloppies()

List of floppy drives.

Returns:

The current value of the property. When clients pass a value of this class as a parameter, the key in the property Map must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Floppy. When methods return a value of this class as a return value, the key in the property Map will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Floppy.

setFloppies

public void setFloppies(java.util.Map<java.lang.String,FloppyTypes.Info> floppies)

List of floppy drives.

Parameters:

floppies - New value for the property. When clients pass a value of this class as a parameter, the key in the property Map must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Floppy. When methods return a value of this class as a return value, the key in the property Map will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Floppy.

getParallelPorts

public java.util.Map<java.lang.String,ParallelTypes.Info> getParallelPorts()

List of parallel ports.

Returns:

The current value of the property. When clients pass a value of this class as a parameter, the key in the property Map must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.ParallelPort. When methods return a value of this class as a return value, the key in the property Map will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.ParallelPort.

setParallelPorts

public void setParallelPorts(java.util.Map<java.lang.String,ParallelTypes.Info> parallelPorts)

List of parallel ports.

Parameters:

parallelPorts - New value for the property. When clients pass a value of this class as a parameter, the key in the property Map must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.ParallelPort. When methods return a value of this class as a return value, the key in the property Map will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.ParallelPort.

getSerialPorts

public java.util.Map<java.lang.String,SerialTypes.Info> getSerialPorts()

List of serial ports.

Returns:

The current value of the property. When clients pass a value of this class as a parameter, the key in the property Map must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SerialPort. When methods return a value of this class as a return value, the key in the property Map will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SerialPort.

setSerialPorts

public void setSerialPorts(java.util.Map<java.lang.String,SerialTypes.Info> serialPorts)

List of serial ports.

Parameters:

serialPorts - New value for the property. When clients pass a value of this class as a parameter, the key in the property Map must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SerialPort. When methods return a value of this class as a return value, the key in the property Map will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SerialPort.

getSataAdapters

public java.util.Map<java.lang.String,SataTypes.Info> getSataAdapters()

List of SATA adapters.

Returns:

The current value of the property. When clients pass a value of this class as a parameter, the key in the property Map must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SataAdapter. When methods return a value of this class as a return value, the key in the property Map will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SataAdapter.

setSataAdapters

public void setSataAdapters(java.util.Map<java.lang.String,SataTypes.Info> sataAdapters)

List of SATA adapters.

Parameters:

sataAdapters - New value for the property. When clients pass a value of this class as a parameter, the key in the property Map must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SataAdapter. When methods return a value of this class as a return value, the key in the property Map will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SataAdapter.

getScsiAdapters

public java.util.Map<java.lang.String,ScsiTypes.Info> getScsiAdapters()

List of SCSI adapters.

Returns:

The current value of the property. When clients pass a value of this class as a parameter, the key in the property Map must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.ScsiAdapter. When methods return a value of this class as a return value, the key in the property Map will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.ScsiAdapter.

setScsiAdapters

public void setScsiAdapters(java.util.Map<java.lang.String,ScsiTypes.Info> scsiAdapters)

List of SCSI adapters.

Parameters:

scsiAdapters - New value for the property. When clients pass a value of this class as a parameter, the key in the property Map must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.ScsiAdapter. When methods return a value of this class as a return value, the key in the property Map will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.ScsiAdapter.

_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 VMTypes.Info _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 VMTypes.Info _newInstance2(StructValue structValue)

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