com.vmware.vcenter.vcha

Class PlacementSpec.Builder

java.lang.Object

com.vmware.vcenter.vcha.PlacementSpec.Builder

Enclosing class:

PlacementSpec

public static final class PlacementSpec.Builder
extends java.lang.Object

Builder class for PlacementSpec.

Constructor Summary

Constructors

Constructor and Description
Builder(java.lang.String name, java.lang.String folder) Constructor with parameters for the required properties of PlacementSpec.

Method Summary

Modifier and Type	Method and Description
PlacementSpec	build()
PlacementSpec.Builder	setHaNetwork(java.lang.String haNetwork) The identifier of the Network object used for the HA network. If the PlacementSpec.getHaNetwork() property is set, then the {#link #haNetworkType} property must be set. If the PlacementSpec.getHaNetwork() property is null, then the PlacementSpec.getHaNetworkType() property is ignored.
PlacementSpec.Builder	setHaNetworkType(NetworkType haNetworkType) The type of the Network object used by the HA network. If the PlacementSpec.getHaNetwork() property is set, then the PlacementSpec.getHaNetworkType() field must be set. If the PlacementSpec.getHaNetwork() property is null, then the PlacementSpec.getHaNetworkType() property is ignored.
PlacementSpec.Builder	setHost(java.lang.String host) The identifier of the host to deploy the VCHA node to.
PlacementSpec.Builder	setManagementNetwork(java.lang.String managementNetwork) The identifier of the Network object used for the Management network.
PlacementSpec.Builder	setManagementNetworkType(NetworkType managementNetworkType) The type of the Network object used by the Management network. If the PlacementSpec.getManagementNetwork() property is set, then the {#link #managementNetworkType} field must be set. If the PlacementSpec.getManagementNetwork() property is null, then the PlacementSpec.getManagementNetworkType() property is ignored.
PlacementSpec.Builder	setResourcePool(java.lang.String resourcePool) The identifier of the resource pool to deploy the VCHA node to.
PlacementSpec.Builder	setStorage(DiskSpec storage) The storage specification to deploy the VCHA node to.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(java.lang.String name,
               java.lang.String folder)

Constructor with parameters for the required properties of PlacementSpec.

Method Detail

setHost

public PlacementSpec.Builder setHost(java.lang.String host)

The identifier of the host to deploy the VCHA node to. This property was added in vSphere API 6.7.1. If null, see vim.vm.RelocateSpec.host.

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

setResourcePool

public PlacementSpec.Builder setResourcePool(java.lang.String resourcePool)

The identifier of the resource pool to deploy the VCHA node to. This property was added in vSphere API 6.7.1. If null, then the active node's resource pool will be used.

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

setHaNetworkType

public PlacementSpec.Builder setHaNetworkType(NetworkType haNetworkType)

The type of the Network object used by the HA network.
If the PlacementSpec.getHaNetwork() property is set, then the PlacementSpec.getHaNetworkType() field must be set.
If the PlacementSpec.getHaNetwork() property is null, then the PlacementSpec.getHaNetworkType() property is ignored. This property was added in vSphere API 6.7.1. If null and the PlacementSpec.getHaNetwork() property is unset, then the same network present on the Active node virtual machine is used to deploy the virtual machine with an assumption that the network is present on the destination.
If null and the PlacementSpec.getHaNetwork() property is set, then an error is reported.

Parameters:

haNetworkType - New value for the property.

setHaNetwork

public PlacementSpec.Builder setHaNetwork(java.lang.String haNetwork)

The identifier of the Network object used for the HA network.
If the PlacementSpec.getHaNetwork() property is set, then the {#link #haNetworkType} property must be set.
If the PlacementSpec.getHaNetwork() property is null, then the PlacementSpec.getHaNetworkType() property is ignored. This property was added in vSphere API 6.7.1. If null and the PlacementSpec.getHaNetworkType() property is unset, then the same network present on the Active node virtual machine is used to deploy the virtual machine with an assumption that the network is present on the destination.

Parameters:

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

setManagementNetworkType

public PlacementSpec.Builder setManagementNetworkType(NetworkType managementNetworkType)

The type of the Network object used by the Management network.
If the PlacementSpec.getManagementNetwork() property is set, then the {#link #managementNetworkType} field must be set.
If the PlacementSpec.getManagementNetwork() property is null, then the PlacementSpec.getManagementNetworkType() property is ignored. This property was added in vSphere API 6.7.1. If null and the PlacementSpec.getManagementNetwork() property is unset, then the same network present on the Active node virtual machine is used to deploy the virtual machine with an assumption that the network is present on the destination.
If null and the PlacementSpec.getManagementNetwork() property is set, then an error is reported.

Parameters:

managementNetworkType - New value for the property.

setManagementNetwork

public PlacementSpec.Builder setManagementNetwork(java.lang.String managementNetwork)

The identifier of the Network object used for the Management network. If the PlacementSpec.getManagementNetwork() property is set, then the PlacementSpec.getManagementNetworkType() property must be set.
If the PlacementSpec.getManagementNetwork() property is null, then the PlacementSpec.getManagementNetworkType() property is ignored. This property was added in vSphere API 6.7.1. If null and the PlacementSpec.getManagementNetworkType() property is unset, then the same network present on the Active node virtual machine is used to deploy the virtual machine with an assumption that the network is present on the destination.

Parameters:

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

setStorage

public PlacementSpec.Builder setStorage(DiskSpec storage)

The storage specification to deploy the VCHA node to. This property was added in vSphere API 6.7.1. If null, see vim.vm.RelocateSpec.datastore.

Parameters:

storage - New value for the property.

build

public PlacementSpec build()