MeterRequest (ONOS Java API (2.5.4))

All Superinterfaces:

Annotated

All Known Implementing Classes:

DefaultMeterRequest
```
public interface MeterRequest
extends Annotated
```
Represents a generalized meter request to be deployed on a device.

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static interface MeterRequest.Builder
A meter builder.

static class MeterRequest.Type

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`ApplicationId`	`appId()`	The id of the application which created this meter.
`Collection<Band>`	`bands()`	The collection of bands to apply on the dataplane.
`Optional<MeterContext>`	`context()`	Returns the callback context for this meter.
`DeviceId`	`deviceId()`	The target device for this meter.
`Optional<Long>`	`index()`	Returns the desired meter index of this meter request.
`boolean`	`isBurst()`	Signals whether this meter applies to bursts only.
`MeterScope`	`scope()`	Returns the scope of this meter request.
`Meter.Unit`	`unit()`	The unit used within this meter.

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

- Method Detail
  - deviceId
```
DeviceId deviceId()
```
    The target device for this meter.
    
    Returns:
    
    a device id
  - appId
```
ApplicationId appId()
```
    The id of the application which created this meter.
    
    Returns:
    
    an application id
  - unit
```
Meter.Unit unit()
```
    The unit used within this meter.
    
    Returns:
    
    the unit
  - isBurst
```
boolean isBurst()
```
    Signals whether this meter applies to bursts only.
    
    Returns:
    
    a boolean
  - bands
```
Collection<Band> bands()
```
    The collection of bands to apply on the dataplane.
    
    Returns:
    
    a collection of bands.
  - context
```
Optional<MeterContext> context()
```
    Returns the callback context for this meter.
    
    Returns:
    
    an optional meter context
  - scope
```
MeterScope scope()
```
    Returns the scope of this meter request.
    
    Returns:
    
    a meter scope
  - index
```
Optional<Long> index()
```
    Returns the desired meter index of this meter request.
    
    Returns:
    
    an optional long index