VMTypes.CloneSpec (vSphere Automation SDK for Java 7.0.1.0)

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

All Implemented Interfaces:

StaticStructure, Structure, java.io.Serializable

Enclosing interface:

VMTypes
```
public static final class VMTypes.CloneSpec
extends java.lang.Object
implements java.io.Serializable, 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 StructValue __dynamicStructureFields

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

Constructor Summary

Constructors
Modifier Constructor and Description

CloneSpec()
Default constructor.

protected CloneSpec(StructValue __dynamicStructureFields)

Constructors
Modifier	Constructor and Description
	`CloneSpec()` Default constructor.
`protected`	`CloneSpec(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.CloneSpec`	`_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.CloneSpec`	`_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)`
`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()` 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
  - CloneSpec
```
public CloneSpec()
```
    Default constructor.
  - CloneSpec
```
protected CloneSpec(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()
```
    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.CloneSpec _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.CloneSpec _newInstance2(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