Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.interfaces.rev210406._interface.counters.state

Interface Counters

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<Counters>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<InterfaceCountersState>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject
    @Generated("mdsal-binding-generator")
public interface Counters
extends org.opendaylight.yangtools.yang.binding.ChildOf<InterfaceCountersState>, org.opendaylight.yangtools.yang.binding.Augmentable<Counters>
    A collection of interface-related statistics objects.

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

     container counters {
   leaf in-octets {
     type oc-yang:counter64;
   }
   leaf in-pkts {
     type oc-yang:counter64;
   }
   leaf in-unicast-pkts {
     type oc-yang:counter64;
   }
   leaf in-broadcast-pkts {
     type oc-yang:counter64;
   }
   leaf in-multicast-pkts {
     type oc-yang:counter64;
   }
   leaf in-discards {
     type oc-yang:counter64;
   }
   leaf in-errors {
     type oc-yang:counter64;
   }
   leaf in-unknown-protos {
     type oc-yang:counter64;
   }
   leaf in-fcs-errors {
     type oc-yang:counter64;
   }
   leaf out-octets {
     type oc-yang:counter64;
   }
   leaf out-pkts {
     type oc-yang:counter64;
   }
   leaf out-unicast-pkts {
     type oc-yang:counter64;
   }
   leaf out-broadcast-pkts {
     type oc-yang:counter64;
   }
   leaf out-multicast-pkts {
     type oc-yang:counter64;
   }
   leaf out-discards {
     type oc-yang:counter64;
   }
   leaf out-errors {
     type oc-yang:counter64;
   }
   leaf carrier-transitions {
     type oc-yang:counter64;
     oc-ext:telemetry-on-change;
   }
   leaf last-clear {
     type oc-types:timeticks64;
     oc-ext:telemetry-on-change;
   }
 }
    The schema path to identify an instance is openconfig-interfacesinterface-counters-statecounters

    To create instances of this class use CountersBuilder.

    See Also:
    CountersBuilder

    • Field Detail

      • QNAME

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

    • Method Detail

      • implementedInterface

        default Class<Counters> 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 Counters 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:
        NullPointerException - if obj is null

      • bindingEquals

        static boolean bindingEquals​(@NonNull Counters thisObj,
                             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:
        NullPointerException - if thisObj is null

      • bindingToString

        static String bindingToString​(@NonNull Counters 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:
        NullPointerException - if obj is null

      • getInOctets

        Counter64 getInOctets()
        Return inOctets, or null if it is not present. 
             
         The total number of octets received on the interface, including framing
         characters. Discontinuities in the value of this counter can occur at
         re-initialization of the management system, and at other times as indicated by
         the value of 'last-clear'.
        Returns:
        Counter64 inOctets, or null if it is not present.

      • requireInOctets

        default @NonNull Counter64 requireInOctets()
        Return inOctets, guaranteed to be non-null. 
             
         The total number of octets received on the interface, including framing
         characters. Discontinuities in the value of this counter can occur at
         re-initialization of the management system, and at other times as indicated by
         the value of 'last-clear'.
        Returns:
        Counter64 inOctets, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if inOctets is not present

      • getInPkts

        Counter64 getInPkts()
        Return inPkts, or null if it is not present. 
             
         The total number of packets received on the interface, including all unicast,
         multicast, broadcast and bad packets etc.
        Returns:
        Counter64 inPkts, or null if it is not present.

      • requireInPkts

        default @NonNull Counter64 requireInPkts()
        Return inPkts, guaranteed to be non-null. 
             
         The total number of packets received on the interface, including all unicast,
         multicast, broadcast and bad packets etc.
        Returns:
        Counter64 inPkts, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if inPkts is not present

      • getInUnicastPkts

        Counter64 getInUnicastPkts()
        Return inUnicastPkts, or null if it is not present. 
             
         The number of packets, delivered by this sub-layer to a higher (sub-)layer, that
         were not addressed to a multicast or broadcast address at this sub-layer.
         Discontinuities in the value of this counter can occur at re-initialization of
         the management system, and at other times as indicated by the value of
         'last-clear'.
        Returns:
        Counter64 inUnicastPkts, or null if it is not present.

      • requireInUnicastPkts

        default @NonNull Counter64 requireInUnicastPkts()
        Return inUnicastPkts, guaranteed to be non-null. 
             
         The number of packets, delivered by this sub-layer to a higher (sub-)layer, that
         were not addressed to a multicast or broadcast address at this sub-layer.
         Discontinuities in the value of this counter can occur at re-initialization of
         the management system, and at other times as indicated by the value of
         'last-clear'.
        Returns:
        Counter64 inUnicastPkts, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if inUnicastPkts is not present

      • getInBroadcastPkts

        Counter64 getInBroadcastPkts()
        Return inBroadcastPkts, or null if it is not present. 
             
         The number of packets, delivered by this sub-layer to a higher (sub-)layer, that
         were addressed to a broadcast address at this sub-layer. Discontinuities in the
         value of this counter can occur at re-initialization of the management system,
         and at other times as indicated by the value of 'last-clear'.
        Returns:
        Counter64 inBroadcastPkts, or null if it is not present.

      • requireInBroadcastPkts

        default @NonNull Counter64 requireInBroadcastPkts()
        Return inBroadcastPkts, guaranteed to be non-null. 
             
         The number of packets, delivered by this sub-layer to a higher (sub-)layer, that
         were addressed to a broadcast address at this sub-layer. Discontinuities in the
         value of this counter can occur at re-initialization of the management system,
         and at other times as indicated by the value of 'last-clear'.
        Returns:
        Counter64 inBroadcastPkts, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if inBroadcastPkts is not present

      • getInMulticastPkts

        Counter64 getInMulticastPkts()
        Return inMulticastPkts, or null if it is not present. 
             
         The number of packets, delivered by this sub-layer to a higher (sub-)layer, that
         were addressed to a multicast address at this sub-layer. For a MAC-layer
         protocol, this includes both Group and Functional addresses. Discontinuities in
         the value of this counter can occur at re-initialization of the management
         system, and at other times as indicated by the value of 'last-clear'.
        Returns:
        Counter64 inMulticastPkts, or null if it is not present.

      • requireInMulticastPkts

        default @NonNull Counter64 requireInMulticastPkts()
        Return inMulticastPkts, guaranteed to be non-null. 
             
         The number of packets, delivered by this sub-layer to a higher (sub-)layer, that
         were addressed to a multicast address at this sub-layer. For a MAC-layer
         protocol, this includes both Group and Functional addresses. Discontinuities in
         the value of this counter can occur at re-initialization of the management
         system, and at other times as indicated by the value of 'last-clear'.
        Returns:
        Counter64 inMulticastPkts, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if inMulticastPkts is not present

      • getInDiscards

        Counter64 getInDiscards()
        Return inDiscards, or null if it is not present. 
             
         The number of inbound packets that were chosen to be discarded even though no
         errors had been detected to prevent their being deliverable to a higher-layer
         protocol. One possible reason for discarding such a packet could be to free up
         buffer space. Discontinuities in the value of this counter can occur at
         re-initialization of the management system, and at other times as indicated by
         the value of 'last-clear'.
        Returns:
        Counter64 inDiscards, or null if it is not present.

      • requireInDiscards

        default @NonNull Counter64 requireInDiscards()
        Return inDiscards, guaranteed to be non-null. 
             
         The number of inbound packets that were chosen to be discarded even though no
         errors had been detected to prevent their being deliverable to a higher-layer
         protocol. One possible reason for discarding such a packet could be to free up
         buffer space. Discontinuities in the value of this counter can occur at
         re-initialization of the management system, and at other times as indicated by
         the value of 'last-clear'.
        Returns:
        Counter64 inDiscards, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if inDiscards is not present

      • getInErrors

        Counter64 getInErrors()
        Return inErrors, or null if it is not present. 
             
         For packet-oriented interfaces, the number of inbound packets that contained
         errors preventing them from being deliverable to a higher-layer protocol. For
         character- oriented or fixed-length interfaces, the number of inbound
         transmission units that contained errors preventing them from being deliverable
         to a higher-layer protocol. Discontinuities in the value of this counter can
         occur at re-initialization of the management system, and at other times as
         indicated by the value of 'last-clear'.
        Returns:
        Counter64 inErrors, or null if it is not present.

      • requireInErrors

        default @NonNull Counter64 requireInErrors()
        Return inErrors, guaranteed to be non-null. 
             
         For packet-oriented interfaces, the number of inbound packets that contained
         errors preventing them from being deliverable to a higher-layer protocol. For
         character- oriented or fixed-length interfaces, the number of inbound
         transmission units that contained errors preventing them from being deliverable
         to a higher-layer protocol. Discontinuities in the value of this counter can
         occur at re-initialization of the management system, and at other times as
         indicated by the value of 'last-clear'.
        Returns:
        Counter64 inErrors, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if inErrors is not present

      • getInUnknownProtos

        Counter64 getInUnknownProtos()
        Return inUnknownProtos, or null if it is not present. 
             
         For packet-oriented interfaces, the number of packets received via the interface
         that were discarded because of an unknown or unsupported protocol. For
         character-oriented or fixed-length interfaces that support protocol
         multiplexing, the number of transmission units received via the interface that
         were discarded because of an unknown or unsupported protocol. For any interface
         that does not support protocol multiplexing, this counter is not present.
         Discontinuities in the value of this counter can occur at re-initialization of
         the management system, and at other times as indicated by the value of
         'last-clear'.
        Returns:
        Counter64 inUnknownProtos, or null if it is not present.

      • requireInUnknownProtos

        default @NonNull Counter64 requireInUnknownProtos()
        Return inUnknownProtos, guaranteed to be non-null. 
             
         For packet-oriented interfaces, the number of packets received via the interface
         that were discarded because of an unknown or unsupported protocol. For
         character-oriented or fixed-length interfaces that support protocol
         multiplexing, the number of transmission units received via the interface that
         were discarded because of an unknown or unsupported protocol. For any interface
         that does not support protocol multiplexing, this counter is not present.
         Discontinuities in the value of this counter can occur at re-initialization of
         the management system, and at other times as indicated by the value of
         'last-clear'.
        Returns:
        Counter64 inUnknownProtos, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if inUnknownProtos is not present

      • getInFcsErrors

        Counter64 getInFcsErrors()
        Return inFcsErrors, or null if it is not present. 
             
         Number of received packets which had errors in the frame check sequence (FCS),
         i.e., framing errors. Discontinuities in the value of this counter can occur
         when the device is re-initialization as indicated by the value of 'last-clear'.
        Returns:
        Counter64 inFcsErrors, or null if it is not present.

      • requireInFcsErrors

        default @NonNull Counter64 requireInFcsErrors()
        Return inFcsErrors, guaranteed to be non-null. 
             
         Number of received packets which had errors in the frame check sequence (FCS),
         i.e., framing errors. Discontinuities in the value of this counter can occur
         when the device is re-initialization as indicated by the value of 'last-clear'.
        Returns:
        Counter64 inFcsErrors, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if inFcsErrors is not present

      • getOutOctets

        Counter64 getOutOctets()
        Return outOctets, or null if it is not present. 
             
         The total number of octets transmitted out of the interface, including framing
         characters. Discontinuities in the value of this counter can occur at
         re-initialization of the management system, and at other times as indicated by
         the value of 'last-clear'.
        Returns:
        Counter64 outOctets, or null if it is not present.

      • requireOutOctets

        default @NonNull Counter64 requireOutOctets()
        Return outOctets, guaranteed to be non-null. 
             
         The total number of octets transmitted out of the interface, including framing
         characters. Discontinuities in the value of this counter can occur at
         re-initialization of the management system, and at other times as indicated by
         the value of 'last-clear'.
        Returns:
        Counter64 outOctets, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if outOctets is not present

      • getOutPkts

        Counter64 getOutPkts()
        Return outPkts, or null if it is not present. 
             
         The total number of packets transmitted out of the interface, including all
         unicast, multicast, broadcast, and bad packets etc.
        Returns:
        Counter64 outPkts, or null if it is not present.

      • requireOutPkts

        default @NonNull Counter64 requireOutPkts()
        Return outPkts, guaranteed to be non-null. 
             
         The total number of packets transmitted out of the interface, including all
         unicast, multicast, broadcast, and bad packets etc.
        Returns:
        Counter64 outPkts, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if outPkts is not present

      • getOutUnicastPkts

        Counter64 getOutUnicastPkts()
        Return outUnicastPkts, or null if it is not present. 
             
         The total number of packets that higher-level protocols requested be
         transmitted, and that were not addressed to a multicast or broadcast address at
         this sub-layer, including those that were discarded or not sent. Discontinuities
         in the value of this counter can occur at re-initialization of the management
         system, and at other times as indicated by the value of 'last-clear'.
        Returns:
        Counter64 outUnicastPkts, or null if it is not present.

      • requireOutUnicastPkts

        default @NonNull Counter64 requireOutUnicastPkts()
        Return outUnicastPkts, guaranteed to be non-null. 
             
         The total number of packets that higher-level protocols requested be
         transmitted, and that were not addressed to a multicast or broadcast address at
         this sub-layer, including those that were discarded or not sent. Discontinuities
         in the value of this counter can occur at re-initialization of the management
         system, and at other times as indicated by the value of 'last-clear'.
        Returns:
        Counter64 outUnicastPkts, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if outUnicastPkts is not present

      • getOutBroadcastPkts

        Counter64 getOutBroadcastPkts()
        Return outBroadcastPkts, or null if it is not present. 
             
         The total number of packets that higher-level protocols requested be
         transmitted, and that were addressed to a broadcast address at this sub-layer,
         including those that were discarded or not sent. Discontinuities in the value of
         this counter can occur at re-initialization of the management system, and at
         other times as indicated by the value of 'last-clear'.
        Returns:
        Counter64 outBroadcastPkts, or null if it is not present.

      • requireOutBroadcastPkts

        default @NonNull Counter64 requireOutBroadcastPkts()
        Return outBroadcastPkts, guaranteed to be non-null. 
             
         The total number of packets that higher-level protocols requested be
         transmitted, and that were addressed to a broadcast address at this sub-layer,
         including those that were discarded or not sent. Discontinuities in the value of
         this counter can occur at re-initialization of the management system, and at
         other times as indicated by the value of 'last-clear'.
        Returns:
        Counter64 outBroadcastPkts, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if outBroadcastPkts is not present

      • getOutMulticastPkts

        Counter64 getOutMulticastPkts()
        Return outMulticastPkts, or null if it is not present. 
             
         The total number of packets that higher-level protocols requested be
         transmitted, and that were addressed to a multicast address at this sub-layer,
         including those that were discarded or not sent. For a MAC-layer protocol, this
         includes both Group and Functional addresses. Discontinuities in the value of
         this counter can occur at re-initialization of the management system, and at
         other times as indicated by the value of 'last-clear'.
        Returns:
        Counter64 outMulticastPkts, or null if it is not present.

      • requireOutMulticastPkts

        default @NonNull Counter64 requireOutMulticastPkts()
        Return outMulticastPkts, guaranteed to be non-null. 
             
         The total number of packets that higher-level protocols requested be
         transmitted, and that were addressed to a multicast address at this sub-layer,
         including those that were discarded or not sent. For a MAC-layer protocol, this
         includes both Group and Functional addresses. Discontinuities in the value of
         this counter can occur at re-initialization of the management system, and at
         other times as indicated by the value of 'last-clear'.
        Returns:
        Counter64 outMulticastPkts, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if outMulticastPkts is not present

      • getOutDiscards

        Counter64 getOutDiscards()
        Return outDiscards, or null if it is not present. 
             
         The number of outbound packets that were chosen to be discarded even though no
         errors had been detected to prevent their being transmitted. One possible reason
         for discarding such a packet could be to free up buffer space. Discontinuities
         in the value of this counter can occur at re-initialization of the management
         system, and at other times as indicated by the value of 'last-clear'.
        Returns:
        Counter64 outDiscards, or null if it is not present.

      • requireOutDiscards

        default @NonNull Counter64 requireOutDiscards()
        Return outDiscards, guaranteed to be non-null. 
             
         The number of outbound packets that were chosen to be discarded even though no
         errors had been detected to prevent their being transmitted. One possible reason
         for discarding such a packet could be to free up buffer space. Discontinuities
         in the value of this counter can occur at re-initialization of the management
         system, and at other times as indicated by the value of 'last-clear'.
        Returns:
        Counter64 outDiscards, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if outDiscards is not present

      • getOutErrors

        Counter64 getOutErrors()
        Return outErrors, or null if it is not present. 
             
         For packet-oriented interfaces, the number of outbound packets that could not be
         transmitted because of errors. For character-oriented or fixed-length
         interfaces, the number of outbound transmission units that could not be
         transmitted because of errors. Discontinuities in the value of this counter can
         occur at re-initialization of the management system, and at other times as
         indicated by the value of 'last-clear'.
        Returns:
        Counter64 outErrors, or null if it is not present.

      • requireOutErrors

        default @NonNull Counter64 requireOutErrors()
        Return outErrors, guaranteed to be non-null. 
             
         For packet-oriented interfaces, the number of outbound packets that could not be
         transmitted because of errors. For character-oriented or fixed-length
         interfaces, the number of outbound transmission units that could not be
         transmitted because of errors. Discontinuities in the value of this counter can
         occur at re-initialization of the management system, and at other times as
         indicated by the value of 'last-clear'.
        Returns:
        Counter64 outErrors, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if outErrors is not present

      • getCarrierTransitions

        Counter64 getCarrierTransitions()
        Return carrierTransitions, or null if it is not present. 
             
         Number of times the interface state has transitioned between up and down since
         the time the device restarted or the last-clear time, whichever is most recent.
        Returns:
        Counter64 carrierTransitions, or null if it is not present.

      • requireCarrierTransitions

        default @NonNull Counter64 requireCarrierTransitions()
        Return carrierTransitions, guaranteed to be non-null. 
             
         Number of times the interface state has transitioned between up and down since
         the time the device restarted or the last-clear time, whichever is most recent.
        Returns:
        Counter64 carrierTransitions, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if carrierTransitions is not present

      • getLastClear

        Timeticks64 getLastClear()
        Return lastClear, or null if it is not present. 
             
         Timestamp of the last time the interface counters were cleared. The value is the
         timestamp in nanoseconds relative to the Unix Epoch (Jan 1, 1970 00:00:00 UTC).
        Returns:
        Timeticks64 lastClear, or null if it is not present.

      • requireLastClear

        default @NonNull Timeticks64 requireLastClear()
        Return lastClear, guaranteed to be non-null. 
             
         Timestamp of the last time the interface counters were cleared. The value is the
         timestamp in nanoseconds relative to the Unix Epoch (Jan 1, 1970 00:00:00 UTC).
        Returns:
        Timeticks64 lastClear, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if lastClear is not present