Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbors

Interface Neighbor

  • All Superinterfaces:
    ApplyPolicyGroup, org.opendaylight.yangtools.yang.binding.Augmentable<Neighbor>, BgpGracefulRestart, BgpNeighborGroup, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<BgpNeighbors>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<NeighborKey>
    @Generated("mdsal-binding-generator")
public interface Neighbor
extends org.opendaylight.yangtools.yang.binding.ChildOf<BgpNeighbors>, org.opendaylight.yangtools.yang.binding.Augmentable<Neighbor>, BgpNeighborGroup, org.opendaylight.yangtools.yang.binding.Identifiable<NeighborKey>
    List of BGP neighbors configured on the local system, uniquely identified by peer IPv[46] address

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

     list neighbor {
   key neighbor-address;
   leaf neighbor-address {
     type inet:ip-address;
   }
   uses bgp-neighbor-group;
 }
    The schema path to identify an instance is openconfig-bgpbgp-neighborsneighbor

    To create instances of this class use NeighborBuilder.

    See Also:
    NeighborBuilder, NeighborKey

    • Field Detail

      • QNAME

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

    • Method Detail

      • bindingHashCode

        static int bindingHashCode​(@NonNull Neighbor 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 Neighbor 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 Neighbor 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

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

      • getNeighborAddress

        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getNeighborAddress()
        Return neighborAddress, or null if it is not present. 
             
         Reference to the address of the BGP neighbor used as a key in the neighbor list
        Returns:
        IpAddress neighborAddress, or null if it is not present.

      • requireNeighborAddress

        default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress requireNeighborAddress()
        Return neighborAddress, guaranteed to be non-null. 
             
         Reference to the address of the BGP neighbor used as a key in the neighbor list
        Returns:
        IpAddress neighborAddress, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if neighborAddress is not present