Interface TedLinkAttributes

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject
    All Known Subinterfaces:
    Ted, Ted

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

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

     grouping ted-link-attributes {
       leaf color {
         type uint32;
       }
       leaf max-link-bandwidth {
         type decimal64 {
           fraction-digits 2;
         }
       }
       leaf max-resv-link-bandwidth {
         type decimal64 {
           fraction-digits 2;
         }
       }
       list unreserved-bandwidth {
         max-elements 8;
         key priority;
         leaf priority {
           type uint8 {
             range 0..7;
           }
         }
         leaf bandwidth {
           type decimal64 {
             fraction-digits 2;
           }
         }
       }
       leaf te-default-metric {
         type uint32;
       }
       container srlg {
         uses srlg-attributes;
       }
     }
     
    The schema path to identify an instance is tedted-link-attributes
    • Field Detail

      • QNAME

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

      • implementedInterface

        Class<? extends TedLinkAttributes> implementedInterface()
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataContainer
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject
      • getColor

        org.opendaylight.yangtools.yang.common.Uint32 getColor()
        Return color, or null if it is not present.
             
                 Administrative group or color of the link
             
         
        Returns:
        Uint32 color, or null if it is not present.
      • requireColor

        default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requireColor()
        Return color, guaranteed to be non-null.
             
                 Administrative group or color of the link
             
         
        Returns:
        Uint32 color, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if color is not present
      • getMaxLinkBandwidth

        BigDecimal getMaxLinkBandwidth()
        Return maxLinkBandwidth, or null if it is not present.
             
                 Maximum bandwidth that can be see on this link in this direction. Units in bytes
                 per second
             
         
        Returns:
        BigDecimal maxLinkBandwidth, or null if it is not present.
      • requireMaxLinkBandwidth

        default @NonNull BigDecimal requireMaxLinkBandwidth()
        Return maxLinkBandwidth, guaranteed to be non-null.
             
                 Maximum bandwidth that can be see on this link in this direction. Units in bytes
                 per second
             
         
        Returns:
        BigDecimal maxLinkBandwidth, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if maxLinkBandwidth is not present
      • getMaxResvLinkBandwidth

        BigDecimal getMaxResvLinkBandwidth()
        Return maxResvLinkBandwidth, or null if it is not present.
             
                 Maximum amount of bandwidth that can be reserved in this direction in this link.
                 Units in bytes per second
             
         
        Returns:
        BigDecimal maxResvLinkBandwidth, or null if it is not present.
      • requireMaxResvLinkBandwidth

        default @NonNull BigDecimal requireMaxResvLinkBandwidth()
        Return maxResvLinkBandwidth, guaranteed to be non-null.
             
                 Maximum amount of bandwidth that can be reserved in this direction in this link.
                 Units in bytes per second
             
         
        Returns:
        BigDecimal maxResvLinkBandwidth, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if maxResvLinkBandwidth is not present
      • getUnreservedBandwidth

        @Nullable Map<UnreservedBandwidthKey,​UnreservedBandwidth> getUnreservedBandwidth()
        Return unreservedBandwidth, or null if it is not present.
             
                 Unreserved bandwidth for 0-7 priority levels. Units in bytes per second
             
         
        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.
      • getTeDefaultMetric

        org.opendaylight.yangtools.yang.common.Uint32 getTeDefaultMetric()
        Return teDefaultMetric, or null if it is not present.
             
                 Traffic Engineering Metric
             
         
        Returns:
        Uint32 teDefaultMetric, or null if it is not present.
      • requireTeDefaultMetric

        default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requireTeDefaultMetric()
        Return teDefaultMetric, guaranteed to be non-null.
             
                 Traffic Engineering Metric
             
         
        Returns:
        Uint32 teDefaultMetric, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if teDefaultMetric is not present
      • getSrlg

        Srlg getSrlg()
        Return srlg, or null if it is not present.
             
                 Shared Risk Link Group Attributes
             
         
        Returns:
        Srlg srlg, or null if it is not present.