VMTypes.CloneSpec

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

All Implemented Interfaces:

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

Enclosing interface:

VMTypes
```
public static final class VMTypes.CloneSpec
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
Document-based clone spec. This class was added in vSphere API 7.0.0.0.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VMTypes.CloneSpec.Builder
Builder class for VMTypes.CloneSpec.

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

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

CloneSpec()
Default constructor.

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

Constructors
Modifier	Constructor and Description
	`CloneSpec()` Default constructor.
`protected`	`CloneSpec(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.CloneSpec`	`_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.CloneSpec`	`_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.util.Set<java.lang.String>`	`getDisksToRemove()` Set of Disks to Remove.
`java.util.Map<java.lang.String,VMTypes.DiskCloneSpec>`	`getDisksToUpdate()` Map of Disks to Update.
`VMTypes.GuestCustomizationSpec`	`getGuestCustomizationSpec()` Guest customization spec to apply to the virtual machine after the virtual machine is deployed.
`java.lang.String`	`getName()` Virtual machine name.
`VMTypes.ClonePlacementSpec`	`getPlacement()` Virtual machine placement information.
`java.lang.Boolean`	`getPowerOn()` Attempt to perform a `getPowerOn()` after clone.
`java.lang.String`	`getSource()` Virtual machine to clone from.
`int`	`hashCode()`
`void`	`setDisksToRemove(java.util.Set<java.lang.String> disksToRemove)` Set of Disks to Remove.
`void`	`setDisksToUpdate(java.util.Map<java.lang.String,VMTypes.DiskCloneSpec> disksToUpdate)` Map of Disks to Update.
`void`	`setGuestCustomizationSpec(VMTypes.GuestCustomizationSpec guestCustomizationSpec)` Guest customization spec to apply to the virtual machine after the virtual machine is deployed.
`void`	`setName(java.lang.String name)` Virtual machine name.
`void`	`setPlacement(VMTypes.ClonePlacementSpec placement)` Virtual machine placement information.
`void`	`setPowerOn(java.lang.Boolean powerOn)` Attempt to perform a `getPowerOn()` after clone.
`void`	`setSource(java.lang.String source)` Virtual machine to clone from.
`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
  - CloneSpec
```
public CloneSpec()
```
    Default constructor.
  - CloneSpec
```
protected CloneSpec(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getSource
```
public java.lang.String getSource()
```
    Virtual machine to clone from. This property was added in vSphere API 7.0.0.0.
    
    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.
  - setSource
```
public void setSource(java.lang.String source)
```
    Virtual machine to clone from. This property was added in vSphere API 7.0.0.0.
    
    Parameters:
    
    source - 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()
```
    Virtual machine name. This property was added in vSphere API 7.0.0.0.
    
    Returns:
    
    The current value of the property.
  - setName
```
public void setName(java.lang.String name)
```
    Virtual machine name. This property was added in vSphere API 7.0.0.0.
    
    Parameters:
    
    name - New value for the property.
  - getPlacement
```
public VMTypes.ClonePlacementSpec getPlacement()
```
    Virtual machine placement information. This property was added in vSphere API 7.0.0.0. If this property is null, the system will use the values from the source virtual machine. If specified, each field will be used for placement. If the fields result in disjoint placement the operation will fail. If the fields along with the placement values of the source virtual machine result in disjoint placement the operation will fail.
    
    Returns:
    
    The current value of the property.
  - setPlacement
```
public void setPlacement(VMTypes.ClonePlacementSpec placement)
```
    Virtual machine placement information. This property was added in vSphere API 7.0.0.0. If this property is null, the system will use the values from the source virtual machine. If specified, each field will be used for placement. If the fields result in disjoint placement the operation will fail. If the fields along with the placement values of the source virtual machine result in disjoint placement the operation will fail.
    
    Parameters:
    
    placement - New value for the property.
  - getDisksToRemove
```
public java.util.Set<java.lang.String> getDisksToRemove()
```
    Set of Disks to Remove. This property was added in vSphere API 7.0.0.0. If null, all disks will be copied. If the same identifier is in getDisksToUpdate() InvalidArgument fault will be returned.
    
    Returns:
    
    The current value of the property. When clients pass a value of this class as a parameter, the property must contain identifiers for the resource type: com.vmware.vcenter.vm.hardware.Disk. When methods return a value of this class as a return value, the property will contain identifiers for the resource type: com.vmware.vcenter.vm.hardware.Disk.
  - setDisksToRemove
```
public void setDisksToRemove(java.util.Set<java.lang.String> disksToRemove)
```
    Set of Disks to Remove. This property was added in vSphere API 7.0.0.0. If null, all disks will be copied. If the same identifier is in getDisksToUpdate() InvalidArgument fault will be returned.
    
    Parameters:
    
    disksToRemove - New value for the property. When clients pass a value of this class as a parameter, the property must contain identifiers for the resource type: com.vmware.vcenter.vm.hardware.Disk. When methods return a value of this class as a return value, the property will contain identifiers for the resource type: com.vmware.vcenter.vm.hardware.Disk.
  - getDisksToUpdate
```
public java.util.Map<java.lang.String,VMTypes.DiskCloneSpec> getDisksToUpdate()
```
    Map of Disks to Update. This property was added in vSphere API 7.0.0.0. If null, all disks will copied to the datastore specified in the VMTypes.ClonePlacementSpec.getDatastore() property of getPlacement(). If the same identifier is in getDisksToRemove() InvalidArgument fault will be thrown.
    
    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.
  - setDisksToUpdate
```
public void setDisksToUpdate(java.util.Map<java.lang.String,VMTypes.DiskCloneSpec> disksToUpdate)
```
    Map of Disks to Update. This property was added in vSphere API 7.0.0.0. If null, all disks will copied to the datastore specified in the VMTypes.ClonePlacementSpec.getDatastore() property of getPlacement(). If the same identifier is in getDisksToRemove() InvalidArgument fault will be thrown.
    
    Parameters:
    
    disksToUpdate - 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.
  - getPowerOn
```
public java.lang.Boolean getPowerOn()
```
    Attempt to perform a getPowerOn() after clone. This property was added in vSphere API 7.0.0.0. If null, the virtual machine will not be powered on.
    
    Returns:
    
    The current value of the property.
  - setPowerOn
```
public void setPowerOn(java.lang.Boolean powerOn)
```
    Attempt to perform a getPowerOn() after clone. This property was added in vSphere API 7.0.0.0. If null, the virtual machine will not be powered on.
    
    Parameters:
    
    powerOn - New value for the property.
  - getGuestCustomizationSpec
```
public VMTypes.GuestCustomizationSpec getGuestCustomizationSpec()
```
    Guest customization spec to apply to the virtual machine after the virtual machine is deployed. This property was added in vSphere API 7.0.0.0. If null, the guest operating system is not customized after clone.
    
    Returns:
    
    The current value of the property.
  - setGuestCustomizationSpec
```
public void setGuestCustomizationSpec(VMTypes.GuestCustomizationSpec guestCustomizationSpec)
```
    Guest customization spec to apply to the virtual machine after the virtual machine is deployed. This property was added in vSphere API 7.0.0.0. If null, the guest operating system is not customized after clone.
    
    Parameters:
    
    guestCustomizationSpec - 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.CloneSpec _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.CloneSpec _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class VMTypes.CloneSpec

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

__dynamicStructureFields

Constructor Detail

CloneSpec

CloneSpec

Method Detail

getSource

setSource

getName

setName

getPlacement

setPlacement

getDisksToRemove

setDisksToRemove

getDisksToUpdate

setDisksToUpdate

getPowerOn

setPowerOn

getGuestCustomizationSpec

setGuestCustomizationSpec

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2