Package com.xensource.xenapi

Class VBDMetrics

java.lang.Object

com.xensource.xenapi.XenAPIObject

com.xensource.xenapi.VBDMetrics

public class VBDMetrics
extends XenAPIObject

The metrics associated with a virtual block device First published in XenServer 4.0.

Author:

Cloud Software Group, Inc.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	ref	The XenAPI reference (OpaqueRef) to this object.

Method Summary

Modifier and Type	Method	Description
void	addToOtherConfig(Connection c, String key, String value)	Deprecated. since XenServer 6.1
boolean	equals(Object obj)	If obj is a VBDMetrics, compares XenAPI references for equality.
static Set<VBDMetrics>	getAll(Connection c)	Deprecated. since XenServer 6.1
static Map<VBDMetrics,VBDMetrics.Record>	getAllRecords(Connection c)	Return a map of VBD_metrics references to VBD_metrics records for all VBD_metrics instances known to the system.
static VBDMetrics	getByUuid(Connection c, String uuid)	Deprecated. since XenServer 6.1
Double	getIoReadKbs(Connection c)	Deprecated. since XenServer 6.1
Double	getIoWriteKbs(Connection c)	Deprecated. since XenServer 6.1
Date	getLastUpdated(Connection c)	Deprecated. since XenServer 6.1
Map<String,String>	getOtherConfig(Connection c)	Deprecated. since XenServer 6.1
VBDMetrics.Record	getRecord(Connection c)	Deprecated. since XenServer 6.1
String	getUuid(Connection c)	Get the uuid field of the given VBD_metrics.
int	hashCode()
void	removeFromOtherConfig(Connection c, String key)	Deprecated. since XenServer 6.1
void	setOtherConfig(Connection c, Map<String,String> otherConfig)	Deprecated. since XenServer 6.1
String	toWireString()

Methods inherited from class com.xensource.xenapi.XenAPIObject

isNull

Methods inherited from class java.lang.Object

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

Field Details

ref

protected final String ref

The XenAPI reference (OpaqueRef) to this object.

Method Details

toWireString

public String toWireString()

Specified by:

toWireString in class XenAPIObject

Returns:

The XenAPI reference (OpaqueRef) to this object.

equals

public boolean equals(Object obj)

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

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getRecord

@Deprecated(since="XenServer 6.1")
public VBDMetrics.Record getRecord(Connection c)
                            throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Deprecated.

since XenServer 6.1

Get a record containing the current state of the given VBD_metrics. Minimum allowed role: read-only First published in XenServer 4.0.

Parameters:

c - The connection the call is made on

Returns:

all fields from the object

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getByUuid

@Deprecated(since="XenServer 6.1")
public static VBDMetrics getByUuid(Connection c,
 String uuid)
                            throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Deprecated.

since XenServer 6.1

Get a reference to the VBD_metrics instance with the specified UUID. Minimum allowed role: read-only First published in XenServer 4.0.

Parameters:

c - The connection the call is made on

uuid - UUID of object to return

Returns:

reference to the object

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getUuid

public String getUuid(Connection c)
               throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get the uuid field of the given VBD_metrics. Minimum allowed role: read-only First published in XenServer 4.0.

Parameters:

c - The connection the call is made on

Returns:

value of the field

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getIoReadKbs

@Deprecated(since="XenServer 6.1")
public Double getIoReadKbs(Connection c)
                    throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Deprecated.

since XenServer 6.1

Get the io/read_kbs field of the given VBD_metrics. Minimum allowed role: read-only First published in XenServer 4.0.

Parameters:

c - The connection the call is made on

Returns:

value of the field

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getIoWriteKbs

@Deprecated(since="XenServer 6.1")
public Double getIoWriteKbs(Connection c)
                     throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Deprecated.

since XenServer 6.1

Get the io/write_kbs field of the given VBD_metrics. Minimum allowed role: read-only First published in XenServer 4.0.

Parameters:

c - The connection the call is made on

Returns:

value of the field

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getLastUpdated

@Deprecated(since="XenServer 6.1")
public Date getLastUpdated(Connection c)
                    throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Deprecated.

since XenServer 6.1

Get the last_updated field of the given VBD_metrics. Minimum allowed role: read-only First published in XenServer 4.0.

Parameters:

c - The connection the call is made on

Returns:

value of the field

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getOtherConfig

@Deprecated(since="XenServer 6.1")
public Map<String,String> getOtherConfig(Connection c)
                                  throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Deprecated.

since XenServer 6.1

Get the other_config field of the given VBD_metrics. Minimum allowed role: read-only First published in XenServer 5.0.

Parameters:

c - The connection the call is made on

Returns:

value of the field

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

setOtherConfig

@Deprecated(since="XenServer 6.1")
public void setOtherConfig(Connection c,
 Map<String,String> otherConfig)
                    throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Deprecated.

since XenServer 6.1

Set the other_config field of the given VBD_metrics. Minimum allowed role: vm-admin First published in XenServer 5.0.

Parameters:

c - The connection the call is made on

otherConfig - New value to set

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

addToOtherConfig

@Deprecated(since="XenServer 6.1")
public void addToOtherConfig(Connection c,
 String key,
 String value)
                      throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Deprecated.

since XenServer 6.1

Add the given key-value pair to the other_config field of the given VBD_metrics. Minimum allowed role: vm-admin First published in XenServer 5.0.

Parameters:

c - The connection the call is made on

key - Key to add

value - Value to add

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

removeFromOtherConfig

@Deprecated(since="XenServer 6.1")
public void removeFromOtherConfig(Connection c,
 String key)
                           throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Deprecated.

since XenServer 6.1

Remove the given key and its corresponding value from the other_config field of the given VBD_metrics. If the key is not in that Map, then do nothing. Minimum allowed role: vm-admin First published in XenServer 5.0.

Parameters:

c - The connection the call is made on

key - Key to remove

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getAll

@Deprecated(since="XenServer 6.1")
public static Set<VBDMetrics> getAll(Connection c)
                              throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Deprecated.

since XenServer 6.1

Return a list of all the VBD_metrics instances known to the system. Minimum allowed role: read-only First published in XenServer 4.0.

Parameters:

c - The connection the call is made on

Returns:

references to all objects

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getAllRecords

public static Map<VBDMetrics,VBDMetrics.Record> getAllRecords(Connection c)
                                                       throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Return a map of VBD_metrics references to VBD_metrics records for all VBD_metrics instances known to the system. Minimum allowed role: read-only First published in XenServer 4.0.

Parameters:

c - The connection the call is made on

Returns:

records of all objects

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.