services.StatisticsService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of model Show documentation

Model management tools for the oVirt Engine API.

There is a newer version: 4.6.0

/*
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 services;

import annotations.Area;
import mixins.Follow;
import org.ovirt.api.metamodel.annotations.In;
import org.ovirt.api.metamodel.annotations.Out;
import org.ovirt.api.metamodel.annotations.Service;
import types.Statistic;

@Service
@Area("Infrastructure")
public interface StatisticsService {
    /**
     * 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
     *     
     *   
     *   
     * 
     * ----
     *
     * The order of the returned list of statistics isn't guaranteed.
     *
     * @author Juan Hernandez 
     * @date 15 Apr 2017
     * @status added
     */
    interface List extends Follow {
        @Out Statistic[] statistics();

        /**
         * Sets the maximum number of statistics to return. If not specified all the statistics are returned.
         */
        @In Integer max();
    }

    @Service StatisticService statistic(String id);
}