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

Interface PeerUp

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:
PeerSession, PeerUpNotification
@Generated("mdsal-binding-generator") public interface PeerUp extends org.opendaylight.yangtools.yang.binding.DataObject

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

 grouping peer-up {
   leaf local-address {
     type inet:ip-address-no-zone;
   }
   leaf local-port {
     type inet:port-number;
   }
   leaf remote-port {
     type inet:port-number;
   }
   container sent-open {
     uses open-msg;
   }
   container received-open {
     uses open-msg;
   }
   container information {
     uses string-informations;
   }
 }

  • 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
    Information
    getInformation()
    Return information, or null if it is not present.
    org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone
    getLocalAddress()
    Return localAddress, or null if it is not present.
    org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber
    getLocalPort()
    Return localPort, or null if it is not present.
    ReceivedOpen
    getReceivedOpen()
    Return receivedOpen, or null if it is not present.
    org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber
    getRemotePort()
    Return remotePort, or null if it is not present.
    SentOpen
    getSentOpen()
    Return sentOpen, or null if it is not present.
    Class<? extends PeerUp>
    implementedInterface()
     
    @NonNull Information
    nonnullInformation()
    Return information, or an empty instance if it is not present.
    @NonNull ReceivedOpen
    nonnullReceivedOpen()
    Return receivedOpen, or an empty instance if it is not present.
    @NonNull SentOpen
    nonnullSentOpen()
    Return sentOpen, or an empty instance if it is not present.
    default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone
    requireLocalAddress()
    Return localAddress, guaranteed to be non-null.
    default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber
    requireLocalPort()
    Return localPort, guaranteed to be non-null.
    default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber
    requireRemotePort()
    Return remotePort, 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 PeerUp> 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

    • getLocalAddress

      org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone getLocalAddress()
      Return localAddress, or null if it is not present. 
           
         The local IP address associated with the peering TCP session.
      Returns:
      IpAddressNoZone localAddress, or null if it is not present.

    • requireLocalAddress

      default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone requireLocalAddress()
      Return localAddress, guaranteed to be non-null. 
           
         The local IP address associated with the peering TCP session.
      Returns:
      IpAddressNoZone localAddress, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if localAddress is not present

    • getLocalPort

      org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber getLocalPort()
      Return localPort, or null if it is not present. 
           
         The local port number associated with the peering TCP session.
      Returns:
      PortNumber localPort, or null if it is not present.

    • requireLocalPort

      default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber requireLocalPort()
      Return localPort, guaranteed to be non-null. 
           
         The local port number associated with the peering TCP session.
      Returns:
      PortNumber localPort, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if localPort is not present

    • getRemotePort

      org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber getRemotePort()
      Return remotePort, or null if it is not present. 
           
         The remote port number associated with the peering TCP session.
      Returns:
      PortNumber remotePort, or null if it is not present.

    • requireRemotePort

      default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber requireRemotePort()
      Return remotePort, guaranteed to be non-null. 
           
         The remote port number associated with the peering TCP session.
      Returns:
      PortNumber remotePort, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if remotePort is not present

    • getSentOpen

      SentOpen getSentOpen()
      Return sentOpen, or null if it is not present. 
           
         The full OPEN message transmitted by the monitored router to its peer.
      Returns:
      SentOpen sentOpen, or null if it is not present.

    • nonnullSentOpen

      @NonNull SentOpen nonnullSentOpen()
      Return sentOpen, or an empty instance if it is not present.
      Returns:
      SentOpen sentOpen, or an empty instance if it is not present.

    • getReceivedOpen

      ReceivedOpen getReceivedOpen()
      Return receivedOpen, or null if it is not present. 
           
         The full OPEN message received by the monitored router from its peer.
      Returns:
      ReceivedOpen receivedOpen, or null if it is not present.

    • nonnullReceivedOpen

      @NonNull ReceivedOpen nonnullReceivedOpen()
      Return receivedOpen, or an empty instance if it is not present.
      Returns:
      ReceivedOpen receivedOpen, or an empty instance if it is not present.

    • getInformation

      Information getInformation()
      Return information, or null if it is not present.
      Returns:
      Information information, or null if it is not present.

    • nonnullInformation

      @NonNull Information nonnullInformation()
      Return information, or an empty instance if it is not present.
      Returns:
      Information information, or an empty instance if it is not present.