TunnelProperties (Java SDK for NSX Manager API 4.1.2.0.0)

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

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class TunnelProperties
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 TunnelProperties.Builder
Builder class for TunnelProperties.

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected com.vmware.vapi.data.StructValue`	`__dynamicStructureFields`
`static java.lang.String`	`ENCAP_GENEVE`
`static java.lang.String`	`ENCAP_NONE`
`static java.lang.String`	`ENCAP_STT`
`static java.lang.String`	`ENCAP_UNKNOWN_ENCAP`
`static java.lang.String`	`ENCAP_VXLAN`
`static java.lang.String`	`LATENCY_TYPE_NOT_READY`
`static java.lang.String`	`LATENCY_TYPE_TIMEOUT`
`static java.lang.String`	`LATENCY_TYPE_UNKNOWN_LATENCY`
`static java.lang.String`	`LATENCY_TYPE_VALID`
`static java.lang.String`	`STATUS_DOWN`
`static java.lang.String`	`STATUS_UNKNOWN`
`static java.lang.String`	`STATUS_UP`

Constructor Summary

Constructors
Modifier Constructor and Description

TunnelProperties()
Default constructor.

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

Constructors
Modifier	Constructor and Description
	`TunnelProperties()` Default constructor.
`protected`	`TunnelProperties(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 TunnelProperties`	`_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 TunnelProperties`	`_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)`
`BFDProperties`	`getBfd()`
`java.lang.String`	`getEgressInterface()` Corresponds to the interface where local_ip_address is routed.
`java.lang.String`	`getEncap()` Possible values are: `ENCAP_STT` `ENCAP_VXLAN` `ENCAP_GENEVE` `ENCAP_NONE` `ENCAP_UNKNOWN_ENCAP` Tunnel encap 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.Long`	`getLastUpdatedTime()` Time at which the Tunnel status has been fetched last time.
`java.lang.String`	`getLatencyType()` Possible values are: `LATENCY_TYPE_UNKNOWN_LATENCY` `LATENCY_TYPE_VALID` `LATENCY_TYPE_NOT_READY` `LATENCY_TYPE_TIMEOUT` Latency type.
`java.lang.Long`	`getLatencyValue()` The latency value is set only when latency_type is VALID.
`java.util.List<ResourceLink>`	`getLinks()` The server will populate this field when returing the resource.
`java.lang.String`	`getLocalIp()` Local IP address of tunnel 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`	`getName()` Name of tunnel 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`	`getRemoteIp()` Remote IP address of tunnel 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`	`getRemoteNodeDisplayName()` Represents the display name of the remote transport node at the other end of the tunnel.
`java.lang.String`	`getRemoteNodeId()` UUID of the remote transport 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`	`getSchema()` Schema for this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`SelfResourceLink`	`getSelf()`
`java.lang.String`	`getStatus()` Possible values are: `STATUS_UP` `STATUS_DOWN` `STATUS_UNKNOWN` Status of tunnel This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`int`	`hashCode()`
`void`	`setBfd(BFDProperties bfd)`
`void`	`setEgressInterface(java.lang.String egressInterface)` Corresponds to the interface where local_ip_address is routed.
`void`	`setEncap(java.lang.String encap)` Possible values are: `ENCAP_STT` `ENCAP_VXLAN` `ENCAP_GENEVE` `ENCAP_NONE` `ENCAP_UNKNOWN_ENCAP` Tunnel encap 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`	`setLastUpdatedTime(java.lang.Long lastUpdatedTime)` Time at which the Tunnel status has been fetched last time.
`void`	`setLatencyType(java.lang.String latencyType)` Possible values are: `LATENCY_TYPE_UNKNOWN_LATENCY` `LATENCY_TYPE_VALID` `LATENCY_TYPE_NOT_READY` `LATENCY_TYPE_TIMEOUT` Latency type.
`void`	`setLatencyValue(java.lang.Long latencyValue)` The latency value is set only when latency_type is VALID.
`void`	`setLinks(java.util.List<ResourceLink> links)` The server will populate this field when returing the resource.
`void`	`setLocalIp(java.lang.String localIp)` Local IP address of tunnel 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`	`setName(java.lang.String name)` Name of tunnel 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`	`setRemoteIp(java.lang.String remoteIp)` Remote IP address of tunnel 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`	`setRemoteNodeDisplayName(java.lang.String remoteNodeDisplayName)` Represents the display name of the remote transport node at the other end of the tunnel.
`void`	`setRemoteNodeId(java.lang.String remoteNodeId)` UUID of the remote transport 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`	`setSchema(java.lang.String schema)` Schema for this resource 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`	`setSelf(SelfResourceLink self)`
`void`	`setStatus(java.lang.String status)` Possible values are: `STATUS_UP` `STATUS_DOWN` `STATUS_UNKNOWN` Status of tunnel 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`	`toString()`

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

- Field Detail
  - ENCAP_STT
```
public static final java.lang.String ENCAP_STT
```
    See Also:
    
    Constant Field Values
  - ENCAP_VXLAN
```
public static final java.lang.String ENCAP_VXLAN
```
    See Also:
    
    Constant Field Values
  - ENCAP_GENEVE
```
public static final java.lang.String ENCAP_GENEVE
```
    See Also:
    
    Constant Field Values
  - ENCAP_NONE
```
public static final java.lang.String ENCAP_NONE
```
    See Also:
    
    Constant Field Values
  - ENCAP_UNKNOWN_ENCAP
```
public static final java.lang.String ENCAP_UNKNOWN_ENCAP
```
    See Also:
    
    Constant Field Values
  - LATENCY_TYPE_UNKNOWN_LATENCY
```
public static final java.lang.String LATENCY_TYPE_UNKNOWN_LATENCY
```
    See Also:
    
    Constant Field Values
  - LATENCY_TYPE_VALID
```
public static final java.lang.String LATENCY_TYPE_VALID
```
    See Also:
    
    Constant Field Values
  - LATENCY_TYPE_NOT_READY
```
public static final java.lang.String LATENCY_TYPE_NOT_READY
```
    See Also:
    
    Constant Field Values
  - LATENCY_TYPE_TIMEOUT
```
public static final java.lang.String LATENCY_TYPE_TIMEOUT
```
    See Also:
    
    Constant Field Values
  - STATUS_UP
```
public static final java.lang.String STATUS_UP
```
    See Also:
    
    Constant Field Values
  - STATUS_DOWN
```
public static final java.lang.String STATUS_DOWN
```
    See Also:
    
    Constant Field Values
  - STATUS_UNKNOWN
```
public static final java.lang.String STATUS_UNKNOWN
```
    See Also:
    
    Constant Field Values
  - __dynamicStructureFields
```
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
```
- Constructor Detail
  - TunnelProperties
```
public TunnelProperties()
```
    Default constructor.
  - TunnelProperties
```
protected TunnelProperties(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getLinks
```
public java.util.List<ResourceLink> getLinks()
```
    The server will populate this field when returing the resource. Ignored on PUT and POST. 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.
  - setLinks
```
public void setLinks(java.util.List<ResourceLink> links)
```
    The server will populate this field when returing the resource. Ignored on PUT and POST. 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:
    
    links - New value for the property.
  - getSchema
```
public java.lang.String getSchema()
```
    Schema for this resource 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.
  - setSchema
```
public void setSchema(java.lang.String schema)
```
    Schema for this resource 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:
    
    schema - New value for the property.
  - getSelf
```
public SelfResourceLink getSelf()
```
    Returns:
    
    The current value of the property.
  - setSelf
```
public void setSelf(SelfResourceLink self)
```
    Parameters:
    
    self - New value for the property.
  - getBfd
```
public BFDProperties getBfd()
```
    Returns:
    
    The current value of the property.
  - setBfd
```
public void setBfd(BFDProperties bfd)
```
    Parameters:
    
    bfd - New value for the property.
  - getEgressInterface
```
public java.lang.String getEgressInterface()
```
    Corresponds to the interface where local_ip_address is routed. 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.
  - setEgressInterface
```
public void setEgressInterface(java.lang.String egressInterface)
```
    Corresponds to the interface where local_ip_address is routed. 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:
    
    egressInterface - New value for the property.
  - getEncap
```
public java.lang.String getEncap()
```
    Possible values are:
    Tunnel encap 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.
  - setEncap
```
public void setEncap(java.lang.String encap)
```
    Possible values are:
    Tunnel encap 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:
    
    encap - New value for the property.
  - getLastUpdatedTime
```
public java.lang.Long getLastUpdatedTime()
```
    Time at which the Tunnel status has been fetched last time. format: int64 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.
  - setLastUpdatedTime
```
public void setLastUpdatedTime(java.lang.Long lastUpdatedTime)
```
    Time at which the Tunnel status has been fetched last time. format: int64 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:
    
    lastUpdatedTime - New value for the property.
  - getLatencyType
```
public java.lang.String getLatencyType()
```
    Possible values are:
    Latency 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.
  - setLatencyType
```
public void setLatencyType(java.lang.String latencyType)
```
    Possible values are:
    Latency 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:
    
    latencyType - New value for the property.
  - getLatencyValue
```
public java.lang.Long getLatencyValue()
```
    The latency value is set only when latency_type is VALID. format: int64 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.
  - setLatencyValue
```
public void setLatencyValue(java.lang.Long latencyValue)
```
    The latency value is set only when latency_type is VALID. format: int64 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:
    
    latencyValue - New value for the property.
  - getLocalIp
```
public java.lang.String getLocalIp()
```
    Local IP address of tunnel 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.
  - setLocalIp
```
public void setLocalIp(java.lang.String localIp)
```
    Local IP address of tunnel 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:
    
    localIp - New value for the property.
  - getName
```
public java.lang.String getName()
```
    Name of tunnel 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.
  - setName
```
public void setName(java.lang.String name)
```
    Name of tunnel 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:
    
    name - New value for the property.
  - getRemoteIp
```
public java.lang.String getRemoteIp()
```
    Remote IP address of tunnel 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.
  - setRemoteIp
```
public void setRemoteIp(java.lang.String remoteIp)
```
    Remote IP address of tunnel 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:
    
    remoteIp - New value for the property.
  - getRemoteNodeDisplayName
```
public java.lang.String getRemoteNodeDisplayName()
```
    Represents the display name of the remote transport node at the other end of the tunnel. 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.
  - setRemoteNodeDisplayName
```
public void setRemoteNodeDisplayName(java.lang.String remoteNodeDisplayName)
```
    Represents the display name of the remote transport node at the other end of the tunnel. 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:
    
    remoteNodeDisplayName - New value for the property.
  - getRemoteNodeId
```
public java.lang.String getRemoteNodeId()
```
    UUID of the remote transport 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.
  - setRemoteNodeId
```
public void setRemoteNodeId(java.lang.String remoteNodeId)
```
    UUID of the remote transport 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:
    
    remoteNodeId - New value for the property.
  - getStatus
```
public java.lang.String getStatus()
```
    Possible values are:
    Status of tunnel 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.
  - setStatus
```
public void setStatus(java.lang.String status)
```
    Possible values are:
    Status of tunnel 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:
    
    status - 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 TunnelProperties _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 TunnelProperties _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class TunnelProperties

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ENCAP_STT

ENCAP_VXLAN

ENCAP_GENEVE

ENCAP_NONE

ENCAP_UNKNOWN_ENCAP

LATENCY_TYPE_UNKNOWN_LATENCY

LATENCY_TYPE_VALID

LATENCY_TYPE_NOT_READY

LATENCY_TYPE_TIMEOUT

STATUS_UP

STATUS_DOWN

STATUS_UNKNOWN

__dynamicStructureFields

Constructor Detail

TunnelProperties

TunnelProperties

Method Detail

getLinks

setLinks

getSchema

setSchema

getSelf

setSelf

getBfd

setBfd

getEgressInterface

setEgressInterface

getEncap

setEncap

getLastUpdatedTime

setLastUpdatedTime

getLatencyType

setLatencyType

getLatencyValue

setLatencyValue

getLocalIp

setLocalIp

getName

setName

getRemoteIp

setRemoteIp

getRemoteNodeDisplayName

setRemoteNodeDisplayName

getRemoteNodeId

setRemoteNodeId

getStatus

setStatus

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2