Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.interfaces.rev210406

Interface InterfaceRefCommon

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject
    All Known Subinterfaces:
    Config, State
    @Generated("mdsal-binding-generator")
public interface InterfaceRefCommon
extends org.opendaylight.yangtools.yang.binding.DataObject
    Reference leafrefs to interface / subinterface

    This class represents the following YANG schema fragment defined in module openconfig-interfaces 

     grouping interface-ref-common {
   leaf interface {
     type leafref {
       path /oc-if:interfaces/oc-if:interface/oc-if:name;
     }
   }
   leaf subinterface {
     type leafref {
       path /oc-if:interfaces/oc-if:interface[oc-if:name=current()/../interface]/oc-if:subinterfaces/oc-if:subinterface/oc-if:index;
     }
   }
 }
    The schema path to identify an instance is openconfig-interfacesinterface-ref-common

    • Field Detail

      • QNAME

        static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME

    • Method Detail

      • implementedInterface

        Class<? extends InterfaceRefCommon> implementedInterface()
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataContainer
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject

      • getInterface

        String getInterface()
        Return interface, or null if it is not present. 
             
         Reference to a base interface. If a reference to a subinterface is required,
         this leaf must be specified to indicate the base interface.
        Returns:
        String interface, or null if it is not present.

      • requireInterface

        default @NonNull String requireInterface()
        Return interface, guaranteed to be non-null. 
             
         Reference to a base interface. If a reference to a subinterface is required,
         this leaf must be specified to indicate the base interface.
        Returns:
        String interface, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if interface is not present

      • getSubinterface

        org.opendaylight.yangtools.yang.common.Uint32 getSubinterface()
        Return subinterface, or null if it is not present. 
             
         Reference to a subinterface -- this requires the base interface to be specified
         using the interface leaf in this container. If only a reference to a base
         interface is requuired, this leaf should not be set.
        Returns:
        Uint32 subinterface, or null if it is not present.

      • requireSubinterface

        default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requireSubinterface()
        Return subinterface, guaranteed to be non-null. 
             
         Reference to a subinterface -- this requires the base interface to be specified
         using the interface leaf in this container. If only a reference to a base
         interface is requuired, this leaf should not be set.
        Returns:
        Uint32 subinterface, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if subinterface is not present