PlacementSpec (vSphere Automation SDK for Java 7.0.1.0)

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

All Implemented Interfaces:

StaticStructure, Structure, java.io.Serializable
```
public final class PlacementSpec
extends java.lang.Object
implements java.io.Serializable, 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 StructValue __dynamicStructureFields

Fields
Modifier and Type	Field and Description
`protected StructValue`	`__dynamicStructureFields`

Constructor Summary

Constructors
Modifier Constructor and Description

PlacementSpec()
Default constructor.

protected PlacementSpec(StructValue __dynamicStructureFields)

Constructors
Modifier	Constructor and Description
	`PlacementSpec()` Default constructor.
`protected`	`PlacementSpec(StructValue __dynamicStructureFields)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T extends Structure> T`	`_convertTo(java.lang.Class<T> clazz)` Converts this structure into an instance of the provided class structure if possible.
`java.lang.String`	`_getCanonicalName()` Returns the canonical name of the structure.
`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.
`StructValue`	`_getDataValue()` Returns this `Structure` represented in the dynamic `DataValue` model.
`DataValue`	`_getDynamicField(java.lang.String fieldName)` Get dynamic filed value.
`java.util.Set<java.lang.String>`	`_getDynamicFieldNames()` Get the names of the dynamic fields in the structure.
`com.vmware.vapi.bindings.type.StructType`	`_getType()` WARNING: Internal method, subject to change in future versions.
`boolean`	`_hasTypeNameOf(java.lang.Class<? extends Structure> clazz)` Checks if the runtime type name of this structure matches the type represented by the specified binding class.
`static PlacementSpec`	`_newInstance(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(StructValue structValue)` WARNING: Internal method, subject to change in future versions. Serves as a versioning mechanism.
`void`	`_setDynamicField(java.lang.String fieldName, DataValue fieldValue)` Sets a dynamic field value.
`protected void`	`_updateDataValue(StructValue structValue)`
`void`	`_validate()` Validates the state of the discriminated unions and HasFieldsOf restrictions (if any) in this Java language binding `Structure`.
`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()` Returns a string representation of this structure.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - __dynamicStructureFields
```
protected StructValue __dynamicStructureFields
```
- Constructor Detail
  - PlacementSpec
```
public PlacementSpec()
```
    Default constructor.
  - PlacementSpec
```
protected PlacementSpec(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()
```
    Description copied from interface: StaticStructure
    
    WARNING: Internal method, subject to change in future versions. Returns StructType instance representing the static bindings type for this Structure.
    
    Specified by:
    
    _getType in interface StaticStructure
    
    Returns:
    
    the static bindings StructType
  - _getDataValue
```
public StructValue _getDataValue()
```
    Description copied from interface: Structure
    
    Returns this Structure represented in the dynamic DataValue model.
    Attempts to change the returned StructValue representation are not required to change the state of this structure. Actually the behavior is implementation dependent and is unspecified. In general the returned value shouldn't be changed.
    
    Specified by:
    
    _getDataValue in interface Structure
    
    Returns:
    
    StructValue representing this structure
  - _updateDataValue
```
protected void _updateDataValue(StructValue structValue)
```
  - _validate
```
public void _validate()
```
    Description copied from interface: StaticStructure
    
    Validates the state of the discriminated unions and HasFieldsOf restrictions (if any) in this Java language binding Structure.
    More precisely, for each union: given value of the discriminant/tag field (@UnionTag in the IDL) of an union in this structure, validates that:
  - all fields of the union required for that value of the discriminant are set
  - fields of the union that are not allowed for that value of the discriminant are not set
  - any other fields of the structure (not participating in the union) do not affect the validation result

Specified by:: _validate in interface 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()
```
Description copied from interface: StaticStructure

Returns a string representation of this structure. The result is pretty printed in order to be easy to read. It is intended to be used for different debugging/tracing purposes, e.g. dumping structures into logging traces.
In general no code should depend on the format of the resulting string. E.g. there must be no attempts to parse for re-creation of the original instance.

Specified by:

toString in interface StaticStructure

Overrides:

toString in class java.lang.Object

Returns:

a string representation of this static structure instance

_hasTypeNameOf
```
public boolean _hasTypeNameOf(java.lang.Class<? extends Structure> clazz)
```
Description copied from interface: Structure

Checks if the runtime type name of this structure matches the type represented by the specified binding class.
This can be used as efficient check to determine if this instance can be successfully converted to the target type.

Specified by:

_hasTypeNameOf in interface Structure

Parameters:

clazz - bindings class for the target structure; must not be null

Returns:

true if this structures type name matches exactly the specified class' type name.

_convertTo
```
public <T extends Structure> T _convertTo(java.lang.Class<T> clazz)
```
Description copied from interface: Structure

Converts this structure into an instance of the provided class structure if possible. A conversion will be possible if the requested structure's fields are all present in this structure.

Specified by:

_convertTo in interface Structure

Parameters:

clazz - type of the result structure. cannot be null.

Returns:

an instance of the requested type if conversion is possible. CoreException is thrown otherwise.

_setDynamicField
```
public void _setDynamicField(java.lang.String fieldName,
                             DataValue fieldValue)
```
Description copied from interface: StaticStructure

Sets a dynamic field value. The dynamic filed is extra filed that is not part of the static fields of the structure.

Specified by:

_setDynamicField in interface StaticStructure

Parameters:

fieldName - canonical name of the dynamic field to set

fieldValue - the value of the field

_getDynamicField
```
public DataValue _getDynamicField(java.lang.String fieldName)
```
Description copied from interface: StaticStructure

Get dynamic filed value. Works only on dynamic fields.

Specified by:

_getDynamicField in interface StaticStructure

Parameters:

fieldName - the canonical name of the dynamic field

Returns:

the DataValue of the dynamic field

_getDynamicFieldNames
```
public java.util.Set<java.lang.String> _getDynamicFieldNames()
```
Description copied from interface: StaticStructure

Get the names of the dynamic fields in the structure.

Specified by:

_getDynamicFieldNames in interface StaticStructure

Returns:

set of the canonical field names for the dynamic fields

_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()
```
Description copied from interface: Structure

Returns the canonical name of the structure. By default the canonical name is derived from the fully-qualified IDL name by converting to lower case and inserting underscores between words. For example org.example.FooBar would turn into org.example.foo_bar.

Specified by:

_getCanonicalName in interface Structure

Returns:

canonical name

_getCanonicalTypeName
```
public static java.lang.String _getCanonicalTypeName()
```
Returns the canonical type name. See _getCanonicalName().

Returns:

canonical type name

_newInstance
```
public static PlacementSpec _newInstance(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(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