Cluster (VMware-vmc-SDK-Java)

java.lang.Object
- com.vmware.vmc.model.Cluster

All Implemented Interfaces:: StaticStructure, Structure, java.io.Serializable

public final class Cluster
extends java.lang.Object
implements java.io.Serializable, StaticStructure

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Cluster.Builder
Builder class for Cluster.

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected StructValue`	`__dynamicStructureFields`
`static java.lang.String`	`AVAILABILITY_TYPE_MULTI_AZ`
`static java.lang.String`	`AVAILABILITY_TYPE_SINGLE_AZ`
`static java.lang.String`	`CLUSTER_STATE_ADDING_HOSTS`
`static java.lang.String`	`CLUSTER_STATE_DEPLOYING`
`static java.lang.String`	`CLUSTER_STATE_FAILED`
`static java.lang.String`	`CLUSTER_STATE_READY`

Constructor Summary

Constructors
Modifier Constructor and Description

Cluster()
Default constructor.

protected Cluster(StructValue __dynamicStructureFields)

Constructors
Modifier	Constructor and Description
	`Cluster()` Default constructor.
`protected`	`Cluster(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 a dynamic field value, doesn't allow access to static fields (which have getters/setters).
`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 Cluster`	`_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 Cluster`	`_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`	`getAvailabilityType()` Possible values are: `AVAILABILITY_TYPE_SINGLE_AZ` `AVAILABILITY_TYPE_MULTI_AZ`
`java.util.List<java.lang.String>`	`getAvailabilityZones()`
`AwsKmsInfo`	`getAwsKmsInfo()` AWS Key Management Service information associated with this cluster
`EntityCapacity`	`getClusterCapacity()` The capacity of this cluster.
`java.lang.String`	`getClusterId()`
`java.lang.String`	`getClusterName()`
`java.lang.String`	`getClusterState()` Possible values are: `CLUSTER_STATE_DEPLOYING` `CLUSTER_STATE_ADDING_HOSTS` `CLUSTER_STATE_READY` `CLUSTER_STATE_FAILED`
`java.lang.String`	`getComputeRpName()`
`java.util.Map<java.lang.String,java.lang.String>`	`getCustomProperties()`
`EsxHostInfo`	`getEsxHostInfo()` Information of the hosts added to this cluster
`java.util.List<AwsEsxHost>`	`getEsxHostList()`
`java.lang.Long`	`getHostCpuCoresCount()` Number of cores enabled on ESX hosts added to this cluster format: int32
`java.lang.Boolean`	`getHyperThreadingEnabled()` Specifies whether hyperThreading is disabled/enabled explicitly
`java.lang.String`	`getMgmtRpName()`
`MsftLicensingConfig`	`getMsftLicenseConfig()` The Microsoft license configuration of this cluster.
`java.util.List<PartitionPlacementGroupInfo>`	`getPartitionPlacementGroupInfo()` Partition placement group infos
`java.lang.String`	`getVsanVersion()` Version of vSAN used in this cluster.
`AwsWitnessEsx`	`getVsanWitness()` Witness node
`WcpDetails`	`getWcpDetails()` WCP details for a given cluster
`int`	`hashCode()`
`void`	`setAvailabilityType(java.lang.String availabilityType)` Possible values are: `AVAILABILITY_TYPE_SINGLE_AZ` `AVAILABILITY_TYPE_MULTI_AZ`
`void`	`setAvailabilityZones(java.util.List<java.lang.String> availabilityZones)`
`void`	`setAwsKmsInfo(AwsKmsInfo awsKmsInfo)` AWS Key Management Service information associated with this cluster
`void`	`setClusterCapacity(EntityCapacity clusterCapacity)` The capacity of this cluster.
`void`	`setClusterId(java.lang.String clusterId)`
`void`	`setClusterName(java.lang.String clusterName)`
`void`	`setClusterState(java.lang.String clusterState)` Possible values are: `CLUSTER_STATE_DEPLOYING` `CLUSTER_STATE_ADDING_HOSTS` `CLUSTER_STATE_READY` `CLUSTER_STATE_FAILED`
`void`	`setComputeRpName(java.lang.String computeRpName)`
`void`	`setCustomProperties(java.util.Map<java.lang.String,java.lang.String> customProperties)`
`void`	`setEsxHostInfo(EsxHostInfo esxHostInfo)` Information of the hosts added to this cluster
`void`	`setEsxHostList(java.util.List<AwsEsxHost> esxHostList)`
`void`	`setHostCpuCoresCount(java.lang.Long hostCpuCoresCount)` Number of cores enabled on ESX hosts added to this cluster format: int32
`void`	`setHyperThreadingEnabled(java.lang.Boolean hyperThreadingEnabled)` Specifies whether hyperThreading is disabled/enabled explicitly
`void`	`setMgmtRpName(java.lang.String mgmtRpName)`
`void`	`setMsftLicenseConfig(MsftLicensingConfig msftLicenseConfig)` The Microsoft license configuration of this cluster.
`void`	`setPartitionPlacementGroupInfo(java.util.List<PartitionPlacementGroupInfo> partitionPlacementGroupInfo)` Partition placement group infos
`void`	`setVsanVersion(java.lang.String vsanVersion)` Version of vSAN used in this cluster.
`void`	`setVsanWitness(AwsWitnessEsx vsanWitness)` Witness node
`void`	`setWcpDetails(WcpDetails wcpDetails)` WCP details for a given cluster
`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
  - CLUSTER_STATE_DEPLOYING
```
public static final java.lang.String CLUSTER_STATE_DEPLOYING
```
    See Also:
    
    Constant Field Values
  - CLUSTER_STATE_ADDING_HOSTS
```
public static final java.lang.String CLUSTER_STATE_ADDING_HOSTS
```
    See Also:
    
    Constant Field Values
  - CLUSTER_STATE_READY
```
public static final java.lang.String CLUSTER_STATE_READY
```
    See Also:
    
    Constant Field Values
  - CLUSTER_STATE_FAILED
```
public static final java.lang.String CLUSTER_STATE_FAILED
```
    See Also:
    
    Constant Field Values
  - AVAILABILITY_TYPE_SINGLE_AZ
```
public static final java.lang.String AVAILABILITY_TYPE_SINGLE_AZ
```
    See Also:
    
    Constant Field Values
  - AVAILABILITY_TYPE_MULTI_AZ
```
public static final java.lang.String AVAILABILITY_TYPE_MULTI_AZ
```
    See Also:
    
    Constant Field Values
  - __dynamicStructureFields
```
protected StructValue __dynamicStructureFields
```
- Constructor Detail
  - Cluster
```
public Cluster()
```
    Default constructor.
  - Cluster
```
protected Cluster(StructValue __dynamicStructureFields)
```
- Method Detail
  - getClusterCapacity
```
public EntityCapacity getClusterCapacity()
```
    The capacity of this cluster.
    
    Returns:
    
    The current value of the property.
  - setClusterCapacity
```
public void setClusterCapacity(EntityCapacity clusterCapacity)
```
    The capacity of this cluster.
    
    Parameters:
    
    clusterCapacity - New value for the property.
  - getEsxHostList
```
public java.util.List<AwsEsxHost> getEsxHostList()
```
    Returns:
    
    The current value of the property.
  - setEsxHostList
```
public void setEsxHostList(java.util.List<AwsEsxHost> esxHostList)
```
    Parameters:
    
    esxHostList - New value for the property.
  - getWcpDetails
```
public WcpDetails getWcpDetails()
```
    WCP details for a given cluster
    
    Returns:
    
    The current value of the property.
  - setWcpDetails
```
public void setWcpDetails(WcpDetails wcpDetails)
```
    WCP details for a given cluster
    
    Parameters:
    
    wcpDetails - New value for the property.
  - getMsftLicenseConfig
```
public MsftLicensingConfig getMsftLicenseConfig()
```
    The Microsoft license configuration of this cluster.
    
    Returns:
    
    The current value of the property.
  - setMsftLicenseConfig
```
public void setMsftLicenseConfig(MsftLicensingConfig msftLicenseConfig)
```
    The Microsoft license configuration of this cluster.
    
    Parameters:
    
    msftLicenseConfig - New value for the property.
  - getClusterState
```
public java.lang.String getClusterState()
```
    Possible values are:
    Returns:
    
    The current value of the property.
  - setClusterState
```
public void setClusterState(java.lang.String clusterState)
```
    Possible values are:
    Parameters:
    
    clusterState - New value for the property.
  - getEsxHostInfo
```
public EsxHostInfo getEsxHostInfo()
```
    Information of the hosts added to this cluster
    
    Returns:
    
    The current value of the property.
  - setEsxHostInfo
```
public void setEsxHostInfo(EsxHostInfo esxHostInfo)
```
    Information of the hosts added to this cluster
    
    Parameters:
    
    esxHostInfo - New value for the property.
  - getHostCpuCoresCount
```
public java.lang.Long getHostCpuCoresCount()
```
    Number of cores enabled on ESX hosts added to this cluster format: int32
    
    Returns:
    
    The current value of the property.
  - setHostCpuCoresCount
```
public void setHostCpuCoresCount(java.lang.Long hostCpuCoresCount)
```
    Number of cores enabled on ESX hosts added to this cluster format: int32
    
    Parameters:
    
    hostCpuCoresCount - New value for the property.
  - getPartitionPlacementGroupInfo
```
public java.util.List<PartitionPlacementGroupInfo> getPartitionPlacementGroupInfo()
```
    Partition placement group infos
    
    Returns:
    
    The current value of the property.
  - setPartitionPlacementGroupInfo
```
public void setPartitionPlacementGroupInfo(java.util.List<PartitionPlacementGroupInfo> partitionPlacementGroupInfo)
```
    Partition placement group infos
    
    Parameters:
    
    partitionPlacementGroupInfo - New value for the property.
  - getClusterId
```
public java.lang.String getClusterId()
```
    Returns:
    
    The current value of the property.
  - setClusterId
```
public void setClusterId(java.lang.String clusterId)
```
    Parameters:
    
    clusterId - New value for the property.
  - getAvailabilityType
```
public java.lang.String getAvailabilityType()
```
    Possible values are:
    - AVAILABILITY_TYPE_SINGLE_AZ
    - AVAILABILITY_TYPE_MULTI_AZ
    Returns:
    
    The current value of the property.
  - setAvailabilityType
```
public void setAvailabilityType(java.lang.String availabilityType)
```
    Possible values are:
    - AVAILABILITY_TYPE_SINGLE_AZ
    - AVAILABILITY_TYPE_MULTI_AZ
    Parameters:
    
    availabilityType - New value for the property.
  - getMgmtRpName
```
public java.lang.String getMgmtRpName()
```
    Returns:
    
    The current value of the property.
  - setMgmtRpName
```
public void setMgmtRpName(java.lang.String mgmtRpName)
```
    Parameters:
    
    mgmtRpName - New value for the property.
  - getAwsKmsInfo
```
public AwsKmsInfo getAwsKmsInfo()
```
    AWS Key Management Service information associated with this cluster
    
    Returns:
    
    The current value of the property.
  - setAwsKmsInfo
```
public void setAwsKmsInfo(AwsKmsInfo awsKmsInfo)
```
    AWS Key Management Service information associated with this cluster
    
    Parameters:
    
    awsKmsInfo - New value for the property.
  - getAvailabilityZones
```
public java.util.List<java.lang.String> getAvailabilityZones()
```
    Returns:
    
    The current value of the property.
  - setAvailabilityZones
```
public void setAvailabilityZones(java.util.List<java.lang.String> availabilityZones)
```
    Parameters:
    
    availabilityZones - New value for the property.
  - getComputeRpName
```
public java.lang.String getComputeRpName()
```
    Returns:
    
    The current value of the property.
  - setComputeRpName
```
public void setComputeRpName(java.lang.String computeRpName)
```
    Parameters:
    
    computeRpName - New value for the property.
  - getVsanWitness
```
public AwsWitnessEsx getVsanWitness()
```
    Witness node
    
    Returns:
    
    The current value of the property.
  - setVsanWitness
```
public void setVsanWitness(AwsWitnessEsx vsanWitness)
```
    Witness node
    
    Parameters:
    
    vsanWitness - New value for the property.
  - getCustomProperties
```
public java.util.Map<java.lang.String,java.lang.String> getCustomProperties()
```
    Returns:
    
    The current value of the property.
  - setCustomProperties
```
public void setCustomProperties(java.util.Map<java.lang.String,java.lang.String> customProperties)
```
    Parameters:
    
    customProperties - New value for the property.
  - getClusterName
```
public java.lang.String getClusterName()
```
    Returns:
    
    The current value of the property.
  - setClusterName
```
public void setClusterName(java.lang.String clusterName)
```
    Parameters:
    
    clusterName - New value for the property.
  - getVsanVersion
```
public java.lang.String getVsanVersion()
```
    Version of vSAN used in this cluster. Empty means vsan 1.0
    
    Returns:
    
    The current value of the property.
  - setVsanVersion
```
public void setVsanVersion(java.lang.String vsanVersion)
```
    Version of vSAN used in this cluster. Empty means vsan 1.0
    
    Parameters:
    
    vsanVersion - New value for the property.
  - getHyperThreadingEnabled
```
public java.lang.Boolean getHyperThreadingEnabled()
```
    Specifies whether hyperThreading is disabled/enabled explicitly
    
    Returns:
    
    The current value of the property.
  - setHyperThreadingEnabled
```
public void setHyperThreadingEnabled(java.lang.Boolean hyperThreadingEnabled)
```
    Specifies whether hyperThreading is disabled/enabled explicitly
    
    Parameters:
    
    hyperThreadingEnabled - 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 structure definition, i.e. not represented with getter/setter.

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 a dynamic field value, doesn't allow access to static fields (which have getters/setters).

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 Cluster _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 Cluster _newInstance2(StructValue structValue)
```
WARNING: Internal method, subject to change in future versions.
Serves as a versioning mechanism.

Class Cluster

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CLUSTER_STATE_DEPLOYING

CLUSTER_STATE_ADDING_HOSTS

CLUSTER_STATE_READY

CLUSTER_STATE_FAILED

AVAILABILITY_TYPE_SINGLE_AZ

AVAILABILITY_TYPE_MULTI_AZ

__dynamicStructureFields

Constructor Detail

Cluster

Cluster

Method Detail

getClusterCapacity

setClusterCapacity

getEsxHostList

setEsxHostList

getWcpDetails

setWcpDetails

getMsftLicenseConfig

setMsftLicenseConfig

getClusterState

setClusterState

getEsxHostInfo

setEsxHostInfo

getHostCpuCoresCount

setHostCpuCoresCount

getPartitionPlacementGroupInfo

setPartitionPlacementGroupInfo

getClusterId

setClusterId

getAvailabilityType

setAvailabilityType

getMgmtRpName

setMgmtRpName

getAwsKmsInfo

setAwsKmsInfo

getAvailabilityZones

setAvailabilityZones

getComputeRpName

setComputeRpName

getVsanWitness

setVsanWitness

getCustomProperties

setCustomProperties

getClusterName

setClusterName

getVsanVersion

setVsanVersion

getHyperThreadingEnabled

setHyperThreadingEnabled

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2