VMTypes.CreateSpec (vSphere Automation SDK for Java 7.0.1.0)

java.lang.Object
- com.vmware.vcenter.VMTypes.CreateSpec

All Implemented Interfaces:

StaticStructure, Structure, java.io.Serializable

Enclosing interface:

VMTypes
```
public static final class VMTypes.CreateSpec
extends java.lang.Object
implements java.io.Serializable, StaticStructure
```
Document-based creation spec.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VMTypes.CreateSpec.Builder
Builder class for VMTypes.CreateSpec.

Nested Classes
Modifier and Type	Class and Description
`static class`	`VMTypes.CreateSpec.Builder` Builder class for `VMTypes.CreateSpec`.

Field Summary

Fields
Modifier and Type Field and Description

protected StructValue __dynamicStructureFields

Fields
Modifier and Type	Field and Description
`protected StructValue`	`__dynamicStructureFields`

Constructor Summary

Constructors
Modifier Constructor and Description

CreateSpec()
Default constructor.

protected CreateSpec(StructValue __dynamicStructureFields)

Constructors
Modifier	Constructor and Description
	`CreateSpec()` Default constructor.
`protected`	`CreateSpec(StructValue __dynamicStructureFields)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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.CreateSpec`	`_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.CreateSpec`	`_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.CreateSpec`	`getBoot()` Boot configuration.
`java.util.List<DeviceTypes.EntryCreateSpec>`	`getBootDevices()` Boot device configuration.
`java.util.List<CdromTypes.CreateSpec>`	`getCdroms()` List of CD-ROMs.
`CpuTypes.UpdateSpec`	`getCpu()` CPU configuration.
`java.util.List<DiskTypes.CreateSpec>`	`getDisks()` List of disks.
`java.util.List<FloppyTypes.CreateSpec>`	`getFloppies()` List of floppy drives.
`GuestOS`	`getGuestOS()` Guest OS.
`HardwareTypes.Version`	`getHardwareVersion()` Virtual hardware version.
`MemoryTypes.UpdateSpec`	`getMemory()` Memory configuration.
`java.lang.String`	`getName()` Virtual machine name.
`java.util.List<EthernetTypes.CreateSpec>`	`getNics()` List of Ethernet adapters.
`java.util.List<ParallelTypes.CreateSpec>`	`getParallelPorts()` List of parallel ports.
`VMTypes.PlacementSpec`	`getPlacement()` Virtual machine placement information.
`java.util.List<SataTypes.CreateSpec>`	`getSataAdapters()` List of SATA adapters.
`java.util.List<ScsiTypes.CreateSpec>`	`getScsiAdapters()` List of SCSI adapters.
`java.util.List<SerialTypes.CreateSpec>`	`getSerialPorts()` List of serial ports.
`VMTypes.StoragePolicySpec`	`getStoragePolicy()` The `StoragePolicySpec` class contains information about the storage policy that is to be associated with the virtual machine home (which contains the configuration and log files).
`int`	`hashCode()`
`void`	`setBoot(BootTypes.CreateSpec boot)` Boot configuration.
`void`	`setBootDevices(java.util.List<DeviceTypes.EntryCreateSpec> bootDevices)` Boot device configuration.
`void`	`setCdroms(java.util.List<CdromTypes.CreateSpec> cdroms)` List of CD-ROMs.
`void`	`setCpu(CpuTypes.UpdateSpec cpu)` CPU configuration.
`void`	`setDisks(java.util.List<DiskTypes.CreateSpec> disks)` List of disks.
`void`	`setFloppies(java.util.List<FloppyTypes.CreateSpec> floppies)` List of floppy drives.
`void`	`setGuestOS(GuestOS guestOS)` Guest OS.
`void`	`setHardwareVersion(HardwareTypes.Version hardwareVersion)` Virtual hardware version.
`void`	`setMemory(MemoryTypes.UpdateSpec memory)` Memory configuration.
`void`	`setName(java.lang.String name)` Virtual machine name.
`void`	`setNics(java.util.List<EthernetTypes.CreateSpec> nics)` List of Ethernet adapters.
`void`	`setParallelPorts(java.util.List<ParallelTypes.CreateSpec> parallelPorts)` List of parallel ports.
`void`	`setPlacement(VMTypes.PlacementSpec placement)` Virtual machine placement information.
`void`	`setSataAdapters(java.util.List<SataTypes.CreateSpec> sataAdapters)` List of SATA adapters.
`void`	`setScsiAdapters(java.util.List<ScsiTypes.CreateSpec> scsiAdapters)` List of SCSI adapters.
`void`	`setSerialPorts(java.util.List<SerialTypes.CreateSpec> serialPorts)` List of serial ports.
`void`	`setStoragePolicy(VMTypes.StoragePolicySpec storagePolicy)` The `StoragePolicySpec` class contains information about the storage policy that is to be associated with the virtual machine home (which contains the configuration and log files).
`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
  - CreateSpec
```
public CreateSpec()
```
    Default constructor.
  - CreateSpec
```
protected CreateSpec(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. If null, a default name will be generated by the server.
    
    Returns:
    
    The current value of the property.
  - setName
```
public void setName(java.lang.String name)
```
    Virtual machine name. If null, a default name will be generated by the server.
    
    Parameters:
    
    name - New value for the property.
  - getPlacement
```
public VMTypes.PlacementSpec getPlacement()
```
    Virtual machine placement information. This property is currently required. In the future, if this property is null, the system will attempt to choose suitable resources on which to place the virtual machine.
    
    Returns:
    
    The current value of the property.
  - setPlacement
```
public void setPlacement(VMTypes.PlacementSpec placement)
```
    Virtual machine placement information. This property is currently required. In the future, if this property is null, the system will attempt to choose suitable resources on which to place the virtual machine.
    
    Parameters:
    
    placement - New value for the property.
  - getHardwareVersion
```
public HardwareTypes.Version getHardwareVersion()
```
    Virtual hardware version. If null, defaults to the most recent version supported by the server.
    
    Returns:
    
    The current value of the property.
  - setHardwareVersion
```
public void setHardwareVersion(HardwareTypes.Version hardwareVersion)
```
    Virtual hardware version. If null, defaults to the most recent version supported by the server.
    
    Parameters:
    
    hardwareVersion - New value for the property.
  - getBoot
```
public BootTypes.CreateSpec getBoot()
```
    Boot configuration. If null, guest-specific default values will be used.
    
    Returns:
    
    The current value of the property.
  - setBoot
```
public void setBoot(BootTypes.CreateSpec boot)
```
    Boot configuration. If null, guest-specific default values will be used.
    
    Parameters:
    
    boot - New value for the property.
  - getBootDevices
```
public java.util.List<DeviceTypes.EntryCreateSpec> getBootDevices()
```
    Boot device configuration. If null, a server-specific boot sequence will be used.
    
    Returns:
    
    The current value of the property.
  - setBootDevices
```
public void setBootDevices(java.util.List<DeviceTypes.EntryCreateSpec> bootDevices)
```
    Boot device configuration. If null, a server-specific boot sequence will be used.
    
    Parameters:
    
    bootDevices - New value for the property.
  - getCpu
```
public CpuTypes.UpdateSpec getCpu()
```
    CPU configuration. If null, guest-specific default values will be used.
    
    Returns:
    
    The current value of the property.
  - setCpu
```
public void setCpu(CpuTypes.UpdateSpec cpu)
```
    CPU configuration. If null, guest-specific default values will be used.
    
    Parameters:
    
    cpu - New value for the property.
  - getMemory
```
public MemoryTypes.UpdateSpec getMemory()
```
    Memory configuration. If null, guest-specific default values will be used.
    
    Returns:
    
    The current value of the property.
  - setMemory
```
public void setMemory(MemoryTypes.UpdateSpec memory)
```
    Memory configuration. If null, guest-specific default values will be used.
    
    Parameters:
    
    memory - New value for the property.
  - getDisks
```
public java.util.List<DiskTypes.CreateSpec> getDisks()
```
    List of disks. If null, a single blank virtual disk of a guest-specific size will be created on the same storage as the virtual machine configuration, and will use a guest-specific host bus adapter type. If the guest-specific size is 0, no virtual disk will be created.
    
    Returns:
    
    The current value of the property.
  - setDisks
```
public void setDisks(java.util.List<DiskTypes.CreateSpec> disks)
```
    List of disks. If null, a single blank virtual disk of a guest-specific size will be created on the same storage as the virtual machine configuration, and will use a guest-specific host bus adapter type. If the guest-specific size is 0, no virtual disk will be created.
    
    Parameters:
    
    disks - New value for the property.
  - getNics
```
public java.util.List<EthernetTypes.CreateSpec> getNics()
```
    List of Ethernet adapters. If null, no Ethernet adapters will be created.
    
    Returns:
    
    The current value of the property.
  - setNics
```
public void setNics(java.util.List<EthernetTypes.CreateSpec> nics)
```
    List of Ethernet adapters. If null, no Ethernet adapters will be created.
    
    Parameters:
    
    nics - New value for the property.
  - getCdroms
```
public java.util.List<CdromTypes.CreateSpec> getCdroms()
```
    List of CD-ROMs. If null, no CD-ROM devices will be created.
    
    Returns:
    
    The current value of the property.
  - setCdroms
```
public void setCdroms(java.util.List<CdromTypes.CreateSpec> cdroms)
```
    List of CD-ROMs. If null, no CD-ROM devices will be created.
    
    Parameters:
    
    cdroms - New value for the property.
  - getFloppies
```
public java.util.List<FloppyTypes.CreateSpec> getFloppies()
```
    List of floppy drives. If null, no floppy drives will be created.
    
    Returns:
    
    The current value of the property.
  - setFloppies
```
public void setFloppies(java.util.List<FloppyTypes.CreateSpec> floppies)
```
    List of floppy drives. If null, no floppy drives will be created.
    
    Parameters:
    
    floppies - New value for the property.
  - getParallelPorts
```
public java.util.List<ParallelTypes.CreateSpec> getParallelPorts()
```
    List of parallel ports. If null, no parallel ports will be created.
    
    Returns:
    
    The current value of the property.
  - setParallelPorts
```
public void setParallelPorts(java.util.List<ParallelTypes.CreateSpec> parallelPorts)
```
    List of parallel ports. If null, no parallel ports will be created.
    
    Parameters:
    
    parallelPorts - New value for the property.
  - getSerialPorts
```
public java.util.List<SerialTypes.CreateSpec> getSerialPorts()
```
    List of serial ports. If null, no serial ports will be created.
    
    Returns:
    
    The current value of the property.
  - setSerialPorts
```
public void setSerialPorts(java.util.List<SerialTypes.CreateSpec> serialPorts)
```
    List of serial ports. If null, no serial ports will be created.
    
    Parameters:
    
    serialPorts - New value for the property.
  - getSataAdapters
```
public java.util.List<SataTypes.CreateSpec> getSataAdapters()
```
    List of SATA adapters. If null, any adapters necessary to connect the virtual machine's storage devices will be created; this includes any devices that explicitly specify a SATA host bus adapter, as well as any devices that do not specify a host bus adapter if the guest's preferred adapter type is SATA.
    
    Returns:
    
    The current value of the property.
  - setSataAdapters
```
public void setSataAdapters(java.util.List<SataTypes.CreateSpec> sataAdapters)
```
    List of SATA adapters. If null, any adapters necessary to connect the virtual machine's storage devices will be created; this includes any devices that explicitly specify a SATA host bus adapter, as well as any devices that do not specify a host bus adapter if the guest's preferred adapter type is SATA.
    
    Parameters:
    
    sataAdapters - New value for the property.
  - getScsiAdapters
```
public java.util.List<ScsiTypes.CreateSpec> getScsiAdapters()
```
    List of SCSI adapters. If null, any adapters necessary to connect the virtual machine's storage devices will be created; this includes any devices that explicitly specify a SCSI host bus adapter, as well as any devices that do not specify a host bus adapter if the guest's preferred adapter type is SCSI. The type of the SCSI adapter will be a guest-specific default type.
    
    Returns:
    
    The current value of the property.
  - setScsiAdapters
```
public void setScsiAdapters(java.util.List<ScsiTypes.CreateSpec> scsiAdapters)
```
    List of SCSI adapters. If null, any adapters necessary to connect the virtual machine's storage devices will be created; this includes any devices that explicitly specify a SCSI host bus adapter, as well as any devices that do not specify a host bus adapter if the guest's preferred adapter type is SCSI. The type of the SCSI adapter will be a guest-specific default type.
    
    Parameters:
    
    scsiAdapters - New value for the property.
  - getStoragePolicy
```
public VMTypes.StoragePolicySpec getStoragePolicy()
```
    The StoragePolicySpec class contains information about the storage policy that is to be associated with the virtual machine home (which contains the configuration and log files). This property was added in vSphere API 6.7. If null the datastore default storage policy (if applicable) is applied. Currently a default storage policy is only supported by object datastores : VVol and vSAN. For non-object datastores, if null then no storage policy would be associated with the virtual machine home.
    
    Returns:
    
    The current value of the property.
  - setStoragePolicy
```
public void setStoragePolicy(VMTypes.StoragePolicySpec storagePolicy)
```
    The StoragePolicySpec class contains information about the storage policy that is to be associated with the virtual machine home (which contains the configuration and log files). This property was added in vSphere API 6.7. If null the datastore default storage policy (if applicable) is applied. Currently a default storage policy is only supported by object datastores : VVol and vSAN. For non-object datastores, if null then no storage policy would be associated with the virtual machine home.
    
    Parameters:
    
    storagePolicy - 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 VMTypes.CreateSpec _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.CreateSpec _newInstance2(StructValue structValue)
```
WARNING: Internal method, subject to change in future versions.
Serves as a versioning mechanism.

Class VMTypes.CreateSpec

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

__dynamicStructureFields

Constructor Detail

CreateSpec

CreateSpec

Method Detail

getGuestOS

setGuestOS

getName

setName

getPlacement

setPlacement

getHardwareVersion

setHardwareVersion

getBoot

setBoot

getBootDevices

setBootDevices

getCpu

setCpu

getMemory

setMemory

getDisks

setDisks

getNics

setNics

getCdroms

setCdroms

getFloppies

setFloppies

getParallelPorts

setParallelPorts

getSerialPorts

setSerialPorts

getSataAdapters

setSataAdapters

getScsiAdapters

setScsiAdapters

getStoragePolicy

setStoragePolicy

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2