VtnService.Builder (onos-apps-xosclient)

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

Enclosing class:: VtnService

public static final class VtnService.Builder
extends Object

Builder of VTN service entities.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`VtnService`	`build()` Builds an immutable VTN service.
`VtnService.Builder`	`id(VtnServiceId id)` Returns VTN service builder with the supplied service ID.
`VtnService.Builder`	`name(String name)` Returns VTN service builder with the supplied service name.
`VtnService.Builder`	`networkType(VtnServiceApi.NetworkType networkType)` Returns VTN service builder with the supplied network type.
`VtnService.Builder`	`providerServices(Set<VtnServiceId> pServices)` Returns VTN service builder with the supplied provider services.
`VtnService.Builder`	`serviceIp(org.onlab.packet.IpAddress serviceIp)` Returns VTN service builder with the supplied service IP address.
`VtnService.Builder`	`serviceIp(String serviceIp)` Returns VTN service builder with the supplied service IP address.
`VtnService.Builder`	`serviceType(VtnServiceApi.ServiceType serviceType)` Returns VTN service builder with the supplied service type.
`VtnService.Builder`	`subnet(org.onlab.packet.IpPrefix subnet)` Returns VTN service builder with the supplied subnet.
`VtnService.Builder`	`subnet(String subnet)` Returns VTN service builder with the supplied subnet.
`VtnService.Builder`	`tenantServices(Set<VtnServiceId> tServices)` Returns VTN service builder with the supplied tenant services.
`VtnService.Builder`	`vni(long vni)` Returns VTN service builder with the supplied VNI.
`VtnService.Builder`	`vni(String vni)` Returns VTN service builder with the supplied VNI.

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

- Method Detail
  - build
```
public VtnService build()
```
    Builds an immutable VTN service.
    
    Returns:
    
    vtn service instance
  - id
```
public VtnService.Builder id(VtnServiceId id)
```
    Returns VTN service builder with the supplied service ID.
    
    Parameters:
    
    id - service identifier
    
    Returns:
    
    vtn service builder
  - name
```
public VtnService.Builder name(String name)
```
    Returns VTN service builder with the supplied service name.
    
    Parameters:
    
    name - service name
    
    Returns:
    
    vtn service builder
  - serviceType
```
public VtnService.Builder serviceType(VtnServiceApi.ServiceType serviceType)
```
    Returns VTN service builder with the supplied service type.
    
    Parameters:
    
    serviceType - service type
    
    Returns:
    
    vtn service builder
  - networkType
```
public VtnService.Builder networkType(VtnServiceApi.NetworkType networkType)
```
    Returns VTN service builder with the supplied network type.
    
    Parameters:
    
    networkType - network type
    
    Returns:
    
    vtn service builder
  - vni
```
public VtnService.Builder vni(long vni)
```
    Returns VTN service builder with the supplied VNI.
    
    Parameters:
    
    vni - vni of the service network
    
    Returns:
    
    vtn service builder
  - vni
```
public VtnService.Builder vni(String vni)
```
    Returns VTN service builder with the supplied VNI.
    
    Parameters:
    
    vni - vni of the service network as a string
    
    Returns:
    
    vtn service builder
  - subnet
```
public VtnService.Builder subnet(org.onlab.packet.IpPrefix subnet)
```
    Returns VTN service builder with the supplied subnet.
    
    Parameters:
    
    subnet - subnet of the service network
    
    Returns:
    
    vtn service builder
  - subnet
```
public VtnService.Builder subnet(String subnet)
```
    Returns VTN service builder with the supplied subnet.
    
    Parameters:
    
    subnet - subnet of the service network as a string
    
    Returns:
    
    vtn service builder
  - serviceIp
```
public VtnService.Builder serviceIp(org.onlab.packet.IpAddress serviceIp)
```
    Returns VTN service builder with the supplied service IP address.
    
    Parameters:
    
    serviceIp - service ip address
    
    Returns:
    
    vtn service builder
  - serviceIp
```
public VtnService.Builder serviceIp(String serviceIp)
```
    Returns VTN service builder with the supplied service IP address.
    
    Parameters:
    
    serviceIp - service ip address as a string
    
    Returns:
    
    vtn service builder
  - providerServices
```
public VtnService.Builder providerServices(Set<VtnServiceId> pServices)
```
    Returns VTN service builder with the supplied provider services.
    
    Parameters:
    
    pServices - provider services
    
    Returns:
    
    vtn service builder
  - tenantServices
```
public VtnService.Builder tenantServices(Set<VtnServiceId> tServices)
```
    Returns VTN service builder with the supplied tenant services.
    
    Parameters:
    
    tServices - tenant services
    
    Returns:
    
    vtn service builder

Class VtnService.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

build

id

name

serviceType

networkType

vni

vni

subnet

subnet

serviceIp

serviceIp

providerServices

tenantServices