Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.path.computation.rev220324

Interface PathConstraints

All Superinterfaces:

org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject

All Known Subinterfaces:

ConstrainedPath, Constraints, Constraints

@Generated("mdsal-binding-generator")
public interface PathConstraints
extends org.opendaylight.yangtools.yang.binding.DataObject

Set of Constraints for Path Computation

This class represents the following YANG schema fragment defined in module path-computation

 grouping path-constraints {
   leaf metric {
     type uint32;
   }
   leaf te-metric {
     type uint32;
   }
   leaf delay {
     type gr:delay;
   }
   leaf jitter {
     type gr:delay;
   }
   leaf loss {
     type gr:loss;
   }
   leaf admin-group {
     type uint32;
   }
   leaf address-family {
     type address-family;
   }
   leaf class-type {
     type uint8 {
       range 0..7;
     }
   }
   leaf bandwidth {
     type gr:decimal-bandwidth;
   }
   list include-route {
     leaf ipv4 {
       when "../../address-family = 0 or ../../address-family = 2";
       type inet:ipv4-address;
     }
     leaf ipv6 {
       when "../../address-family = 1 or ../../address-family = 3";
       type inet:ipv6-address;
     }
   }
   list exclude-route {
     leaf ipv4 {
       when "../../address-family = 0 or ../../address-family = 2";
       type inet:ipv4-address;
     }
     leaf ipv6 {
       when "../../address-family = 1 or ../../address-family = 3";
       type inet:ipv6-address;
     }
   }
 }
 

Field Summary

Fields

Modifier and Type	Field	Description
static final @NonNull org.opendaylight.yangtools.yang.common.QName	QNAME	YANG identifier of the statement represented by this class.

Method Summary

Modifier and Type	Method	Description
AddressFamily	getAddressFamily()	Return addressFamily, or null if it is not present.
org.opendaylight.yangtools.yang.common.Uint32	getAdminGroup()	Return adminGroup, or null if it is not present.
DecimalBandwidth	getBandwidth()	Return bandwidth, or null if it is not present.
org.opendaylight.yangtools.yang.common.Uint8	getClassType()	Return classType, or null if it is not present.
Delay	getDelay()	Return delay, or null if it is not present.
@Nullable List<ExcludeRoute>	getExcludeRoute()	Return excludeRoute, or null if it is not present.
@Nullable List<IncludeRoute>	getIncludeRoute()	Return includeRoute, or null if it is not present.
Delay	getJitter()	Return jitter, or null if it is not present.
Loss	getLoss()	Return loss, or null if it is not present.
org.opendaylight.yangtools.yang.common.Uint32	getMetric()	Return metric, or null if it is not present.
org.opendaylight.yangtools.yang.common.Uint32	getTeMetric()	Return teMetric, or null if it is not present.
Class<? extends PathConstraints>	implementedInterface()
default @NonNull List<ExcludeRoute>	nonnullExcludeRoute()	Return excludeRoute, or an empty list if it is not present.
default @NonNull List<IncludeRoute>	nonnullIncludeRoute()	Return includeRoute, or an empty list if it is not present.
default @NonNull AddressFamily	requireAddressFamily()	Return addressFamily, guaranteed to be non-null.
default @NonNull org.opendaylight.yangtools.yang.common.Uint32	requireAdminGroup()	Return adminGroup, guaranteed to be non-null.
default @NonNull DecimalBandwidth	requireBandwidth()	Return bandwidth, guaranteed to be non-null.
default @NonNull org.opendaylight.yangtools.yang.common.Uint8	requireClassType()	Return classType, guaranteed to be non-null.
default @NonNull Delay	requireDelay()	Return delay, guaranteed to be non-null.
default @NonNull Delay	requireJitter()	Return jitter, guaranteed to be non-null.
default @NonNull Loss	requireLoss()	Return loss, guaranteed to be non-null.
default @NonNull org.opendaylight.yangtools.yang.common.Uint32	requireMetric()	Return metric, guaranteed to be non-null.
default @NonNull org.opendaylight.yangtools.yang.common.Uint32	requireTeMetric()	Return teMetric, guaranteed to be non-null.

Field Details

QNAME

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

YANG identifier of the statement represented by this class.

Method Details

implementedInterface

Class<? extends PathConstraints> implementedInterface()

Specified by:

implementedInterface in interface org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>

Specified by:

implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject

getMetric

org.opendaylight.yangtools.yang.common.Uint32 getMetric()

Return metric, or null if it is not present.

     
         Maximum end to end IGP metric
     
 

Returns:

Uint32 metric, or null if it is not present.

requireMetric

default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requireMetric()

Return metric, guaranteed to be non-null.

     
         Maximum end to end IGP metric
     
 

Returns:

Uint32 metric, guaranteed to be non-null.

Throws:

NoSuchElementException - if metric is not present

getTeMetric

org.opendaylight.yangtools.yang.common.Uint32 getTeMetric()

Return teMetric, or null if it is not present.

     
         Maximum end to end Traffic Engineering metric
     
 

Returns:

Uint32 teMetric, or null if it is not present.

requireTeMetric

default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requireTeMetric()

Return teMetric, guaranteed to be non-null.

     
         Maximum end to end Traffic Engineering metric
     
 

Returns:

Uint32 teMetric, guaranteed to be non-null.

Throws:

NoSuchElementException - if teMetric is not present

getDelay

Delay getDelay()

Return delay, or null if it is not present.

     
         Maximum end to end delay
     
 

Returns:

Delay delay, or null if it is not present.

requireDelay

default @NonNull Delay requireDelay()

Return delay, guaranteed to be non-null.

     
         Maximum end to end delay
     
 

Returns:

Delay delay, guaranteed to be non-null.

Throws:

NoSuchElementException - if delay is not present

getJitter

Delay getJitter()

Return jitter, or null if it is not present.

     
         Maximum delay variation for selected edges
     
 

Returns:

Delay jitter, or null if it is not present.

requireJitter

default @NonNull Delay requireJitter()

Return jitter, guaranteed to be non-null.

     
         Maximum delay variation for selected edges
     
 

Returns:

Delay jitter, guaranteed to be non-null.

Throws:

NoSuchElementException - if jitter is not present

getLoss

Loss getLoss()

Return loss, or null if it is not present.

     
         Maximum loss for selected edges
     
 

Returns:

Loss loss, or null if it is not present.

requireLoss

default @NonNull Loss requireLoss()

Return loss, guaranteed to be non-null.

     
         Maximum loss for selected edges
     
 

Returns:

Loss loss, guaranteed to be non-null.

Throws:

NoSuchElementException - if loss is not present

getAdminGroup

org.opendaylight.yangtools.yang.common.Uint32 getAdminGroup()

Return adminGroup, or null if it is not present.

     
         Admin group to select edges
     
 

Returns:

Uint32 adminGroup, or null if it is not present.

requireAdminGroup

default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requireAdminGroup()

Return adminGroup, guaranteed to be non-null.

     
         Admin group to select edges
     
 

Returns:

Uint32 adminGroup, guaranteed to be non-null.

Throws:

NoSuchElementException - if adminGroup is not present

getAddressFamily

AddressFamily getAddressFamily()

Return addressFamily, or null if it is not present.

Returns:

AddressFamily addressFamily, or null if it is not present.

requireAddressFamily

default @NonNull AddressFamily requireAddressFamily()

Return addressFamily, guaranteed to be non-null.

Returns:

AddressFamily addressFamily, guaranteed to be non-null.

Throws:

NoSuchElementException - if addressFamily is not present

getClassType

org.opendaylight.yangtools.yang.common.Uint8 getClassType()

Return classType, or null if it is not present.

     
         Class Type for bandwidth constraints
     
 

Returns:

Uint8 classType, or null if it is not present.

requireClassType

default @NonNull org.opendaylight.yangtools.yang.common.Uint8 requireClassType()

Return classType, guaranteed to be non-null.

     
         Class Type for bandwidth constraints
     
 

Returns:

Uint8 classType, guaranteed to be non-null.

Throws:

NoSuchElementException - if classType is not present

getBandwidth

DecimalBandwidth getBandwidth()

Return bandwidth, or null if it is not present.

     
         Requested bandwidth for the computed path
     
 

Returns:

DecimalBandwidth bandwidth, or null if it is not present.

requireBandwidth

default @NonNull DecimalBandwidth requireBandwidth()

Return bandwidth, guaranteed to be non-null.

     
         Requested bandwidth for the computed path
     
 

Returns:

DecimalBandwidth bandwidth, guaranteed to be non-null.

Throws:

NoSuchElementException - if bandwidth is not present

getIncludeRoute

@Nullable List<IncludeRoute> getIncludeRoute()

Return includeRoute, or null if it is not present.

     
         Speficy routes which must be included in the computed path, i.e. IRO
     
 

Returns:

List<IncludeRoute> includeRoute, or null if it is not present.

nonnullIncludeRoute

default @NonNull List<IncludeRoute> nonnullIncludeRoute()

Return includeRoute, or an empty list if it is not present.

Returns:

List<IncludeRoute> includeRoute, or an empty list if it is not present.

getExcludeRoute

@Nullable List<ExcludeRoute> getExcludeRoute()

Return excludeRoute, or null if it is not present.

     
         Speficy routes which must be excluded in the computed path, i.e. XRO
     
 

Returns:

List<ExcludeRoute> excludeRoute, or null if it is not present.

nonnullExcludeRoute

default @NonNull List<ExcludeRoute> nonnullExcludeRoute()

Return excludeRoute, or an empty list if it is not present.

Returns:

List<ExcludeRoute> excludeRoute, or an empty list if it is not present.