Interface LinkstateAttribute

  • 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;
       }
     }
     
    The schema path to identify an instance is bgp-linkstate/linkstate-attribute
    • Field Detail

      • QNAME

        static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME
    • 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:
        org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev200120.Ipv4RouterIdentifier localIpv4RouterId, or null if it is not present.
      • getLocalIpv6RouterId

        Ipv6RouterIdentifier getLocalIpv6RouterId()
        Return localIpv6RouterId, or null if it is not present.
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev200120.Ipv6RouterIdentifier localIpv6RouterId, or null if it is not present.
      • getRemoteIpv4RouterId

        Ipv4RouterIdentifier getRemoteIpv4RouterId()
        Return remoteIpv4RouterId, or null if it is not present.
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev200120.Ipv4RouterIdentifier remoteIpv4RouterId, or null if it is not present.
      • getRemoteIpv6RouterId

        Ipv6RouterIdentifier getRemoteIpv6RouterId()
        Return remoteIpv6RouterId, or null if it is not present.
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev200120.Ipv6RouterIdentifier remoteIpv6RouterId, or null if it is not present.
      • getMplsProtocol

        MplsProtocolMask getMplsProtocol()
        Return mplsProtocol, or null if it is not present.
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev200120.MplsProtocolMask mplsProtocol, or null if it is not present.
      • getTeMetric

        TeMetric getTeMetric()
        Return teMetric, or null if it is not present.
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.network.concepts.rev131125.TeMetric teMetric, or null if it is not present.
      • getMetric

        Metric getMetric()
        Return metric, or null if it is not present.
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.network.concepts.rev131125.Metric metric, or null if it is not present.
      • getSharedRiskLinkGroups

        @Nullable List<SrlgId> getSharedRiskLinkGroups()
        Return sharedRiskLinkGroups, or null if it is not present.
        Returns:
        java.util.List sharedRiskLinkGroups, or null if it is not present.
      • getLinkName

        String getLinkName()
        Return linkName, or null if it is not present.
        Returns:
        java.lang.String linkName, or null if it is not present.
      • getMaxLinkBandwidth

        Bandwidth getMaxLinkBandwidth()
        Return maxLinkBandwidth, or null if it is not present.
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.network.concepts.rev131125.Bandwidth maxLinkBandwidth, or null if it is not present.
      • getMaxReservableBandwidth

        Bandwidth getMaxReservableBandwidth()
        Return maxReservableBandwidth, or null if it is not present.
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.network.concepts.rev131125.Bandwidth maxReservableBandwidth, or null if it is not present.
      • getUnreservedBandwidth

        @Nullable Map<UnreservedBandwidthKey,​UnreservedBandwidth> getUnreservedBandwidth()
        Return unreservedBandwidth, or null if it is not present.
        Returns:
        java.util.Map 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:
        java.util.Map unreservedBandwidth, or an empty list if it is not present.
      • getLinkProtection

        LinkProtectionType getLinkProtection()
        Return linkProtection, or null if it is not present.
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev200120.LinkProtectionType linkProtection, or null if it is not present.
      • getAdminGroup

        AdministrativeGroup getAdminGroup()
        Return adminGroup, or null if it is not present.
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev200120.AdministrativeGroup adminGroup, or null if it is not present.
      • getSrAdjIds

        @Nullable List<SrAdjIds> getSrAdjIds()
        Return srAdjIds, or null if it is not present.
        Returns:
        java.util.List 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:
        java.util.List 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:
        java.util.List 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:
        java.util.List 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:
        org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev200120.linkstate.attribute.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:
        org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev200120.linkstate.attribute.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:
        java.util.List 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:
        java.util.List 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:
        org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev200120.Delay linkDelay, or null if it is not present.
      • getLinkMinMaxDelay

        LinkMinMaxDelay getLinkMinMaxDelay()
        Return linkMinMaxDelay, or null if it is not present.
             
                 Min/Max Unidirectional Link Delay
             
         
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev200120.linkstate.attribute.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:
        org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev200120.Delay delayVariation, or null if it is not present.
      • getLinkLoss

        Loss getLinkLoss()
        Return linkLoss, or null if it is not present.
             
                 Unidirectional Link Loss
             
         
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev200120.Loss linkLoss, or null if it is not present.
      • getResidualBandwidth

        Bandwidth getResidualBandwidth()
        Return residualBandwidth, or null if it is not present.
             
                 Unidirectional Residual Bandwidth
             
         
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.network.concepts.rev131125.Bandwidth residualBandwidth, or null if it is not present.
      • getAvailableBandwidth

        Bandwidth getAvailableBandwidth()
        Return availableBandwidth, or null if it is not present.
             
                 Unidirectional Available Bandwidth
             
         
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.network.concepts.rev131125.Bandwidth availableBandwidth, or null if it is not present.
      • getUtilizedBandwidth

        Bandwidth getUtilizedBandwidth()
        Return utilizedBandwidth, or null if it is not present.
             
                 Unidirectional Utilized Bandwidth
             
         
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.network.concepts.rev131125.Bandwidth utilizedBandwidth, or null if it is not present.