Interface MeterRequest

  • All Superinterfaces:
    Annotated
    All Known Implementing Classes:
    DefaultMeterRequest

    public interface MeterRequest
    extends Annotated
    Represents a generalized meter request to be deployed on a device.
    • 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