All Superinterfaces:: org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject

All Known Subinterfaces:: LinkAttributes

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

This class represents the following YANG schema fragment defined in module bgp-linkstate

 grouping linkstate-attribute {
   leaf local-ipv4-router-id {
     type ipv4-router-identifier;
   }
   leaf local-ipv6-router-id {
     type ipv6-router-identifier;
   }
   leaf remote-ipv4-router-id {
     type ipv4-router-identifier;
   }
   leaf remote-ipv6-router-id {
     type ipv6-router-identifier;
   }
   leaf mpls-protocol {
     type mpls-protocol-mask;
   }
   leaf te-metric {
     type netc:te-metric;
   }
   leaf metric {
     type netc:metric;
   }
   leaf-list shared-risk-link-groups {
     type rsvp:srlg-id;
   }
   leaf link-name {
     type string;
   }
   leaf max-link-bandwidth {
     type netc:bandwidth;
   }
   leaf max-reservable-bandwidth {
     type netc:bandwidth;
   }
   list unreserved-bandwidth {
     key priority;
     uses unreserved-bandwidth;
   }
   leaf link-protection {
     type link-protection-type;
   }
   leaf admin-group {
     type administrative-group;
   }
   list sr-adj-ids {
     uses bgp-sr:adj-sid-tlv;
   }
   list sr-lan-adj-ids {
     uses bgp-sr:lan-adj-sid-tlv;
   }
   container peer-node-sid {
     uses bgp-sr:epe-adj-sid-tlv;
   }
   container peer-adj-sid {
     uses bgp-sr:epe-adj-sid-tlv;
   }
   list peer-set-sids {
     uses bgp-sr:epe-adj-sid-tlv;
   }
   leaf link-delay {
     type delay;
   }
   container link-min-max-delay {
     leaf min-delay {
       type delay;
     }
     leaf max-delay {
       type delay;
     }
   }
   leaf delay-variation {
     type delay;
   }
   leaf link-loss {
     type loss;
   }
   leaf residual-bandwidth {
     type netc:bandwidth;
   }
   leaf available-bandwidth {
     type netc:bandwidth;
   }
   leaf utilized-bandwidth {
     type netc:bandwidth;
   }
 }

Field Summary

Fields
Modifier and Type Field Description

static @NonNull org.opendaylight.yangtools.yang.common.QName QNAME
YANG identifier of the statement represented by this class.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`AdministrativeGroup`	`getAdminGroup()`	Return adminGroup, or `null` if it is not present.
`Bandwidth`	`getAvailableBandwidth()`	Return availableBandwidth, or `null` if it is not present.
`Delay`	`getDelayVariation()`	Return delayVariation, or `null` if it is not present.
`Delay`	`getLinkDelay()`	Return linkDelay, or `null` if it is not present.
`Loss`	`getLinkLoss()`	Return linkLoss, or `null` if it is not present.
`LinkMinMaxDelay`	`getLinkMinMaxDelay()`	Return linkMinMaxDelay, or `null` if it is not present.
`String`	`getLinkName()`	Return linkName, or `null` if it is not present.
`LinkProtectionType`	`getLinkProtection()`	Return linkProtection, or `null` if it is not present.
`Ipv4RouterIdentifier`	`getLocalIpv4RouterId()`	Return localIpv4RouterId, or `null` if it is not present.
`Ipv6RouterIdentifier`	`getLocalIpv6RouterId()`	Return localIpv6RouterId, or `null` if it is not present.
`Bandwidth`	`getMaxLinkBandwidth()`	Return maxLinkBandwidth, or `null` if it is not present.
`Bandwidth`	`getMaxReservableBandwidth()`	Return maxReservableBandwidth, or `null` if it is not present.
`Metric`	`getMetric()`	Return metric, or `null` if it is not present.
`MplsProtocolMask`	`getMplsProtocol()`	Return mplsProtocol, or `null` if it is not present.
`PeerAdjSid`	`getPeerAdjSid()`	Return peerAdjSid, or `null` if it is not present.
`PeerNodeSid`	`getPeerNodeSid()`	Return peerNodeSid, or `null` if it is not present.
`@Nullable List<PeerSetSids>`	`getPeerSetSids()`	Return peerSetSids, or `null` if it is not present.
`Ipv4RouterIdentifier`	`getRemoteIpv4RouterId()`	Return remoteIpv4RouterId, or `null` if it is not present.
`Ipv6RouterIdentifier`	`getRemoteIpv6RouterId()`	Return remoteIpv6RouterId, or `null` if it is not present.
`Bandwidth`	`getResidualBandwidth()`	Return residualBandwidth, or `null` if it is not present.
`@Nullable Set<SrlgId>`	`getSharedRiskLinkGroups()`	Return sharedRiskLinkGroups, or `null` if it is not present.
`@Nullable List<SrAdjIds>`	`getSrAdjIds()`	Return srAdjIds, or `null` if it is not present.
`@Nullable List<SrLanAdjIds>`	`getSrLanAdjIds()`	Return srLanAdjIds, or `null` if it is not present.
`TeMetric`	`getTeMetric()`	Return teMetric, or `null` if it is not present.
`@Nullable Map<UnreservedBandwidthKey,UnreservedBandwidth>`	`getUnreservedBandwidth()`	Return unreservedBandwidth, or `null` if it is not present.
`Bandwidth`	`getUtilizedBandwidth()`	Return utilizedBandwidth, or `null` if it is not present.
`Class<? extends LinkstateAttribute>`	`implementedInterface()`
`default @NonNull List<PeerSetSids>`	`nonnullPeerSetSids()`	Return peerSetSids, or an empty list if it is not present.
`default @NonNull List<SrAdjIds>`	`nonnullSrAdjIds()`	Return srAdjIds, or an empty list if it is not present.
`default @NonNull List<SrLanAdjIds>`	`nonnullSrLanAdjIds()`	Return srLanAdjIds, or an empty list if it is not present.
`default @NonNull Map<UnreservedBandwidthKey,UnreservedBandwidth>`	`nonnullUnreservedBandwidth()`	Return unreservedBandwidth, or an empty list if it is not present.
`default @NonNull AdministrativeGroup`	`requireAdminGroup()`	Return adminGroup, guaranteed to be non-null.
`default @NonNull Bandwidth`	`requireAvailableBandwidth()`	Return availableBandwidth, guaranteed to be non-null.
`default @NonNull Delay`	`requireDelayVariation()`	Return delayVariation, guaranteed to be non-null.
`default @NonNull Delay`	`requireLinkDelay()`	Return linkDelay, guaranteed to be non-null.
`default @NonNull Loss`	`requireLinkLoss()`	Return linkLoss, guaranteed to be non-null.
`default @NonNull String`	`requireLinkName()`	Return linkName, guaranteed to be non-null.
`default @NonNull LinkProtectionType`	`requireLinkProtection()`	Return linkProtection, guaranteed to be non-null.
`default @NonNull Ipv4RouterIdentifier`	`requireLocalIpv4RouterId()`	Return localIpv4RouterId, guaranteed to be non-null.
`default @NonNull Ipv6RouterIdentifier`	`requireLocalIpv6RouterId()`	Return localIpv6RouterId, guaranteed to be non-null.
`default @NonNull Bandwidth`	`requireMaxLinkBandwidth()`	Return maxLinkBandwidth, guaranteed to be non-null.
`default @NonNull Bandwidth`	`requireMaxReservableBandwidth()`	Return maxReservableBandwidth, guaranteed to be non-null.
`default @NonNull Metric`	`requireMetric()`	Return metric, guaranteed to be non-null.
`default @NonNull MplsProtocolMask`	`requireMplsProtocol()`	Return mplsProtocol, guaranteed to be non-null.
`default @NonNull Ipv4RouterIdentifier`	`requireRemoteIpv4RouterId()`	Return remoteIpv4RouterId, guaranteed to be non-null.
`default @NonNull Ipv6RouterIdentifier`	`requireRemoteIpv6RouterId()`	Return remoteIpv6RouterId, guaranteed to be non-null.
`default @NonNull Bandwidth`	`requireResidualBandwidth()`	Return residualBandwidth, guaranteed to be non-null.
`default @NonNull Set<SrlgId>`	`requireSharedRiskLinkGroups()`	Return sharedRiskLinkGroups, guaranteed to be non-null.
`default @NonNull TeMetric`	`requireTeMetric()`	Return teMetric, guaranteed to be non-null.
`default @NonNull Bandwidth`	`requireUtilizedBandwidth()`	Return utilizedBandwidth, guaranteed to be non-null.

- Field Detail
  - QNAME
```
static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME
```
    YANG identifier of the statement represented by this class.
- Method Detail
  - implementedInterface
```
Class<? extends LinkstateAttribute> implementedInterface()
```
    Specified by:
    
    implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataContainer
    
    Specified by:
    
    implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject
  - getLocalIpv4RouterId
```
Ipv4RouterIdentifier getLocalIpv4RouterId()
```
    Return localIpv4RouterId, or null if it is not present.
    
    Returns:
    
    Ipv4RouterIdentifier localIpv4RouterId, or null if it is not present.
  - requireLocalIpv4RouterId
```
default @NonNull Ipv4RouterIdentifier requireLocalIpv4RouterId()
```
    Return localIpv4RouterId, guaranteed to be non-null.
    
    Returns:
    
    Ipv4RouterIdentifier localIpv4RouterId, guaranteed to be non-null.
    
    Throws:
    
    NoSuchElementException - if localIpv4RouterId is not present
  - getLocalIpv6RouterId
```
Ipv6RouterIdentifier getLocalIpv6RouterId()
```
    Return localIpv6RouterId, or null if it is not present.
    
    Returns:
    
    Ipv6RouterIdentifier localIpv6RouterId, or null if it is not present.
  - requireLocalIpv6RouterId
```
default @NonNull Ipv6RouterIdentifier requireLocalIpv6RouterId()
```
    Return localIpv6RouterId, guaranteed to be non-null.
    
    Returns:
    
    Ipv6RouterIdentifier localIpv6RouterId, guaranteed to be non-null.
    
    Throws:
    
    NoSuchElementException - if localIpv6RouterId is not present
  - getRemoteIpv4RouterId
```
Ipv4RouterIdentifier getRemoteIpv4RouterId()
```
    Return remoteIpv4RouterId, or null if it is not present.
    
    Returns:
    
    Ipv4RouterIdentifier remoteIpv4RouterId, or null if it is not present.
  - requireRemoteIpv4RouterId
```
default @NonNull Ipv4RouterIdentifier requireRemoteIpv4RouterId()
```
    Return remoteIpv4RouterId, guaranteed to be non-null.
    
    Returns:
    
    Ipv4RouterIdentifier remoteIpv4RouterId, guaranteed to be non-null.
    
    Throws:
    
    NoSuchElementException - if remoteIpv4RouterId is not present
  - getRemoteIpv6RouterId
```
Ipv6RouterIdentifier getRemoteIpv6RouterId()
```
    Return remoteIpv6RouterId, or null if it is not present.
    
    Returns:
    
    Ipv6RouterIdentifier remoteIpv6RouterId, or null if it is not present.
  - requireRemoteIpv6RouterId
```
default @NonNull Ipv6RouterIdentifier requireRemoteIpv6RouterId()
```
    Return remoteIpv6RouterId, guaranteed to be non-null.
    
    Returns:
    
    Ipv6RouterIdentifier remoteIpv6RouterId, guaranteed to be non-null.
    
    Throws:
    
    NoSuchElementException - if remoteIpv6RouterId is not present
  - getMplsProtocol
```
MplsProtocolMask getMplsProtocol()
```
    Return mplsProtocol, or null if it is not present.
    
    Returns:
    
    MplsProtocolMask mplsProtocol, or null if it is not present.
  - requireMplsProtocol
```
default @NonNull MplsProtocolMask requireMplsProtocol()
```
    Return mplsProtocol, guaranteed to be non-null.
    
    Returns:
    
    MplsProtocolMask mplsProtocol, guaranteed to be non-null.
    
    Throws:
    
    NoSuchElementException - if mplsProtocol is not present
  - getTeMetric
```
TeMetric getTeMetric()
```
    Return teMetric, or null if it is not present.
    
    Returns:
    
    TeMetric teMetric, or null if it is not present.
  - requireTeMetric
```
default @NonNull TeMetric requireTeMetric()
```
    Return teMetric, guaranteed to be non-null.
    
    Returns:
    
    TeMetric teMetric, guaranteed to be non-null.
    
    Throws:
    
    NoSuchElementException - if teMetric is not present
  - getMetric
```
Metric getMetric()
```
    Return metric, or null if it is not present.
    
    Returns:
    
    Metric metric, or null if it is not present.
  - requireMetric
```
default @NonNull Metric requireMetric()
```
    Return metric, guaranteed to be non-null.
    
    Returns:
    
    Metric metric, guaranteed to be non-null.
    
    Throws:
    
    NoSuchElementException - if metric is not present
  - getSharedRiskLinkGroups
```
@Nullable Set<SrlgId> getSharedRiskLinkGroups()
```
    Return sharedRiskLinkGroups, or null if it is not present.
    
    Returns:
    
    Set<SrlgId> sharedRiskLinkGroups, or null if it is not present.
  - requireSharedRiskLinkGroups
```
default @NonNull Set<SrlgId> requireSharedRiskLinkGroups()
```
    Return sharedRiskLinkGroups, guaranteed to be non-null.
    
    Returns:
    
    Set<SrlgId> sharedRiskLinkGroups, guaranteed to be non-null.
    
    Throws:
    
    NoSuchElementException - if sharedRiskLinkGroups is not present
  - getLinkName
```
String getLinkName()
```
    Return linkName, or null if it is not present.
    
    Returns:
    
    String linkName, or null if it is not present.
  - requireLinkName
```
default @NonNull String requireLinkName()
```
    Return linkName, guaranteed to be non-null.
    
    Returns:
    
    String linkName, guaranteed to be non-null.
    
    Throws:
    
    NoSuchElementException - if linkName is not present
  - getMaxLinkBandwidth
```
Bandwidth getMaxLinkBandwidth()
```
    Return maxLinkBandwidth, or null if it is not present.
    
    Returns:
    
    Bandwidth maxLinkBandwidth, or null if it is not present.
  - requireMaxLinkBandwidth
```
default @NonNull Bandwidth requireMaxLinkBandwidth()
```
    Return maxLinkBandwidth, guaranteed to be non-null.
    
    Returns:
    
    Bandwidth maxLinkBandwidth, guaranteed to be non-null.
    
    Throws:
    
    NoSuchElementException - if maxLinkBandwidth is not present
  - getMaxReservableBandwidth
```
Bandwidth getMaxReservableBandwidth()
```
    Return maxReservableBandwidth, or null if it is not present.
    
    Returns:
    
    Bandwidth maxReservableBandwidth, or null if it is not present.
  - requireMaxReservableBandwidth
```
default @NonNull Bandwidth requireMaxReservableBandwidth()
```
    Return maxReservableBandwidth, guaranteed to be non-null.
    
    Returns:
    
    Bandwidth maxReservableBandwidth, guaranteed to be non-null.
    
    Throws:
    
    NoSuchElementException - if maxReservableBandwidth is not present
  - getUnreservedBandwidth
```
@Nullable Map<UnreservedBandwidthKey,UnreservedBandwidth> getUnreservedBandwidth()
```
    Return unreservedBandwidth, or null if it is not present.
    
    Returns:
    
    Map<UnreservedBandwidthKey, UnreservedBandwidth> unreservedBandwidth, or null if it is not present.
  - nonnullUnreservedBandwidth
```
default @NonNull Map<UnreservedBandwidthKey,UnreservedBandwidth> nonnullUnreservedBandwidth()
```
    Return unreservedBandwidth, or an empty list if it is not present.
    
    Returns:
    
    Map<UnreservedBandwidthKey, UnreservedBandwidth> unreservedBandwidth, or an empty list if it is not present.
  - getLinkProtection
```
LinkProtectionType getLinkProtection()
```
    Return linkProtection, or null if it is not present.
    
    Returns:
    
    LinkProtectionType linkProtection, or null if it is not present.
  - requireLinkProtection
```
default @NonNull LinkProtectionType requireLinkProtection()
```
    Return linkProtection, guaranteed to be non-null.
    
    Returns:
    
    LinkProtectionType linkProtection, guaranteed to be non-null.
    
    Throws:
    
    NoSuchElementException - if linkProtection is not present
  - getAdminGroup
```
AdministrativeGroup getAdminGroup()
```
    Return adminGroup, or null if it is not present.
    
    Returns:
    
    AdministrativeGroup adminGroup, or null if it is not present.
  - requireAdminGroup
```
default @NonNull AdministrativeGroup requireAdminGroup()
```
    Return adminGroup, guaranteed to be non-null.
    
    Returns:
    
    AdministrativeGroup adminGroup, guaranteed to be non-null.
    
    Throws:
    
    NoSuchElementException - if adminGroup is not present
  - getSrAdjIds
```
@Nullable List<SrAdjIds> getSrAdjIds()
```
    Return srAdjIds, or null if it is not present.
    
    Returns:
    
    List<SrAdjIds> srAdjIds, or null if it is not present.
  - nonnullSrAdjIds
```
default @NonNull List<SrAdjIds> nonnullSrAdjIds()
```
    Return srAdjIds, or an empty list if it is not present.
    
    Returns:
    
    List<SrAdjIds> srAdjIds, or an empty list if it is not present.
  - getSrLanAdjIds
```
@Nullable List<SrLanAdjIds> getSrLanAdjIds()
```
    Return srLanAdjIds, or null if it is not present.
    
    Returns:
    
    List<SrLanAdjIds> srLanAdjIds, or null if it is not present.
  - nonnullSrLanAdjIds
```
default @NonNull List<SrLanAdjIds> nonnullSrLanAdjIds()
```
    Return srLanAdjIds, or an empty list if it is not present.
    
    Returns:
    
    List<SrLanAdjIds> srLanAdjIds, or an empty list if it is not present.
  - getPeerNodeSid
```
PeerNodeSid getPeerNodeSid()
```
    Return peerNodeSid, or null if it is not present.
    The SID representing the peer of the BGP session.
    Returns:
    
    PeerNodeSid peerNodeSid, or null if it is not present.
  - getPeerAdjSid
```
PeerAdjSid getPeerAdjSid()
```
    Return peerAdjSid, or null if it is not present.
    The SID representing the peer of the BGP session.
    Returns:
    
    PeerAdjSid peerAdjSid, or null if it is not present.
  - getPeerSetSids
```
@Nullable List<PeerSetSids> getPeerSetSids()
```
    Return peerSetSids, or null if it is not present.
    The SID representing the group the peer is part of.
    Returns:
    
    List<PeerSetSids> peerSetSids, or null if it is not present.
  - nonnullPeerSetSids
```
default @NonNull List<PeerSetSids> nonnullPeerSetSids()
```
    Return peerSetSids, or an empty list if it is not present.
    
    Returns:
    
    List<PeerSetSids> peerSetSids, or an empty list if it is not present.
  - getLinkDelay
```
Delay getLinkDelay()
```
    Return linkDelay, or null if it is not present.
    Unidirectional Link Delay
    Returns:
    
    Delay linkDelay, or null if it is not present.
  - requireLinkDelay
```
default @NonNull Delay requireLinkDelay()
```
    Return linkDelay, guaranteed to be non-null.
    Unidirectional Link Delay
    Returns:
    
    Delay linkDelay, guaranteed to be non-null.
    
    Throws:
    
    NoSuchElementException - if linkDelay is not present
  - getLinkMinMaxDelay
```
LinkMinMaxDelay getLinkMinMaxDelay()
```
    Return linkMinMaxDelay, or null if it is not present.
    Min/Max Unidirectional Link Delay
    Returns:
    
    LinkMinMaxDelay linkMinMaxDelay, or null if it is not present.
  - getDelayVariation
```
Delay getDelayVariation()
```
    Return delayVariation, or null if it is not present.
    Unidirectional Delay Variation
    Returns:
    
    Delay delayVariation, or null if it is not present.
  - requireDelayVariation
```
default @NonNull Delay requireDelayVariation()
```
    Return delayVariation, guaranteed to be non-null.
    Unidirectional Delay Variation
    Returns:
    
    Delay delayVariation, guaranteed to be non-null.
    
    Throws:
    
    NoSuchElementException - if delayVariation is not present
  - getLinkLoss
```
Loss getLinkLoss()
```
    Return linkLoss, or null if it is not present.
    Unidirectional Link Loss
    Returns:
    
    Loss linkLoss, or null if it is not present.
  - requireLinkLoss
```
default @NonNull Loss requireLinkLoss()
```
    Return linkLoss, guaranteed to be non-null.
    Unidirectional Link Loss
    Returns:
    
    Loss linkLoss, guaranteed to be non-null.
    
    Throws:
    
    NoSuchElementException - if linkLoss is not present
  - getResidualBandwidth
```
Bandwidth getResidualBandwidth()
```
    Return residualBandwidth, or null if it is not present.
    Unidirectional Residual Bandwidth
    Returns:
    
    Bandwidth residualBandwidth, or null if it is not present.
  - requireResidualBandwidth
```
default @NonNull Bandwidth requireResidualBandwidth()
```
    Return residualBandwidth, guaranteed to be non-null.
    Unidirectional Residual Bandwidth
    Returns:
    
    Bandwidth residualBandwidth, guaranteed to be non-null.
    
    Throws:
    
    NoSuchElementException - if residualBandwidth is not present
  - getAvailableBandwidth
```
Bandwidth getAvailableBandwidth()
```
    Return availableBandwidth, or null if it is not present.
    Unidirectional Available Bandwidth
    Returns:
    
    Bandwidth availableBandwidth, or null if it is not present.
  - requireAvailableBandwidth
```
default @NonNull Bandwidth requireAvailableBandwidth()
```
    Return availableBandwidth, guaranteed to be non-null.
    Unidirectional Available Bandwidth
    Returns:
    
    Bandwidth availableBandwidth, guaranteed to be non-null.
    
    Throws:
    
    NoSuchElementException - if availableBandwidth is not present
  - getUtilizedBandwidth
```
Bandwidth getUtilizedBandwidth()
```
    Return utilizedBandwidth, or null if it is not present.
    Unidirectional Utilized Bandwidth
    Returns:
    
    Bandwidth utilizedBandwidth, or null if it is not present.
  - requireUtilizedBandwidth
```
default @NonNull Bandwidth requireUtilizedBandwidth()
```
    Return utilizedBandwidth, guaranteed to be non-null.
    Unidirectional Utilized Bandwidth
    Returns:
    
    Bandwidth utilizedBandwidth, guaranteed to be non-null.
    
    Throws:
    
    NoSuchElementException - if utilizedBandwidth is not present

Interface LinkstateAttribute

Field Summary

Method Summary

Field Detail

QNAME

Method Detail

implementedInterface

getLocalIpv4RouterId

requireLocalIpv4RouterId

getLocalIpv6RouterId

requireLocalIpv6RouterId

getRemoteIpv4RouterId

requireRemoteIpv4RouterId

getRemoteIpv6RouterId

requireRemoteIpv6RouterId

getMplsProtocol

requireMplsProtocol

getTeMetric

requireTeMetric

getMetric

requireMetric

getSharedRiskLinkGroups

requireSharedRiskLinkGroups

getLinkName

requireLinkName

getMaxLinkBandwidth

requireMaxLinkBandwidth

getMaxReservableBandwidth

requireMaxReservableBandwidth

getUnreservedBandwidth

nonnullUnreservedBandwidth

getLinkProtection

requireLinkProtection

getAdminGroup

requireAdminGroup

getSrAdjIds

nonnullSrAdjIds

getSrLanAdjIds

nonnullSrLanAdjIds

getPeerNodeSid

getPeerAdjSid

getPeerSetSids

nonnullPeerSetSids

getLinkDelay

requireLinkDelay

getLinkMinMaxDelay

getDelayVariation

requireDelayVariation

getLinkLoss

requireLinkLoss

getResidualBandwidth

requireResidualBandwidth

getAvailableBandwidth

requireAvailableBandwidth

getUtilizedBandwidth

requireUtilizedBandwidth