Package org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.map.register.cache.metadata.container

Interface MapRegisterCacheMetadata

All Superinterfaces:
org.opendaylight.yangtools.yang.binding.Augmentable<MapRegisterCacheMetadata>, org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>, 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:

  • Field Details

    • QNAME

      static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME
      YANG identifier of the statement represented by this class.

  • Method Details

    • implementedInterface

      default Class<MapRegisterCacheMetadata> implementedInterface()
      Specified by:
      implementedInterface in interface org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>
      Specified by:
      implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject

    • bindingHashCode

      static int bindingHashCode(@NonNull MapRegisterCacheMetadata 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 MapRegisterCacheMetadata 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 MapRegisterCacheMetadata 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

    • getEidLispAddress

      @Nullable Map<EidLispAddressKey,EidLispAddress> getEidLispAddress()
      Return eidLispAddress, or null if it is not present. 
           
         List of EID-Prefixes from Map-Register message.
      Returns:
      Map<EidLispAddressKey, EidLispAddress> eidLispAddress, or null if it is not present.

    • nonnullEidLispAddress

      default @NonNull 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, or null if it is not present. 
           
         128 bit xTR identifier.
      Returns:
      XtrId xtrId, or null 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:
      NoSuchElementException - if xtrId is not present

    • getSiteId

      SiteId getSiteId()
      Return siteId, or null if it is not present. 
           
         64 bit site identifier.
      Returns:
      SiteId siteId, or null 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:
      NoSuchElementException - if siteId is not present

    • getTimestamp

      Long getTimestamp()
      Return timestamp, or null if it is not present. 
           
         Milliseconds since January 1, 1970, 00:00:00 GMT
      Returns:
      Long timestamp, or null if it is not present.

    • requireTimestamp

      default @NonNull 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:
      NoSuchElementException - if timestamp is not present

    • getWantMapNotify

      Boolean getWantMapNotify()
      Return wantMapNotify, or null if it is not present. 
           
         xTR askes for Map-Register acknowledgement in form of a Map-Notify control
         message.
      Returns:
      Boolean wantMapNotify, or null if it is not present.

    • requireWantMapNotify

      default @NonNull 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:
      NoSuchElementException - if wantMapNotify is not present

    • getMergeEnabled

      Boolean getMergeEnabled()
      Return mergeEnabled, or null if it is not present. 
           
         Value of 22th bit in map register message.
      Returns:
      Boolean mergeEnabled, or null if it is not present.

    • requireMergeEnabled

      default @NonNull 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:
      NoSuchElementException - if mergeEnabled is not present