VMTypes.PlacementSpec

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

All Implemented Interfaces:

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

Enclosing interface:

VMTypes
```
public static final class VMTypes.PlacementSpec
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
The PlacementSpec class contains information used to place a virtual machine onto resources within the vCenter inventory.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VMTypes.PlacementSpec.Builder
Builder class for VMTypes.PlacementSpec.

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

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

PlacementSpec()
Default constructor.

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

Constructors
Modifier	Constructor and Description
	`PlacementSpec()` Default constructor.
`protected`	`PlacementSpec(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.PlacementSpec`	`_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.PlacementSpec`	`_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 virtual machine should be placed.
`java.lang.String`	`getDatastore()` Datastore on which the virtual machine's configuration state should be stored.
`java.lang.String`	`getFolder()` Virtual machine folder into which the virtual machine should be placed.
`java.lang.String`	`getHost()` Host onto which the virtual machine should be placed.
`java.lang.String`	`getResourcePool()` Resource pool into which the virtual machine should be placed.
`int`	`hashCode()`
`void`	`setCluster(java.lang.String cluster)` Cluster into which the virtual machine should be placed.
`void`	`setDatastore(java.lang.String datastore)` Datastore on which the virtual machine's configuration state should be stored.
`void`	`setFolder(java.lang.String folder)` Virtual machine folder into which the virtual machine should be placed.
`void`	`setHost(java.lang.String host)` Host onto which the virtual machine should be placed.
`void`	`setResourcePool(java.lang.String resourcePool)` Resource pool into which the 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
  - PlacementSpec
```
public PlacementSpec()
```
    Default constructor.
  - PlacementSpec
```
protected PlacementSpec(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getFolder
```
public java.lang.String getFolder()
```
    Virtual machine folder into which the virtual machine should be placed. This property is currently required. In the future, if this property is null, the system will attempt to choose a suitable folder for the virtual machine; if a folder cannot be chosen, the virtual machine creation 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 virtual machine should be placed. This property is currently required. In the future, if this property is null, the system will attempt to choose a suitable folder for the virtual machine; if a folder cannot be chosen, the virtual machine creation 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 virtual machine should be placed. This property is currently required if both getHost() and getCluster() are null. In the future, if this property is null, the system will attempt to choose a suitable resource pool for the virtual machine; if a resource pool cannot be chosen, the virtual machine creation 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 virtual machine should be placed. This property is currently required if both getHost() and getCluster() are null. In the future, if this property is null, the system will attempt to choose a suitable resource pool for the virtual machine; if a resource pool cannot be chosen, the virtual machine creation 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 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 may be null if getResourcePool() or getCluster() is specified. If null, the system will attempt to choose a suitable host for the virtual machine; if a host cannot be chosen, the virtual machine creation 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: 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 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 may be null if getResourcePool() or getCluster() is specified. If null, the system will attempt to choose a suitable host for the virtual machine; if a host cannot be chosen, the virtual machine creation operation will fail.
    
    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 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().
    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 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().
    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 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 creation operation. This property is currently required. In the future, if this property is null, the system will attempt to choose suitable storage for the virtual machine; if storage cannot be chosen, the virtual machine creation 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: 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 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 creation operation. This property is currently required. In the future, if this property is null, the system will attempt to choose suitable storage for the virtual machine; if storage cannot be chosen, the virtual machine creation operation will fail.
    
    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.PlacementSpec _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.PlacementSpec _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class VMTypes.PlacementSpec

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

__dynamicStructureFields

Constructor Detail

PlacementSpec

PlacementSpec

Method Detail

getFolder

setFolder

getResourcePool

setResourcePool

getHost

setHost

getCluster

setCluster

getDatastore

setDatastore

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2