QosDescription (ONOS Java API (2.5.0))

All Superinterfaces:

Annotated, Description

All Known Implementing Classes:

DefaultQosDescription
```
@Beta
public interface QosDescription
extends Description, Annotated
```
Default implementation of immutable Qos description.

Nested Class Summary

Nested Classes
Modifier and Type	Interface	Description
`static interface`	`QosDescription.Builder`	Builder of qos description entities.
`static class`	`QosDescription.Type`	Denotes the type of the Qos.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`Optional<Long>`	`cbs()`	Returns Committed Burst Size of Qos, Valid only in specific qos type.
`Optional<Long>`	`cir()`	Returns Committed Information Rate of Qos, Valid only in specific qos type.
`Optional<Bandwidth>`	`maxRate()`	Returns the max rate of qos, Valid only in specific qos type.
`QosId`	`qosId()`	Returns qos identifier.
`Optional<Map<Long,QueueDescription>>`	`queues()`	Returns map of integer-Queue pairs, Valid only in specific qos type.
`QosDescription.Type`	`type()`	Returns qos type.

Methods inherited from interface org.onosproject.net.Description
annotations

- Method Detail
  - qosId
```
QosId qosId()
```
    Returns qos identifier.
    
    Returns:
    
    qos identifier
  - type
```
QosDescription.Type type()
```
    Returns qos type.
    
    Returns:
    
    qos type
  - maxRate
```
Optional<Bandwidth> maxRate()
```
    Returns the max rate of qos, Valid only in specific qos type.
    
    Returns:
    
    Maximum rate shared by all queued traffic, in bit/s.
  - cir
```
Optional<Long> cir()
```
    Returns Committed Information Rate of Qos, Valid only in specific qos type. the CIR is measured in bytes of IP packets per second.
    
    Returns:
    
    cir
  - cbs
```
Optional<Long> cbs()
```
    Returns Committed Burst Size of Qos, Valid only in specific qos type. the CBS is measured in bytes and represents a token bucket.
    
    Returns:
    
    cbs
  - queues
```
Optional<Map<Long,QueueDescription>> queues()
```
    Returns map of integer-Queue pairs, Valid only in specific qos type.
    
    Returns:
    
    queues