Package org.onosproject.net.meter
Interface MeterRequest
-
- All Known Implementing Classes:
DefaultMeterRequest
public interface MeterRequest
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.java.util.Collection<Band>
bands()
The collection of bands to apply on the dataplane.java.util.Optional<MeterContext>
context()
Returns the callback context for this meter.DeviceId
deviceId()
The target device for this meter.boolean
isBurst()
Signals whether this meter applies to bursts only.Meter.Unit
unit()
The unit used within this meter.
-
-
-
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
java.util.Collection<Band> bands()
The collection of bands to apply on the dataplane.- Returns:
- a collection of bands.
-
context
java.util.Optional<MeterContext> context()
Returns the callback context for this meter.- Returns:
- an optional meter context
-
-