com.huawei.openstack4j.api.telemetry.MeterService Maven / Gradle / Ivy
/*******************************************************************************
* Copyright 2016 ContainX and OpenStack4j
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*******************************************************************************/
package com.huawei.openstack4j.api.telemetry;
import java.util.List;
import com.huawei.openstack4j.common.RestService;
import com.huawei.openstack4j.model.telemetry.Meter;
import com.huawei.openstack4j.model.telemetry.MeterSample;
import com.huawei.openstack4j.model.telemetry.SampleCriteria;
import com.huawei.openstack4j.model.telemetry.Statistics;
/**
* Provides Measurements against Meters within an OpenStack deployment
*
* @author Jeremy Unruh
*/
public interface MeterService extends RestService {
/**
* Return all known meters, based on the data recorded so far.
*
* @return list of all known meters
*/
List list();
/**
* Returns samples for the specified Meter
* @param meterName the name of the meter to fetch samples from
*
* @return List of Samples
*/
List samples(String meterName);
/**
* Returns samples for the specified Meter
* @param meterName the name of the meter to fetch samples from
* @param criteria the sample query criteria for filtering results
*
* @return List of Samples
*/
List samples(String meterName, SampleCriteria criteria);
/**
* Returns computed statistics for the given meterName
* @param meterName the name of the meter to fetch statistics for
*
* @return List of Statistics
*/
List statistics(String meterName);
/**
* Returns computed statistics for the given meterName
*
* @param meterName the name of the meter to fetch statistics for
* @param criteria additional query criteria
* @return List of Statistics
*/
List statistics(String meterName, SampleCriteria criteria);
/**
* Returns computed statistics for the given meterName
*
* @param meterName the name of the meter to fetch statistics for
* @param criteria additional query criteria
* @param period the result will be statistics for a period long of that number of seconds
* @return List of Statistics
*/
List statistics(String meterName, SampleCriteria criteria, int period);
/**
* Returns computed statistics for the given meterName for the given time range
*
* @param meterName the name of the meter to fetch statistics for
* @param period the result will be statistics for a period long of that number of seconds
* @return List of Statistics
*/
List statistics(String meterName, int period);
void putSamples(List sampleList, String meterName);
}