VtnService (onos-apps-xosclient)

java.lang.Object
- org.onosproject.xosclient.api.VtnService

```
public final class VtnService
extends Object
```
Representation of CORD VTN controlled network service.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VtnService.Builder
Builder of VTN service entities.

Nested Classes
Modifier and Type	Class and Description
`static class`	`VtnService.Builder` Builder of VTN service entities.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static VtnService.Builder`	`build()` Returns a new builder instance.
`boolean`	`equals(Object obj)`
`int`	`hashCode()`
`VtnServiceId`	`id()` Returns service ID.
`String`	`name()` Returns service name.
`VtnServiceApi.NetworkType`	`networkType()` Returns network type.
`Set<VtnServiceId>`	`providerServices()` Returns provider service IDs.
`org.onlab.packet.IpAddress`	`serviceIp()` Returns service IP address.
`VtnServiceApi.ServiceType`	`serviceType()` Returns service type.
`org.onlab.packet.IpPrefix`	`subnet()` Returns service IP range.
`Set<VtnServiceId>`	`tenantServices()` Returns tenant service IDs.
`String`	`toString()`
`long`	`vni()` Returns segmentation ID of this service.

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

- Method Detail
  - id
```
public VtnServiceId id()
```
    Returns service ID.
    
    Returns:
    
    service id
  - name
```
public String name()
```
    Returns service name.
    
    Returns:
    
    name
  - serviceType
```
public VtnServiceApi.ServiceType serviceType()
```
    Returns service type.
    
    Returns:
    
    service type
  - vni
```
public long vni()
```
    Returns segmentation ID of this service.
    
    Returns:
    
    segmentation id
  - networkType
```
public VtnServiceApi.NetworkType networkType()
```
    Returns network type.
    
    Returns:
    
    network type
  - subnet
```
public org.onlab.packet.IpPrefix subnet()
```
    Returns service IP range.
    
    Returns:
    
    subnet cidr
  - serviceIp
```
public org.onlab.packet.IpAddress serviceIp()
```
    Returns service IP address.
    
    Returns:
    
    ip address
  - providerServices
```
public Set<VtnServiceId> providerServices()
```
    Returns provider service IDs.
    
    Returns:
    
    list of provider service id
  - tenantServices
```
public Set<VtnServiceId> tenantServices()
```
    Returns tenant service IDs.
    
    Returns:
    
    list of tenant service id
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - build
```
public static final VtnService.Builder build()
```
    Returns a new builder instance.
    
    Returns:
    
    new builder

Class VtnService

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

id

name

serviceType

vni

networkType

subnet

serviceIp

providerServices

tenantServices

hashCode

equals

toString

build