Package org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.dpn.endpoints.dpn.teps.info
Interface TunnelEndPoints
-
- All Superinterfaces:
org.opendaylight.yangtools.yang.binding.Augmentable<TunnelEndPoints>
,org.opendaylight.yangtools.yang.binding.BindingObject
,org.opendaylight.yangtools.yang.binding.ChildOf<DPNTEPsInfo>
,org.opendaylight.yangtools.yang.binding.DataContainer
,org.opendaylight.yangtools.yang.binding.DataObject
,org.opendaylight.yangtools.yang.binding.Identifiable<TunnelEndPointsKey>
@Generated("mdsal-binding-generator") public interface TunnelEndPoints extends org.opendaylight.yangtools.yang.binding.ChildOf<DPNTEPsInfo>, org.opendaylight.yangtools.yang.binding.Augmentable<TunnelEndPoints>, org.opendaylight.yangtools.yang.binding.Identifiable<TunnelEndPointsKey>
This class represents the following YANG schema fragment defined in module itm-state
list tunnel-end-points { ordered-by user; key "ip-address tunnel-type"; leaf ip-address { type inet:ip-address; } list tz-membership { key zone-name; leaf zone-name { type string; } } leaf interface-name { type string; } leaf tunnel-type { type identityref { base tunnel-type-base; } } leaf option-of-tunnel { type boolean; default false; } leaf option-tunnel-tos { type string { length 1..8; } } }
The schema path to identify an instance is itm-state/dpn-endpoints/DPN-TEPs-info/tunnel-end-pointsTo create instances of this class use
TunnelEndPointsBuilder
.- See Also:
TunnelEndPointsBuilder
,TunnelEndPointsKey
-
-
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 TunnelEndPoints thisObj, java.lang.Object obj)
Default implementation ofObject.equals(Object)
contract for this interface.static int
bindingHashCode(@NonNull TunnelEndPoints obj)
Default implementation ofObject.hashCode()
contract for this interface.static java.lang.String
bindingToString(@NonNull TunnelEndPoints obj)
Default implementation ofObject.toString()
contract for this interface.java.lang.String
getInterfaceName()
Return interfaceName, ornull
if it is not present.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress
getIpAddress()
Return ipAddress, ornull
if it is not present.java.lang.Boolean
getOptionOfTunnel()
Return optionOfTunnel, ornull
if it is not present.java.lang.String
getOptionTunnelTos()
Return optionTunnelTos, ornull
if it is not present.java.lang.Class<? extends TunnelTypeBase>
getTunnelType()
Return tunnelType, ornull
if it is not present.@Nullable java.util.Map<TzMembershipKey,TzMembership>
getTzMembership()
Return tzMembership, ornull
if it is not present.default java.lang.Class<TunnelEndPoints>
implementedInterface()
default java.lang.Boolean
isOptionOfTunnel()
Deprecated, for removal: This API element is subject to removal in a future version.TunnelEndPointsKey
key()
default @NonNull java.util.Map<TzMembershipKey,TzMembership>
nonnullTzMembership()
Return tzMembership, or an empty list if it is not present.
-
-
-
Method Detail
-
implementedInterface
default java.lang.Class<TunnelEndPoints> implementedInterface()
- Specified by:
implementedInterface
in interfaceorg.opendaylight.yangtools.yang.binding.DataContainer
- Specified by:
implementedInterface
in interfaceorg.opendaylight.yangtools.yang.binding.DataObject
-
bindingHashCode
static int bindingHashCode(@NonNull TunnelEndPoints 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:
java.lang.NullPointerException
- ifobj
is null
-
bindingEquals
static boolean bindingEquals(@NonNull TunnelEndPoints thisObj, java.lang.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:
java.lang.NullPointerException
- ifthisObj
is null
-
bindingToString
static java.lang.String bindingToString(@NonNull TunnelEndPoints 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:
java.lang.NullPointerException
- ifobj
is null
-
getIpAddress
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getIpAddress()
Return ipAddress, ornull
if it is not present.- Returns:
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress
ipAddress, ornull
if it is not present.
-
getTzMembership
@Nullable java.util.Map<TzMembershipKey,TzMembership> getTzMembership()
Return tzMembership, ornull
if it is not present.- Returns:
java.util.Map
tzMembership, ornull
if it is not present.
-
nonnullTzMembership
default @NonNull java.util.Map<TzMembershipKey,TzMembership> nonnullTzMembership()
Return tzMembership, or an empty list if it is not present.- Returns:
java.util.Map
tzMembership, or an empty list if it is not present.
-
getInterfaceName
java.lang.String getInterfaceName()
Return interfaceName, ornull
if it is not present.- Returns:
java.lang.String
interfaceName, ornull
if it is not present.
-
getTunnelType
java.lang.Class<? extends TunnelTypeBase> getTunnelType()
Return tunnelType, ornull
if it is not present.- Returns:
java.lang.Class
tunnelType, ornull
if it is not present.
-
getOptionOfTunnel
java.lang.Boolean getOptionOfTunnel()
Return optionOfTunnel, ornull
if it is not present.Use flow based tunnels for remote-ip
- Returns:
java.lang.Boolean
optionOfTunnel, ornull
if it is not present.
-
isOptionOfTunnel
@Deprecated(forRemoval=true) default java.lang.Boolean isOptionOfTunnel()
Deprecated, for removal: This API element is subject to removal in a future version.
-
getOptionTunnelTos
java.lang.String getOptionTunnelTos()
Return optionTunnelTos, ornull
if it is not present.Value of ToS bits to be set on the encapsulating packet. The value of 'inherit' will copy the DSCP value from inner IPv4 or IPv6 packets. When ToS is given as a numberic value, the least significant two bits will be ignored.
- Returns:
java.lang.String
optionTunnelTos, ornull
if it is not present.
-
key
TunnelEndPointsKey key()
- Specified by:
key
in interfaceorg.opendaylight.yangtools.yang.binding.Identifiable<TunnelEndPointsKey>
-
-