org.ovirt.engine.sdk4.services.StatisticsService Maven / Gradle / Ivy
/*
Copyright (c) 2015 Red Hat, Inc.
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 org.ovirt.engine.sdk4.services;
import java.io.IOException;
import java.math.BigInteger;
import java.util.List;
import org.ovirt.engine.sdk4.Request;
import org.ovirt.engine.sdk4.Response;
import org.ovirt.engine.sdk4.Service;
import org.ovirt.engine.sdk4.types.Statistic;
public interface StatisticsService extends Service {
/**
* Retrieves a list of statistics.
*
* For example, to retrieve the statistics for virtual machine `123` send a
* request like this:
*
* [source]
* ----
* GET /ovirt-engine/api/vms/123/statistics
* ----
*
* The result will be like this:
*
* [source,xml]
* ----
*
*
* memory.installed
* Total memory configured
* gauge
* integer
* bytes
*
*
* 1073741824
*
*
*
* ...
*
* ----
*
* Just a single part of the statistics can be retrieved by specifying its id at the end of the URI. That means:
*
* [source]
* ----
* GET /ovirt-engine/api/vms/123/statistics/456
* ----
*
* Outputs:
*
* [source,xml]
* ----
*
* memory.installed
* Total memory configured
* gauge
* integer
* bytes
*
*
* 1073741824
*
*
*
* ----
*/
public interface ListRequest extends Request {
/**
* Sets the maximum number of statistics to return. If not specified all the statistics are returned.
*/
ListRequest max(Integer max);
/**
* Sets the maximum number of statistics to return. If not specified all the statistics are returned.
*/
ListRequest max(Long max);
/**
* Sets the maximum number of statistics to return. If not specified all the statistics are returned.
*/
ListRequest max(BigInteger max);
}
/**
* Retrieves a list of statistics.
*
* For example, to retrieve the statistics for virtual machine `123` send a
* request like this:
*
* [source]
* ----
* GET /ovirt-engine/api/vms/123/statistics
* ----
*
* The result will be like this:
*
* [source,xml]
* ----
*
*
* memory.installed
* Total memory configured
* gauge
* integer
* bytes
*
*
* 1073741824
*
*
*
* ...
*
* ----
*
* Just a single part of the statistics can be retrieved by specifying its id at the end of the URI. That means:
*
* [source]
* ----
* GET /ovirt-engine/api/vms/123/statistics/456
* ----
*
* Outputs:
*
* [source,xml]
* ----
*
* memory.installed
* Total memory configured
* gauge
* integer
* bytes
*
*
* 1073741824
*
*
*
* ----
*/
public interface ListResponse extends Response {
List statistics();
}
/**
* Retrieves a list of statistics.
*
* For example, to retrieve the statistics for virtual machine `123` send a
* request like this:
*
* [source]
* ----
* GET /ovirt-engine/api/vms/123/statistics
* ----
*
* The result will be like this:
*
* [source,xml]
* ----
*
*
* memory.installed
* Total memory configured
* gauge
* integer
* bytes
*
*
* 1073741824
*
*
*
* ...
*
* ----
*
* Just a single part of the statistics can be retrieved by specifying its id at the end of the URI. That means:
*
* [source]
* ----
* GET /ovirt-engine/api/vms/123/statistics/456
* ----
*
* Outputs:
*
* [source,xml]
* ----
*
* memory.installed
* Total memory configured
* gauge
* integer
* bytes
*
*
* 1073741824
*
*
*
* ----
*/
ListRequest list();
StatisticService statisticService(String id);
/**
* Service locator method, returns individual service on which the URI is dispatched.
*/
Service service(String path);
}