com.xensource.xenapi
Class PIFMetrics

java.lang.Object
  com.xensource.xenapi.PIFMetrics

public class PIFMetrics
extends Object

The metrics associated with a physical network interface

Nested Class Summary

static class

PIFMetrics.Record Represents all the fields in a PIFMetrics

Field Summary

protected String

ref The XenAPI reference to this object.

Method Summary

static Set<PIFMetrics>	getAll() Return a list of all the PIF_metrics instances known to the system.
static Map<PIFMetrics,PIFMetrics.Record>	getAllRecords() Get all the PIFMetrics Records at once, in a single XML RPC call
static PIFMetrics	getByUuid(String uuid) Get a reference to the PIF_metrics instance with the specified UUID.
protected static PIFMetrics	getInstFromRef(String ref)
Double	getIoReadKbs() Get the io/read_kbs field of the given PIF_metrics.
Double	getIoWriteKbs() Get the io/write_kbs field of the given PIF_metrics.
Date	getLastUpdated() Get the last_updated field of the given PIF_metrics.
PIFMetrics.Record	getRecord() Get a record containing the current state of the given PIF_metrics.
String	getUuid() Get the uuid field of the given PIF_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 PIFMetrics getInstFromRef(String ref)

getRecord

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

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

Returns:

all fields from the object

Throws:

Types.BadServerResponse

ConnectionHelper.NoConnectionOnThisThreadException

XmlRpcException

getByUuid

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

Get a reference to the PIF_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 PIF_metrics.

Returns:

value of the field

Throws:

Types.BadServerResponse

ConnectionHelper.NoConnectionOnThisThreadException

XmlRpcException

getIoReadKbs

public Double getIoReadKbs()
                    throws Types.BadServerResponse,
                           ConnectionHelper.NoConnectionOnThisThreadException,
                           XmlRpcException

Get the io/read_kbs field of the given PIF_metrics.

Returns:

value of the field

Throws:

Types.BadServerResponse

ConnectionHelper.NoConnectionOnThisThreadException

XmlRpcException

getIoWriteKbs

public Double getIoWriteKbs()
                     throws Types.BadServerResponse,
                            ConnectionHelper.NoConnectionOnThisThreadException,
                            XmlRpcException

Get the io/write_kbs field of the given PIF_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 PIF_metrics.

Returns:

value of the field

Throws:

Types.BadServerResponse

ConnectionHelper.NoConnectionOnThisThreadException

XmlRpcException

getAll

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

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

Returns:

references to all objects

Throws:

Types.BadServerResponse

ConnectionHelper.NoConnectionOnThisThreadException

XmlRpcException

getAllRecords

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

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

Returns:

A map from PIFMetrics to PIFMetrics.Record

Throws:

Types.BadServerResponse

ConnectionHelper.NoConnectionOnThisThreadException

XmlRpcException