org.openstack4j.api.telemetry

Interface MeterService

All Superinterfaces:

RestService

All Known Implementing Classes:

MeterServiceImpl

public interface MeterService
extends RestService

Provides Measurements against Meters within an OpenStack deployment

Author:

Jeremy Unruh

Method Summary

Modifier and Type	Method and Description
List<? extends Meter>	list() Return all known meters, based on the data recorded so far.
void	putSamples(List<MeterSample> sampleList, String meterName)
List<? extends MeterSample>	samples(String meterName) Returns samples for the specified Meter
List<? extends MeterSample>	samples(String meterName, SampleCriteria criteria) Returns samples for the specified Meter
List<? extends Statistics>	statistics(String meterName) Returns computed statistics for the given meterName
List<? extends Statistics>	statistics(String meterName, int period) Returns computed statistics for the given meterName for the given time range
List<? extends Statistics>	statistics(String meterName, SampleCriteria criteria) Returns computed statistics for the given meterName
List<? extends Statistics>	statistics(String meterName, SampleCriteria criteria, int period) Returns computed statistics for the given meterName

Method Detail

list

List<? extends Meter> list()

Return all known meters, based on the data recorded so far.

Returns:

list of all known meters

samples

List<? extends MeterSample> samples(String meterName)

Returns samples for the specified Meter

Parameters:

meterName - the name of the meter to fetch samples from

Returns:

List of Samples

samples

List<? extends MeterSample> samples(String meterName,
                                    SampleCriteria criteria)

Returns samples for the specified Meter

Parameters:

meterName - the name of the meter to fetch samples from

criteria - the sample query criteria for filtering results

Returns:

List of Samples

statistics

List<? extends Statistics> statistics(String meterName)

Returns computed statistics for the given meterName

Parameters:

meterName - the name of the meter to fetch statistics for

Returns:

List of Statistics

statistics

List<? extends Statistics> statistics(String meterName,
                                      SampleCriteria criteria)

Returns computed statistics for the given meterName

Parameters:

meterName - the name of the meter to fetch statistics for

criteria - additional query criteria

Returns:

List of Statistics

statistics

List<? extends Statistics> statistics(String meterName,
                                      SampleCriteria criteria,
                                      int period)

Returns computed statistics for the given meterName

Parameters:

meterName - the name of the meter to fetch statistics for

criteria - additional query criteria

period - the result will be statistics for a period long of that number of seconds

Returns:

List of Statistics

statistics

List<? extends Statistics> statistics(String meterName,
                                      int period)

Returns computed statistics for the given meterName for the given time range

Parameters:

meterName - the name of the meter to fetch statistics for

period - the result will be statistics for a period long of that number of seconds

Returns:

List of Statistics

putSamples

void putSamples(List<MeterSample> sampleList,
                String meterName)