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/routerTo create instances of this class use
RouterBuilder
.- See Also:
RouterBuilder
,RouterKey
-
-
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 Modifier and Type Method Description static boolean
bindingEquals(@NonNull Router thisObj, Object obj)
Default implementation ofObject.equals(Object)
contract for this interface.static int
bindingHashCode(@NonNull Router obj)
Default implementation ofObject.hashCode()
contract for this interface.static String
bindingToString(@NonNull Router obj)
Default implementation ofObject.toString()
contract for this interface.ExternalGatewayInfo
getExternalGatewayInfo()
Return externalGatewayInfo, ornull
if it is not present.default Class<Router>
implementedInterface()
RouterKey
key()
-
Methods inherited from interface org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.attrs.rev150712.AdminAttributes
getAdminStateUp, getStatus, requireAdminStateUp, requireStatus
-
Methods inherited from interface org.opendaylight.yangtools.yang.binding.Augmentable
augmentation, augmentations
-
Methods inherited from interface org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.attrs.rev150712.BaseAttributes
getName, requireName
-
Methods inherited from interface org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.attrs.rev150712.IdAttributes
getProjectId, getRevisionNumber, getTenantId, getUuid, requireProjectId, requireRevisionNumber, requireTenantId, requireUuid
-
Methods inherited from interface org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.rev150712.L3Attributes
getDistributed, getGatewayPortId, getRouterStatus, getRoutes, nonnullRoutes, requireDistributed, requireGatewayPortId, requireRouterStatus
-
-
-
-
Method Detail
-
implementedInterface
default Class<Router> implementedInterface()
- Specified by:
implementedInterface
in interfaceAdminAttributes
- Specified by:
implementedInterface
in interfaceBaseAttributes
- Specified by:
implementedInterface
in interfaceorg.opendaylight.yangtools.yang.binding.DataContainer
- Specified by:
implementedInterface
in interfaceorg.opendaylight.yangtools.yang.binding.DataObject
- Specified by:
implementedInterface
in interfaceIdAttributes
- Specified by:
implementedInterface
in interfaceL3Attributes
-
bindingHashCode
static int bindingHashCode(@NonNull Router obj)
Default implementation ofObject.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
- ifobj
is null
-
bindingEquals
static boolean bindingEquals(@NonNull Router thisObj, Object obj)
Default implementation ofObject.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 invocationobj
- Object acting as argument to equals invocation- Returns:
- True if thisObj and obj are considered equal
- Throws:
NullPointerException
- ifthisObj
is null
-
bindingToString
static String bindingToString(@NonNull Router obj)
Default implementation ofObject.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
- ifobj
is null
-
key
RouterKey key()
- Specified by:
key
in interfaceorg.opendaylight.yangtools.yang.binding.Identifiable<RouterKey>
-
getExternalGatewayInfo
ExternalGatewayInfo getExternalGatewayInfo()
Return externalGatewayInfo, ornull
if it is not present.- Returns:
ExternalGatewayInfo
externalGatewayInfo, ornull
if it is not present.
-
-