PathDescription (bgpcep 0.13.4-SNAPSHOT API)

All Superinterfaces:

org.opendaylight.yangtools.yang.binding.Augmentable<PathDescription>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<PathDescriptions>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, SrDescription
```
public interface PathDescription
extends org.opendaylight.yangtools.yang.binding.ChildOf<PathDescriptions>, org.opendaylight.yangtools.yang.binding.Augmentable<PathDescription>, SrDescription
```
This class represents the following YANG schema fragment defined in module path-computation
```
 list path-description {
   leaf ipv4 {
     when "path-constraints/address-family = 0";
     type inet:ipv4-address;
   }
   leaf ipv6 {
     when "path-constraints/address-family = 1";
     type inet:ipv6-address;
   }
   uses sr-description;
 }
 
```
The schema path to identify an instance is path-computation/path-descriptions/path-description
To create instances of this class use PathDescriptionBuilder.
See Also:

PathDescriptionBuilder

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.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address`	`getIpv4()`
`@Nullable org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address`	`getIpv6()`
`default Class<PathDescription>`	`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.SrDescription
getLocalIpv4, getLocalIpv6, getRemoteIpv4, getRemoteIpv6, getSid

- Field Detail
  - QNAME
```
static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME
```
- Method Detail
  - implementedInterface
```
default Class<PathDescription> 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 SrDescription
  - getIpv4
```
@Nullable org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address getIpv4()
```
    Returns:
    
    org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address ipv4, or null if not present
  - getIpv6
```
@Nullable org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address getIpv6()
```
    Returns:
    
    org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address ipv6, or null if not present