types.Api 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) 2016 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 types;

import java.util.Date;

import org.ovirt.api.metamodel.annotations.Type;

/**
 * This type contains the information returned by root service of the API.
 */
@Type
public interface Api {
    /**
     * References to special objects, like the blank template and the root of the hierarchy of tags.
     */
    SpecialObjects specialObjects();

    /**
     * Information about the product, like its name, the name of the vendor and the version.
     */
    ProductInfo productInfo();

    /**
     * A summary containing the total number of relevant objects, like virtual machines, hosts and storage domains.
     */
    ApiSummary summary();

    /**
     * The date and time when this information was generated.
     */
    Date time();
}