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

Interface ExternalGatewayInfo

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

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

     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/external_gateway_info

    To create instances of this class use ExternalGatewayInfoBuilder.

    See Also:
    ExternalGatewayInfoBuilder

    • Field Detail

      • QNAME

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

    • Method Detail

      • implementedInterface

        default Class<ExternalGatewayInfo> 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 ExternalGatewayInfo 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 ExternalGatewayInfo 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 ExternalGatewayInfo 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

      • 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. 
             
         The network_id, for the external gateways. If this is empty, then this network
         does not have external access
        Returns:
        Uuid externalNetworkId, or null if it is not present.

      • requireExternalNetworkId

        default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid requireExternalNetworkId()
        Return externalNetworkId, guaranteed to be non-null. 
             
         The network_id, for the external gateways. If this is empty, then this network
         does not have external access
        Returns:
        Uuid externalNetworkId, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if externalNetworkId is not present

      • getEnableSnat

        Boolean getEnableSnat()
        Return enableSnat, or null if it is not present. 
             
         If true, it indicates that the router is performing snat on external access
        Returns:
        Boolean enableSnat, or null if it is not present.

      • requireEnableSnat

        default @NonNull Boolean requireEnableSnat()
        Return enableSnat, guaranteed to be non-null. 
             
         If true, it indicates that the router is performing snat on external access
        Returns:
        Boolean enableSnat, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if enableSnat is not present

      • getExternalFixedIps

        @Nullable Map<ExternalFixedIpsKey,​ExternalFixedIps> getExternalFixedIps()
        Return externalFixedIps, or null if it is not present. 
             
         external fixed IPs for this router
        Returns:
        Map<ExternalFixedIpsKey, ExternalFixedIps> externalFixedIps, or null if it is not present.

      • nonnullExternalFixedIps

        default @NonNull Map<ExternalFixedIpsKey,​ExternalFixedIps> nonnullExternalFixedIps()
        Return externalFixedIps, or an empty list if it is not present.
        Returns:
        Map<ExternalFixedIpsKey, ExternalFixedIps> externalFixedIps, or an empty list if it is not present.