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

Interface PeerGroup

All Superinterfaces:
ApplyPolicyGroup, org.opendaylight.yangtools.yang.binding.Augmentable<PeerGroup>, BgpGracefulRestart, BgpNeighborGroup, org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<BgpPeerGroup>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.KeyAware<PeerGroupKey>
@Generated("mdsal-binding-generator") public interface PeerGroup extends org.opendaylight.yangtools.yang.binding.ChildOf<BgpPeerGroup>, org.opendaylight.yangtools.yang.binding.Augmentable<PeerGroup>, BgpNeighborGroup, org.opendaylight.yangtools.yang.binding.KeyAware<PeerGroupKey>
List of BGP peer-groups configured on the local system - uniquely identified by peer-group name

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

 list peer-group {
   key peer-group-name;
   leaf peer-group-name {
     type string;
   }
   uses bgp-neighbor-group;
 }

To create instances of this class use PeerGroupBuilder.

See Also:

  • 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<PeerGroup> implementedInterface()
      Specified by:
      implementedInterface in interface ApplyPolicyGroup
      Specified by:
      implementedInterface in interface BgpGracefulRestart
      Specified by:
      implementedInterface in interface BgpNeighborGroup
      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 PeerGroup 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 PeerGroup 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 PeerGroup 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

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

    • getPeerGroupName

      String getPeerGroupName()
      Return peerGroupName, or null if it is not present. 
           
         Reference to the name of the BGP peer-group used as a key in the peer-group list
      Returns:
      String peerGroupName, or null if it is not present.

    • requirePeerGroupName

      default @NonNull String requirePeerGroupName()
      Return peerGroupName, guaranteed to be non-null. 
           
         Reference to the name of the BGP peer-group used as a key in the peer-group list
      Returns:
      String peerGroupName, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if peerGroupName is not present