Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.overlay.rev150105

Interface IpPortLocator

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject
    All Known Subinterfaces:
    IpPortLocatorEntry, TunnelDestParameters, TunnelSourceParameters
    @Generated("mdsal-binding-generator")
public interface IpPortLocator
extends org.opendaylight.yangtools.yang.binding.DataObject
    Data plane-locator: IP address and L4 port

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

     grouping ip-port-locator {
   leaf ip {
     type inet:ip-address;
   }
   leaf port {
     type inet:port-number;
   }
 }

    • Field Summary

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

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getIp()
      Return ip, or null if it is not present.
      org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber getPort()
      Return port, or null if it is not present.
      Class<? extends IpPortLocator> implementedInterface()  
      default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress requireIp()
      Return ip, guaranteed to be non-null.
      default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber requirePort()
      Return port, guaranteed to be non-null.

    • Field Detail

      • QNAME

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

    • Method Detail

      • implementedInterface

        Class<? extends IpPortLocator> implementedInterface()
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataContainer
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject

      • getIp

        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getIp()
        Return ip, or null if it is not present. 
             
         Data-plane IP address
        Returns:
        IpAddress ip, or null if it is not present.

      • requireIp

        default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress requireIp()
        Return ip, guaranteed to be non-null. 
             
         Data-plane IP address
        Returns:
        IpAddress ip, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if ip is not present

      • getPort

        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber getPort()
        Return port, or null if it is not present. 
             
         Data-plane port number
        Returns:
        PortNumber port, or null if it is not present.

      • requirePort

        default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber requirePort()
        Return port, guaranteed to be non-null. 
             
         Data-plane port number
        Returns:
        PortNumber port, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if port is not present