ConstrainedPath (bgpcep 0.13.4-SNAPSHOT API)

All Superinterfaces:

org.opendaylight.yangtools.yang.binding.Augmentable<ConstrainedPath>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<PathComputationData>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, PathConstraints, PathDescriptions
```
public interface ConstrainedPath
extends org.opendaylight.yangtools.yang.binding.ChildOf<PathComputationData>, org.opendaylight.yangtools.yang.binding.Augmentable<ConstrainedPath>, PathConstraints, PathDescriptions
```
Computed Path as result of Path Computation Algorithms
This class represents the following YANG schema fragment defined in module path-computation
```
 container constrained-path {
   uses path-constraints;
   leaf source {
     type uint64;
   }
   leaf destination {
     type uint64;
   }
   uses path-descriptions;
   leaf status {
     type computation-status;
   }
 }
 
```
The schema path to identify an instance is path-computation/constrained-path
To create instances of this class use ConstrainedPathBuilder.
See Also:

ConstrainedPathBuilder

Nested Class Summary
- Nested classes/interfaces inherited from interface org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.path.computation.rev200120.PathConstraints
  PathConstraints.AddressFamily

Field Summary

Fields
Modifier and Type Field Description

static @NonNull org.opendaylight.yangtools.yang.common.QName QNAME

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`@Nullable org.opendaylight.yangtools.yang.common.Uint64`	`getDestination()`
`@Nullable org.opendaylight.yangtools.yang.common.Uint64`	`getSource()`
`@Nullable ComputationStatus`	`getStatus()`
`default Class<ConstrainedPath>`	`implementedInterface()`

Methods inherited from interface org.opendaylight.yangtools.yang.binding.Augmentable
augmentation

Methods inherited from interface org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.path.computation.rev200120.PathConstraints
getAddressFamily, getAdminGroup, getBandwidth, getClassType, getDelay, getJitter, getLoss, getMetric, getTeMetric

Methods inherited from interface org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.path.computation.rev200120.PathDescriptions
getPathDescription, nonnullPathDescription

- Field Detail
  - QNAME
```
static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME
```
- Method Detail
  - implementedInterface
```
default Class<ConstrainedPath> implementedInterface()
```
    Specified by:
    
    implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataContainer
    
    Specified by:
    
    implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject
    
    Specified by:
    
    implementedInterface in interface PathConstraints
    
    Specified by:
    
    implementedInterface in interface PathDescriptions
  - getSource
```
@Nullable org.opendaylight.yangtools.yang.common.Uint64 getSource()
```
    Returns:
    
    org.opendaylight.yangtools.yang.common.Uint64 source, or null if not present
  - getDestination
```
@Nullable org.opendaylight.yangtools.yang.common.Uint64 getDestination()
```
    Returns:
    
    org.opendaylight.yangtools.yang.common.Uint64 destination, or null if not present
  - getStatus
```
@Nullable ComputationStatus getStatus()
```
    Returns:
    
    org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.path.computation.rev200120.ComputationStatus status, or null if not present