PIFMetrics

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

```
public class PIFMetrics
extends XenAPIObject
```
The metrics associated with a physical network interface

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class PIFMetrics.Record
Represents all the fields in a PIFMetrics

Nested Classes
Modifier and Type	Class and Description
`static class`	`PIFMetrics.Record` Represents all the fields in a PIFMetrics

Field Summary

Fields
Modifier and Type Field and Description

protected java.lang.String ref
The XenAPI reference to this object.

Fields
Modifier and Type	Field and Description
`protected java.lang.String`	`ref` The XenAPI reference to this object.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addToOtherConfig(Connection c, java.lang.String key, java.lang.String value)` Add the given key-value pair to the other_config field of the given PIF_metrics.
`boolean`	`equals(java.lang.Object obj)` If obj is a PIFMetrics, compares XenAPI references for equality.
`static java.util.Set<PIFMetrics>`	`getAll(Connection c)` Return a list of all the PIF_metrics instances known to the system.
`static java.util.Map<PIFMetrics,PIFMetrics.Record>`	`getAllRecords(Connection c)` Return a map of PIF_metrics references to PIF_metrics records for all PIF_metrics instances known to the system.
`static PIFMetrics`	`getByUuid(Connection c, java.lang.String uuid)` Get a reference to the PIF_metrics instance with the specified UUID.
`java.lang.Boolean`	`getCarrier(Connection c)` Get the carrier field of the given PIF_metrics.
`java.lang.String`	`getDeviceId(Connection c)` Get the device_id field of the given PIF_metrics.
`java.lang.String`	`getDeviceName(Connection c)` Get the device_name field of the given PIF_metrics.
`java.lang.Boolean`	`getDuplex(Connection c)` Get the duplex field of the given PIF_metrics.
`java.lang.Double`	`getIoReadKbs(Connection c)` Get the io/read_kbs field of the given PIF_metrics.
`java.lang.Double`	`getIoWriteKbs(Connection c)` Get the io/write_kbs field of the given PIF_metrics.
`java.util.Date`	`getLastUpdated(Connection c)` Get the last_updated field of the given PIF_metrics.
`java.util.Map<java.lang.String,java.lang.String>`	`getOtherConfig(Connection c)` Get the other_config field of the given PIF_metrics.
`java.lang.String`	`getPciBusPath(Connection c)` Get the pci_bus_path field of the given PIF_metrics.
`PIFMetrics.Record`	`getRecord(Connection c)` Get a record containing the current state of the given PIF_metrics.
`java.lang.Long`	`getSpeed(Connection c)` Get the speed field of the given PIF_metrics.
`java.lang.String`	`getUuid(Connection c)` Get the uuid field of the given PIF_metrics.
`java.lang.String`	`getVendorId(Connection c)` Get the vendor_id field of the given PIF_metrics.
`java.lang.String`	`getVendorName(Connection c)` Get the vendor_name field of the given PIF_metrics.
`int`	`hashCode()`
`void`	`removeFromOtherConfig(Connection c, java.lang.String key)` Remove the given key and its corresponding value from the other_config field of the given PIF_metrics.
`void`	`setOtherConfig(Connection c, java.util.Map<java.lang.String,java.lang.String> otherConfig)` Set the other_config field of the given PIF_metrics.
`java.lang.String`	`toWireString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail
- ref
```
protected final java.lang.String ref
```
  The XenAPI reference to this object.

Method Detail

toWireString
```
public java.lang.String toWireString()
```
Specified by:

toWireString in class XenAPIObject

equals
```
public boolean equals(java.lang.Object obj)
```
If obj is a PIFMetrics, compares XenAPI references for equality.

Overrides:

equals in class java.lang.Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class java.lang.Object

getRecord

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

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

Returns:: all fields from the object
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

getByUuid

public static PIFMetrics getByUuid(Connection c,
                                   java.lang.String uuid)
                            throws Types.BadServerResponse,
                                   Types.XenAPIException,
                                   org.apache.xmlrpc.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; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

getUuid

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

Get the uuid field of the given PIF_metrics.

Returns:: value of the field
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

getIoReadKbs

public java.lang.Double getIoReadKbs(Connection c)
                              throws Types.BadServerResponse,
                                     Types.XenAPIException,
                                     org.apache.xmlrpc.XmlRpcException

Get the io/read_kbs field of the given PIF_metrics.

Returns:: value of the field
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

getIoWriteKbs

public java.lang.Double getIoWriteKbs(Connection c)
                               throws Types.BadServerResponse,
                                      Types.XenAPIException,
                                      org.apache.xmlrpc.XmlRpcException

Get the io/write_kbs field of the given PIF_metrics.

Returns:: value of the field
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

getCarrier

public java.lang.Boolean getCarrier(Connection c)
                             throws Types.BadServerResponse,
                                    Types.XenAPIException,
                                    org.apache.xmlrpc.XmlRpcException

Get the carrier field of the given PIF_metrics.

Returns:: value of the field
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

getVendorId

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

Get the vendor_id field of the given PIF_metrics.

Returns:: value of the field
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

getVendorName

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

Get the vendor_name field of the given PIF_metrics.

Returns:: value of the field
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

getDeviceId

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

Get the device_id field of the given PIF_metrics.

Returns:: value of the field
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

getDeviceName

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

Get the device_name field of the given PIF_metrics.

Returns:: value of the field
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

getSpeed

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

Get the speed field of the given PIF_metrics.

Returns:: value of the field
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

getDuplex

public java.lang.Boolean getDuplex(Connection c)
                            throws Types.BadServerResponse,
                                   Types.XenAPIException,
                                   org.apache.xmlrpc.XmlRpcException

Get the duplex field of the given PIF_metrics.

Returns:: value of the field
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

getPciBusPath

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

Get the pci_bus_path field of the given PIF_metrics.

Returns:: value of the field
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

getLastUpdated

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

Get the last_updated field of the given PIF_metrics.

Returns:: value of the field
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

getOtherConfig

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

Get the other_config field of the given PIF_metrics.

Returns:: value of the field
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

setOtherConfig

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

Set the other_config field of the given PIF_metrics.

Parameters:: otherConfig - New value to set
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

addToOtherConfig

public void addToOtherConfig(Connection c,
                             java.lang.String key,
                             java.lang.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 PIF_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,
                                  java.lang.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 PIF_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 java.util.Set<PIFMetrics> getAll(Connection c)
                                        throws Types.BadServerResponse,
                                               Types.XenAPIException,
                                               org.apache.xmlrpc.XmlRpcException

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

Returns:: references to all objects
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

getAllRecords

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

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

Returns:: records of all objects
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

Class PIFMetrics

Nested Class Summary

Field Summary