com.xensource.xenapi

Class VMMetrics

java.lang.Object

com.xensource.xenapi.XenAPIObject

com.xensource.xenapi.VMMetrics

public class VMMetrics
extends XenAPIObject

The metrics associated with a VM

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VMMetrics.Record Represents all the fields in a VMMetrics

Field Summary

Fields

Modifier and Type	Field and Description
protected String	ref The XenAPI reference to this object.

Method Summary

Methods

Modifier and Type	Method and Description
void	addToOtherConfig(Connection c, String key, String value) Add the given key-value pair to the other_config field of the given VM_metrics.
boolean	equals(Object obj) If obj is a VMMetrics, compares XenAPI references for equality.
static Set<VMMetrics>	getAll(Connection c) Return a list of all the VM_metrics instances known to the system.
static Map<VMMetrics,VMMetrics.Record>	getAllRecords(Connection c) Return a map of VM_metrics references to VM_metrics records for all VM_metrics instances known to the system.
static VMMetrics	getByUuid(Connection c, String uuid) Get a reference to the VM_metrics instance with the specified UUID.
Date	getInstallTime(Connection c) Get the install_time field of the given VM_metrics.
Date	getLastUpdated(Connection c) Get the last_updated field of the given VM_metrics.
Long	getMemoryActual(Connection c) Get the memory/actual field of the given VM_metrics.
Map<String,String>	getOtherConfig(Connection c) Get the other_config field of the given VM_metrics.
VMMetrics.Record	getRecord(Connection c) Get a record containing the current state of the given VM_metrics.
Date	getStartTime(Connection c) Get the start_time field of the given VM_metrics.
Set<String>	getState(Connection c) Get the state field of the given VM_metrics.
String	getUuid(Connection c) Get the uuid field of the given VM_metrics.
Map<Long,Long>	getVCPUsCPU(Connection c) Get the VCPUs/CPU field of the given VM_metrics.
Map<Long,Set<String>>	getVCPUsFlags(Connection c) Get the VCPUs/flags field of the given VM_metrics.
Long	getVCPUsNumber(Connection c) Get the VCPUs/number field of the given VM_metrics.
Map<String,String>	getVCPUsParams(Connection c) Get the VCPUs/params field of the given VM_metrics.
Map<Long,Double>	getVCPUsUtilisation(Connection c) Get the VCPUs/utilisation field of the given VM_metrics.
int	hashCode()
void	removeFromOtherConfig(Connection c, String key) Remove the given key and its corresponding value from the other_config field of the given VM_metrics.
void	setOtherConfig(Connection c, Map<String,String> otherConfig) Set the other_config field of the given VM_metrics.
String	toWireString()

Methods inherited from class java.lang.Object

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

Field Detail

ref

protected final String ref

The XenAPI reference to this object.

Method Detail

toWireString

public String toWireString()

Specified by:

toWireString in class XenAPIObject

equals

public boolean equals(Object obj)

If obj is a VMMetrics, compares XenAPI references for equality.

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getRecord

public VMMetrics.Record getRecord(Connection c)
                           throws Types.BadServerResponse,
                                  Types.XenAPIException,
                                  org.apache.xmlrpc.XmlRpcException

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

Returns:

all fields from the object

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getByUuid

public static VMMetrics getByUuid(Connection c,
                  String uuid)
                           throws Types.BadServerResponse,
                                  Types.XenAPIException,
                                  org.apache.xmlrpc.XmlRpcException

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

Parameters:

uuid - UUID of object to return

Returns:

reference to the object

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getUuid

public String getUuid(Connection c)
               throws Types.BadServerResponse,
                      Types.XenAPIException,
                      org.apache.xmlrpc.XmlRpcException

Get the uuid field of the given VM_metrics.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getMemoryActual

public Long getMemoryActual(Connection c)
                     throws Types.BadServerResponse,
                            Types.XenAPIException,
                            org.apache.xmlrpc.XmlRpcException

Get the memory/actual field of the given VM_metrics.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getVCPUsNumber

public Long getVCPUsNumber(Connection c)
                    throws Types.BadServerResponse,
                           Types.XenAPIException,
                           org.apache.xmlrpc.XmlRpcException

Get the VCPUs/number field of the given VM_metrics.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getVCPUsUtilisation

public Map<Long,Double> getVCPUsUtilisation(Connection c)
                                     throws Types.BadServerResponse,
                                            Types.XenAPIException,
                                            org.apache.xmlrpc.XmlRpcException

Get the VCPUs/utilisation field of the given VM_metrics.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getVCPUsCPU

public Map<Long,Long> getVCPUsCPU(Connection c)
                           throws Types.BadServerResponse,
                                  Types.XenAPIException,
                                  org.apache.xmlrpc.XmlRpcException

Get the VCPUs/CPU field of the given VM_metrics.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getVCPUsParams

public Map<String,String> getVCPUsParams(Connection c)
                                  throws Types.BadServerResponse,
                                         Types.XenAPIException,
                                         org.apache.xmlrpc.XmlRpcException

Get the VCPUs/params field of the given VM_metrics.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getVCPUsFlags

public Map<Long,Set<String>> getVCPUsFlags(Connection c)
                                    throws Types.BadServerResponse,
                                           Types.XenAPIException,
                                           org.apache.xmlrpc.XmlRpcException

Get the VCPUs/flags field of the given VM_metrics.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getState

public Set<String> getState(Connection c)
                     throws Types.BadServerResponse,
                            Types.XenAPIException,
                            org.apache.xmlrpc.XmlRpcException

Get the state field of the given VM_metrics.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getStartTime

public Date getStartTime(Connection c)
                  throws Types.BadServerResponse,
                         Types.XenAPIException,
                         org.apache.xmlrpc.XmlRpcException

Get the start_time field of the given VM_metrics.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getInstallTime

public Date getInstallTime(Connection c)
                    throws Types.BadServerResponse,
                           Types.XenAPIException,
                           org.apache.xmlrpc.XmlRpcException

Get the install_time field of the given VM_metrics.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getLastUpdated

public Date getLastUpdated(Connection c)
                    throws Types.BadServerResponse,
                           Types.XenAPIException,
                           org.apache.xmlrpc.XmlRpcException

Get the last_updated field of the given VM_metrics.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getOtherConfig

public Map<String,String> getOtherConfig(Connection c)
                                  throws Types.BadServerResponse,
                                         Types.XenAPIException,
                                         org.apache.xmlrpc.XmlRpcException

Get the other_config field of the given VM_metrics.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

setOtherConfig

public void setOtherConfig(Connection c,
                  Map<String,String> otherConfig)
                    throws Types.BadServerResponse,
                           Types.XenAPIException,
                           org.apache.xmlrpc.XmlRpcException

Set the other_config field of the given VM_metrics.

Parameters:

otherConfig - New value to set

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

addToOtherConfig

public void addToOtherConfig(Connection c,
                    String key,
                    String value)
                      throws Types.BadServerResponse,
                             Types.XenAPIException,
                             org.apache.xmlrpc.XmlRpcException

Add the given key-value pair to the other_config field of the given VM_metrics.

Parameters:

key - Key to add

value - Value to add

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

removeFromOtherConfig

public void removeFromOtherConfig(Connection c,
                         String key)
                           throws Types.BadServerResponse,
                                  Types.XenAPIException,
                                  org.apache.xmlrpc.XmlRpcException

Remove the given key and its corresponding value from the other_config field of the given VM_metrics. If the key is not in that Map, then do nothing.

Parameters:

key - Key to remove

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getAll

public static Set<VMMetrics> getAll(Connection c)
                             throws Types.BadServerResponse,
                                    Types.XenAPIException,
                                    org.apache.xmlrpc.XmlRpcException

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

Returns:

references to all objects

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getAllRecords

public static Map<VMMetrics,VMMetrics.Record> getAllRecords(Connection c)
                                                     throws Types.BadServerResponse,
                                                            Types.XenAPIException,
                                                            org.apache.xmlrpc.XmlRpcException

Return a map of VM_metrics references to VM_metrics records for all VM_metrics instances known to the system.

Returns:

records of all objects

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException