TenantNetwork (onos-app-vtnrsc 1.3.0 API)

All Known Implementing Classes:

DefaultTenantNetwork
```
public interface TenantNetwork
```
Representation of the tenantNetwork.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`TenantNetwork.State` Coarse classification of the state of the tenantNetwork.
`static class`	`TenantNetwork.Type` Coarse classification of the type of the tenantNetwork.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`adminStateUp()` Returns the administrative state of the tenantNetwork,which is up(true) or down(false).
`TenantNetworkId`	`id()` Returns the tenantNetwork identifier.
`String`	`name()` Returns the tenantNetwork name.
`PhysicalNetwork`	`physicalNetwork()` Returns the tenantNetwork physical network.
`boolean`	`routerExternal()` Returns the routerExternal.Indicates whether this network is externally accessible.
`SegmentationId`	`segmentationId()` Returns the tenantNetwork segmentation id.
`boolean`	`shared()` Indicates whether this tenantNetwork is shared across all tenants.
`TenantNetwork.State`	`state()` Returns the tenantNetwork state.
`TenantId`	`tenantId()` Returns the UUID of the tenant that will own the tenantNetwork.
`TenantNetwork.Type`	`type()` Returns the tenantNetwork Type.

- Method Detail
  - id
```
TenantNetworkId id()
```
    Returns the tenantNetwork identifier.
    
    Returns:
    
    tenantNetwork identifier
  - name
```
String name()
```
    Returns the tenantNetwork name.
    
    Returns:
    
    tenantNetwork name
  - adminStateUp
```
boolean adminStateUp()
```
    Returns the administrative state of the tenantNetwork,which is up(true) or down(false).
    
    Returns:
    
    true or false
  - state
```
TenantNetwork.State state()
```
    Returns the tenantNetwork state.
    
    Returns:
    
    tenant network state
  - shared
```
boolean shared()
```
    Indicates whether this tenantNetwork is shared across all tenants. By default,only administrative user can change this value.
    
    Returns:
    
    true or false
  - tenantId
```
TenantId tenantId()
```
    Returns the UUID of the tenant that will own the tenantNetwork. This tenant can be different from the tenant that makes the create tenantNetwork request.
    
    Returns:
    
    the tenant identifier
  - routerExternal
```
boolean routerExternal()
```
    Returns the routerExternal.Indicates whether this network is externally accessible.
    
    Returns:
    
    true or false
  - type
```
TenantNetwork.Type type()
```
    Returns the tenantNetwork Type.
    
    Returns:
    
    tenantNetwork Type
  - physicalNetwork
```
PhysicalNetwork physicalNetwork()
```
    Returns the tenantNetwork physical network.
    
    Returns:
    
    tenantNetwork physical network
  - segmentationId
```
SegmentationId segmentationId()
```
    Returns the tenantNetwork segmentation id.
    
    Returns:
    
    tenantNetwork segmentation id

Interface TenantNetwork

Nested Class Summary

Method Summary

Method Detail

id

name

adminStateUp

state

shared

tenantId

routerExternal

type

physicalNetwork

segmentationId