TunnelDescription.Builder (ONOS Java API (2.1.0))

All Known Implementing Classes:

DefaultTunnelDescription.Builder

Enclosing interface:

TunnelDescription
```
public static interface TunnelDescription.Builder
```
Builder of tunnel interface description entities.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`TunnelDescription`	`build()` Returns new tunnel interface description.
`TunnelDescription.Builder`	`deviceId(String deviceId)` Returns tunnel interface description biulder with supplied device ID.
`TunnelDescription.Builder`	`ifaceName(String name)` Returns tunnel interface description builder with a given interface name.
`TunnelDescription.Builder`	`key(TunnelKey tunnelKey)` Returns tunnel interface description builder with a tunnel key.
`TunnelDescription.Builder`	`local(TunnelEndPoint endpoint)` Returns tunnel interface description builder with a given local tunnel endpoint.
`TunnelDescription.Builder`	`otherConfigs(SparseAnnotations configs)` Returns tunnel interface descriptions builder with other configurations.
`TunnelDescription.Builder`	`remote(TunnelEndPoint endpoint)` Returns tunnel interface description builder with a given remote tunnel endpoint.
`TunnelDescription.Builder`	`type(TunnelDescription.Type type)` Returns tunnel interface description builder with a given tunnel type.

- Method Detail
  - build
```
TunnelDescription build()
```
    Returns new tunnel interface description.
    
    Returns:
    
    tunnel description
  - deviceId
```
TunnelDescription.Builder deviceId(String deviceId)
```
    Returns tunnel interface description biulder with supplied device ID.
    
    Parameters:
    
    deviceId - device identifier
    
    Returns:
    
    tunnel description builder
  - ifaceName
```
TunnelDescription.Builder ifaceName(String name)
```
    Returns tunnel interface description builder with a given interface name.
    
    Parameters:
    
    name - tunnel interface name
    
    Returns:
    
    tunnel description builder
  - type
```
TunnelDescription.Builder type(TunnelDescription.Type type)
```
    Returns tunnel interface description builder with a given tunnel type.
    
    Parameters:
    
    type - tunnel type
    
    Returns:
    
    tunnel description builder
  - local
```
TunnelDescription.Builder local(TunnelEndPoint endpoint)
```
    Returns tunnel interface description builder with a given local tunnel endpoint.
    
    Parameters:
    
    endpoint - tunnel endpoint
    
    Returns:
    
    tunnel description builder
  - remote
```
TunnelDescription.Builder remote(TunnelEndPoint endpoint)
```
    Returns tunnel interface description builder with a given remote tunnel endpoint.
    
    Parameters:
    
    endpoint - tunnel endpoint
    
    Returns:
    
    tunnel description builder
  - key
```
TunnelDescription.Builder key(TunnelKey tunnelKey)
```
    Returns tunnel interface description builder with a tunnel key.
    
    Parameters:
    
    tunnelKey - tunnel key
    
    Returns:
    
    tunnel description builder
  - otherConfigs
```
TunnelDescription.Builder otherConfigs(SparseAnnotations configs)
```
    Returns tunnel interface descriptions builder with other configurations.
    
    Parameters:
    
    configs - configurations
    
    Returns:
    
    tunnel description builder

Interface TunnelDescription.Builder

Method Summary

Method Detail

build

deviceId

ifaceName

type

local

remote

key

otherConfigs