EdgeNode (Java SDK for NSX Manager API 4.1.2.0.0)

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

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class EdgeNode
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class EdgeNode.Builder
Builder class for EdgeNode.

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected com.vmware.vapi.data.StructValue`	`__dynamicStructureFields`
`static java.lang.String`	`_TYPE_IDENTIFIER` Identifier denoting this class, when it is used in polymorphic context.
`static java.lang.String`	`DEPLOYMENT_TYPE_PHYSICAL_MACHINE`
`static java.lang.String`	`DEPLOYMENT_TYPE_UNKNOWN`
`static java.lang.String`	`DEPLOYMENT_TYPE_VIRTUAL_MACHINE`

Constructor Summary

Constructors
Modifier Constructor and Description

EdgeNode()
Default constructor.

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

Constructors
Modifier	Constructor and Description
	`EdgeNode()` Default constructor.
`protected`	`EdgeNode(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 EdgeNode`	`_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 EdgeNode`	`_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.util.List<java.lang.String>`	`getAllocationList()` List of logical router ids to which this edge node is allocated.
`EdgeNodeDeploymentConfig`	`getDeploymentConfig()`
`java.lang.String`	`getDeploymentType()` Possible values are: `DEPLOYMENT_TYPE_VIRTUAL_MACHINE` `DEPLOYMENT_TYPE_PHYSICAL_MACHINE` `DEPLOYMENT_TYPE_UNKNOWN` Supported edge deployment type.
`java.lang.String`	`getDescription()` Deprecated.
`java.util.List<java.lang.String>`	`getDiscoveredIpAddresses()` Discovered IP Addresses of the fabric node, version 4 or 6 format: ip This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`java.lang.String`	`getDisplayName()` Deprecated.
`java.lang.String`	`getExternalId()` ID of the Node maintained on the Node and used to recognize the Node
`java.lang.String`	`getFqdn()` Fully qualified domain name of the fabric node This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`java.lang.String`	`getId()` Unique identifier of this resource.
`java.util.List<java.lang.String>`	`getIpAddresses()` IP Addresses of the Node, version 4 or 6.
`EdgeNodeSettings`	`getNodeSettings()`
`java.lang.String`	`getResourceType()` Fabric node type, for example 'HostNode', 'EdgeNode' or 'PublicCloudGatewayNode' The value of this property is automatically populated to `"EdgeNode"`.
`java.util.List<Tag>`	`getTags()` Deprecated.
`int`	`hashCode()`
`void`	`setAllocationList(java.util.List<java.lang.String> allocationList)` List of logical router ids to which this edge node is allocated.
`void`	`setDeploymentConfig(EdgeNodeDeploymentConfig deploymentConfig)`
`void`	`setDeploymentType(java.lang.String deploymentType)` Possible values are: `DEPLOYMENT_TYPE_VIRTUAL_MACHINE` `DEPLOYMENT_TYPE_PHYSICAL_MACHINE` `DEPLOYMENT_TYPE_UNKNOWN` Supported edge deployment type.
`void`	`setDescription(java.lang.String description)` Deprecated.
`void`	`setDiscoveredIpAddresses(java.util.List<java.lang.String> discoveredIpAddresses)` Discovered IP Addresses of the fabric node, version 4 or 6 format: ip This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`void`	`setDisplayName(java.lang.String displayName)` Deprecated.
`void`	`setExternalId(java.lang.String externalId)` ID of the Node maintained on the Node and used to recognize the Node
`void`	`setFqdn(java.lang.String fqdn)` Fully qualified domain name of the fabric node This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`void`	`setId(java.lang.String id)` Unique identifier of this resource.
`void`	`setIpAddresses(java.util.List<java.lang.String> ipAddresses)` IP Addresses of the Node, version 4 or 6.
`void`	`setNodeSettings(EdgeNodeSettings nodeSettings)`
`void`	`setTags(java.util.List<Tag> tags)` Deprecated.
`java.lang.String`	`toString()`

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

- Field Detail
  - _TYPE_IDENTIFIER
```
public static final java.lang.String _TYPE_IDENTIFIER
```
    Identifier denoting this class, when it is used in polymorphic context.
    This value should be assigned to the property which is used to discriminate the actual type used in the polymorphic context.
    
    See Also:
    
    Constant Field Values
  - DEPLOYMENT_TYPE_VIRTUAL_MACHINE
```
public static final java.lang.String DEPLOYMENT_TYPE_VIRTUAL_MACHINE
```
    See Also:
    
    Constant Field Values
  - DEPLOYMENT_TYPE_PHYSICAL_MACHINE
```
public static final java.lang.String DEPLOYMENT_TYPE_PHYSICAL_MACHINE
```
    See Also:
    
    Constant Field Values
  - DEPLOYMENT_TYPE_UNKNOWN
```
public static final java.lang.String DEPLOYMENT_TYPE_UNKNOWN
```
    See Also:
    
    Constant Field Values
  - __dynamicStructureFields
```
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
```
- Constructor Detail
  - EdgeNode
```
public EdgeNode()
```
    Default constructor.
  - EdgeNode
```
protected EdgeNode(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getAllocationList
```
public java.util.List<java.lang.String> getAllocationList()
```
    List of logical router ids to which this edge node is allocated. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setAllocationList
```
public void setAllocationList(java.util.List<java.lang.String> allocationList)
```
    List of logical router ids to which this edge node is allocated. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    allocationList - New value for the property.
  - getDeploymentConfig
```
public EdgeNodeDeploymentConfig getDeploymentConfig()
```
    Returns:
    
    The current value of the property.
  - setDeploymentConfig
```
public void setDeploymentConfig(EdgeNodeDeploymentConfig deploymentConfig)
```
    Parameters:
    
    deploymentConfig - New value for the property.
  - getDeploymentType
```
public java.lang.String getDeploymentType()
```
    Possible values are:
    Supported edge deployment type. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    Returns:
    
    The current value of the property.
  - setDeploymentType
```
public void setDeploymentType(java.lang.String deploymentType)
```
    Possible values are:
    Supported edge deployment type. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    Parameters:
    
    deploymentType - New value for the property.
  - getNodeSettings
```
public EdgeNodeSettings getNodeSettings()
```
    Returns:
    
    The current value of the property.
  - setNodeSettings
```
public void setNodeSettings(EdgeNodeSettings nodeSettings)
```
    Parameters:
    
    nodeSettings - New value for the property.
  - getDescription
```
@Deprecated
public java.lang.String getDescription()
```
    Deprecated.
    
    This field is deprecated. TransportNode field 'description' must be used instead. For EdgeNode and PublicCloudGatewayNode, this field is ignored if specified in request payload.
    
    Returns:
    
    The current value of the property.
  - setDescription
```
@Deprecated
public void setDescription(java.lang.String description)
```
    Deprecated.
    
    This field is deprecated. TransportNode field 'description' must be used instead. For EdgeNode and PublicCloudGatewayNode, this field is ignored if specified in request payload.
    
    Parameters:
    
    description - New value for the property.
  - getDiscoveredIpAddresses
```
public java.util.List<java.lang.String> getDiscoveredIpAddresses()
```
    Discovered IP Addresses of the fabric node, version 4 or 6 format: ip This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setDiscoveredIpAddresses
```
public void setDiscoveredIpAddresses(java.util.List<java.lang.String> discoveredIpAddresses)
```
    Discovered IP Addresses of the fabric node, version 4 or 6 format: ip This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    discoveredIpAddresses - New value for the property.
  - getDisplayName
```
@Deprecated
public java.lang.String getDisplayName()
```
    Deprecated.
    
    This field is deprecated. TransportNode field 'display_name' must be used instead. For HostNode, this field defaults to ID if not set. For EdgeNode and PublicCloudGatewayNode, this field is ignored if specified in request payload.
    
    Returns:
    
    The current value of the property.
  - setDisplayName
```
@Deprecated
public void setDisplayName(java.lang.String displayName)
```
    Deprecated.
    
    This field is deprecated. TransportNode field 'display_name' must be used instead. For HostNode, this field defaults to ID if not set. For EdgeNode and PublicCloudGatewayNode, this field is ignored if specified in request payload.
    
    Parameters:
    
    displayName - New value for the property.
  - getExternalId
```
public java.lang.String getExternalId()
```
    ID of the Node maintained on the Node and used to recognize the Node
    
    Returns:
    
    The current value of the property.
  - setExternalId
```
public void setExternalId(java.lang.String externalId)
```
    ID of the Node maintained on the Node and used to recognize the Node
    
    Parameters:
    
    externalId - New value for the property.
  - getFqdn
```
public java.lang.String getFqdn()
```
    Fully qualified domain name of the fabric node This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setFqdn
```
public void setFqdn(java.lang.String fqdn)
```
    Fully qualified domain name of the fabric node This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    fqdn - New value for the property.
  - getId
```
public java.lang.String getId()
```
    Unique identifier of this resource.
    
    Returns:
    
    The current value of the property.
  - setId
```
public void setId(java.lang.String id)
```
    Unique identifier of this resource.
    
    Parameters:
    
    id - New value for the property.
  - getIpAddresses
```
public java.util.List<java.lang.String> getIpAddresses()
```
    IP Addresses of the Node, version 4 or 6. This property is mandatory for all nodes except for automatic deployment of edge virtual machine node. For automatic deployment, the ip address from management_port_subnets property will be considered. format: ip
    
    Returns:
    
    The current value of the property.
  - setIpAddresses
```
public void setIpAddresses(java.util.List<java.lang.String> ipAddresses)
```
    IP Addresses of the Node, version 4 or 6. This property is mandatory for all nodes except for automatic deployment of edge virtual machine node. For automatic deployment, the ip address from management_port_subnets property will be considered. format: ip
    
    Parameters:
    
    ipAddresses - New value for the property.
  - getResourceType
```
public java.lang.String getResourceType()
```
    Fabric node type, for example 'HostNode', 'EdgeNode' or 'PublicCloudGatewayNode' The value of this property is automatically populated to "EdgeNode".
    
    Returns:
    
    The current value of the property.
  - getTags
```
@Deprecated
public java.util.List<Tag> getTags()
```
    Deprecated.
    
    This field is deprecated. TransportNode field 'tags' must be used instead. For EdgeNode and PublicCloudGatewayNode, this field is ignored if specified in request payload.
    
    Returns:
    
    The current value of the property.
  - setTags
```
@Deprecated
public void setTags(java.util.List<Tag> tags)
```
    Deprecated.
    
    This field is deprecated. TransportNode field 'tags' must be used instead. For EdgeNode and PublicCloudGatewayNode, this field is ignored if specified in request payload.
    
    Parameters:
    
    tags - 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 EdgeNode _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 EdgeNode _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class EdgeNode

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

_TYPE_IDENTIFIER

DEPLOYMENT_TYPE_VIRTUAL_MACHINE

DEPLOYMENT_TYPE_PHYSICAL_MACHINE

DEPLOYMENT_TYPE_UNKNOWN

__dynamicStructureFields

Constructor Detail

EdgeNode

EdgeNode

Method Detail

getAllocationList

setAllocationList

getDeploymentConfig

setDeploymentConfig

getDeploymentType

setDeploymentType

getNodeSettings

setNodeSettings

getDescription

setDescription

getDiscoveredIpAddresses

setDiscoveredIpAddresses

getDisplayName

setDisplayName

getExternalId

setExternalId

getFqdn

setFqdn

getId

setId

getIpAddresses

setIpAddresses

getResourceType

getTags

setTags

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2