Package org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.rev150712.routers.attributes.routers

Interface Router

  • All Superinterfaces:
    AdminAttributes, org.opendaylight.yangtools.yang.binding.Augmentable<Router>, BaseAttributes, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<Routers>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, IdAttributes, org.opendaylight.yangtools.yang.binding.Identifiable<RouterKey>, L3Attributes
    @Generated("mdsal-binding-generator")
public interface Router
extends org.opendaylight.yangtools.yang.binding.ChildOf<Routers>, org.opendaylight.yangtools.yang.binding.Augmentable<Router>, BaseAttributes, AdminAttributes, L3Attributes, org.opendaylight.yangtools.yang.binding.Identifiable<RouterKey>
    A logical entity for forwarding packets across internal subnets and NATting on external networks through an appropriate external gateway.

    This class represents the following YANG schema fragment defined in module neutron-L3 

     list router {
   key uuid;
   uses attrs:base-attributes;
   uses attrs:admin-attributes;
   uses L3-attributes;
   container external_gateway_info {
     leaf external-network-id {
       type yang:uuid;
     }
     leaf enable-snat {
       type boolean;
       default true;
     }
     list external-fixed-ips {
       key "subnet-id ip-address";
       leaf subnet-id {
         type yang:uuid;
       }
       leaf ip-address {
         type inet:ip-address;
       }
     }
   }
 }
    The schema path to identify an instance is neutron-L3/routers-attributes/routers/router

    To create instances of this class use RouterBuilder.

    See Also:
    RouterBuilder, RouterKey

    • Field Detail

      • QNAME

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

    • Method Detail

      • bindingHashCode

        static int bindingHashCode​(@NonNull Router 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:
        NullPointerException - if obj is null

      • bindingEquals

        static boolean bindingEquals​(@NonNull Router thisObj,
                             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:
        NullPointerException - if thisObj is null

      • bindingToString

        static String bindingToString​(@NonNull Router 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:
        NullPointerException - if obj is null

      • key

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

      • getExternalGatewayInfo

        ExternalGatewayInfo getExternalGatewayInfo()
        Return externalGatewayInfo, or null if it is not present.
        Returns:
        ExternalGatewayInfo externalGatewayInfo, or null if it is not present.