Interface RouterPorts

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<RouterPorts>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<FloatingIpInfo>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<RouterPortsKey>

    @Generated("mdsal-binding-generator")
    public interface RouterPorts
    extends org.opendaylight.yangtools.yang.binding.ChildOf<FloatingIpInfo>, org.opendaylight.yangtools.yang.binding.Augmentable<RouterPorts>, org.opendaylight.yangtools.yang.binding.Identifiable<RouterPortsKey>

    This class represents the following YANG schema fragment defined in module odl-nat

     list router-ports {
       key router-id;
       leaf router-id {
         type string;
       }
       leaf external-network-id {
         type yang:uuid;
       }
       list ports {
         key port-name;
         leaf port-name {
           type string;
         }
         list internal-to-external-port-map {
           key internal-ip;
           leaf internal-ip {
             type string;
           }
           leaf external-ip {
             type string;
           }
           leaf external-id {
             type yang:uuid;
           }
           leaf label {
             type uint32;
             config false;
           }
         }
       }
     }
     
    The schema path to identify an instance is odl-nat/floating-ip-info/router-ports

    To create instances of this class use RouterPortsBuilder.

    See Also:
    RouterPortsBuilder, RouterPortsKey
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static @NonNull org.opendaylight.yangtools.yang.common.QName QNAME  
    • Field Detail

      • QNAME

        static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME
    • Method Detail

      • implementedInterface

        default java.lang.Class<RouterPorts> implementedInterface()
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataContainer
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject
      • bindingHashCode

        static int bindingHashCode​(@NonNull RouterPorts 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:
        java.lang.NullPointerException - if obj is null
      • bindingEquals

        static boolean bindingEquals​(@NonNull RouterPorts thisObj,
                                     java.lang.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:
        java.lang.NullPointerException - if thisObj is null
      • bindingToString

        static java.lang.String bindingToString​(@NonNull RouterPorts 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:
        java.lang.NullPointerException - if obj is null
      • getRouterId

        java.lang.String getRouterId()
        Return routerId, or null if it is not present.
        Returns:
        java.lang.String routerId, or null if it is not present.
      • getExternalNetworkId

        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getExternalNetworkId()
        Return externalNetworkId, or null if it is not present.
        Returns:
        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid externalNetworkId, or null if it is not present.
      • getPorts

        @Nullable java.util.Map<PortsKey,​Ports> getPorts()
        Return ports, or null if it is not present.
        Returns:
        java.util.Map ports, or null if it is not present.
      • nonnullPorts

        default @NonNull java.util.Map<PortsKey,​Ports> nonnullPorts()
        Return ports, or an empty list if it is not present.
        Returns:
        java.util.Map ports, or an empty list if it is not present.