PlacementInfo

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

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class PlacementInfo
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
The PlacementInfo class contains information to describe the inventory placement of a single node of a VCHA cluster.
The active node's management vCenter server credentials are required to populate all properties except biosUuid. 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 PlacementInfo.Builder
Builder class for PlacementInfo.

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

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

PlacementInfo()
Default constructor.

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

Constructors
Modifier	Constructor and Description
	`PlacementInfo()` Default constructor.
`protected`	`PlacementInfo(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 PlacementInfo`	`_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 PlacementInfo`	`_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`	`getBiosUuid()` BIOS UUID for the node.
`java.lang.String`	`getCluster()` The identifier of the cluster of which `getHost()` is member.
`java.lang.String`	`getClusterName()` The name of the cluster of which `getHost()` is member.
`java.lang.String`	`getDatacenter()` The identifier of the datacenter of the VCHA node.
`java.lang.String`	`getDatacenterName()` The name of the datacenter of the VCHA node.
`java.lang.String`	`getHaNetwork()` The identifier of the Network object used for the HA network.
`java.lang.String`	`getHaNetworkName()` The name of the Network object used for the HA network.
`NetworkType`	`getHaNetworkType()` The type of the Network object used for the HA network.
`java.lang.String`	`getHost()` The identifier of the host of the VCHA node.
`java.lang.String`	`getHostName()` The name of the host of the VCHA node.
`java.lang.String`	`getManagementNetwork()` The identifier of the Network object used for the Management network.
`java.lang.String`	`getManagementNetworkName()` The name of the Network object used for the Management network.
`NetworkType`	`getManagementNetworkType()` The type of the Network object used for the Management network.
`java.lang.String`	`getManagementVcenterName()` The hostname of the vCenter server that is managing the VCHA node.
`java.lang.String`	`getManagementVcenterServerGuid()` The unique identifier of the vCenter server that is managing the VCHA node.
`DiskInfo`	`getStorage()` The storage information of the VCHA node.
`java.lang.String`	`getVmName()` The virtual machine name of the VCHA node.
`int`	`hashCode()`
`void`	`setBiosUuid(java.lang.String biosUuid)` BIOS UUID for the node.
`void`	`setCluster(java.lang.String cluster)` The identifier of the cluster of which `getHost()` is member.
`void`	`setClusterName(java.lang.String clusterName)` The name of the cluster of which `getHost()` is member.
`void`	`setDatacenter(java.lang.String datacenter)` The identifier of the datacenter of the VCHA node.
`void`	`setDatacenterName(java.lang.String datacenterName)` The name of the datacenter of the VCHA node.
`void`	`setHaNetwork(java.lang.String haNetwork)` The identifier of the Network object used for the HA network.
`void`	`setHaNetworkName(java.lang.String haNetworkName)` The name of the Network object used for the HA network.
`void`	`setHaNetworkType(NetworkType haNetworkType)` The type of the Network object used for the HA network.
`void`	`setHost(java.lang.String host)` The identifier of the host of the VCHA node.
`void`	`setHostName(java.lang.String hostName)` The name of the host of the VCHA node.
`void`	`setManagementNetwork(java.lang.String managementNetwork)` The identifier of the Network object used for the Management network.
`void`	`setManagementNetworkName(java.lang.String managementNetworkName)` The name of the Network object used for the Management network.
`void`	`setManagementNetworkType(NetworkType managementNetworkType)` The type of the Network object used for the Management network.
`void`	`setManagementVcenterName(java.lang.String managementVcenterName)` The hostname of the vCenter server that is managing the VCHA node.
`void`	`setManagementVcenterServerGuid(java.lang.String managementVcenterServerGuid)` The unique identifier of the vCenter server that is managing the VCHA node.
`void`	`setStorage(DiskInfo storage)` The storage information of the VCHA node.
`void`	`setVmName(java.lang.String vmName)` The virtual machine name of the VCHA node.
`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
  - PlacementInfo
```
public PlacementInfo()
```
    Default constructor.
  - PlacementInfo
```
protected PlacementInfo(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getManagementVcenterName
```
public java.lang.String getManagementVcenterName()
```
    The hostname of the vCenter server that is managing the VCHA node. This property was added in vSphere API 6.7.1.
    
    Returns:
    
    The current value of the property.
  - setManagementVcenterName
```
public void setManagementVcenterName(java.lang.String managementVcenterName)
```
    The hostname of the vCenter server that is managing the VCHA node. This property was added in vSphere API 6.7.1.
    
    Parameters:
    
    managementVcenterName - New value for the property.
  - getManagementVcenterServerGuid
```
public java.lang.String getManagementVcenterServerGuid()
```
    The unique identifier of the vCenter server that is managing the VCHA node. This property was added in vSphere API 7.0.0.1. This property is optional because it was added in a newer version than its parent node.
    
    Returns:
    
    The current value of the property.
  - setManagementVcenterServerGuid
```
public void setManagementVcenterServerGuid(java.lang.String managementVcenterServerGuid)
```
    The unique identifier of the vCenter server that is managing the VCHA node. This property was added in vSphere API 7.0.0.1. This property is optional because it was added in a newer version than its parent node.
    
    Parameters:
    
    managementVcenterServerGuid - New value for the property.
  - getVmName
```
public java.lang.String getVmName()
```
    The virtual machine name of the VCHA node. This property was added in vSphere API 6.7.1.
    
    Returns:
    
    The current value of the property.
  - setVmName
```
public void setVmName(java.lang.String vmName)
```
    The virtual machine name of the VCHA node. This property was added in vSphere API 6.7.1.
    
    Parameters:
    
    vmName - New value for the property.
  - getDatacenter
```
public java.lang.String getDatacenter()
```
    The identifier of the datacenter of the VCHA node. 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: Datacenter:VCenter. When methods return a value of this class as a return value, the property will be an identifier for the resource type: Datacenter:VCenter.
  - setDatacenter
```
public void setDatacenter(java.lang.String datacenter)
```
    The identifier of the datacenter of the VCHA node. This property was added in vSphere API 6.7.1.
    
    Parameters:
    
    datacenter - 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: Datacenter:VCenter. When methods return a value of this class as a return value, the property will be an identifier for the resource type: Datacenter:VCenter.
  - getDatacenterName
```
public java.lang.String getDatacenterName()
```
    The name of the datacenter of the VCHA node. This property was added in vSphere API 6.7.1.
    
    Returns:
    
    The current value of the property.
  - setDatacenterName
```
public void setDatacenterName(java.lang.String datacenterName)
```
    The name of the datacenter of the VCHA node. This property was added in vSphere API 6.7.1.
    
    Parameters:
    
    datacenterName - New value for the property.
  - getHost
```
public java.lang.String getHost()
```
    The identifier of the host of the VCHA node. 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: 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 of the VCHA node. This property was added in vSphere API 6.7.1.
    
    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.
  - getHostName
```
public java.lang.String getHostName()
```
    The name of the host of the VCHA node. This property was added in vSphere API 6.7.1.
    
    Returns:
    
    The current value of the property.
  - setHostName
```
public void setHostName(java.lang.String hostName)
```
    The name of the host of the VCHA node. This property was added in vSphere API 6.7.1.
    
    Parameters:
    
    hostName - New value for the property.
  - getCluster
```
public java.lang.String getCluster()
```
    The identifier of the cluster of which getHost() is member. This property was added in vSphere API 6.7.1. If null, getHost() is a standalone 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: ClusterComputeResource:VCenter. When methods return a value of this class as a return value, the property will be an identifier for the resource type: ClusterComputeResource:VCenter.
  - setCluster
```
public void setCluster(java.lang.String cluster)
```
    The identifier of the cluster of which getHost() is member. This property was added in vSphere API 6.7.1. If null, getHost() is a standalone host.
    
    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:VCenter. When methods return a value of this class as a return value, the property will be an identifier for the resource type: ClusterComputeResource:VCenter.
  - getClusterName
```
public java.lang.String getClusterName()
```
    The name of the cluster of which getHost() is member. This property was added in vSphere API 6.7.1. If null, getHost() is a standalone host.
    
    Returns:
    
    The current value of the property.
  - setClusterName
```
public void setClusterName(java.lang.String clusterName)
```
    The name of the cluster of which getHost() is member. This property was added in vSphere API 6.7.1. If null, getHost() is a standalone host.
    
    Parameters:
    
    clusterName - New value for the property.
  - getHaNetwork
```
public java.lang.String getHaNetwork()
```
    The identifier of the Network object used for the HA network. This property was added in vSphere API 6.7.1. If null, the information is currently unavailable or the haNetwork is not configured.
    
    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. This property was added in vSphere API 6.7.1. If null, the information is currently unavailable or the haNetwork is not configured.
    
    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.
  - getHaNetworkName
```
public java.lang.String getHaNetworkName()
```
    The name of the Network object used for the HA network. This property was added in vSphere API 6.7.1. If null, the information is currently unavailable or the haNetwork is not configured.
    
    Returns:
    
    The current value of the property.
  - setHaNetworkName
```
public void setHaNetworkName(java.lang.String haNetworkName)
```
    The name of the Network object used for the HA network. This property was added in vSphere API 6.7.1. If null, the information is currently unavailable or the haNetwork is not configured.
    
    Parameters:
    
    haNetworkName - New value for the property.
  - getHaNetworkType
```
public NetworkType getHaNetworkType()
```
    The type of the Network object used for the HA network. This property was added in vSphere API 6.7.1. If null, the information is currently unavailable or the haNetwork is not configured.
    
    Returns:
    
    The current value of the property.
  - setHaNetworkType
```
public void setHaNetworkType(NetworkType haNetworkType)
```
    The type of the Network object used for the HA network. This property was added in vSphere API 6.7.1. If null, the information is currently unavailable or the haNetwork is not configured.
    
    Parameters:
    
    haNetworkType - New value for the property.
  - getManagementNetwork
```
public java.lang.String getManagementNetwork()
```
    The identifier of the Network object used for the Management network. 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: 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. This property was added in vSphere API 6.7.1.
    
    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.
  - getManagementNetworkName
```
public java.lang.String getManagementNetworkName()
```
    The name of the Network object used for the Management network. This property was added in vSphere API 6.7.1.
    
    Returns:
    
    The current value of the property.
  - setManagementNetworkName
```
public void setManagementNetworkName(java.lang.String managementNetworkName)
```
    The name of the Network object used for the Management network. This property was added in vSphere API 6.7.1.
    
    Parameters:
    
    managementNetworkName - New value for the property.
  - getManagementNetworkType
```
public NetworkType getManagementNetworkType()
```
    The type of the Network object used for the Management network. This property was added in vSphere API 6.7.1.
    
    Returns:
    
    The current value of the property.
  - setManagementNetworkType
```
public void setManagementNetworkType(NetworkType managementNetworkType)
```
    The type of the Network object used for the Management network. This property was added in vSphere API 6.7.1.
    
    Parameters:
    
    managementNetworkType - New value for the property.
  - getStorage
```
public DiskInfo getStorage()
```
    The storage information of the VCHA node. This property was added in vSphere API 6.7.1.
    
    Returns:
    
    The current value of the property.
  - setStorage
```
public void setStorage(DiskInfo storage)
```
    The storage information of the VCHA node. This property was added in vSphere API 6.7.1.
    
    Parameters:
    
    storage - New value for the property.
  - getBiosUuid
```
public java.lang.String getBiosUuid()
```
    BIOS UUID for the node. This property was added in vSphere API 6.7.1. If null, the information is currently unavailable.
    
    Returns:
    
    The current value of the property.
  - setBiosUuid
```
public void setBiosUuid(java.lang.String biosUuid)
```
    BIOS UUID for the node. This property was added in vSphere API 6.7.1. If null, the information is currently unavailable.
    
    Parameters:
    
    biosUuid - 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 PlacementInfo _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 PlacementInfo _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class PlacementInfo

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

__dynamicStructureFields

Constructor Detail

PlacementInfo

PlacementInfo

Method Detail

getManagementVcenterName

setManagementVcenterName

getManagementVcenterServerGuid

setManagementVcenterServerGuid

getVmName

setVmName

getDatacenter

setDatacenter

getDatacenterName

setDatacenterName

getHost

setHost

getHostName

setHostName

getCluster

setCluster

getClusterName

setClusterName

getHaNetwork

setHaNetwork

getHaNetworkName

setHaNetworkName

getHaNetworkType

setHaNetworkType

getManagementNetwork

setManagementNetwork

getManagementNetworkName

setManagementNetworkName

getManagementNetworkType

setManagementNetworkType

getStorage

setStorage

getBiosUuid

setBiosUuid

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2