Interface MapRegisterCacheMetadata
-
- All Superinterfaces:
org.opendaylight.yangtools.yang.binding.Augmentable<MapRegisterCacheMetadata>
,org.opendaylight.yangtools.yang.binding.BindingObject
,org.opendaylight.yangtools.yang.binding.ChildOf<MapRegisterCacheMetadataContainer>
,org.opendaylight.yangtools.yang.binding.DataContainer
,org.opendaylight.yangtools.yang.binding.DataObject
@Generated("mdsal-binding-generator") public interface MapRegisterCacheMetadata extends org.opendaylight.yangtools.yang.binding.ChildOf<MapRegisterCacheMetadataContainer>, org.opendaylight.yangtools.yang.binding.Augmentable<MapRegisterCacheMetadata>
The Map-Register cache metadata is information for a mapping database about mapping update event, without the full Map-Register packet data. The metadata and the packet data together will form the Map-Register cache value.This class represents the following YANG schema fragment defined in module odl-lisp-proto
container map-register-cache-metadata { list eid-lisp-address { key eid-lisp-address-id; leaf eid-lisp-address-id { type string; } uses eid-container; } leaf xtr-id { type xtr-id; } leaf site-id { type site-id; } leaf timestamp { type int64; } leaf want-map-notify { type boolean; } leaf merge-enabled { type boolean; } }
To create instances of this class use
MapRegisterCacheMetadataBuilder
.- See Also:
MapRegisterCacheMetadataBuilder
-
-
Field Summary
Fields Modifier and Type Field Description static @NonNull org.opendaylight.yangtools.yang.common.QName
QNAME
YANG identifier of the statement represented by this class.
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description static boolean
bindingEquals(@NonNull MapRegisterCacheMetadata thisObj, java.lang.Object obj)
Default implementation ofObject.equals(Object)
contract for this interface.static int
bindingHashCode(@NonNull MapRegisterCacheMetadata obj)
Default implementation ofObject.hashCode()
contract for this interface.static java.lang.String
bindingToString(@NonNull MapRegisterCacheMetadata obj)
Default implementation ofObject.toString()
contract for this interface.@Nullable java.util.Map<EidLispAddressKey,EidLispAddress>
getEidLispAddress()
Return eidLispAddress, ornull
if it is not present.java.lang.Boolean
getMergeEnabled()
Return mergeEnabled, ornull
if it is not present.SiteId
getSiteId()
Return siteId, ornull
if it is not present.java.lang.Long
getTimestamp()
Return timestamp, ornull
if it is not present.java.lang.Boolean
getWantMapNotify()
Return wantMapNotify, ornull
if it is not present.XtrId
getXtrId()
Return xtrId, ornull
if it is not present.default java.lang.Class<MapRegisterCacheMetadata>
implementedInterface()
default @NonNull java.util.Map<EidLispAddressKey,EidLispAddress>
nonnullEidLispAddress()
Return eidLispAddress, or an empty list if it is not present.default @NonNull java.lang.Boolean
requireMergeEnabled()
Return mergeEnabled, guaranteed to be non-null.default @NonNull SiteId
requireSiteId()
Return siteId, guaranteed to be non-null.default @NonNull java.lang.Long
requireTimestamp()
Return timestamp, guaranteed to be non-null.default @NonNull java.lang.Boolean
requireWantMapNotify()
Return wantMapNotify, guaranteed to be non-null.default @NonNull XtrId
requireXtrId()
Return xtrId, guaranteed to be non-null.
-
-
-
Method Detail
-
implementedInterface
default java.lang.Class<MapRegisterCacheMetadata> 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 MapRegisterCacheMetadata 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 MapRegisterCacheMetadata 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 MapRegisterCacheMetadata 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
-
getEidLispAddress
@Nullable java.util.Map<EidLispAddressKey,EidLispAddress> getEidLispAddress()
Return eidLispAddress, ornull
if it is not present.List of EID-Prefixes from Map-Register message.
- Returns:
Map<EidLispAddressKey, EidLispAddress>
eidLispAddress, ornull
if it is not present.
-
nonnullEidLispAddress
default @NonNull java.util.Map<EidLispAddressKey,EidLispAddress> nonnullEidLispAddress()
Return eidLispAddress, or an empty list if it is not present.- Returns:
Map<EidLispAddressKey, EidLispAddress>
eidLispAddress, or an empty list if it is not present.
-
getXtrId
XtrId getXtrId()
Return xtrId, ornull
if it is not present.128 bit xTR identifier.
- Returns:
XtrId
xtrId, ornull
if it is not present.
-
requireXtrId
default @NonNull XtrId requireXtrId()
Return xtrId, guaranteed to be non-null.128 bit xTR identifier.
- Returns:
XtrId
xtrId, guaranteed to be non-null.- Throws:
java.util.NoSuchElementException
- if xtrId is not present
-
getSiteId
SiteId getSiteId()
Return siteId, ornull
if it is not present.64 bit site identifier.
- Returns:
SiteId
siteId, ornull
if it is not present.
-
requireSiteId
default @NonNull SiteId requireSiteId()
Return siteId, guaranteed to be non-null.64 bit site identifier.
- Returns:
SiteId
siteId, guaranteed to be non-null.- Throws:
java.util.NoSuchElementException
- if siteId is not present
-
getTimestamp
java.lang.Long getTimestamp()
Return timestamp, ornull
if it is not present.Milliseconds since January 1, 1970, 00:00:00 GMT
- Returns:
Long
timestamp, ornull
if it is not present.
-
requireTimestamp
default @NonNull java.lang.Long requireTimestamp()
Return timestamp, guaranteed to be non-null.Milliseconds since January 1, 1970, 00:00:00 GMT
- Returns:
Long
timestamp, guaranteed to be non-null.- Throws:
java.util.NoSuchElementException
- if timestamp is not present
-
getWantMapNotify
java.lang.Boolean getWantMapNotify()
Return wantMapNotify, ornull
if it is not present.xTR askes for Map-Register acknowledgement in form of a Map-Notify control message.
- Returns:
Boolean
wantMapNotify, ornull
if it is not present.
-
requireWantMapNotify
default @NonNull java.lang.Boolean requireWantMapNotify()
Return wantMapNotify, guaranteed to be non-null.xTR askes for Map-Register acknowledgement in form of a Map-Notify control message.
- Returns:
Boolean
wantMapNotify, guaranteed to be non-null.- Throws:
java.util.NoSuchElementException
- if wantMapNotify is not present
-
getMergeEnabled
java.lang.Boolean getMergeEnabled()
Return mergeEnabled, ornull
if it is not present.Value of 22th bit in map register message.
- Returns:
Boolean
mergeEnabled, ornull
if it is not present.
-
requireMergeEnabled
default @NonNull java.lang.Boolean requireMergeEnabled()
Return mergeEnabled, guaranteed to be non-null.Value of 22th bit in map register message.
- Returns:
Boolean
mergeEnabled, guaranteed to be non-null.- Throws:
java.util.NoSuchElementException
- if mergeEnabled is not present
-
-