Interface Neighbors

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<Neighbors>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<NeighborsContainer>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<NeighborsKey>, TcpSecurityOptionGrouping

    @Generated("mdsal-binding-generator")
    public interface Neighbors
    extends org.opendaylight.yangtools.yang.binding.ChildOf<NeighborsContainer>, org.opendaylight.yangtools.yang.binding.Augmentable<Neighbors>, TcpSecurityOptionGrouping, org.opendaylight.yangtools.yang.binding.Identifiable<NeighborsKey>

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

     list neighbors {
       key address;
       leaf address {
         type inet:ipv4-address;
       }
       leaf remote-as {
         type uint32;
       }
       uses tcp-security-option-grouping;
       container ebgp-multihop {
         leaf nhops {
           type uint32;
         }
         leaf peer-ip {
           type leafref {
             path /ericsson-bgp:bgp/neighborsContainer/neighbors/address;
           }
         }
       }
       container update-source {
         leaf source-ip {
           type inet:ipv4-address;
         }
         leaf peer-ip {
           type leafref {
             path /ericsson-bgp:bgp/neighborsContainer/neighbors/address;
           }
         }
       }
       list address-families {
         key "afi safi";
         leaf afi {
           type uint32;
         }
         leaf safi {
           type uint32;
         }
         leaf peer-ip {
           type leafref {
             path /ericsson-bgp:bgp/neighborsContainer/neighbors/address;
           }
         }
       }
     }
     
    The schema path to identify an instance is ebgp/bgp/neighborsContainer/neighbors

    To create instances of this class use NeighborsBuilder.

    See Also:
    NeighborsBuilder, NeighborsKey
    • Field Detail

      • QNAME

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

      • implementedInterface

        default java.lang.Class<Neighbors> implementedInterface()
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataContainer
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject
        Specified by:
        implementedInterface in interface TcpSecurityOptionGrouping
      • bindingHashCode

        static int bindingHashCode​(@NonNull Neighbors 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:
        java.lang.NullPointerException - if obj is null
      • bindingEquals

        static boolean bindingEquals​(@NonNull Neighbors thisObj,
                                     java.lang.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:
        java.lang.NullPointerException - if thisObj is null
      • bindingToString

        static java.lang.String bindingToString​(@NonNull Neighbors 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:
        java.lang.NullPointerException - if obj is null
      • getAddress

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

        org.opendaylight.yangtools.yang.common.Uint32 getRemoteAs()
        Return remoteAs, or null if it is not present.
        Returns:
        org.opendaylight.yangtools.yang.common.Uint32 remoteAs, or null if it is not present.
      • getEbgpMultihop

        EbgpMultihop getEbgpMultihop()
        Return ebgpMultihop, or null if it is not present.
        Returns:
        org.opendaylight.yang.gen.v1.urn.ericsson.params.xml.ns.yang.ebgp.rev150901.bgp.neighborscontainer.neighbors.EbgpMultihop ebgpMultihop, or null if it is not present.
      • getUpdateSource

        UpdateSource getUpdateSource()
        Return updateSource, or null if it is not present.
        Returns:
        org.opendaylight.yang.gen.v1.urn.ericsson.params.xml.ns.yang.ebgp.rev150901.bgp.neighborscontainer.neighbors.UpdateSource updateSource, or null if it is not present.
      • getAddressFamilies

        @Nullable java.util.Map<AddressFamiliesKey,​AddressFamilies> getAddressFamilies()
        Return addressFamilies, or null if it is not present.
        Returns:
        java.util.Map addressFamilies, or null if it is not present.
      • nonnullAddressFamilies

        default @NonNull java.util.Map<AddressFamiliesKey,​AddressFamilies> nonnullAddressFamilies()
        Return addressFamilies, or an empty list if it is not present.
        Returns:
        java.util.Map addressFamilies, or an empty list if it is not present.
      • key

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