com.xensource.xenapi
Class VMGuestMetrics

java.lang.Object
  com.xensource.xenapi.VMGuestMetrics

public class VMGuestMetrics
extends Object

The metrics reported by the guest (as opposed to inferred from outside)

Nested Class Summary

static class

VMGuestMetrics.Record Represents all the fields in a VMGuestMetrics

Field Summary

protected String

ref The XenAPI reference to this object.

Method Summary

static Set<VMGuestMetrics>	getAll() Return a list of all the VM_guest_metrics instances known to the system.
static Map<VMGuestMetrics,VMGuestMetrics.Record>	getAllRecords() Get all the VMGuestMetrics Records at once, in a single XML RPC call
static VMGuestMetrics	getByUuid(String uuid) Get a reference to the VM_guest_metrics instance with the specified UUID.
Map<String,String>	getDisks() Get the disks field of the given VM_guest_metrics.
protected static VMGuestMetrics	getInstFromRef(String ref)
Date	getLastUpdated() Get the last_updated field of the given VM_guest_metrics.
Map<String,String>	getMemory() Get the memory field of the given VM_guest_metrics.
Map<String,String>	getNetworks() Get the networks field of the given VM_guest_metrics.
Map<String,String>	getOsVersion() Get the os_version field of the given VM_guest_metrics.
Map<String,String>	getOther() Get the other field of the given VM_guest_metrics.
Map<String,String>	getPVDriversVersion() Get the PV_drivers_version field of the given VM_guest_metrics.
VMGuestMetrics.Record	getRecord() Get a record containing the current state of the given VM_guest_metrics.
String	getUuid() Get the uuid field of the given VM_guest_metrics.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ref

protected final String ref

The XenAPI reference to this object.

Method Detail

getInstFromRef

protected static VMGuestMetrics getInstFromRef(String ref)

getRecord

public VMGuestMetrics.Record getRecord()
                                throws Types.BadServerResponse,
                                       ConnectionHelper.NoConnectionOnThisThreadException,
                                       XmlRpcException

Get a record containing the current state of the given VM_guest_metrics.

Returns:

all fields from the object

Throws:

Types.BadServerResponse

ConnectionHelper.NoConnectionOnThisThreadException

XmlRpcException

getByUuid

public static VMGuestMetrics getByUuid(String uuid)
                                throws Types.BadServerResponse,
                                       ConnectionHelper.NoConnectionOnThisThreadException,
                                       XmlRpcException

Get a reference to the VM_guest_metrics instance with the specified UUID.

Parameters:

uuid - UUID of object to return

Returns:

reference to the object

Throws:

Types.BadServerResponse

ConnectionHelper.NoConnectionOnThisThreadException

XmlRpcException

getUuid

public String getUuid()
               throws Types.BadServerResponse,
                      ConnectionHelper.NoConnectionOnThisThreadException,
                      XmlRpcException

Get the uuid field of the given VM_guest_metrics.

Returns:

value of the field

Throws:

Types.BadServerResponse

ConnectionHelper.NoConnectionOnThisThreadException

XmlRpcException

getOsVersion

public Map<String,String> getOsVersion()
                                throws Types.BadServerResponse,
                                       ConnectionHelper.NoConnectionOnThisThreadException,
                                       XmlRpcException

Get the os_version field of the given VM_guest_metrics.

Returns:

value of the field

Throws:

Types.BadServerResponse

ConnectionHelper.NoConnectionOnThisThreadException

XmlRpcException

getPVDriversVersion

public Map<String,String> getPVDriversVersion()
                                       throws Types.BadServerResponse,
                                              ConnectionHelper.NoConnectionOnThisThreadException,
                                              XmlRpcException

Get the PV_drivers_version field of the given VM_guest_metrics.

Returns:

value of the field

Throws:

Types.BadServerResponse

ConnectionHelper.NoConnectionOnThisThreadException

XmlRpcException

getMemory

public Map<String,String> getMemory()
                             throws Types.BadServerResponse,
                                    ConnectionHelper.NoConnectionOnThisThreadException,
                                    XmlRpcException

Get the memory field of the given VM_guest_metrics.

Returns:

value of the field

Throws:

Types.BadServerResponse

ConnectionHelper.NoConnectionOnThisThreadException

XmlRpcException

getDisks

public Map<String,String> getDisks()
                            throws Types.BadServerResponse,
                                   ConnectionHelper.NoConnectionOnThisThreadException,
                                   XmlRpcException

Get the disks field of the given VM_guest_metrics.

Returns:

value of the field

Throws:

Types.BadServerResponse

ConnectionHelper.NoConnectionOnThisThreadException

XmlRpcException

getNetworks

public Map<String,String> getNetworks()
                               throws Types.BadServerResponse,
                                      ConnectionHelper.NoConnectionOnThisThreadException,
                                      XmlRpcException

Get the networks field of the given VM_guest_metrics.

Returns:

value of the field

Throws:

Types.BadServerResponse

ConnectionHelper.NoConnectionOnThisThreadException

XmlRpcException

getOther

public Map<String,String> getOther()
                            throws Types.BadServerResponse,
                                   ConnectionHelper.NoConnectionOnThisThreadException,
                                   XmlRpcException

Get the other field of the given VM_guest_metrics.

Returns:

value of the field

Throws:

Types.BadServerResponse

ConnectionHelper.NoConnectionOnThisThreadException

XmlRpcException

getLastUpdated

public Date getLastUpdated()
                    throws Types.BadServerResponse,
                           ConnectionHelper.NoConnectionOnThisThreadException,
                           XmlRpcException

Get the last_updated field of the given VM_guest_metrics.

Returns:

value of the field

Throws:

Types.BadServerResponse

ConnectionHelper.NoConnectionOnThisThreadException

XmlRpcException

getAll

public static Set<VMGuestMetrics> getAll()
                                  throws Types.BadServerResponse,
                                         ConnectionHelper.NoConnectionOnThisThreadException,
                                         XmlRpcException

Return a list of all the VM_guest_metrics instances known to the system.

Returns:

references to all objects

Throws:

Types.BadServerResponse

ConnectionHelper.NoConnectionOnThisThreadException

XmlRpcException

getAllRecords

public static Map<VMGuestMetrics,VMGuestMetrics.Record> getAllRecords()
                                                               throws Types.BadServerResponse,
                                                                      ConnectionHelper.NoConnectionOnThisThreadException,
                                                                      XmlRpcException

Get all the VMGuestMetrics Records at once, in a single XML RPC call

Returns:

A map from VMGuestMetrics to VMGuestMetrics.Record

Throws:

Types.BadServerResponse

ConnectionHelper.NoConnectionOnThisThreadException

XmlRpcException