java.lang.Object
- org.onosproject.net.behaviour.upf.UpfCounter

All Implemented Interfaces:

UpfEntity
```
@Beta
public final class UpfCounter
extends Object
implements UpfEntity
```
A structure for compactly passing UPF counter values for a given counter ID. Contains four counts: Ingress Packets, Ingress Bytes, Egress Packets, Egress Bytes. UpfCounter can be used ONLY on apply and readAll calls in the UpfDevice interface.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class UpfCounter.Builder

Field Summary
- Fields inherited from interface org.onosproject.net.behaviour.upf.UpfEntity
  DEFAULT_APP_ID, DEFAULT_APP_INDEX, DEFAULT_SESSION_INDEX

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static UpfCounter.Builder`	`builder()`
`boolean`	`equals(Object object)`
`boolean`	`exactlyEquals(UpfCounter that)`	Returns whether this UpfCounter is exactly equal to the given UpfCounter, including their packets and bytes values.
`int`	`getCellId()`	Get the cell ID (index) of the dataplane counter that produced this set of stats.
`long`	`getEgressBytes()`	Get the number of packet bytes that hit this counter in the dataplane egress pipeline.
`long`	`getEgressPkts()`	Get the number of packets that hit this counter in the dataplane egress pipeline.
`long`	`getIngressBytes()`	Get the number of packet bytes that hit this counter in the dataplane ingress pipeline.
`long`	`getIngressPkts()`	Get the number of packets that hit this counter in the dataplane ingress pipeline.
`int`	`hashCode()`
`String`	`toString()`
`UpfEntityType`	`type()`	Returns the type of this entity.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - builder
```
public static UpfCounter.Builder builder()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object object)
```
    Overrides:
    
    equals in class Object
  - exactlyEquals
```
public boolean exactlyEquals(UpfCounter that)
```
    Returns whether this UpfCounter is exactly equal to the given UpfCounter, including their packets and bytes values.
    
    Parameters:
    
    that - other UpfCounter instance to compare
    
    Returns:
    
    true if exactly equals, false otherwise
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - getCellId
```
public int getCellId()
```
    Get the cell ID (index) of the dataplane counter that produced this set of stats.
    
    Returns:
    
    counter cell ID
  - getIngressPkts
```
public long getIngressPkts()
```
    Get the number of packets that hit this counter in the dataplane ingress pipeline.
    
    Returns:
    
    ingress packet count
  - getEgressPkts
```
public long getEgressPkts()
```
    Get the number of packets that hit this counter in the dataplane egress pipeline.
    
    Returns:
    
    egress packet count
  - getIngressBytes
```
public long getIngressBytes()
```
    Get the number of packet bytes that hit this counter in the dataplane ingress pipeline.
    
    Returns:
    
    ingress byte count
  - getEgressBytes
```
public long getEgressBytes()
```
    Get the number of packet bytes that hit this counter in the dataplane egress pipeline.
    
    Returns:
    
    egress byte count
  - type
```
public UpfEntityType type()
```
    Description copied from interface: UpfEntity
    
    Returns the type of this entity.
    
    Specified by:
    
    type in interface UpfEntity
    
    Returns:
    
    entity type

Class UpfCounter

Nested Class Summary

Field Summary

Fields inherited from interface org.onosproject.net.behaviour.upf.UpfEntity

Method Summary

Methods inherited from class java.lang.Object

Method Detail

builder

toString

equals

exactlyEquals

hashCode

getCellId

getIngressPkts

getEgressPkts

getIngressBytes

getEgressBytes

type