Interface DbInstance

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject
    All Known Subinterfaces:
    VirtualNetworkIdentifier

    @Generated("mdsal-binding-generator")
    public interface DbInstance
    extends org.opendaylight.yangtools.yang.binding.DataObject
    Describes the mappings belonging to the same Virtual Network Identifier

    This class represents the following YANG schema fragment defined in module odl-mappingservice

     grouping db-instance {
       leaf vni {
         type vni-uri;
       }
       list mapping {
         key "eid-uri origin";
         ext:context-instance eid-context;
         leaf eid-uri {
           type eid-uri;
         }
         leaf origin {
           type mapping-origin;
         }
         leaf-list site-id {
           type lisp-proto:site-id;
         }
         uses lisp-proto:mapping-record-container;
         list xtr-id-mapping {
           config false;
           key xtr-id-uri;
           ext:context-instance xtrid-context;
           leaf xtr-id-uri {
             type xtr-id-uri;
           }
           uses lisp-proto:mapping-record-container;
         }
       }
       list authentication-key {
         key eid-uri;
         ext:context-instance eid-context;
         leaf eid-uri {
           type eid-uri;
         }
         uses lisp-proto:eid-container;
         uses lisp-proto:mapping-authkey-container;
       }
     }
     
    • Field Detail

      • QNAME

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

      • implementedInterface

        java.lang.Class<? extends DbInstance> implementedInterface()
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataContainer
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject
      • getVni

        VniUri getVni()
        Return vni, or null if it is not present.
             
                 The 24-bit Virtual Network Identifier
             
         
        Returns:
        VniUri vni, or null if it is not present.
      • requireVni

        default @NonNull VniUri requireVni()
        Return vni, guaranteed to be non-null.
             
                 The 24-bit Virtual Network Identifier
             
         
        Returns:
        VniUri vni, guaranteed to be non-null.
        Throws:
        java.util.NoSuchElementException - if vni is not present
      • getMapping

        @Nullable java.util.Map<MappingKey,​Mapping> getMapping()
        Return mapping, or null if it is not present.
             
                 A list of EID-to-RLOC mappings within the same Instance ID
             
         
        Returns:
        Map<MappingKey, Mapping> mapping, or null if it is not present.
      • nonnullMapping

        default @NonNull java.util.Map<MappingKey,​Mapping> nonnullMapping()
        Return mapping, or an empty list if it is not present.
        Returns:
        Map<MappingKey, Mapping> mapping, or an empty list if it is not present.
      • getAuthenticationKey

        @Nullable java.util.Map<AuthenticationKeyKey,​AuthenticationKey> getAuthenticationKey()
        Return authenticationKey, or null if it is not present.
             
                 A list of authentication keys for EID prefixes within the same Virtual Network
                 Identifier
             
         
        Returns:
        Map<AuthenticationKeyKey, AuthenticationKey> authenticationKey, or null if it is not present.
      • nonnullAuthenticationKey

        default @NonNull java.util.Map<AuthenticationKeyKey,​AuthenticationKey> nonnullAuthenticationKey()
        Return authenticationKey, or an empty list if it is not present.
        Returns:
        Map<AuthenticationKeyKey, AuthenticationKey> authenticationKey, or an empty list if it is not present.