Package org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ext.routers

Interface Routers

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<Routers>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<ExtRouters>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<RoutersKey>
    @Generated("mdsal-binding-generator")
public interface Routers
extends org.opendaylight.yangtools.yang.binding.ChildOf<ExtRouters>, org.opendaylight.yangtools.yang.binding.Augmentable<Routers>, org.opendaylight.yangtools.yang.binding.Identifiable<RoutersKey>

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

     list routers {
   key router-name;
   leaf router-name {
     type string;
   }
   leaf network-id {
     type yang:uuid;
   }
   leaf enable-snat {
     type boolean;
   }
   list external-ips {
     key "subnet-id ip-address";
     leaf subnet-id {
       type yang:uuid;
     }
     leaf ip-address {
       type string;
     }
   }
   leaf-list subnet-ids {
     type yang:uuid;
   }
   leaf ext_gw_mac_address {
     type string;
   }
 }
    The schema path to identify an instance is odl-nat/ext-routers/routers

    To create instances of this class use RoutersBuilder.

    See Also:
    RoutersBuilder, RoutersKey

    • Field Summary

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

    • Method Summary

      All Methods Static Methods Instance Methods Abstract Methods Default Methods Deprecated Methods 
      Modifier and Type Method Description
      static boolean bindingEquals​(@NonNull Routers thisObj, java.lang.Object obj)
      Default implementation of Object.equals(Object) contract for this interface.
      static int bindingHashCode​(@NonNull Routers obj)
      Default implementation of Object.hashCode() contract for this interface.
      static java.lang.String bindingToString​(@NonNull Routers obj)
      Default implementation of Object.toString() contract for this interface.
      java.lang.Boolean getEnableSnat()
      Return enableSnat, or null if it is not present.
      @Nullable java.util.Map<ExternalIpsKey,​ExternalIps> getExternalIps()
      Return externalIps, or null if it is not present.
      java.lang.String getExtGwMacAddress()
      Return extGwMacAddress, or null if it is not present.
      org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getNetworkId()
      Return networkId, or null if it is not present.
      java.lang.String getRouterName()
      Return routerName, or null if it is not present.
      @Nullable java.util.List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid> getSubnetIds()
      Return subnetIds, or null if it is not present.
      default java.lang.Class<Routers> implementedInterface()  
      default java.lang.Boolean isEnableSnat()
      Deprecated, for removal: This API element is subject to removal in a future version.
      RoutersKey key()  
      default @NonNull java.util.Map<ExternalIpsKey,​ExternalIps> nonnullExternalIps()
      Return externalIps, or an empty list if it is not present.

      • Methods inherited from interface org.opendaylight.yangtools.yang.binding.Augmentable

        augmentation, augmentations

    • Field Detail

      • QNAME

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

    • Method Detail

      • implementedInterface

        default java.lang.Class<Routers> 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 Routers 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 Routers 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 Routers 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

      • getRouterName

        java.lang.String getRouterName()
        Return routerName, or null if it is not present.
        Returns:
        java.lang.String routerName, or null if it is not present.

      • getNetworkId

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

      • getEnableSnat

        java.lang.Boolean getEnableSnat()
        Return enableSnat, or null if it is not present.
        Returns:
        java.lang.Boolean enableSnat, or null if it is not present.

      • isEnableSnat

        @Deprecated(forRemoval=true)
default java.lang.Boolean isEnableSnat()
        Deprecated, for removal: This API element is subject to removal in a future version.

      • getExternalIps

        @Nullable java.util.Map<ExternalIpsKey,​ExternalIps> getExternalIps()
        Return externalIps, or null if it is not present.
        Returns:
        java.util.Map externalIps, or null if it is not present.

      • nonnullExternalIps

        default @NonNull java.util.Map<ExternalIpsKey,​ExternalIps> nonnullExternalIps()
        Return externalIps, or an empty list if it is not present.
        Returns:
        java.util.Map externalIps, or an empty list if it is not present.

      • getSubnetIds

        @Nullable java.util.List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid> getSubnetIds()
        Return subnetIds, or null if it is not present.
        Returns:
        java.util.List subnetIds, or null if it is not present.

      • getExtGwMacAddress

        java.lang.String getExtGwMacAddress()
        Return extGwMacAddress, or null if it is not present.
        Returns:
        java.lang.String extGwMacAddress, or null if it is not present.

      • key

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