com.vmware.vcenter

Class VMTypes.ClonePlacementSpec

java.lang.Object

com.vmware.vcenter.VMTypes.ClonePlacementSpec

All Implemented Interfaces:

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

Enclosing interface:

VMTypes

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

The ClonePlacementSpec class contains information used to place a clone of a virtual machine onto resources within the vCenter inventory. 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.ClonePlacementSpec.Builder Builder class for VMTypes.ClonePlacementSpec.

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	ClonePlacementSpec() Default constructor.
protected	ClonePlacementSpec(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.ClonePlacementSpec	_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.ClonePlacementSpec	_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.String	getCluster() Cluster into which the cloned virtual machine should be placed.
java.lang.String	getDatastore() Datastore on which the cloned virtual machine's configuration state should be stored.
java.lang.String	getFolder() Virtual machine folder into which the cloned virtual machine should be placed.
java.lang.String	getHost() Host onto which the cloned virtual machine should be placed.
java.lang.String	getResourcePool() Resource pool into which the cloned virtual machine should be placed.
int	hashCode()
void	setCluster(java.lang.String cluster) Cluster into which the cloned virtual machine should be placed.
void	setDatastore(java.lang.String datastore) Datastore on which the cloned virtual machine's configuration state should be stored.
void	setFolder(java.lang.String folder) Virtual machine folder into which the cloned virtual machine should be placed.
void	setHost(java.lang.String host) Host onto which the cloned virtual machine should be placed.
void	setResourcePool(java.lang.String resourcePool) Resource pool into which the cloned virtual machine should be placed.
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

ClonePlacementSpec

public ClonePlacementSpec()

Default constructor.

ClonePlacementSpec

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

Method Detail

getFolder

public java.lang.String getFolder()

Virtual machine folder into which the cloned virtual machine should be placed. This property was added in vSphere API 7.0.0.0. If property is null, the system will use the virtual machine folder of the source virtual machine. If this results in a conflict due to other placement parameters, the virtual machine clone operation will fail.

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

setFolder

public void setFolder(java.lang.String folder)

Virtual machine folder into which the cloned virtual machine should be placed. This property was added in vSphere API 7.0.0.0. If property is null, the system will use the virtual machine folder of the source virtual machine. If this results in a conflict due to other placement parameters, the virtual machine clone operation will fail.

Parameters:

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

getResourcePool

public java.lang.String getResourcePool()

Resource pool into which the cloned virtual machine should be placed. This property was added in vSphere API 7.0.0.0. If property is null, the system will use the resource pool of the source virtual machine. If this results in a conflict due to other placement parameters, the virtual machine clone operation will fail.

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

setResourcePool

public void setResourcePool(java.lang.String resourcePool)

Resource pool into which the cloned virtual machine should be placed. This property was added in vSphere API 7.0.0.0. If property is null, the system will use the resource pool of the source virtual machine. If this results in a conflict due to other placement parameters, the virtual machine clone operation will fail.

Parameters:

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

getHost

public java.lang.String getHost()

Host onto which the cloned virtual machine should be placed.

If getHost() and getResourcePool() are both specified, getResourcePool() must belong to getHost().

If getHost() and getCluster() are both specified, getHost() must be a member of getCluster().

. This property was added in vSphere API 7.0.0.0. If this property is unset, if getResourcePool() is unset, the cloned virtual machine will use the host of the source virtual machine. if getResourcePool() is set, and the target is a standalone host, the host is used. if getResourcePool() is set, and the target is a DRS cluster, a host will be picked by DRS. if getResourcePool() is set, and the target is a cluster without DRS, InvalidArgument will be thrown.

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

setHost

public void setHost(java.lang.String host)

Host onto which the cloned virtual machine should be placed.

If getHost() and getResourcePool() are both specified, getResourcePool() must belong to getHost().

If getHost() and getCluster() are both specified, getHost() must be a member of getCluster().

. This property was added in vSphere API 7.0.0.0. If this property is unset, if getResourcePool() is unset, the cloned virtual machine will use the host of the source virtual machine. if getResourcePool() is set, and the target is a standalone host, the host is used. if getResourcePool() is set, and the target is a DRS cluster, a host will be picked by DRS. if getResourcePool() is set, and the target is a cluster without DRS, InvalidArgument will be thrown.

Parameters:

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

getCluster

public java.lang.String getCluster()

Cluster into which the cloned virtual machine should be placed.

If getCluster() and getResourcePool() are both specified, getResourcePool() must belong to getCluster().

If getCluster() and getHost() are both specified, getHost() must be a member of getCluster().

. This property was added in vSphere API 7.0.0.0. If getResourcePool() or getHost() is specified, it is recommended that this property be null.

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

setCluster

public void setCluster(java.lang.String cluster)

Cluster into which the cloned virtual machine should be placed.

If getCluster() and getResourcePool() are both specified, getResourcePool() must belong to getCluster().

If getCluster() and getHost() are both specified, getHost() must be a member of getCluster().

. This property was added in vSphere API 7.0.0.0. If getResourcePool() or getHost() is specified, it is recommended that this property be null.

Parameters:

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

getDatastore

public java.lang.String getDatastore()

Datastore on which the cloned virtual machine's configuration state should be stored. This datastore will also be used for any virtual disks that are created as part of the virtual machine clone operation unless individually overridden. This property was added in vSphere API 7.0.0.0. If property is null, the system will use the datastore of the source 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: Datastore. When methods return a value of this class as a return value, the property will be an identifier for the resource type: Datastore.

setDatastore

public void setDatastore(java.lang.String datastore)

Datastore on which the cloned virtual machine's configuration state should be stored. This datastore will also be used for any virtual disks that are created as part of the virtual machine clone operation unless individually overridden. This property was added in vSphere API 7.0.0.0. If property is null, the system will use the datastore of the source virtual machine.

Parameters:

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

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

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