Interface PathConstraints
-
- All Superinterfaces:
org.opendaylight.yangtools.yang.binding.BindingObject
,org.opendaylight.yangtools.yang.binding.DataContainer
,org.opendaylight.yangtools.yang.binding.DataObject
- All Known Subinterfaces:
ConstrainedPath
,Constraints
@Generated("mdsal-binding-generator") public interface PathConstraints extends org.opendaylight.yangtools.yang.binding.DataObject
Set of Constraints for Path ComputationThis 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 enumeration { enum ipv4 { value 0; } enum ipv6 { value 1; } enum sr-ipv4 { value 2; } enum sr-ipv6 { value 3; } } default ipv4; } leaf class-type { type uint8 { range 0..7; } } leaf bandwidth { type gr:decimal-bandwidth; } }
The schema path to identify an instance is path-computationpath-constraints
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
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 PathConstraints.AddressFamily
getAddressFamily()
Return addressFamily, ornull
if it is not present.org.opendaylight.yangtools.yang.common.Uint32
getAdminGroup()
Return adminGroup, ornull
if it is not present.DecimalBandwidth
getBandwidth()
Return bandwidth, ornull
if it is not present.org.opendaylight.yangtools.yang.common.Uint8
getClassType()
Return classType, ornull
if it is not present.Delay
getDelay()
Return delay, ornull
if it is not present.Delay
getJitter()
Return jitter, ornull
if it is not present.Loss
getLoss()
Return loss, ornull
if it is not present.org.opendaylight.yangtools.yang.common.Uint32
getMetric()
Return metric, ornull
if it is not present.org.opendaylight.yangtools.yang.common.Uint32
getTeMetric()
Return teMetric, ornull
if it is not present.Class<? extends PathConstraints>
implementedInterface()
default @NonNull PathConstraints.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.
-
-
-
Method Detail
-
implementedInterface
Class<? extends PathConstraints> implementedInterface()
- Specified by:
implementedInterface
in interfaceorg.opendaylight.yangtools.yang.binding.DataContainer
- Specified by:
implementedInterface
in interfaceorg.opendaylight.yangtools.yang.binding.DataObject
-
getMetric
org.opendaylight.yangtools.yang.common.Uint32 getMetric()
Return metric, ornull
if it is not present.Maximum end to end IGP metric
- Returns:
Uint32
metric, ornull
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, ornull
if it is not present.Maximum end to end Traffic Engineering metric
- Returns:
Uint32
teMetric, ornull
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, ornull
if it is not present.Maximum end to end delay
- Returns:
Delay
delay, ornull
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, ornull
if it is not present.Maximum delay variation for selected edges
- Returns:
Delay
jitter, ornull
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, ornull
if it is not present.Maximum loss for selected edges
- Returns:
Loss
loss, ornull
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, ornull
if it is not present.Admin group to select edges
- Returns:
Uint32
adminGroup, ornull
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
PathConstraints.AddressFamily getAddressFamily()
Return addressFamily, ornull
if it is not present.Address family of the computed path
- Returns:
AddressFamily
addressFamily, ornull
if it is not present.
-
requireAddressFamily
default @NonNull PathConstraints.AddressFamily requireAddressFamily()
Return addressFamily, guaranteed to be non-null.Address family of the computed path
- 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, ornull
if it is not present.Class Type for bandwidth constraints
- Returns:
Uint8
classType, ornull
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, ornull
if it is not present.Requested bandwidth for the computed path
- Returns:
DecimalBandwidth
bandwidth, ornull
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
-
-