types.NumaNode 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 types;

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

/**
 * Represents a physical NUMA node.
 *
 * Example XML representation:
 *
 * [source,xml]
 * ----
 * 
 *   
 *     
 *       
 *         0
 *       
 *     
 *   
 *   0
 *   65536
 *   40 20 40 10
 *   
 * 
 * ----
 *
 * @author Andrej Krejcir 
 * @author Tahlia Richardson 
 * @date 16 Nov 2016
 * @status updated_by_docs
 */
@Type
public interface NumaNode extends Identified {
    Integer index();

    /**
     * Memory of the NUMA node in MB.
     *
     * @author Andrej Krejcir 
     * @author Tahlia Richardson 
     * @date 16 Nov 2016
     * @status updated_by_docs
     */
    Integer memory();
    Cpu cpu();
    String nodeDistance();

    @Link Host host();

    /**
     * Each host NUMA node resource exposes a statistics sub-collection for host NUMA node specific statistics.
     *
     * An example of an XML representation:
     *
     * [source,xml]
     * ----
     * 
     *   
     *     memory.total
     *     Total memory
     *     gauge
     *     integer
     *     bytes
     *     
     *       
     *         25165824000
     *       
     *     
     *     
     *   
     *     ...
     * 
     * ----
     *
     * NOTE: This statistics sub-collection is read-only.
     *
     * The following list shows the statistic types for a host NUMA node:
     *
     * |===
     * |Name |Description
     *
     * |`memory.total`
     * |Total memory in bytes on the NUMA node.
     *
     * |`memory.used`
     * |Memory in bytes used on the NUMA node.
     *
     * |`memory.free`
     * |Memory in bytes free on the NUMA node.
     *
     * |`cpu.current.user`
     * |Percentage of CPU usage for user slice.
     *
     * |`cpu.current.system`
     * |Percentage of CPU usage for system.
     *
     * |`cpu.current.idle`
     * |Percentage of idle CPU usage.
     * |===
     *
     * @author Artyom Lukianov 
     * @date 12 Dec 2016
     * @status added
     */
    @Link Statistic[] statistics();
}