Interface L3FloatingipAttributes
-
- All Superinterfaces:
org.opendaylight.yangtools.yang.binding.BindingObject
,org.opendaylight.yangtools.yang.binding.DataContainer
,org.opendaylight.yangtools.yang.binding.DataObject
- All Known Subinterfaces:
Floatingip
@Generated("mdsal-binding-generator") public interface L3FloatingipAttributes extends org.opendaylight.yangtools.yang.binding.DataObject
This class represents the following YANG schema fragment defined in module neutron-L3
grouping L3-floatingip-attributes { leaf router-id { type yang:uuid; } leaf port-id { type yang:uuid; } leaf floating-network-id { type yang:uuid; } leaf floating-ip-address { type inet:ip-address; } leaf fixed-ip-address { type inet:ip-address; } leaf status { type string; } }
The schema path to identify an instance is neutron-L3/L3-floatingip-attributes
-
-
Field Summary
Fields Modifier and Type Field Description static @NonNull org.opendaylight.yangtools.yang.common.QName
QNAME
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress
getFixedIpAddress()
Return fixedIpAddress, ornull
if it is not present.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress
getFloatingIpAddress()
Return floatingIpAddress, ornull
if it is not present.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid
getFloatingNetworkId()
Return floatingNetworkId, ornull
if it is not present.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid
getPortId()
Return portId, ornull
if it is not present.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid
getRouterId()
Return routerId, ornull
if it is not present.String
getStatus()
Return status, ornull
if it is not present.Class<? extends L3FloatingipAttributes>
implementedInterface()
default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress
requireFixedIpAddress()
Return fixedIpAddress, guaranteed to be non-null.default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress
requireFloatingIpAddress()
Return floatingIpAddress, guaranteed to be non-null.default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid
requireFloatingNetworkId()
Return floatingNetworkId, guaranteed to be non-null.default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid
requirePortId()
Return portId, guaranteed to be non-null.default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid
requireRouterId()
Return routerId, guaranteed to be non-null.default @NonNull String
requireStatus()
Return status, guaranteed to be non-null.
-
-
-
Method Detail
-
implementedInterface
Class<? extends L3FloatingipAttributes> implementedInterface()
- Specified by:
implementedInterface
in interfaceorg.opendaylight.yangtools.yang.binding.DataContainer
- Specified by:
implementedInterface
in interfaceorg.opendaylight.yangtools.yang.binding.DataObject
-
getRouterId
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getRouterId()
Return routerId, ornull
if it is not present.Contains the Router ID of this floatingip object.
- Returns:
Uuid
routerId, ornull
if it is not present.
-
requireRouterId
default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid requireRouterId()
Return routerId, guaranteed to be non-null.Contains the Router ID of this floatingip object.
- Returns:
Uuid
routerId, guaranteed to be non-null.- Throws:
NoSuchElementException
- if routerId is not present
-
getPortId
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getPortId()
Return portId, ornull
if it is not present.Contains the Port ID of the fixed IP address that will be associated with this object.
- Returns:
Uuid
portId, ornull
if it is not present.
-
requirePortId
default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid requirePortId()
Return portId, guaranteed to be non-null.Contains the Port ID of the fixed IP address that will be associated with this object.
- Returns:
Uuid
portId, guaranteed to be non-null.- Throws:
NoSuchElementException
- if portId is not present
-
getFloatingNetworkId
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getFloatingNetworkId()
Return floatingNetworkId, ornull
if it is not present.The ID of the network associated with the floating IP.
- Returns:
Uuid
floatingNetworkId, ornull
if it is not present.
-
requireFloatingNetworkId
default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid requireFloatingNetworkId()
Return floatingNetworkId, guaranteed to be non-null.The ID of the network associated with the floating IP.
- Returns:
Uuid
floatingNetworkId, guaranteed to be non-null.- Throws:
NoSuchElementException
- if floatingNetworkId is not present
-
getFloatingIpAddress
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getFloatingIpAddress()
Return floatingIpAddress, ornull
if it is not present.The floating IP address.
- Returns:
IpAddress
floatingIpAddress, ornull
if it is not present.
-
requireFloatingIpAddress
default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress requireFloatingIpAddress()
Return floatingIpAddress, guaranteed to be non-null.The floating IP address.
- Returns:
IpAddress
floatingIpAddress, guaranteed to be non-null.- Throws:
NoSuchElementException
- if floatingIpAddress is not present
-
getFixedIpAddress
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getFixedIpAddress()
Return fixedIpAddress, ornull
if it is not present.The fixed IP address associated with the floating IP. If you intend to associate the floating IP with a fixed IP at creation time, then you must indicate the identifier of the internal port(using port-id object). If an internal port has multiple associated IP addresses, the service chooses the first IP unless you explicitly specify the parameter fixed_ip_address to select a specific IP.
- Returns:
IpAddress
fixedIpAddress, ornull
if it is not present.
-
requireFixedIpAddress
default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress requireFixedIpAddress()
Return fixedIpAddress, guaranteed to be non-null.The fixed IP address associated with the floating IP. If you intend to associate the floating IP with a fixed IP at creation time, then you must indicate the identifier of the internal port(using port-id object). If an internal port has multiple associated IP addresses, the service chooses the first IP unless you explicitly specify the parameter fixed_ip_address to select a specific IP.
- Returns:
IpAddress
fixedIpAddress, guaranteed to be non-null.- Throws:
NoSuchElementException
- if fixedIpAddress is not present
-
getStatus
String getStatus()
Return status, ornull
if it is not present.The network status.
- Returns:
String
status, ornull
if it is not present.
-
requireStatus
default @NonNull String requireStatus()
Return status, guaranteed to be non-null.The network status.
- Returns:
String
status, guaranteed to be non-null.- Throws:
NoSuchElementException
- if status is not present
-
-