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

Interface IpMatchFields

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:
IpMatch
@Generated("mdsal-binding-generator") public interface IpMatchFields extends org.opendaylight.yangtools.yang.binding.DataObject

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

 grouping ip-match-fields {
   leaf ip-protocol {
     type uint8;
   }
   leaf ip-dscp {
     type inet:dscp;
   }
   leaf ip-ecn {
     type uint8;
   }
   leaf ip-proto {
     type inet:ip-version;
   }
 }

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final @NonNull org.opendaylight.yangtools.yang.common.QName
    QNAME
    YANG identifier of the statement represented by this class.

  • Method Summary

    Modifier and Type
    Method
    Description
    org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Dscp
    getIpDscp()
    Return ipDscp, or null if it is not present.
    org.opendaylight.yangtools.yang.common.Uint8
    getIpEcn()
    Return ipEcn, or null if it is not present.
    org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpVersion
    getIpProto()
    Return ipProto, or null if it is not present.
    org.opendaylight.yangtools.yang.common.Uint8
    getIpProtocol()
    Return ipProtocol, or null if it is not present.
    Class<? extends IpMatchFields>
    implementedInterface()
     
    default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Dscp
    requireIpDscp()
    Return ipDscp, guaranteed to be non-null.
    default @NonNull org.opendaylight.yangtools.yang.common.Uint8
    requireIpEcn()
    Return ipEcn, guaranteed to be non-null.
    default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpVersion
    requireIpProto()
    Return ipProto, guaranteed to be non-null.
    default @NonNull org.opendaylight.yangtools.yang.common.Uint8
    requireIpProtocol()
    Return ipProtocol, guaranteed to be non-null.

  • 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 IpMatchFields> 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

    • getIpProtocol

      org.opendaylight.yangtools.yang.common.Uint8 getIpProtocol()
      Return ipProtocol, or null if it is not present. 
           
         IP protocol.
      Returns:
      Uint8 ipProtocol, or null if it is not present.

    • requireIpProtocol

      default @NonNull org.opendaylight.yangtools.yang.common.Uint8 requireIpProtocol()
      Return ipProtocol, guaranteed to be non-null. 
           
         IP protocol.
      Returns:
      Uint8 ipProtocol, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if ipProtocol is not present

    • getIpDscp

      org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Dscp getIpDscp()
      Return ipDscp, or null if it is not present. 
           
         IP DSCP (6 bits in ToS field).
      Returns:
      Dscp ipDscp, or null if it is not present.

    • requireIpDscp

      default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Dscp requireIpDscp()
      Return ipDscp, guaranteed to be non-null. 
           
         IP DSCP (6 bits in ToS field).
      Returns:
      Dscp ipDscp, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if ipDscp is not present

    • getIpEcn

      org.opendaylight.yangtools.yang.common.Uint8 getIpEcn()
      Return ipEcn, or null if it is not present. 
           
         IP ECN (2 bits in ToS field).
      Returns:
      Uint8 ipEcn, or null if it is not present.

    • requireIpEcn

      default @NonNull org.opendaylight.yangtools.yang.common.Uint8 requireIpEcn()
      Return ipEcn, guaranteed to be non-null. 
           
         IP ECN (2 bits in ToS field).
      Returns:
      Uint8 ipEcn, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if ipEcn is not present

    • getIpProto

      org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpVersion getIpProto()
      Return ipProto, or null if it is not present. 
           
         IP Proto (IPv4 or IPv6 Protocol Number).
      Returns:
      IpVersion ipProto, or null if it is not present.

    • requireIpProto

      default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpVersion requireIpProto()
      Return ipProto, guaranteed to be non-null. 
           
         IP Proto (IPv4 or IPv6 Protocol Number).
      Returns:
      IpVersion ipProto, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if ipProto is not present