PlacementSpec

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

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class PlacementSpec
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
The PlacementSpec class contains information to describe the inventory placement of a single node of a VCHA cluster. This class was added in vSphere API 6.7.1.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class PlacementSpec.Builder
Builder class for PlacementSpec.

Nested Classes
Modifier and Type	Class and Description
`static class`	`PlacementSpec.Builder` Builder class for `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 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 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`	`getFolder()` The identifier of the folder to deploy the VCHA node to.
`java.lang.String`	`getHaNetwork()` The identifier of the Network object used for the HA network. If the `getHaNetwork()` property is set, then the {#link #haNetworkType} property must be set. If the `getHaNetwork()` property is `null`, then the `getHaNetworkType()` property is ignored.
`NetworkType`	`getHaNetworkType()` The type of the Network object used by the HA network. If the `getHaNetwork()` property is set, then the `getHaNetworkType()` field must be set. If the `getHaNetwork()` property is `null`, then the `getHaNetworkType()` property is ignored.
`java.lang.String`	`getHost()` The identifier of the host to deploy the VCHA node to.
`java.lang.String`	`getManagementNetwork()` The identifier of the Network object used for the Management network.
`NetworkType`	`getManagementNetworkType()` The type of the Network object used by the Management network. If the `getManagementNetwork()` property is set, then the {#link #managementNetworkType} field must be set. If the `getManagementNetwork()` property is `null`, then the `getManagementNetworkType()` property is ignored.
`java.lang.String`	`getName()` The name of the VCHA node to be used for the virtual machine name.
`java.lang.String`	`getResourcePool()` The identifier of the resource pool to deploy the VCHA node to.
`DiskSpec`	`getStorage()` The storage specification to deploy the VCHA node to.
`int`	`hashCode()`
`void`	`setFolder(java.lang.String folder)` The identifier of the folder to deploy the VCHA node to.
`void`	`setHaNetwork(java.lang.String haNetwork)` The identifier of the Network object used for the HA network. If the `getHaNetwork()` property is set, then the {#link #haNetworkType} property must be set. If the `getHaNetwork()` property is `null`, then the `getHaNetworkType()` property is ignored.
`void`	`setHaNetworkType(NetworkType haNetworkType)` The type of the Network object used by the HA network. If the `getHaNetwork()` property is set, then the `getHaNetworkType()` field must be set. If the `getHaNetwork()` property is `null`, then the `getHaNetworkType()` property is ignored.
`void`	`setHost(java.lang.String host)` The identifier of the host to deploy the VCHA node to.
`void`	`setManagementNetwork(java.lang.String managementNetwork)` The identifier of the Network object used for the Management network.
`void`	`setManagementNetworkType(NetworkType managementNetworkType)` The type of the Network object used by the Management network. If the `getManagementNetwork()` property is set, then the {#link #managementNetworkType} field must be set. If the `getManagementNetwork()` property is `null`, then the `getManagementNetworkType()` property is ignored.
`void`	`setName(java.lang.String name)` The name of the VCHA node to be used for the virtual machine name.
`void`	`setResourcePool(java.lang.String resourcePool)` The identifier of the resource pool to deploy the VCHA node to.
`void`	`setStorage(DiskSpec storage)` The storage specification to deploy the VCHA node to.
`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
  - getName
```
public java.lang.String getName()
```
    The name of the VCHA node to be used for the virtual machine name. This property was added in vSphere API 6.7.1.
    
    Returns:
    
    The current value of the property.
  - setName
```
public void setName(java.lang.String name)
```
    The name of the VCHA node to be used for the virtual machine name. This property was added in vSphere API 6.7.1.
    
    Parameters:
    
    name - New value for the property.
  - getFolder
```
public java.lang.String getFolder()
```
    The identifier of the folder to deploy the VCHA node to. This property was added in vSphere API 6.7.1.
    
    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:VCenter. When methods return a value of this class as a return value, the property will be an identifier for the resource type: Folder:VCenter.
  - setFolder
```
public void setFolder(java.lang.String folder)
```
    The identifier of the folder to deploy the VCHA node to. This property was added in vSphere API 6.7.1.
    
    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:VCenter. When methods return a value of this class as a return value, the property will be an identifier for the resource type: Folder:VCenter.
  - getHost
```
public java.lang.String getHost()
```
    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.
    
    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: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.
  - setHost
```
public void 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.
  - getResourcePool
```
public java.lang.String getResourcePool()
```
    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.
    
    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: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.
  - setResourcePool
```
public void 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.
  - getHaNetworkType
```
public NetworkType getHaNetworkType()
```
    The type of the Network object used by the HA network.
    If the getHaNetwork() property is set, then the getHaNetworkType() field must be set.
    If the getHaNetwork() property is null, then the getHaNetworkType() property is ignored. This property was added in vSphere API 6.7.1. If null and the 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 getHaNetwork() property is set, then an error is reported.
    
    Returns:
    
    The current value of the property.
  - setHaNetworkType
```
public void setHaNetworkType(NetworkType haNetworkType)
```
    The type of the Network object used by the HA network.
    If the getHaNetwork() property is set, then the getHaNetworkType() field must be set.
    If the getHaNetwork() property is null, then the getHaNetworkType() property is ignored. This property was added in vSphere API 6.7.1. If null and the 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 getHaNetwork() property is set, then an error is reported.
    
    Parameters:
    
    haNetworkType - New value for the property.
  - getHaNetwork
```
public java.lang.String getHaNetwork()
```
    The identifier of the Network object used for the HA network.
    If the getHaNetwork() property is set, then the {#link #haNetworkType} property must be set.
    If the getHaNetwork() property is null, then the getHaNetworkType() property is ignored. This property was added in vSphere API 6.7.1. If null and the 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.
    
    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: 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.
  - setHaNetwork
```
public void setHaNetwork(java.lang.String haNetwork)
```
    The identifier of the Network object used for the HA network.
    If the getHaNetwork() property is set, then the {#link #haNetworkType} property must be set.
    If the getHaNetwork() property is null, then the getHaNetworkType() property is ignored. This property was added in vSphere API 6.7.1. If null and the 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.
  - getManagementNetworkType
```
public NetworkType getManagementNetworkType()
```
    The type of the Network object used by the Management network.
    If the getManagementNetwork() property is set, then the {#link #managementNetworkType} field must be set.
    If the getManagementNetwork() property is null, then the getManagementNetworkType() property is ignored. This property was added in vSphere API 6.7.1. If null and the 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 getManagementNetwork() property is set, then an error is reported.
    
    Returns:
    
    The current value of the property.
  - setManagementNetworkType
```
public void setManagementNetworkType(NetworkType managementNetworkType)
```
    The type of the Network object used by the Management network.
    If the getManagementNetwork() property is set, then the {#link #managementNetworkType} field must be set.
    If the getManagementNetwork() property is null, then the getManagementNetworkType() property is ignored. This property was added in vSphere API 6.7.1. If null and the 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 getManagementNetwork() property is set, then an error is reported.
    
    Parameters:
    
    managementNetworkType - New value for the property.
  - getManagementNetwork
```
public java.lang.String getManagementNetwork()
```
    The identifier of the Network object used for the Management network. If the getManagementNetwork() property is set, then the getManagementNetworkType() property must be set.
    If the getManagementNetwork() property is null, then the getManagementNetworkType() property is ignored. This property was added in vSphere API 6.7.1. If null and the 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.
    
    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: 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.
  - setManagementNetwork
```
public void setManagementNetwork(java.lang.String managementNetwork)
```
    The identifier of the Network object used for the Management network. If the getManagementNetwork() property is set, then the getManagementNetworkType() property must be set.
    If the getManagementNetwork() property is null, then the getManagementNetworkType() property is ignored. This property was added in vSphere API 6.7.1. If null and the 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.
  - getStorage
```
public DiskSpec getStorage()
```
    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.
    
    Returns:
    
    The current value of the property.
  - setStorage
```
public void 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.
  - _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 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 PlacementSpec _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class 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

getName

setName

getFolder

setFolder

getHost

setHost

getResourcePool

setResourcePool

getHaNetworkType

setHaNetworkType

getHaNetwork

setHaNetwork

getManagementNetworkType

setManagementNetworkType

getManagementNetwork

setManagementNetwork

getStorage

setStorage

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2