Interface MatchV10

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<MatchV10>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<MatchV10Grouping>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject

    public interface MatchV10
    extends org.opendaylight.yangtools.yang.binding.ChildOf<MatchV10Grouping>, org.opendaylight.yangtools.yang.binding.Augmentable<MatchV10>
    OF v1.0 match structure

    This class represents the following YANG schema fragment defined in module openflow-extensible-match

     container match-v10 {
       leaf wildcards {
         type oft:flow-wildcards-v10;
       }
       leaf nw-src-mask {
         type uint8;
       }
       leaf nw-dst-mask {
         type uint8;
       }
       leaf in-port {
         type uint16;
       }
       leaf dl-src {
         type yang:mac-address;
       }
       leaf dl-dst {
         type yang:mac-address;
       }
       leaf dl-vlan {
         type uint16;
       }
       leaf dl-vlan-pcp {
         type uint8;
       }
       leaf dl-type {
         type uint16;
       }
       leaf nw-tos {
         type uint8;
       }
       leaf nw-proto {
         type uint8;
       }
       leaf nw-src {
         type inet:ipv4-address;
       }
       leaf nw-dst {
         type inet:ipv4-address;
       }
       leaf tp-src {
         type uint16;
       }
       leaf tp-dst {
         type uint16;
       }
     }
     
    The schema path to identify an instance is openflow-extensible-match/match-v10-grouping/match-v10

    To create instances of this class use MatchV10Builder.

    See Also:
    MatchV10Builder
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static @NonNull org.opendaylight.yangtools.yang.common.QName QNAME  
    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress getDlDst()
      Ethernet destination address.
      org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress getDlSrc()
      Ethernet source address.
      org.opendaylight.yangtools.yang.common.Uint16 getDlType()
      Ethernet frame type.
      org.opendaylight.yangtools.yang.common.Uint16 getDlVlan()
      Input VLAN id.
      org.opendaylight.yangtools.yang.common.Uint8 getDlVlanPcp()
      Input VLAN priority.
      org.opendaylight.yangtools.yang.common.Uint16 getInPort()
      Input switch port.
      org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address getNwDst()
      IP destination address.
      org.opendaylight.yangtools.yang.common.Uint8 getNwDstMask()
      IP destination address mask (definition differs from OF v1.0.0 spec to ease understanding, library does the transformation into OF v1.0 spec correct data)
      org.opendaylight.yangtools.yang.common.Uint8 getNwProto()
      IP protocol or lower 8 bits of ARP opcode.
      org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address getNwSrc()
      IP source address.
      org.opendaylight.yangtools.yang.common.Uint8 getNwSrcMask()
      IP source address mask (definition differs from OF v1.0.0 spec to ease understanding, library does the transformation into OF v1.0 spec correct data)
      org.opendaylight.yangtools.yang.common.Uint8 getNwTos()
      IP ToS (actually DSCP field, 6 bits).
      org.opendaylight.yangtools.yang.common.Uint16 getTpDst()
      TCP/UDP destination port.
      org.opendaylight.yangtools.yang.common.Uint16 getTpSrc()
      TCP/UDP source port.
      FlowWildcardsV10 getWildcards()
      Wildcard fields (only flags).
      default Class<MatchV10> implementedInterface()  
      • Methods inherited from interface org.opendaylight.yangtools.yang.binding.Augmentable

        augmentation
    • Field Detail

      • QNAME

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

      • implementedInterface

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

        FlowWildcardsV10 getWildcards()
        Wildcard fields (only flags).
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.FlowWildcardsV10 wildcards, or null if not present
      • getNwSrcMask

        org.opendaylight.yangtools.yang.common.Uint8 getNwSrcMask()
        IP source address mask (definition differs from OF v1.0.0 spec to ease understanding, library does the transformation into OF v1.0 spec correct data)
        Returns:
        org.opendaylight.yangtools.yang.common.Uint8 nwSrcMask, or null if not present
      • getNwDstMask

        org.opendaylight.yangtools.yang.common.Uint8 getNwDstMask()
        IP destination address mask (definition differs from OF v1.0.0 spec to ease understanding, library does the transformation into OF v1.0 spec correct data)
        Returns:
        org.opendaylight.yangtools.yang.common.Uint8 nwDstMask, or null if not present
      • getInPort

        org.opendaylight.yangtools.yang.common.Uint16 getInPort()
        Input switch port.
        Returns:
        org.opendaylight.yangtools.yang.common.Uint16 inPort, or null if not present
      • getDlSrc

        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress getDlSrc()
        Ethernet source address.
        Returns:
        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress dlSrc, or null if not present
      • getDlDst

        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress getDlDst()
        Ethernet destination address.
        Returns:
        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress dlDst, or null if not present
      • getDlVlan

        org.opendaylight.yangtools.yang.common.Uint16 getDlVlan()
        Input VLAN id.
        Returns:
        org.opendaylight.yangtools.yang.common.Uint16 dlVlan, or null if not present
      • getDlVlanPcp

        org.opendaylight.yangtools.yang.common.Uint8 getDlVlanPcp()
        Input VLAN priority.
        Returns:
        org.opendaylight.yangtools.yang.common.Uint8 dlVlanPcp, or null if not present
      • getDlType

        org.opendaylight.yangtools.yang.common.Uint16 getDlType()
        Ethernet frame type.
        Returns:
        org.opendaylight.yangtools.yang.common.Uint16 dlType, or null if not present
      • getNwTos

        org.opendaylight.yangtools.yang.common.Uint8 getNwTos()
        IP ToS (actually DSCP field, 6 bits).
        Returns:
        org.opendaylight.yangtools.yang.common.Uint8 nwTos, or null if not present
      • getNwProto

        org.opendaylight.yangtools.yang.common.Uint8 getNwProto()
        IP protocol or lower 8 bits of ARP opcode.
        Returns:
        org.opendaylight.yangtools.yang.common.Uint8 nwProto, or null if not present
      • getNwSrc

        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address getNwSrc()
        IP source address.
        Returns:
        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address nwSrc, or null if not present
      • getNwDst

        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address getNwDst()
        IP destination address.
        Returns:
        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address nwDst, or null if not present
      • getTpSrc

        org.opendaylight.yangtools.yang.common.Uint16 getTpSrc()
        TCP/UDP source port.
        Returns:
        org.opendaylight.yangtools.yang.common.Uint16 tpSrc, or null if not present
      • getTpDst

        org.opendaylight.yangtools.yang.common.Uint16 getTpDst()
        TCP/UDP destination port.
        Returns:
        org.opendaylight.yangtools.yang.common.Uint16 tpDst, or null if not present