com.vmware.vcenter

Class VMTypes.Summary

java.lang.Object

com.vmware.vcenter.VMTypes.Summary

All Implemented Interfaces:

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

Enclosing interface:

VMTypes

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

The Summary class contains commonly used information about a virtual machine.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	Summary() Default constructor.
protected	Summary(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 VMTypes.Summary	_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 VMTypes.Summary	_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.lang.Long	getCpuCount() Number of CPU cores.
java.lang.Long	getMemorySizeMiB() Memory size in mebibytes.
java.lang.String	getName() Name of the Virtual machine.
PowerTypes.State	getPowerState() Power state of the virtual machine.
java.lang.String	getVm() Identifier of the virtual machine.
int	hashCode()
void	setCpuCount(java.lang.Long cpuCount) Number of CPU cores.
void	setMemorySizeMiB(java.lang.Long memorySizeMiB) Memory size in mebibytes.
void	setName(java.lang.String name) Name of the Virtual machine.
void	setPowerState(PowerTypes.State powerState) Power state of the virtual machine.
void	setVm(java.lang.String vm) Identifier of the virtual machine.
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

Summary

public Summary()

Default constructor.

Summary

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

Method Detail

getVm

public java.lang.String getVm()

Identifier of the virtual machine.

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: VirtualMachine. When methods return a value of this class as a return value, the property will be an identifier for the resource type: VirtualMachine.

setVm

public void setVm(java.lang.String vm)

Identifier of the virtual machine.

Parameters:

vm - 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: VirtualMachine. When methods return a value of this class as a return value, the property will be an identifier for the resource type: VirtualMachine.

getName

public java.lang.String getName()

Name of the Virtual machine.

Returns:

The current value of the property.

setName

public void setName(java.lang.String name)

Name of the Virtual machine.

Parameters:

name - 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.

getCpuCount

public java.lang.Long getCpuCount()

Number of CPU cores. This property will be null if the virtual machine configuration is not available. For example, the configuration information would be unavailable if the server is unable to access the virtual machine files on disk, and is often also unavailable during the intial phases of virtual machine creation.

Returns:

The current value of the property.

setCpuCount

public void setCpuCount(java.lang.Long cpuCount)

Number of CPU cores. This property will be null if the virtual machine configuration is not available. For example, the configuration information would be unavailable if the server is unable to access the virtual machine files on disk, and is often also unavailable during the intial phases of virtual machine creation.

Parameters:

cpuCount - New value for the property.

getMemorySizeMiB

public java.lang.Long getMemorySizeMiB()

Memory size in mebibytes. This property will be null if the virtual machine configuration is not available. For example, the configuration information would be unavailable if the server is unable to access the virtual machine files on disk, and is often also unavailable during the intial phases of virtual machine creation.

Returns:

The current value of the property.

setMemorySizeMiB

public void setMemorySizeMiB(java.lang.Long memorySizeMiB)

Memory size in mebibytes. This property will be null if the virtual machine configuration is not available. For example, the configuration information would be unavailable if the server is unable to access the virtual machine files on disk, and is often also unavailable during the intial phases of virtual machine creation.

Parameters:

memorySizeMiB - 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 VMTypes.Summary _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 VMTypes.Summary _newInstance2(com.vmware.vapi.data.StructValue structValue)

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