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

Interface Bgp

All Superinterfaces:
org.opendaylight.yangtools.yang.binding.Augmentable<Bgp>, org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<BgpTop>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject
@Generated("mdsal-binding-generator") public interface Bgp extends org.opendaylight.yangtools.yang.binding.ChildOf<BgpTop>, org.opendaylight.yangtools.yang.binding.Augmentable<Bgp>
Top-level configuration and state for the BGP router

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

 container bgp {
   presence "Container for BGP protocol hierarchy";
   container global {
     uses bgp-global-base;
     uses rpol:apply-policy-group;
   }
   container neighbors {
     uses bgp-neighbors;
   }
   container peer-groups {
     uses bgp-peer-group;
   }
 }

To create instances of this class use BgpBuilder.

See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final @NonNull org.opendaylight.yangtools.yang.common.QName
    QNAME
    YANG identifier of the statement represented by this class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static boolean
    bindingEquals(@NonNull Bgp thisObj, Object obj)
    Default implementation of Object.equals(Object) contract for this interface.
    static int
    bindingHashCode(@NonNull Bgp obj)
    Default implementation of Object.hashCode() contract for this interface.
    static String
    bindingToString(@NonNull Bgp obj)
    Default implementation of Object.toString() contract for this interface.
    Global
    getGlobal()
    Return global, or null if it is not present.
    Neighbors
    getNeighbors()
    Return neighbors, or null if it is not present.
    PeerGroups
    getPeerGroups()
    Return peerGroups, or null if it is not present.
    default Class<Bgp>
    implementedInterface()
     
    @NonNull Global
    nonnullGlobal()
    Return global, or an empty instance if it is not present.
    @NonNull Neighbors
    nonnullNeighbors()
    Return neighbors, or an empty instance if it is not present.
    @NonNull PeerGroups
    nonnullPeerGroups()
    Return peerGroups, or an empty instance if it is not present.

    Methods inherited from interface org.opendaylight.yangtools.yang.binding.Augmentable

    augmentation, augmentationOrElseThrow, augmentationOrElseThrow, augmentations

  • Field Details

    • QNAME

      static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME
      YANG identifier of the statement represented by this class.

  • Method Details

    • implementedInterface

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

    • bindingHashCode

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

    • getGlobal

      Global getGlobal()
      Return global, or null if it is not present. 
           
         Global configuration for the BGP router
      Returns:
      Global global, or null if it is not present.

    • nonnullGlobal

      @NonNull Global nonnullGlobal()
      Return global, or an empty instance if it is not present.
      Returns:
      Global global, or an empty instance if it is not present.

    • getNeighbors

      Neighbors getNeighbors()
      Return neighbors, or null if it is not present. 
           
         Configuration for BGP neighbors
      Returns:
      Neighbors neighbors, or null if it is not present.

    • nonnullNeighbors

      @NonNull Neighbors nonnullNeighbors()
      Return neighbors, or an empty instance if it is not present.
      Returns:
      Neighbors neighbors, or an empty instance if it is not present.

    • getPeerGroups

      PeerGroups getPeerGroups()
      Return peerGroups, or null if it is not present. 
           
         Configuration for BGP peer-groups
      Returns:
      PeerGroups peerGroups, or null if it is not present.

    • nonnullPeerGroups

      @NonNull PeerGroups nonnullPeerGroups()
      Return peerGroups, or an empty instance if it is not present.
      Returns:
      PeerGroups peerGroups, or an empty instance if it is not present.