UpfSessionUplink (ONOS Java API (2.5.7))

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

All Implemented Interfaces:

UpfEntity
```
@Beta
public final class UpfSessionUplink
extends Object
implements UpfEntity
```
A structure representing the UE Session on the UPF-programmable device. Provide means to set up the UPF UE Session in the uplink direction.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class UpfSessionUplink.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 UpfSessionUplink.Builder`	`builder()`
`boolean`	`equals(Object object)`
`int`	`hashCode()`
`boolean`	`needsDropping()`	True if this UPF UE Session needs dropping of the uplink traffic.
`int`	`sessionMeterIdx()`	Get the session meter index that is set by this UPF UE Session rule.
`Integer`	`teid()`	Get the identifier of the GTP tunnel that this UPF UE Session rule matches on.
`String`	`toString()`
`Ip4Address`	`tunDstAddr()`	Get the tunnel destination IP address in the uplink UPF UE session (N3/S1U IP address).
`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 UpfSessionUplink.Builder builder()
```
  - equals
```
public boolean equals(Object object)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - needsDropping
```
public boolean needsDropping()
```
    True if this UPF UE Session needs dropping of the uplink traffic.
    
    Returns:
    
    true if the UE Session needs dropping.
  - tunDstAddr
```
public Ip4Address tunDstAddr()
```
    Get the tunnel destination IP address in the uplink UPF UE session (N3/S1U IP address).
    
    Returns:
    
    UE IP address
  - teid
```
public Integer teid()
```
    Get the identifier of the GTP tunnel that this UPF UE Session rule matches on.
    
    Returns:
    
    GTP tunnel ID
  - sessionMeterIdx
```
public int sessionMeterIdx()
```
    Get the session meter index that is set by this UPF UE Session rule.
    
    Returns:
    
    Session meter index
  - type
```
public UpfEntityType type()
```
    Description copied from interface: UpfEntity
    
    Returns the type of this entity.
    
    Specified by:
    
    type in interface UpfEntity
    
    Returns:
    
    entity type