com.xensource.xenapi
Class HostCpu

java.lang.Object
  com.xensource.xenapi.HostCpu

public class HostCpu
extends Object

A physical CPU

Nested Class Summary

static class

HostCpu.Record Represents all the fields in a HostCpu

Field Summary

protected String

ref The XenAPI reference to this object.

Method Summary

static Set<HostCpu>	getAll() Return a list of all the host_cpus known to the system.
static Map<HostCpu,HostCpu.Record>	getAllRecords() Get all the HostCpu Records at once, in a single XML RPC call
static HostCpu	getByUuid(String uuid) Get a reference to the host_cpu instance with the specified UUID.
String	getFeatures() Get the features field of the given host_cpu.
String	getFlags() Get the flags field of the given host_cpu.
Host	getHost() Get the host field of the given host_cpu.
protected static HostCpu	getInstFromRef(String ref)
String	getModelname() Get the modelname field of the given host_cpu.
Long	getNumber() Get the number field of the given host_cpu.
HostCpu.Record	getRecord() Get a record containing the current state of the given host_cpu.
Long	getSpeed() Get the speed field of the given host_cpu.
String	getStepping() Get the stepping field of the given host_cpu.
Double	getUtilisation() Get the utilisation field of the given host_cpu.
String	getUuid() Get the uuid field of the given host_cpu.
String	getVendor() Get the vendor field of the given host_cpu.

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 HostCpu getInstFromRef(String ref)

getRecord

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

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

Returns:

all fields from the object

Throws:

Types.BadServerResponse

ConnectionHelper.NoConnectionOnThisThreadException

XmlRpcException

getByUuid

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

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

Returns:

value of the field

Throws:

Types.BadServerResponse

ConnectionHelper.NoConnectionOnThisThreadException

XmlRpcException

getHost

public Host getHost()
             throws Types.BadServerResponse,
                    ConnectionHelper.NoConnectionOnThisThreadException,
                    XmlRpcException

Get the host field of the given host_cpu.

Returns:

value of the field

Throws:

Types.BadServerResponse

ConnectionHelper.NoConnectionOnThisThreadException

XmlRpcException

getNumber

public Long getNumber()
               throws Types.BadServerResponse,
                      ConnectionHelper.NoConnectionOnThisThreadException,
                      XmlRpcException

Get the number field of the given host_cpu.

Returns:

value of the field

Throws:

Types.BadServerResponse

ConnectionHelper.NoConnectionOnThisThreadException

XmlRpcException

getVendor

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

Get the vendor field of the given host_cpu.

Returns:

value of the field

Throws:

Types.BadServerResponse

ConnectionHelper.NoConnectionOnThisThreadException

XmlRpcException

getSpeed

public Long getSpeed()
              throws Types.BadServerResponse,
                     ConnectionHelper.NoConnectionOnThisThreadException,
                     XmlRpcException

Get the speed field of the given host_cpu.

Returns:

value of the field

Throws:

Types.BadServerResponse

ConnectionHelper.NoConnectionOnThisThreadException

XmlRpcException

getModelname

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

Get the modelname field of the given host_cpu.

Returns:

value of the field

Throws:

Types.BadServerResponse

ConnectionHelper.NoConnectionOnThisThreadException

XmlRpcException

getStepping

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

Get the stepping field of the given host_cpu.

Returns:

value of the field

Throws:

Types.BadServerResponse

ConnectionHelper.NoConnectionOnThisThreadException

XmlRpcException

getFlags

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

Get the flags field of the given host_cpu.

Returns:

value of the field

Throws:

Types.BadServerResponse

ConnectionHelper.NoConnectionOnThisThreadException

XmlRpcException

getFeatures

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

Get the features field of the given host_cpu.

Returns:

value of the field

Throws:

Types.BadServerResponse

ConnectionHelper.NoConnectionOnThisThreadException

XmlRpcException

getUtilisation

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

Get the utilisation field of the given host_cpu.

Returns:

value of the field

Throws:

Types.BadServerResponse

ConnectionHelper.NoConnectionOnThisThreadException

XmlRpcException

getAll

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

Return a list of all the host_cpus known to the system.

Returns:

references to all objects

Throws:

Types.BadServerResponse

ConnectionHelper.NoConnectionOnThisThreadException

XmlRpcException

getAllRecords

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

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

Returns:

A map from HostCpu to HostCpu.Record

Throws:

Types.BadServerResponse

ConnectionHelper.NoConnectionOnThisThreadException

XmlRpcException