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:
EdgeAttributes

@Generated("mdsal-binding-generator") public interface EdgeAttributes extends org.opendaylight.yangtools.yang.binding.DataObject
Attributes associated with the Edge

This class represents the following YANG schema fragment defined in module graph

 grouping edge-attributes {
   leaf metric {
     type uint32;
   }
   leaf te-metric {
     type uint32;
   }
   leaf admin-group {
     type uint32;
   }
   leaf local-address {
     type inet:ipv4-address;
   }
   leaf remote-address {
     type inet:ipv4-address;
   }
   leaf local-address6 {
     type inet:ipv6-address;
   }
   leaf remote-address6 {
     type inet:ipv6-address;
   }
   leaf local-identifier {
     type uint32;
   }
   leaf remote-identifier {
     type uint32;
   }
   leaf max-link-bandwidth {
     type decimal-bandwidth;
   }
   leaf max-resv-link-bandwidth {
     type decimal-bandwidth;
   }
   list unreserved-bandwidth {
     max-elements 8;
     ordered-by user;
     key class-type;
     leaf class-type {
       type uint8 {
         range 0..7;
       }
     }
     leaf bandwidth {
       type decimal-bandwidth;
     }
   }
   leaf delay {
     type delay;
   }
   container min-max-delay {
     leaf min-delay {
       type delay;
     }
     leaf max-delay {
       type delay;
     }
   }
   leaf jitter {
     type delay;
   }
   leaf loss {
     type loss;
   }
   leaf residual-bandwidth {
     type decimal-bandwidth;
   }
   leaf available-bandwidth {
     type decimal-bandwidth;
   }
   leaf utilized-bandwidth {
     type decimal-bandwidth;
   }
   leaf adj-sid {
     units "MPLS label";
     type uint32;
   }
   leaf backup-adj-sid {
     units "MPLS label";
     type uint32;
   }
   leaf adj-sid6 {
     units "MPLS label";
     type uint32;
   }
   leaf backup-adj-sid6 {
     units "MPLS label";
     type uint32;
   }
   leaf-list srlgs {
     type uint32;
   }
 }
 
  • Field Summary

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

    Modifier and Type
    Method
    Description
    org.opendaylight.yangtools.yang.common.Uint32
    Return adjSid, or null if it is not present.
    org.opendaylight.yangtools.yang.common.Uint32
    Return adjSid6, or null if it is not present.
    org.opendaylight.yangtools.yang.common.Uint32
    Return adminGroup, or null if it is not present.
    Return availableBandwidth, or null if it is not present.
    org.opendaylight.yangtools.yang.common.Uint32
    Return backupAdjSid, or null if it is not present.
    org.opendaylight.yangtools.yang.common.Uint32
    Return backupAdjSid6, or null if it is not present.
    Return delay, or null if it is not present.
    Return jitter, or null if it is not present.
    org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address
    Return localAddress, or null if it is not present.
    org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address
    Return localAddress6, or null if it is not present.
    org.opendaylight.yangtools.yang.common.Uint32
    Return localIdentifier, or null if it is not present.
    Return loss, or null if it is not present.
    Return maxLinkBandwidth, or null if it is not present.
    Return maxResvLinkBandwidth, or null if it is not present.
    org.opendaylight.yangtools.yang.common.Uint32
    Return metric, or null if it is not present.
    Return minMaxDelay, or null if it is not present.
    org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address
    Return remoteAddress, or null if it is not present.
    org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address
    Return remoteAddress6, or null if it is not present.
    org.opendaylight.yangtools.yang.common.Uint32
    Return remoteIdentifier, or null if it is not present.
    Return residualBandwidth, or null if it is not present.
    @Nullable Set<org.opendaylight.yangtools.yang.common.Uint32>
    Return srlgs, or null if it is not present.
    org.opendaylight.yangtools.yang.common.Uint32
    Return teMetric, or null if it is not present.
    Return unreservedBandwidth, or null if it is not present.
    Return utilizedBandwidth, or null if it is not present.
     
    @NonNull MinMaxDelay
    Return minMaxDelay, or an empty instance if it is not present.
    default @NonNull List<UnreservedBandwidth>
    Return unreservedBandwidth, or an empty list if it is not present.
    default @NonNull org.opendaylight.yangtools.yang.common.Uint32
    Return adjSid, guaranteed to be non-null.
    default @NonNull org.opendaylight.yangtools.yang.common.Uint32
    Return adjSid6, guaranteed to be non-null.
    default @NonNull org.opendaylight.yangtools.yang.common.Uint32
    Return adminGroup, guaranteed to be non-null.
    default @NonNull DecimalBandwidth
    Return availableBandwidth, guaranteed to be non-null.
    default @NonNull org.opendaylight.yangtools.yang.common.Uint32
    Return backupAdjSid, guaranteed to be non-null.
    default @NonNull org.opendaylight.yangtools.yang.common.Uint32
    Return backupAdjSid6, guaranteed to be non-null.
    default @NonNull Delay
    Return delay, guaranteed to be non-null.
    default @NonNull Delay
    Return jitter, guaranteed to be non-null.
    default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address
    Return localAddress, guaranteed to be non-null.
    default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address
    Return localAddress6, guaranteed to be non-null.
    default @NonNull org.opendaylight.yangtools.yang.common.Uint32
    Return localIdentifier, guaranteed to be non-null.
    default @NonNull Loss
    Return loss, guaranteed to be non-null.
    default @NonNull DecimalBandwidth
    Return maxLinkBandwidth, guaranteed to be non-null.
    default @NonNull DecimalBandwidth
    Return maxResvLinkBandwidth, guaranteed to be non-null.
    default @NonNull org.opendaylight.yangtools.yang.common.Uint32
    Return metric, guaranteed to be non-null.
    default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address
    Return remoteAddress, guaranteed to be non-null.
    default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address
    Return remoteAddress6, guaranteed to be non-null.
    default @NonNull org.opendaylight.yangtools.yang.common.Uint32
    Return remoteIdentifier, guaranteed to be non-null.
    default @NonNull DecimalBandwidth
    Return residualBandwidth, guaranteed to be non-null.
    default @NonNull Set<org.opendaylight.yangtools.yang.common.Uint32>
    Return srlgs, guaranteed to be non-null.
    default @NonNull org.opendaylight.yangtools.yang.common.Uint32
    Return teMetric, guaranteed to be non-null.
    default @NonNull DecimalBandwidth
    Return utilizedBandwidth, 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 EdgeAttributes> 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.
           
               Standard Metric from the routing protocol
           
       
      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.
           
               Standard Metric from the routing protocol
           
       
      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.
           
               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.
           
               Traffic Engineering Metric
           
       
      Returns:
      Uint32 teMetric, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if teMetric is not present
    • getAdminGroup

      org.opendaylight.yangtools.yang.common.Uint32 getAdminGroup()
      Return adminGroup, or null if it is not present.
           
               Administrative group or color of the link
           
       
      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.
           
               Administrative group or color of the link
           
       
      Returns:
      Uint32 adminGroup, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if adminGroup is not present
    • getLocalAddress

      org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address getLocalAddress()
      Return localAddress, or null if it is not present.
      Returns:
      Ipv4Address localAddress, or null if it is not present.
    • requireLocalAddress

      default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address requireLocalAddress()
      Return localAddress, guaranteed to be non-null.
      Returns:
      Ipv4Address localAddress, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if localAddress is not present
    • getRemoteAddress

      org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address getRemoteAddress()
      Return remoteAddress, or null if it is not present.
      Returns:
      Ipv4Address remoteAddress, or null if it is not present.
    • requireRemoteAddress

      default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address requireRemoteAddress()
      Return remoteAddress, guaranteed to be non-null.
      Returns:
      Ipv4Address remoteAddress, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if remoteAddress is not present
    • getLocalAddress6

      org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address getLocalAddress6()
      Return localAddress6, or null if it is not present.
      Returns:
      Ipv6Address localAddress6, or null if it is not present.
    • requireLocalAddress6

      default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address requireLocalAddress6()
      Return localAddress6, guaranteed to be non-null.
      Returns:
      Ipv6Address localAddress6, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if localAddress6 is not present
    • getRemoteAddress6

      org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address getRemoteAddress6()
      Return remoteAddress6, or null if it is not present.
      Returns:
      Ipv6Address remoteAddress6, or null if it is not present.
    • requireRemoteAddress6

      default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address requireRemoteAddress6()
      Return remoteAddress6, guaranteed to be non-null.
      Returns:
      Ipv6Address remoteAddress6, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if remoteAddress6 is not present
    • getLocalIdentifier

      org.opendaylight.yangtools.yang.common.Uint32 getLocalIdentifier()
      Return localIdentifier, or null if it is not present.
      Returns:
      Uint32 localIdentifier, or null if it is not present.
    • requireLocalIdentifier

      default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requireLocalIdentifier()
      Return localIdentifier, guaranteed to be non-null.
      Returns:
      Uint32 localIdentifier, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if localIdentifier is not present
    • getRemoteIdentifier

      org.opendaylight.yangtools.yang.common.Uint32 getRemoteIdentifier()
      Return remoteIdentifier, or null if it is not present.
      Returns:
      Uint32 remoteIdentifier, or null if it is not present.
    • requireRemoteIdentifier

      default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requireRemoteIdentifier()
      Return remoteIdentifier, guaranteed to be non-null.
      Returns:
      Uint32 remoteIdentifier, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if remoteIdentifier is not present
    • getMaxLinkBandwidth

      DecimalBandwidth getMaxLinkBandwidth()
      Return maxLinkBandwidth, or null if it is not present.
           
               Maximum bandwidth that can be use
           
       
      Returns:
      DecimalBandwidth maxLinkBandwidth, or null if it is not present.
    • requireMaxLinkBandwidth

      default @NonNull DecimalBandwidth requireMaxLinkBandwidth()
      Return maxLinkBandwidth, guaranteed to be non-null.
           
               Maximum bandwidth that can be use
           
       
      Returns:
      DecimalBandwidth maxLinkBandwidth, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if maxLinkBandwidth is not present
    • getMaxResvLinkBandwidth

      DecimalBandwidth getMaxResvLinkBandwidth()
      Return maxResvLinkBandwidth, or null if it is not present.
           
               Maximum amount of bandwidth that can be reserved
           
       
      Returns:
      DecimalBandwidth maxResvLinkBandwidth, or null if it is not present.
    • requireMaxResvLinkBandwidth

      default @NonNull DecimalBandwidth requireMaxResvLinkBandwidth()
      Return maxResvLinkBandwidth, guaranteed to be non-null.
           
               Maximum amount of bandwidth that can be reserved
           
       
      Returns:
      DecimalBandwidth maxResvLinkBandwidth, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if maxResvLinkBandwidth is not present
    • getUnreservedBandwidth

      @Nullable List<UnreservedBandwidth> getUnreservedBandwidth()
      Return unreservedBandwidth, or null if it is not present.
           
               Unreserved bandwidth for 0-7 class type
           
       
      Returns:
      List<UnreservedBandwidth> unreservedBandwidth, or null if it is not present.
    • nonnullUnreservedBandwidth

      default @NonNull List<UnreservedBandwidth> nonnullUnreservedBandwidth()
      Return unreservedBandwidth, or an empty list if it is not present.
      Returns:
      List<UnreservedBandwidth> unreservedBandwidth, or an empty list if it is not present.
    • getDelay

      Delay getDelay()
      Return delay, or null if it is not present.
           
               Unidirectional Delay.
           
       
      Returns:
      Delay delay, or null if it is not present.
    • requireDelay

      default @NonNull Delay requireDelay()
      Return delay, guaranteed to be non-null.
           
               Unidirectional Delay.
           
       
      Returns:
      Delay delay, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if delay is not present
    • getMinMaxDelay

      MinMaxDelay getMinMaxDelay()
      Return minMaxDelay, or null if it is not present.
           
               Min/Max Unidirectional Delay
           
       
      Returns:
      MinMaxDelay minMaxDelay, or null if it is not present.
    • nonnullMinMaxDelay

      @NonNull MinMaxDelay nonnullMinMaxDelay()
      Return minMaxDelay, or an empty instance if it is not present.
      Returns:
      MinMaxDelay minMaxDelay, or an empty instance if it is not present.
    • getJitter

      Delay getJitter()
      Return jitter, or null if it is not present.
           
               Unidirectional Delay Variation
           
       
      Returns:
      Delay jitter, or null if it is not present.
    • requireJitter

      default @NonNull Delay requireJitter()
      Return jitter, guaranteed to be non-null.
           
               Unidirectional Delay Variation
           
       
      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.
           
               Unidirectional Loss
           
       
      Returns:
      Loss loss, or null if it is not present.
    • requireLoss

      default @NonNull Loss requireLoss()
      Return loss, guaranteed to be non-null.
           
               Unidirectional Loss
           
       
      Returns:
      Loss loss, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if loss is not present
    • getResidualBandwidth

      DecimalBandwidth getResidualBandwidth()
      Return residualBandwidth, or null if it is not present.
           
               Unidirectional Residual Bandwidth
           
       
      Returns:
      DecimalBandwidth residualBandwidth, or null if it is not present.
    • requireResidualBandwidth

      default @NonNull DecimalBandwidth requireResidualBandwidth()
      Return residualBandwidth, guaranteed to be non-null.
           
               Unidirectional Residual Bandwidth
           
       
      Returns:
      DecimalBandwidth residualBandwidth, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if residualBandwidth is not present
    • getAvailableBandwidth

      DecimalBandwidth getAvailableBandwidth()
      Return availableBandwidth, or null if it is not present.
           
               Unidirectional Available Bandwidth
           
       
      Returns:
      DecimalBandwidth availableBandwidth, or null if it is not present.
    • requireAvailableBandwidth

      default @NonNull DecimalBandwidth requireAvailableBandwidth()
      Return availableBandwidth, guaranteed to be non-null.
           
               Unidirectional Available Bandwidth
           
       
      Returns:
      DecimalBandwidth availableBandwidth, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if availableBandwidth is not present
    • getUtilizedBandwidth

      DecimalBandwidth getUtilizedBandwidth()
      Return utilizedBandwidth, or null if it is not present.
           
               Unidirectional Utilized Bandwidth
           
       
      Returns:
      DecimalBandwidth utilizedBandwidth, or null if it is not present.
    • requireUtilizedBandwidth

      default @NonNull DecimalBandwidth requireUtilizedBandwidth()
      Return utilizedBandwidth, guaranteed to be non-null.
           
               Unidirectional Utilized Bandwidth
           
       
      Returns:
      DecimalBandwidth utilizedBandwidth, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if utilizedBandwidth is not present
    • getAdjSid

      org.opendaylight.yangtools.yang.common.Uint32 getAdjSid()
      Return adjSid, or null if it is not present.
           
               Segment Routing Adjacency Identifier for IPv4
           
       
      Returns:
      Uint32 adjSid, or null if it is not present.
    • requireAdjSid

      default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requireAdjSid()
      Return adjSid, guaranteed to be non-null.
           
               Segment Routing Adjacency Identifier for IPv4
           
       
      Returns:
      Uint32 adjSid, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if adjSid is not present
    • getBackupAdjSid

      org.opendaylight.yangtools.yang.common.Uint32 getBackupAdjSid()
      Return backupAdjSid, or null if it is not present.
           
               Segment Routing Backup Adjacency Identifier for IPv4
           
       
      Returns:
      Uint32 backupAdjSid, or null if it is not present.
    • requireBackupAdjSid

      default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requireBackupAdjSid()
      Return backupAdjSid, guaranteed to be non-null.
           
               Segment Routing Backup Adjacency Identifier for IPv4
           
       
      Returns:
      Uint32 backupAdjSid, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if backupAdjSid is not present
    • getAdjSid6

      org.opendaylight.yangtools.yang.common.Uint32 getAdjSid6()
      Return adjSid6, or null if it is not present.
           
               Segment Routing Adjacency Identifier for IPv6
           
       
      Returns:
      Uint32 adjSid6, or null if it is not present.
    • requireAdjSid6

      default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requireAdjSid6()
      Return adjSid6, guaranteed to be non-null.
           
               Segment Routing Adjacency Identifier for IPv6
           
       
      Returns:
      Uint32 adjSid6, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if adjSid6 is not present
    • getBackupAdjSid6

      org.opendaylight.yangtools.yang.common.Uint32 getBackupAdjSid6()
      Return backupAdjSid6, or null if it is not present.
           
               Segment Routing Backup Adjacency Identifier for IPv6
           
       
      Returns:
      Uint32 backupAdjSid6, or null if it is not present.
    • requireBackupAdjSid6

      default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requireBackupAdjSid6()
      Return backupAdjSid6, guaranteed to be non-null.
           
               Segment Routing Backup Adjacency Identifier for IPv6
           
       
      Returns:
      Uint32 backupAdjSid6, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if backupAdjSid6 is not present
    • getSrlgs

      @Nullable Set<org.opendaylight.yangtools.yang.common.Uint32> getSrlgs()
      Return srlgs, or null if it is not present.
           
               List of Shared Risk Link Group Attributes
           
       
      Returns:
      Set<Uint32> srlgs, or null if it is not present.
    • requireSrlgs

      default @NonNull Set<org.opendaylight.yangtools.yang.common.Uint32> requireSrlgs()
      Return srlgs, guaranteed to be non-null.
           
               List of Shared Risk Link Group Attributes
           
       
      Returns:
      Set<Uint32> srlgs, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if srlgs is not present