Package org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160218.access.lists.acl.access.list.entries

Interface Ace

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<Ace>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<AccessListEntries>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<AceKey>
    @Generated("mdsal-binding-generator")
public interface Ace
extends org.opendaylight.yangtools.yang.binding.ChildOf<AccessListEntries>, org.opendaylight.yangtools.yang.binding.Augmentable<Ace>, org.opendaylight.yangtools.yang.binding.Identifiable<AceKey>
    List of access list entries(ACE)

    This class represents the following YANG schema fragment defined in module ietf-access-control-list 

     list ace {
   key rule-name;
   ordered-by user;
   leaf rule-name {
     type string;
   }
   container matches {
     choice ace-type {
       case ace-ip {
         choice ace-ip-version {
           case ace-ipv4 {
             uses packet-fields:acl-ipv4-header-fields;
           }
           case ace-ipv6 {
             uses packet-fields:acl-ipv6-header-fields;
           }
         }
         uses packet-fields:acl-ip-header-fields;
       }
       case ace-eth {
         uses packet-fields:acl-eth-header-fields;
       }
     }
     uses packet-fields:metadata;
   }
   container actions {
     choice packet-handling {
       default deny;
       case deny {
         leaf deny {
           type empty;
         }
       }
       case permit {
         leaf permit {
           type empty;
         }
       }
     }
   }
   container ace-oper-data {
     config false;
     leaf match-counter {
       type yang:counter64;
     }
   }
 }
    The schema path to identify an instance is ietf-access-control-list/access-lists/acl/access-list-entries/ace

    To create instances of this class use AceBuilder.

    See Also:
    AceBuilder, AceKey

    • Field Summary

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

    • Field Detail

      • QNAME

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

    • Method Detail

      • implementedInterface

        default java.lang.Class<Ace> implementedInterface()
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataContainer
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject

      • bindingHashCode

        static int bindingHashCode​(@NonNull Ace obj)
        Default implementation of Object.hashCode() contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent hashing results across all implementations.
        Parameters:
        obj - Object for which to generate hashCode() result.
        Returns:
        Hash code value of data modeled by this interface.
        Throws:
        java.lang.NullPointerException - if obj is null

      • bindingEquals

        static boolean bindingEquals​(@NonNull Ace thisObj,
                             java.lang.Object obj)
        Default implementation of Object.equals(Object) contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent equality results across all implementations.
        Parameters:
        thisObj - Object acting as the receiver of equals invocation
        obj - Object acting as argument to equals invocation
        Returns:
        True if thisObj and obj are considered equal
        Throws:
        java.lang.NullPointerException - if thisObj is null

      • bindingToString

        static java.lang.String bindingToString​(@NonNull Ace obj)
        Default implementation of Object.toString() contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent string representations across all implementations.
        Parameters:
        obj - Object for which to generate toString() result.
        Returns:
        String value of data modeled by this interface.
        Throws:
        java.lang.NullPointerException - if obj is null

      • getRuleName

        java.lang.String getRuleName()
        Return ruleName, or null if it is not present. 
             
         A unique name identifying this Access List Entry(ACE).
        Returns:
        java.lang.String ruleName, or null if it is not present.

      • getMatches

        Matches getMatches()
        Return matches, or null if it is not present. 
             
         Definitions for match criteria for this Access List Entry.
        Returns:
        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160218.access.lists.acl.access.list.entries.ace.Matches matches, or null if it is not present.

      • getActions

        Actions getActions()
        Return actions, or null if it is not present. 
             
         Definitions of action criteria for this Access List Entry.
        Returns:
        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160218.access.lists.acl.access.list.entries.ace.Actions actions, or null if it is not present.

      • getAceOperData

        AceOperData getAceOperData()
        Return aceOperData, or null if it is not present. 
             
         Operational data for this Access List Entry.
        Returns:
        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160218.access.lists.acl.access.list.entries.ace.AceOperData aceOperData, or null if it is not present.

      • key

        AceKey key()
        Specified by:
        key in interface org.opendaylight.yangtools.yang.binding.Identifiable<AceKey>