LinkCollectionIntent.Builder (ONOS Java API (2.0.0))

java.lang.Object
- org.onosproject.net.intent.Intent.Builder
- - org.onosproject.net.intent.ConnectivityIntent.Builder
  - - org.onosproject.net.intent.LinkCollectionIntent.Builder

Enclosing class:: LinkCollectionIntent

public static final class LinkCollectionIntent.Builder
extends ConnectivityIntent.Builder

Builder of a single point to multi point intent.

Field Summary
- Fields inherited from class org.onosproject.net.intent.ConnectivityIntent.Builder
  constraints, selector, treatment
- Fields inherited from class org.onosproject.net.intent.Intent.Builder
  appId, key, priority, resourceGroup, resources

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`LinkCollectionIntent.Builder`	`appId(ApplicationId appId)` Sets the application id for the intent that will be built.
`LinkCollectionIntent.Builder`	`applyTreatmentOnEgress(boolean treatmentOnEgress)` Sets the intent to apply treatment at the egress rather than the ingress.
`LinkCollectionIntent`	`build()` Builds a single point to multi point intent from the accumulated parameters.
`LinkCollectionIntent.Builder`	`constraints(List<Constraint> constraints)` Sets the constraints for the intent that will be built.
`LinkCollectionIntent.Builder`	`cost(double cost)` Sets the cost for the links of the Intent.
`LinkCollectionIntent.Builder`	`filteredEgressPoints(Set<FilteredConnectPoint> egressPoints)` Sets the filtered egress points of the single point to multi point intent that will be built.
`LinkCollectionIntent.Builder`	`filteredIngressPoints(Set<FilteredConnectPoint> ingressPoints)` Sets the filtered ingress point of the single point to multi point intent that will be built.
`LinkCollectionIntent.Builder`	`key(Key key)` Sets the key for the intent that will be built.
`LinkCollectionIntent.Builder`	`links(Set<Link> links)` Sets the links of the link collection intent that will be built.
`LinkCollectionIntent.Builder`	`priority(int priority)` Sets the priority for the intent that will be built.
`LinkCollectionIntent.Builder`	`resourceGroup(ResourceGroup resourceGroup)` Sets the resource group for this intent.
`LinkCollectionIntent.Builder`	`resources(Collection<NetworkResource> resources)` Sets the collection of resources required for this intent.
`LinkCollectionIntent.Builder`	`selector(TrafficSelector selector)` Sets the traffic selector for the intent that will be built.
`LinkCollectionIntent.Builder`	`treatment(TrafficTreatment treatment)` Sets the traffic treatment for the intent that will be built.

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

- Method Detail
  - appId
```
public LinkCollectionIntent.Builder appId(ApplicationId appId)
```
    Description copied from class: Intent.Builder
    
    Sets the application id for the intent that will be built.
    
    Overrides:
    
    appId in class ConnectivityIntent.Builder
    
    Parameters:
    
    appId - application id to use for built intent
    
    Returns:
    
    this builder
  - key
```
public LinkCollectionIntent.Builder key(Key key)
```
    Description copied from class: Intent.Builder
    
    Sets the key for the intent that will be built.
    
    Overrides:
    
    key in class ConnectivityIntent.Builder
    
    Parameters:
    
    key - key to use for built intent
    
    Returns:
    
    this builder
  - selector
```
public LinkCollectionIntent.Builder selector(TrafficSelector selector)
```
    Description copied from class: ConnectivityIntent.Builder
    
    Sets the traffic selector for the intent that will be built.
    
    Overrides:
    
    selector in class ConnectivityIntent.Builder
    
    Parameters:
    
    selector - selector to use for built intent
    
    Returns:
    
    this builder
  - treatment
```
public LinkCollectionIntent.Builder treatment(TrafficTreatment treatment)
```
    Description copied from class: ConnectivityIntent.Builder
    
    Sets the traffic treatment for the intent that will be built.
    
    Overrides:
    
    treatment in class ConnectivityIntent.Builder
    
    Parameters:
    
    treatment - treatment to use for built intent
    
    Returns:
    
    this builder
  - constraints
```
public LinkCollectionIntent.Builder constraints(List<Constraint> constraints)
```
    Description copied from class: ConnectivityIntent.Builder
    
    Sets the constraints for the intent that will be built.
    
    Overrides:
    
    constraints in class ConnectivityIntent.Builder
    
    Parameters:
    
    constraints - constraints to use for built intent
    
    Returns:
    
    this builder
  - priority
```
public LinkCollectionIntent.Builder priority(int priority)
```
    Description copied from class: Intent.Builder
    
    Sets the priority for the intent that will be built.
    
    Overrides:
    
    priority in class ConnectivityIntent.Builder
    
    Parameters:
    
    priority - priority to use for built intent
    
    Returns:
    
    this builder
  - resources
```
public LinkCollectionIntent.Builder resources(Collection<NetworkResource> resources)
```
    Description copied from class: Intent.Builder
    
    Sets the collection of resources required for this intent.
    
    Overrides:
    
    resources in class Intent.Builder
    
    Parameters:
    
    resources - collection of resources
    
    Returns:
    
    this builder
  - resourceGroup
```
public LinkCollectionIntent.Builder resourceGroup(ResourceGroup resourceGroup)
```
    Description copied from class: Intent.Builder
    
    Sets the resource group for this intent.
    
    Overrides:
    
    resourceGroup in class Intent.Builder
    
    Parameters:
    
    resourceGroup - the resource group
    
    Returns:
    
    this builder
  - filteredIngressPoints
```
public LinkCollectionIntent.Builder filteredIngressPoints(Set<FilteredConnectPoint> ingressPoints)
```
    Sets the filtered ingress point of the single point to multi point intent that will be built.
    
    Parameters:
    
    ingressPoints - ingress connect points
    
    Returns:
    
    this builder
  - filteredEgressPoints
```
public LinkCollectionIntent.Builder filteredEgressPoints(Set<FilteredConnectPoint> egressPoints)
```
    Sets the filtered egress points of the single point to multi point intent that will be built.
    
    Parameters:
    
    egressPoints - egress connect points
    
    Returns:
    
    this builder
  - links
```
public LinkCollectionIntent.Builder links(Set<Link> links)
```
    Sets the links of the link collection intent that will be built.
    
    Parameters:
    
    links - links for the intent
    
    Returns:
    
    this builder
  - applyTreatmentOnEgress
```
public LinkCollectionIntent.Builder applyTreatmentOnEgress(boolean treatmentOnEgress)
```
    Sets the intent to apply treatment at the egress rather than the ingress.
    
    Parameters:
    
    treatmentOnEgress - true applies treatment on egress device
    
    Returns:
    
    this builder
  - cost
```
public LinkCollectionIntent.Builder cost(double cost)
```
    Sets the cost for the links of the Intent.
    
    Parameters:
    
    cost - the cost of the links
    
    Returns:
    
    this builder
  - build
```
public LinkCollectionIntent build()
```
    Builds a single point to multi point intent from the accumulated parameters.
    
    Returns:
    
    point to point intent

Class LinkCollectionIntent.Builder

Field Summary

Fields inherited from class org.onosproject.net.intent.ConnectivityIntent.Builder

Fields inherited from class org.onosproject.net.intent.Intent.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

appId

key

selector

treatment

constraints

priority

resources

resourceGroup

filteredIngressPoints

filteredEgressPoints

links

applyTreatmentOnEgress

cost

build