JoinClusterParameters (Java SDK for NSX Manager API 4.1.2.0.0)

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

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class JoinClusterParameters
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
To join a new node to the NSX cluster, issue a JoinCluster API on the new node. The JoinCluster API takes this object as a parameter. Provide the ID of the NSX cluster you want the new node to join and the IP address of one of the nodes already in that cluster. The Cluster Boot Manager running on the new node will then add the new node to the NSX cluster by making a AttachClusterNode REST API call on the node that is already part of the cluster. In order to make a REST API call to the node in the cluster, the Cluster Boot Manager will need username and password of a priviledged user on the node in the cluster. In place of a username and password, Cluster Boot Manager could also use a OAuth token provided. The Cluster Boot Manager needs either the username and password or the OAuth token to make the REST call but not both.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class JoinClusterParameters.Builder
Builder class for JoinClusterParameters.

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

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
	`JoinClusterParameters()` Default constructor.
`protected`	`JoinClusterParameters(com.vmware.vapi.data.StructValue __dynamicStructureFields)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated 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 JoinClusterParameters`	`_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 JoinClusterParameters`	`_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`	`getCertficateSha256Thumbprint()` Deprecated.
`java.lang.String`	`getCertificateSha256Thumbprint()` SHA256 Thumbprint of the API certificate of the cluster node.
`java.lang.String`	`getClusterId()` UUID of the cluster to join.
`java.lang.String`	`getIpAddress()` IP address of a node already part of the cluster to join.
`java.lang.String`	`getPassword()` Password of the user on the cluster node.
`java.lang.Long`	`getPort()` API port on the cluster node.
`java.lang.String`	`getToken()` Limited time OAuth token instead of the username/password.
`java.lang.String`	`getUsername()` Username on the cluster node.
`int`	`hashCode()`
`void`	`setCertficateSha256Thumbprint(java.lang.String certficateSha256Thumbprint)` Deprecated.
`void`	`setCertificateSha256Thumbprint(java.lang.String certificateSha256Thumbprint)` SHA256 Thumbprint of the API certificate of the cluster node.
`void`	`setClusterId(java.lang.String clusterId)` UUID of the cluster to join.
`void`	`setIpAddress(java.lang.String ipAddress)` IP address of a node already part of the cluster to join.
`void`	`setPassword(java.lang.String password)` Password of the user on the cluster node.
`void`	`setPort(java.lang.Long port)` API port on the cluster node.
`void`	`setToken(java.lang.String token)` Limited time OAuth token instead of the username/password.
`void`	`setUsername(java.lang.String username)` Username on the cluster 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
  - JoinClusterParameters
```
public JoinClusterParameters()
```
    Default constructor.
  - JoinClusterParameters
```
protected JoinClusterParameters(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getCertficateSha256Thumbprint
```
@Deprecated
public java.lang.String getCertficateSha256Thumbprint()
```
    Deprecated.
    
    SHA256 Thumbprint of the API certificate of the cluster node.
    
    Returns:
    
    The current value of the property.
  - setCertficateSha256Thumbprint
```
@Deprecated
public void setCertficateSha256Thumbprint(java.lang.String certficateSha256Thumbprint)
```
    Deprecated.
    
    SHA256 Thumbprint of the API certificate of the cluster node.
    
    Parameters:
    
    certficateSha256Thumbprint - New value for the property.
  - getCertificateSha256Thumbprint
```
public java.lang.String getCertificateSha256Thumbprint()
```
    SHA256 Thumbprint of the API certificate of the cluster node.
    
    Returns:
    
    The current value of the property.
  - setCertificateSha256Thumbprint
```
public void setCertificateSha256Thumbprint(java.lang.String certificateSha256Thumbprint)
```
    SHA256 Thumbprint of the API certificate of the cluster node.
    
    Parameters:
    
    certificateSha256Thumbprint - New value for the property.
  - getClusterId
```
public java.lang.String getClusterId()
```
    UUID of the cluster to join.
    
    Returns:
    
    The current value of the property.
  - setClusterId
```
public void setClusterId(java.lang.String clusterId)
```
    UUID of the cluster to join.
    
    Parameters:
    
    clusterId - New value for the property.
  - getIpAddress
```
public java.lang.String getIpAddress()
```
    IP address of a node already part of the cluster to join.
    
    Returns:
    
    The current value of the property.
  - setIpAddress
```
public void setIpAddress(java.lang.String ipAddress)
```
    IP address of a node already part of the cluster to join.
    
    Parameters:
    
    ipAddress - New value for the property.
  - getPassword
```
public java.lang.String getPassword()
```
    Password of the user on the cluster node.
    
    Returns:
    
    The current value of the property.
  - setPassword
```
public void setPassword(java.lang.String password)
```
    Password of the user on the cluster node.
    
    Parameters:
    
    password - New value for the property.
  - getPort
```
public java.lang.Long getPort()
```
    API port on the cluster node. format: int64
    
    Returns:
    
    The current value of the property.
  - setPort
```
public void setPort(java.lang.Long port)
```
    API port on the cluster node. format: int64
    
    Parameters:
    
    port - New value for the property.
  - getToken
```
public java.lang.String getToken()
```
    Limited time OAuth token instead of the username/password.
    
    Returns:
    
    The current value of the property.
  - setToken
```
public void setToken(java.lang.String token)
```
    Limited time OAuth token instead of the username/password.
    
    Parameters:
    
    token - New value for the property.
  - getUsername
```
public java.lang.String getUsername()
```
    Username on the cluster node.
    
    Returns:
    
    The current value of the property.
  - setUsername
```
public void setUsername(java.lang.String username)
```
    Username on the cluster node.
    
    Parameters:
    
    username - 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 JoinClusterParameters _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 JoinClusterParameters _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class JoinClusterParameters

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

__dynamicStructureFields

Constructor Detail

JoinClusterParameters

JoinClusterParameters

Method Detail

getCertficateSha256Thumbprint

setCertficateSha256Thumbprint

getCertificateSha256Thumbprint

setCertificateSha256Thumbprint

getClusterId

setClusterId

getIpAddress

setIpAddress

getPassword

setPassword

getPort

setPort

getToken

setToken

getUsername

setUsername

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2