VMTypes.CreateSpec

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

All Implemented Interfaces:

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

Enclosing interface:

VMTypes
```
public static final class VMTypes.CreateSpec
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.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 com.vmware.vapi.data.StructValue __dynamicStructureFields

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

Constructor Summary

Constructors
Modifier Constructor and Description

CreateSpec()
Default constructor.

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

Constructors
Modifier	Constructor and Description
	`CreateSpec()` Default constructor.
`protected`	`CreateSpec(com.vmware.vapi.data.StructValue __dynamicStructureFields)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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.CreateSpec`	`_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.CreateSpec`	`_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)`
`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<NvmeTypes.CreateSpec>`	`getNvmeAdapters()` List of NVMe 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`	`setNvmeAdapters(java.util.List<NvmeTypes.CreateSpec> nvmeAdapters)` List of NVMe 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()`

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
  - CreateSpec
```
public CreateSpec()
```
    Default constructor.
  - CreateSpec
```
protected CreateSpec(com.vmware.vapi.data.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.
  - getNvmeAdapters
```
public java.util.List<NvmeTypes.CreateSpec> getNvmeAdapters()
```
    List of NVMe adapters. This property was added in vSphere API 7.0.0.1. If null, any adapters necessary to connect the virtual machine's storage devices will be created; this includes any devices that explicitly specify a NVMe host bus adapter, as well as any devices that do not specify a host bus adapter if the guest's preferred adapter type is NVMe.
    
    Returns:
    
    The current value of the property.
  - setNvmeAdapters
```
public void setNvmeAdapters(java.util.List<NvmeTypes.CreateSpec> nvmeAdapters)
```
    List of NVMe adapters. This property was added in vSphere API 7.0.0.1. If null, any adapters necessary to connect the virtual machine's storage devices will be created; this includes any devices that explicitly specify a NVMe host bus adapter, as well as any devices that do not specify a host bus adapter if the guest's preferred adapter type is NVMe.
    
    Parameters:
    
    nvmeAdapters - 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()
```
    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.CreateSpec _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.CreateSpec _newInstance2(com.vmware.vapi.data.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

getNvmeAdapters

setNvmeAdapters

getStoragePolicy

setStoragePolicy

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2