Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.message.rev200120

Interface Peer

All Superinterfaces:
org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject
All Known Subinterfaces:
Peer, PeerHeader
@Generated("mdsal-binding-generator") public interface Peer extends org.opendaylight.yangtools.yang.binding.DataObject

This class represents the following YANG schema fragment defined in module bmp-message 

 grouping peer {
   leaf type {
     type peer-type;
   }
   leaf peer-distinguisher {
     type union {
       type bgp-t:route-distinguisher;
       type binary {
         length 8;
       }
     }
   }
   leaf address {
     type inet:ip-address-no-zone;
   }
   leaf as {
     type inet:as-number;
   }
   leaf bgp-id {
     type inet:ipv4-address-no-zone;
   }
 }

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static final class 
    Peer.PeerDistinguisher
    This class represents the following YANG schema fragment defined in module bmp-message

  • 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
    org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone
    getAddress()
    Return address, or null if it is not present.
    org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber
    getAs()
    Return as, or null if it is not present.
    org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone
    getBgpId()
    Return bgpId, or null if it is not present.
    Peer.PeerDistinguisher
    getPeerDistinguisher()
    Return peerDistinguisher, or null if it is not present.
    PeerType
    getType()
    Return type, or null if it is not present.
    Class<? extends Peer>
    implementedInterface()
     
    default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone
    requireAddress()
    Return address, guaranteed to be non-null.
    default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber
    requireAs()
    Return as, guaranteed to be non-null.
    default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone
    requireBgpId()
    Return bgpId, guaranteed to be non-null.
    default @NonNull Peer.PeerDistinguisher
    requirePeerDistinguisher()
    Return peerDistinguisher, guaranteed to be non-null.
    default @NonNull PeerType
    requireType()
    Return type, guaranteed to be non-null.

  • 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

      Class<? extends Peer> 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

    • getType

      PeerType getType()
      Return type, or null if it is not present.
      Returns:
      PeerType type, or null if it is not present.

    • requireType

      default @NonNull PeerType requireType()
      Return type, guaranteed to be non-null.
      Returns:
      PeerType type, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if type is not present

    • getPeerDistinguisher

      Peer.PeerDistinguisher getPeerDistinguisher()
      Return peerDistinguisher, or null if it is not present. 
           
         This field is present to distinguish peers that belong to one address domain
         from the other.
      Returns:
      PeerDistinguisher peerDistinguisher, or null if it is not present.

    • requirePeerDistinguisher

      default @NonNull Peer.PeerDistinguisher requirePeerDistinguisher()
      Return peerDistinguisher, guaranteed to be non-null. 
           
         This field is present to distinguish peers that belong to one address domain
         from the other.
      Returns:
      PeerDistinguisher peerDistinguisher, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if peerDistinguisher is not present

    • getAddress

      org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone getAddress()
      Return address, or null if it is not present. 
           
         The remote IP address associated with the TCP session over which the
         encapsulated PDU was received. It is 4 bytes long if an IPv4 address is carried
         in this field (with most significant bytes zero filled) and 16 bytes long if an
         IPv6 address is carried in this field.
      Returns:
      IpAddressNoZone address, or null if it is not present.

    • requireAddress

      default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone requireAddress()
      Return address, guaranteed to be non-null. 
           
         The remote IP address associated with the TCP session over which the
         encapsulated PDU was received. It is 4 bytes long if an IPv4 address is carried
         in this field (with most significant bytes zero filled) and 16 bytes long if an
         IPv6 address is carried in this field.
      Returns:
      IpAddressNoZone address, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if address is not present

    • getAs

      org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber getAs()
      Return as, or null if it is not present. 
           
         The Autonomous System number of the peer from which the encapsulated PDU was
         received. If a 16 bit AS number is stored in this field [RFC4893], it should be
         padded with zeroes in the most significant bits.
      Returns:
      AsNumber as, or null if it is not present.

    • requireAs

      default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber requireAs()
      Return as, guaranteed to be non-null. 
           
         The Autonomous System number of the peer from which the encapsulated PDU was
         received. If a 16 bit AS number is stored in this field [RFC4893], it should be
         padded with zeroes in the most significant bits.
      Returns:
      AsNumber as, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if as is not present

    • getBgpId

      org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone getBgpId()
      Return bgpId, or null if it is not present. 
           
         The BGP Identifier of the peer from which the encapsulated PDU was received.
      Returns:
      Ipv4AddressNoZone bgpId, or null if it is not present.

    • requireBgpId

      default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone requireBgpId()
      Return bgpId, guaranteed to be non-null. 
           
         The BGP Identifier of the peer from which the encapsulated PDU was received.
      Returns:
      Ipv4AddressNoZone bgpId, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if bgpId is not present