ClusterNodeEntity (Java SDK for NSX Manager API 4.1.0.2.0)

java.lang.Object
- com.vmware.nsx.model.ClusterNodeEntity

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class ClusterNodeEntity
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
NSX Cluster is made up of multiple cluster nodes. Each node can perform multiple functions, commonly referred to as roles. Cluster node entities are processes running in a cluster node that assist in the performance of a role. Cluster Boot Manager is a daemon that securely bootstraps and configures the entities. This type contains attributes of a cluster node entity that are relevant to the Cluster Boot Manager.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ClusterNodeEntity.Builder
Builder class for ClusterNodeEntity.

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected com.vmware.vapi.data.StructValue`	`__dynamicStructureFields`
`static java.lang.String`	`ENTITY_TYPE_ASYNC_REPLICATOR`
`static java.lang.String`	`ENTITY_TYPE_CLUSTER_BOOT_MANAGER`
`static java.lang.String`	`ENTITY_TYPE_CM_INVENTORY`
`static java.lang.String`	`ENTITY_TYPE_CONTROLLER`
`static java.lang.String`	`ENTITY_TYPE_CORFU_NONCONFIG`
`static java.lang.String`	`ENTITY_TYPE_DATASTORE`
`static java.lang.String`	`ENTITY_TYPE_GLOBAL_MANAGER`
`static java.lang.String`	`ENTITY_TYPE_HTTPS`
`static java.lang.String`	`ENTITY_TYPE_IDPS_REPORTING`
`static java.lang.String`	`ENTITY_TYPE_MANAGER`
`static java.lang.String`	`ENTITY_TYPE_MESSAGING_MANAGER`
`static java.lang.String`	`ENTITY_TYPE_MONITORING`
`static java.lang.String`	`ENTITY_TYPE_POLICY`
`static java.lang.String`	`ENTITY_TYPE_UPGRADE_COORDINATOR`

Constructor Summary

Constructors
Modifier Constructor and Description

ClusterNodeEntity()
Default constructor.

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

Constructors
Modifier	Constructor and Description
	`ClusterNodeEntity()` Default constructor.
`protected`	`ClusterNodeEntity(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 ClusterNodeEntity`	`_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 ClusterNodeEntity`	`_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`	`getCertificate()` Public certificate of the entity in PEM format
`java.lang.String`	`getEntityType()` Possible values are: `ENTITY_TYPE_MANAGER` `ENTITY_TYPE_CONTROLLER` `ENTITY_TYPE_POLICY` `ENTITY_TYPE_HTTPS` `ENTITY_TYPE_CLUSTER_BOOT_MANAGER` `ENTITY_TYPE_DATASTORE` `ENTITY_TYPE_GLOBAL_MANAGER` `ENTITY_TYPE_ASYNC_REPLICATOR` `ENTITY_TYPE_MONITORING` `ENTITY_TYPE_IDPS_REPORTING` `ENTITY_TYPE_CORFU_NONCONFIG` `ENTITY_TYPE_UPGRADE_COORDINATOR` `ENTITY_TYPE_CM_INVENTORY` `ENTITY_TYPE_MESSAGING_MANAGER` Type of the entity
`java.lang.String`	`getEntityUuid()` UUID of the entity
`java.lang.String`	`getFqdn()` Domain name the entity binds to format: hostname
`java.lang.String`	`getIpAddress()` IP address the entity binds to
`java.lang.String`	`getIpv6Address()` IPv6 address the entity binds to
`java.lang.Long`	`getIpv6SubnetPrefixLength()` IPv6 subnet mask prefix length of the entity binds to format: int64
`java.lang.Long`	`getPort()` Port the entity binds to format: int64
`java.lang.Long`	`getSubnetPrefixLength()` Subnet mask prefix length of the entity binds to format: int64
`int`	`hashCode()`
`void`	`setCertificate(java.lang.String certificate)` Public certificate of the entity in PEM format
`void`	`setEntityType(java.lang.String entityType)` Possible values are: `ENTITY_TYPE_MANAGER` `ENTITY_TYPE_CONTROLLER` `ENTITY_TYPE_POLICY` `ENTITY_TYPE_HTTPS` `ENTITY_TYPE_CLUSTER_BOOT_MANAGER` `ENTITY_TYPE_DATASTORE` `ENTITY_TYPE_GLOBAL_MANAGER` `ENTITY_TYPE_ASYNC_REPLICATOR` `ENTITY_TYPE_MONITORING` `ENTITY_TYPE_IDPS_REPORTING` `ENTITY_TYPE_CORFU_NONCONFIG` `ENTITY_TYPE_UPGRADE_COORDINATOR` `ENTITY_TYPE_CM_INVENTORY` `ENTITY_TYPE_MESSAGING_MANAGER` Type of the entity
`void`	`setEntityUuid(java.lang.String entityUuid)` UUID of the entity
`void`	`setFqdn(java.lang.String fqdn)` Domain name the entity binds to format: hostname
`void`	`setIpAddress(java.lang.String ipAddress)` IP address the entity binds to
`void`	`setIpv6Address(java.lang.String ipv6Address)` IPv6 address the entity binds to
`void`	`setIpv6SubnetPrefixLength(java.lang.Long ipv6SubnetPrefixLength)` IPv6 subnet mask prefix length of the entity binds to format: int64
`void`	`setPort(java.lang.Long port)` Port the entity binds to format: int64
`void`	`setSubnetPrefixLength(java.lang.Long subnetPrefixLength)` Subnet mask prefix length of the entity binds to format: int64
`java.lang.String`	`toString()`

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

- Field Detail
  - ENTITY_TYPE_MANAGER
```
public static final java.lang.String ENTITY_TYPE_MANAGER
```
    See Also:
    
    Constant Field Values
  - ENTITY_TYPE_CONTROLLER
```
public static final java.lang.String ENTITY_TYPE_CONTROLLER
```
    See Also:
    
    Constant Field Values
  - ENTITY_TYPE_POLICY
```
public static final java.lang.String ENTITY_TYPE_POLICY
```
    See Also:
    
    Constant Field Values
  - ENTITY_TYPE_HTTPS
```
public static final java.lang.String ENTITY_TYPE_HTTPS
```
    See Also:
    
    Constant Field Values
  - ENTITY_TYPE_CLUSTER_BOOT_MANAGER
```
public static final java.lang.String ENTITY_TYPE_CLUSTER_BOOT_MANAGER
```
    See Also:
    
    Constant Field Values
  - ENTITY_TYPE_DATASTORE
```
public static final java.lang.String ENTITY_TYPE_DATASTORE
```
    See Also:
    
    Constant Field Values
  - ENTITY_TYPE_GLOBAL_MANAGER
```
public static final java.lang.String ENTITY_TYPE_GLOBAL_MANAGER
```
    See Also:
    
    Constant Field Values
  - ENTITY_TYPE_ASYNC_REPLICATOR
```
public static final java.lang.String ENTITY_TYPE_ASYNC_REPLICATOR
```
    See Also:
    
    Constant Field Values
  - ENTITY_TYPE_MONITORING
```
public static final java.lang.String ENTITY_TYPE_MONITORING
```
    See Also:
    
    Constant Field Values
  - ENTITY_TYPE_IDPS_REPORTING
```
public static final java.lang.String ENTITY_TYPE_IDPS_REPORTING
```
    See Also:
    
    Constant Field Values
  - ENTITY_TYPE_CORFU_NONCONFIG
```
public static final java.lang.String ENTITY_TYPE_CORFU_NONCONFIG
```
    See Also:
    
    Constant Field Values
  - ENTITY_TYPE_UPGRADE_COORDINATOR
```
public static final java.lang.String ENTITY_TYPE_UPGRADE_COORDINATOR
```
    See Also:
    
    Constant Field Values
  - ENTITY_TYPE_CM_INVENTORY
```
public static final java.lang.String ENTITY_TYPE_CM_INVENTORY
```
    See Also:
    
    Constant Field Values
  - ENTITY_TYPE_MESSAGING_MANAGER
```
public static final java.lang.String ENTITY_TYPE_MESSAGING_MANAGER
```
    See Also:
    
    Constant Field Values
  - __dynamicStructureFields
```
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
```
- Constructor Detail
  - ClusterNodeEntity
```
public ClusterNodeEntity()
```
    Default constructor.
  - ClusterNodeEntity
```
protected ClusterNodeEntity(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getCertificate
```
public java.lang.String getCertificate()
```
    Public certificate of the entity in PEM format
    
    Returns:
    
    The current value of the property.
  - setCertificate
```
public void setCertificate(java.lang.String certificate)
```
    Public certificate of the entity in PEM format
    
    Parameters:
    
    certificate - New value for the property.
  - getEntityType
```
public java.lang.String getEntityType()
```
    Possible values are:
    Type of the entity
    Returns:
    
    The current value of the property.
  - setEntityType
```
public void setEntityType(java.lang.String entityType)
```
    Possible values are:
    Type of the entity
    Parameters:
    
    entityType - New value for the property.
  - getEntityUuid
```
public java.lang.String getEntityUuid()
```
    UUID of the entity
    
    Returns:
    
    The current value of the property.
  - setEntityUuid
```
public void setEntityUuid(java.lang.String entityUuid)
```
    UUID of the entity
    
    Parameters:
    
    entityUuid - New value for the property.
  - getFqdn
```
public java.lang.String getFqdn()
```
    Domain name the entity binds to format: hostname
    
    Returns:
    
    The current value of the property.
  - setFqdn
```
public void setFqdn(java.lang.String fqdn)
```
    Domain name the entity binds to format: hostname
    
    Parameters:
    
    fqdn - New value for the property.
  - getIpAddress
```
public java.lang.String getIpAddress()
```
    IP address the entity binds to
    
    Returns:
    
    The current value of the property.
  - setIpAddress
```
public void setIpAddress(java.lang.String ipAddress)
```
    IP address the entity binds to
    
    Parameters:
    
    ipAddress - New value for the property.
  - getIpv6Address
```
public java.lang.String getIpv6Address()
```
    IPv6 address the entity binds to
    
    Returns:
    
    The current value of the property.
  - setIpv6Address
```
public void setIpv6Address(java.lang.String ipv6Address)
```
    IPv6 address the entity binds to
    
    Parameters:
    
    ipv6Address - New value for the property.
  - getIpv6SubnetPrefixLength
```
public java.lang.Long getIpv6SubnetPrefixLength()
```
    IPv6 subnet mask prefix length of the entity binds to format: int64
    
    Returns:
    
    The current value of the property.
  - setIpv6SubnetPrefixLength
```
public void setIpv6SubnetPrefixLength(java.lang.Long ipv6SubnetPrefixLength)
```
    IPv6 subnet mask prefix length of the entity binds to format: int64
    
    Parameters:
    
    ipv6SubnetPrefixLength - New value for the property.
  - getPort
```
public java.lang.Long getPort()
```
    Port the entity binds to format: int64
    
    Returns:
    
    The current value of the property.
  - setPort
```
public void setPort(java.lang.Long port)
```
    Port the entity binds to format: int64
    
    Parameters:
    
    port - New value for the property.
  - getSubnetPrefixLength
```
public java.lang.Long getSubnetPrefixLength()
```
    Subnet mask prefix length of the entity binds to format: int64
    
    Returns:
    
    The current value of the property.
  - setSubnetPrefixLength
```
public void setSubnetPrefixLength(java.lang.Long subnetPrefixLength)
```
    Subnet mask prefix length of the entity binds to format: int64
    
    Parameters:
    
    subnetPrefixLength - 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 ClusterNodeEntity _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 ClusterNodeEntity _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class ClusterNodeEntity

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ENTITY_TYPE_MANAGER

ENTITY_TYPE_CONTROLLER

ENTITY_TYPE_POLICY

ENTITY_TYPE_HTTPS

ENTITY_TYPE_CLUSTER_BOOT_MANAGER

ENTITY_TYPE_DATASTORE

ENTITY_TYPE_GLOBAL_MANAGER

ENTITY_TYPE_ASYNC_REPLICATOR

ENTITY_TYPE_MONITORING

ENTITY_TYPE_IDPS_REPORTING

ENTITY_TYPE_CORFU_NONCONFIG

ENTITY_TYPE_UPGRADE_COORDINATOR

ENTITY_TYPE_CM_INVENTORY

ENTITY_TYPE_MESSAGING_MANAGER

__dynamicStructureFields

Constructor Detail

ClusterNodeEntity

ClusterNodeEntity

Method Detail

getCertificate

setCertificate

getEntityType

setEntityType

getEntityUuid

setEntityUuid

getFqdn

setFqdn

getIpAddress

setIpAddress

getIpv6Address

setIpv6Address

getIpv6SubnetPrefixLength

setIpv6SubnetPrefixLength

getPort

setPort

getSubnetPrefixLength

setSubnetPrefixLength

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2