TunnelDescription (ONOS Java API (2.3.0))

All Superinterfaces:

Annotated, Description

All Known Implementing Classes:

DefaultTunnelDescription
```
@Beta
public interface TunnelDescription
extends Description, Annotated
```
Describes a tunnel interface.

Nested Class Summary

Nested Classes
Modifier and Type	Interface	Description
`static interface`	`TunnelDescription.Builder`	Builder of tunnel interface description entities.
`static class`	`TunnelDescription.Type`	Tunnel technology type.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`java.util.Optional<java.lang.String>`	`deviceId()`	Returns the identifier of the device where the interface is.
`java.lang.String`	`ifaceName()`	Return the name of the tunnel interface.
`java.util.Optional<TunnelKey>`	`key()`	Returns the tunnel key.
`java.util.Optional<TunnelEndPoint>`	`local()`	Returns the local connection point.
`java.util.Optional<TunnelEndPoint>`	`remote()`	Returns the remote connection point.
`TunnelDescription.Type`	`type()`	Returns the tunnel type.

Methods inherited from interface org.onosproject.net.Description
annotations

- Method Detail
  - deviceId
```
java.util.Optional<java.lang.String> deviceId()
```
    Returns the identifier of the device where the interface is.
    
    Returns:
    
    device identifier
  - ifaceName
```
java.lang.String ifaceName()
```
    Return the name of the tunnel interface.
    
    Returns:
    
    tunnel interface name
  - type
```
TunnelDescription.Type type()
```
    Returns the tunnel type.
    
    Returns:
    
    tunnel type
  - local
```
java.util.Optional<TunnelEndPoint> local()
```
    Returns the local connection point.
    
    Returns:
    
    tunnel source ConnectionPoint
  - remote
```
java.util.Optional<TunnelEndPoint> remote()
```
    Returns the remote connection point.
    
    Returns:
    
    tunnel destination
  - key
```
java.util.Optional<TunnelKey> key()
```
    Returns the tunnel key.
    
    Returns:
    
    tunnel key