Interface VlanLogicalIngressMappingConfig

  • 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 VlanLogicalIngressMappingConfig
    extends org.opendaylight.yangtools.yang.binding.DataObject
    Configuration for ingress VLAN stack behaviors for packets that arrive on this subinterface.

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

     grouping vlan-logical-ingress-mapping-config {
       leaf vlan-stack-action {
         type oc-vlan-types:vlan-stack-action;
       }
       leaf vlan-id {
         type oc-vlan-types:vlan-id;
       }
       leaf tpid {
         type identityref {
           base TPID_TYPES;
         }
       }
     }
     
    The schema path to identify an instance is openconfig-vlanvlan-logical-ingress-mapping-config
    • Field Detail

      • QNAME

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

      • implementedInterface

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

        VlanStackAction getVlanStackAction()
        Return vlanStackAction, or null if it is not present.
             
                 The action to take on the VLAN stack of a packet. This is optionally used in
                 conjunction with adjacent leaves to override the values of the action.
             
         
        Returns:
        VlanStackAction vlanStackAction, or null if it is not present.
      • requireVlanStackAction

        default @NonNull VlanStackAction requireVlanStackAction()
        Return vlanStackAction, guaranteed to be non-null.
             
                 The action to take on the VLAN stack of a packet. This is optionally used in
                 conjunction with adjacent leaves to override the values of the action.
             
         
        Returns:
        VlanStackAction vlanStackAction, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if vlanStackAction is not present
      • getVlanId

        VlanId getVlanId()
        Return vlanId, or null if it is not present.
             
                 Optionally specifies a fixed VLAN identifier that is used by the action
                 configured in 'vlan-stack-action'. For example, if the action is 'PUSH' then
                 this VLAN identifier is added to the the stack. This value must be non-zero if
                 the 'vlan-stack-action' is one of 'PUSH' or 'SWAP'.
             
         
        Returns:
        VlanId vlanId, or null if it is not present.
      • requireVlanId

        default @NonNull VlanId requireVlanId()
        Return vlanId, guaranteed to be non-null.
             
                 Optionally specifies a fixed VLAN identifier that is used by the action
                 configured in 'vlan-stack-action'. For example, if the action is 'PUSH' then
                 this VLAN identifier is added to the the stack. This value must be non-zero if
                 the 'vlan-stack-action' is one of 'PUSH' or 'SWAP'.
             
         
        Returns:
        VlanId vlanId, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if vlanId is not present
      • getTpid

        Class<? extends TPIDTYPES> getTpid()
        Return tpid, or null if it is not present.
             
                 Optionally override the tag protocol identifier field (TPID) that is used by the
                 action configured by 'vlan-stack-action' when modifying the VLAN stack.
             
         
        Returns:
        Class<? extends TPIDTYPES> tpid, or null if it is not present.
      • requireTpid

        default @NonNull Class<? extends TPIDTYPES> requireTpid()
        Return tpid, guaranteed to be non-null.
             
                 Optionally override the tag protocol identifier field (TPID) that is used by the
                 action configured by 'vlan-stack-action' when modifying the VLAN stack.
             
         
        Returns:
        Class<? extends TPIDTYPES> tpid, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if tpid is not present