com.vmware.vcenter

Class VMTypes.PlacementSpec.Builder

java.lang.Object

com.vmware.vcenter.VMTypes.PlacementSpec.Builder

Enclosing class:

VMTypes.PlacementSpec

public static final class VMTypes.PlacementSpec.Builder
extends Object

Builder class for VMTypes.PlacementSpec.

Constructor Summary

Constructors

Constructor and Description
VMTypes.PlacementSpec.Builder() Constructor with parameters for the required properties of VMTypes.PlacementSpec.

Method Summary

Methods

Modifier and Type	Method and Description
VMTypes.PlacementSpec	build()
VMTypes.PlacementSpec.Builder	setCluster(String cluster) Cluster onto which the virtual machine should be placed.
VMTypes.PlacementSpec.Builder	setDatastore(String datastore) Datastore on which the virtual machine's configuration state should be stored.
VMTypes.PlacementSpec.Builder	setFolder(String folder) Virtual machine folder into which the virtual machine should be placed.
VMTypes.PlacementSpec.Builder	setHost(String host) Host onto which the virtual machine should be placed.
VMTypes.PlacementSpec.Builder	setResourcePool(String resourcePool) Resource pool into which the virtual machine should be placed.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VMTypes.PlacementSpec.Builder

public VMTypes.PlacementSpec.Builder()

Constructor with parameters for the required properties of VMTypes.PlacementSpec.

Method Detail

setFolder

public VMTypes.PlacementSpec.Builder setFolder(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.

setResourcePool

public VMTypes.PlacementSpec.Builder setResourcePool(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.

setHost

public VMTypes.PlacementSpec.Builder setHost(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.

setCluster

public VMTypes.PlacementSpec.Builder setCluster(String cluster)

Cluster onto 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.

setDatastore

public VMTypes.PlacementSpec.Builder setDatastore(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.

build

public VMTypes.PlacementSpec build()