Package org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026

Interface Match

All Superinterfaces:
org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject
All Known Subinterfaces:
Match, Match, Match, Match, SetField
@Generated("mdsal-binding-generator") public interface Match extends org.opendaylight.yangtools.yang.binding.DataObject

This class represents the following YANG schema fragment defined in module opendaylight-match-types 

 grouping match {
   leaf in-port {
     type inv:node-connector-id;
   }
   leaf in-phy-port {
     type inv:node-connector-id;
   }
   container packet-type-match {
     uses packet-type-fields;
   }
   container metadata {
     uses of-metadata;
   }
   container tunnel {
     leaf tunnel-id {
       type uint64;
     }
     leaf tunnel-mask {
       type uint64;
     }
   }
   container ethernet-match {
     uses ethernet-match-fields;
   }
   container vlan-match {
     uses vlan-match-fields;
   }
   container ip-match {
     uses ip-match-fields;
   }
   choice layer-3-match {
     case ipv4-match {
       uses ipv4-match-fields;
     }
     case ipv4-match-arbitrary-bit-mask {
       uses mask:ipv4-match-arbitrary-bitmask-fields;
     }
     case ipv6-match {
       uses ipv6-match-fields;
     }
     case ipv6-match-arbitrary-bit-mask {
       uses ipv6-arbitrary-mask:ipv6-match-arbitrary-bitmask-fields;
     }
     case arp-match {
       uses arp-match-fields;
     }
     case tunnel-ipv4-match {
       uses tunnel-ipv4-match-fields;
     }
   }
   choice layer-4-match {
     case udp-match {
       uses udp-match-fields;
     }
     case tcp-match {
       uses tcp-match-fields;
     }
     case sctp-match {
       uses sctp-match-fields;
     }
   }
   container icmpv4-match {
     uses icmpv4-match-fields;
   }
   container icmpv6-match {
     uses icmpv6-match-fields;
   }
   container protocol-match-fields {
     uses protocol-match-fields;
   }
   container tcp-flags-match {
     uses tcp-flags-match-fields;
   }
 }

  • 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

      Class<? extends Match> 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

    • getInPort

      NodeConnectorId getInPort()
      Return inPort, or null if it is not present.
      Returns:
      NodeConnectorId inPort, or null if it is not present.

    • requireInPort

      default @NonNull NodeConnectorId requireInPort()
      Return inPort, guaranteed to be non-null.
      Returns:
      NodeConnectorId inPort, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if inPort is not present

    • getInPhyPort

      NodeConnectorId getInPhyPort()
      Return inPhyPort, or null if it is not present.
      Returns:
      NodeConnectorId inPhyPort, or null if it is not present.

    • requireInPhyPort

      default @NonNull NodeConnectorId requireInPhyPort()
      Return inPhyPort, guaranteed to be non-null.
      Returns:
      NodeConnectorId inPhyPort, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if inPhyPort is not present

    • getPacketTypeMatch

      PacketTypeMatch getPacketTypeMatch()
      Return packetTypeMatch, or null if it is not present.
      Returns:
      PacketTypeMatch packetTypeMatch, or null if it is not present.

    • getMetadata

      Metadata getMetadata()
      Return metadata, or null if it is not present.
      Returns:
      Metadata metadata, or null if it is not present.

    • getTunnel

      Tunnel getTunnel()
      Return tunnel, or null if it is not present.
      Returns:
      Tunnel tunnel, or null if it is not present.

    • getEthernetMatch

      EthernetMatch getEthernetMatch()
      Return ethernetMatch, or null if it is not present.
      Returns:
      EthernetMatch ethernetMatch, or null if it is not present.

    • getVlanMatch

      VlanMatch getVlanMatch()
      Return vlanMatch, or null if it is not present.
      Returns:
      VlanMatch vlanMatch, or null if it is not present.

    • getIpMatch

      IpMatch getIpMatch()
      Return ipMatch, or null if it is not present.
      Returns:
      IpMatch ipMatch, or null if it is not present.

    • getLayer3Match

      Layer3Match getLayer3Match()
      Return layer3Match, or null if it is not present.
      Returns:
      Layer3Match layer3Match, or null if it is not present.

    • getLayer4Match

      Layer4Match getLayer4Match()
      Return layer4Match, or null if it is not present.
      Returns:
      Layer4Match layer4Match, or null if it is not present.

    • getIcmpv4Match

      Icmpv4Match getIcmpv4Match()
      Return icmpv4Match, or null if it is not present.
      Returns:
      Icmpv4Match icmpv4Match, or null if it is not present.

    • getIcmpv6Match

      Icmpv6Match getIcmpv6Match()
      Return icmpv6Match, or null if it is not present.
      Returns:
      Icmpv6Match icmpv6Match, or null if it is not present.

    • getProtocolMatchFields

      ProtocolMatchFields getProtocolMatchFields()
      Return protocolMatchFields, or null if it is not present.
      Returns:
      ProtocolMatchFields protocolMatchFields, or null if it is not present.

    • getTcpFlagsMatch

      TcpFlagsMatch getTcpFlagsMatch()
      Return tcpFlagsMatch, or null if it is not present.
      Returns:
      TcpFlagsMatch tcpFlagsMatch, or null if it is not present.