Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.bgp.rib.rib

Interface Peer

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<Peer>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<Rib>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<PeerKey>
    @Generated("mdsal-binding-generator")
public interface Peer
extends org.opendaylight.yangtools.yang.binding.ChildOf<Rib>, org.opendaylight.yangtools.yang.binding.Augmentable<Peer>, org.opendaylight.yangtools.yang.binding.Identifiable<PeerKey>

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

     list peer {
   key peer-id;
   leaf peer-id {
     type peer-id;
   }
   leaf peer-role {
     type peer-role;
   }
   list supported-tables {
     key "afi safi";
     uses bgp-mp:bgp-add-path-table-type;
   }
   container adj-rib-in {
     uses rib {
       augment tables/attributes {
         leaf llgr-stale {
           type empty;
         }
       }
     }
   }
   container effective-rib-in {
     uses rib;
   }
   container adj-rib-out {
     uses rib;
   }
 }
    The schema path to identify an instance is bgp-ribbgp-ribribpeer

    To create instances of this class use PeerBuilder.

    See Also:
    PeerBuilder, PeerKey

    • Field Detail

      • QNAME

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

    • Method Detail

      • implementedInterface

        default Class<Peer> implementedInterface()
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataContainer
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject

      • bindingHashCode

        static int bindingHashCode​(@NonNull Peer obj)
        Default implementation of Object.hashCode() contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent hashing results across all implementations.
        Parameters:
        obj - Object for which to generate hashCode() result.
        Returns:
        Hash code value of data modeled by this interface.
        Throws:
        NullPointerException - if obj is null

      • bindingEquals

        static boolean bindingEquals​(@NonNull Peer thisObj,
                             Object obj)
        Default implementation of Object.equals(Object) contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent equality results across all implementations.
        Parameters:
        thisObj - Object acting as the receiver of equals invocation
        obj - Object acting as argument to equals invocation
        Returns:
        True if thisObj and obj are considered equal
        Throws:
        NullPointerException - if thisObj is null

      • bindingToString

        static String bindingToString​(@NonNull Peer obj)
        Default implementation of Object.toString() contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent string representations across all implementations.
        Parameters:
        obj - Object for which to generate toString() result.
        Returns:
        String value of data modeled by this interface.
        Throws:
        NullPointerException - if obj is null

      • key

        PeerKey key()
        Specified by:
        key in interface org.opendaylight.yangtools.yang.binding.Identifiable<PeerKey>

      • getPeerId

        PeerId getPeerId()
        Return peerId, or null if it is not present.
        Returns:
        PeerId peerId, or null if it is not present.

      • requirePeerId

        default @NonNull PeerId requirePeerId()
        Return peerId, guaranteed to be non-null.
        Returns:
        PeerId peerId, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if peerId is not present

      • getPeerRole

        PeerRole getPeerRole()
        Return peerRole, or null if it is not present.
        Returns:
        PeerRole peerRole, or null if it is not present.

      • requirePeerRole

        default @NonNull PeerRole requirePeerRole()
        Return peerRole, guaranteed to be non-null.
        Returns:
        PeerRole peerRole, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if peerRole is not present

      • getSupportedTables

        @Nullable Map<SupportedTablesKey,​SupportedTables> getSupportedTables()
        Return supportedTables, or null if it is not present.
        Returns:
        Map<SupportedTablesKey, SupportedTables> supportedTables, or null if it is not present.

      • nonnullSupportedTables

        default @NonNull Map<SupportedTablesKey,​SupportedTables> nonnullSupportedTables()
        Return supportedTables, or an empty list if it is not present.
        Returns:
        Map<SupportedTablesKey, SupportedTables> supportedTables, or an empty list if it is not present.

      • getAdjRibIn

        AdjRibIn getAdjRibIn()
        Return adjRibIn, or null if it is not present. 
             
         Routes as we have received them from the peer.
        Returns:
        AdjRibIn adjRibIn, or null if it is not present.

      • getEffectiveRibIn

        EffectiveRibIn getEffectiveRibIn()
        Return effectiveRibIn, or null if it is not present. 
             
         Routes as processed by inbound policy.
        Returns:
        EffectiveRibIn effectiveRibIn, or null if it is not present.

      • getAdjRibOut

        AdjRibOut getAdjRibOut()
        Return adjRibOut, or null if it is not present.
        Returns:
        AdjRibOut adjRibOut, or null if it is not present.