com.xensource.xenapi
Class VGPUType

java.lang.Object
  extended by com.xensource.xenapi.XenAPIObject
      extended by com.xensource.xenapi.VGPUType

public class VGPUType
extends XenAPIObject

A type of virtual GPU First published in XenServer 6.2 SP1 Tech-Preview.


Nested Class Summary
static class VGPUType.Record
          Represents all the fields in a VGPUType
 
Field Summary
protected  java.lang.String ref
          The XenAPI reference (OpaqueRef) to this object.
 
Method Summary
 boolean equals(java.lang.Object obj)
          If obj is a VGPUType, compares XenAPI references for equality.
static java.util.Set<VGPUType> getAll(Connection c)
          Return a list of all the VGPU_types known to the system.
static java.util.Map<VGPUType,VGPUType.Record> getAllRecords(Connection c)
          Return a map of VGPU_type references to VGPU_type records for all VGPU_types known to the system.
static VGPUType getByUuid(Connection c, java.lang.String uuid)
          Get a reference to the VGPU_type instance with the specified UUID.
 java.util.Set<GPUGroup> getEnabledOnGPUGroups(Connection c)
          Get the enabled_on_GPU_groups field of the given VGPU_type.
 java.util.Set<PGPU> getEnabledOnPGPUs(Connection c)
          Get the enabled_on_PGPUs field of the given VGPU_type.
 java.lang.Long getFramebufferSize(Connection c)
          Get the framebuffer_size field of the given VGPU_type.
 java.lang.Long getMaxHeads(Connection c)
          Get the max_heads field of the given VGPU_type.
 java.lang.Long getMaxResolutionX(Connection c)
          Get the max_resolution_x field of the given VGPU_type.
 java.lang.Long getMaxResolutionY(Connection c)
          Get the max_resolution_y field of the given VGPU_type.
 java.lang.String getModelName(Connection c)
          Get the model_name field of the given VGPU_type.
 VGPUType.Record getRecord(Connection c)
          Get a record containing the current state of the given VGPU_type.
 java.util.Set<GPUGroup> getSupportedOnGPUGroups(Connection c)
          Get the supported_on_GPU_groups field of the given VGPU_type.
 java.util.Set<PGPU> getSupportedOnPGPUs(Connection c)
          Get the supported_on_PGPUs field of the given VGPU_type.
 java.lang.String getUuid(Connection c)
          Get the uuid field of the given VGPU_type.
 java.lang.String getVendorName(Connection c)
          Get the vendor_name field of the given VGPU_type.
 java.util.Set<VGPU> getVGPUs(Connection c)
          Get the VGPUs field of the given VGPU_type.
 int hashCode()
           
 java.lang.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 Detail

ref

protected final java.lang.String ref
The XenAPI reference (OpaqueRef) to this object.

Method Detail

toWireString

public java.lang.String toWireString()
Specified by:
toWireString in class XenAPIObject
Returns:
The XenAPI reference (OpaqueRef) to this object.

equals

public boolean equals(java.lang.Object obj)
If obj is a VGPUType, 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 VGPUType.Record getRecord(Connection c)
                          throws Types.BadServerResponse,
                                 Types.XenAPIException,
                                 org.apache.xmlrpc.XmlRpcException
Get a record containing the current state of the given VGPU_type. First published in XenServer 6.2 SP1 Tech-Preview.

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

getByUuid

public static VGPUType getByUuid(Connection c,
                                 java.lang.String uuid)
                          throws Types.BadServerResponse,
                                 Types.XenAPIException,
                                 org.apache.xmlrpc.XmlRpcException
Get a reference to the VGPU_type instance with the specified UUID. First published in XenServer 6.2 SP1 Tech-Preview.

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 VGPU_type. First published in XenServer 6.2 SP1 Tech-Preview.

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 VGPU_type. First published in XenServer 6.2 SP1 Tech-Preview.

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

getModelName

public java.lang.String getModelName(Connection c)
                              throws Types.BadServerResponse,
                                     Types.XenAPIException,
                                     org.apache.xmlrpc.XmlRpcException
Get the model_name field of the given VGPU_type. First published in XenServer 6.2 SP1 Tech-Preview.

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

getFramebufferSize

public java.lang.Long getFramebufferSize(Connection c)
                                  throws Types.BadServerResponse,
                                         Types.XenAPIException,
                                         org.apache.xmlrpc.XmlRpcException
Get the framebuffer_size field of the given VGPU_type. First published in XenServer 6.2 SP1 Tech-Preview.

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

getMaxHeads

public java.lang.Long getMaxHeads(Connection c)
                           throws Types.BadServerResponse,
                                  Types.XenAPIException,
                                  org.apache.xmlrpc.XmlRpcException
Get the max_heads field of the given VGPU_type. First published in XenServer 6.2 SP1 Tech-Preview.

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

getMaxResolutionX

public java.lang.Long getMaxResolutionX(Connection c)
                                 throws Types.BadServerResponse,
                                        Types.XenAPIException,
                                        org.apache.xmlrpc.XmlRpcException
Get the max_resolution_x field of the given VGPU_type. First published in XenServer 6.2 SP1.

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

getMaxResolutionY

public java.lang.Long getMaxResolutionY(Connection c)
                                 throws Types.BadServerResponse,
                                        Types.XenAPIException,
                                        org.apache.xmlrpc.XmlRpcException
Get the max_resolution_y field of the given VGPU_type. First published in XenServer 6.2 SP1.

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

getSupportedOnPGPUs

public java.util.Set<PGPU> getSupportedOnPGPUs(Connection c)
                                        throws Types.BadServerResponse,
                                               Types.XenAPIException,
                                               org.apache.xmlrpc.XmlRpcException
Get the supported_on_PGPUs field of the given VGPU_type. First published in XenServer 6.2 SP1 Tech-Preview.

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

getEnabledOnPGPUs

public java.util.Set<PGPU> getEnabledOnPGPUs(Connection c)
                                      throws Types.BadServerResponse,
                                             Types.XenAPIException,
                                             org.apache.xmlrpc.XmlRpcException
Get the enabled_on_PGPUs field of the given VGPU_type. First published in XenServer 6.2 SP1 Tech-Preview.

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

getVGPUs

public java.util.Set<VGPU> getVGPUs(Connection c)
                             throws Types.BadServerResponse,
                                    Types.XenAPIException,
                                    org.apache.xmlrpc.XmlRpcException
Get the VGPUs field of the given VGPU_type. First published in XenServer 6.2 SP1 Tech-Preview.

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

getSupportedOnGPUGroups

public java.util.Set<GPUGroup> getSupportedOnGPUGroups(Connection c)
                                                throws Types.BadServerResponse,
                                                       Types.XenAPIException,
                                                       org.apache.xmlrpc.XmlRpcException
Get the supported_on_GPU_groups field of the given VGPU_type. First published in XenServer 6.2 SP1.

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

getEnabledOnGPUGroups

public java.util.Set<GPUGroup> getEnabledOnGPUGroups(Connection c)
                                              throws Types.BadServerResponse,
                                                     Types.XenAPIException,
                                                     org.apache.xmlrpc.XmlRpcException
Get the enabled_on_GPU_groups field of the given VGPU_type. First published in XenServer 6.2 SP1.

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

getAll

public static java.util.Set<VGPUType> getAll(Connection c)
                                      throws Types.BadServerResponse,
                                             Types.XenAPIException,
                                             org.apache.xmlrpc.XmlRpcException
Return a list of all the VGPU_types known to the system. First published in XenServer 6.2 SP1 Tech-Preview.

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

getAllRecords

public static java.util.Map<VGPUType,VGPUType.Record> getAllRecords(Connection c)
                                                             throws Types.BadServerResponse,
                                                                    Types.XenAPIException,
                                                                    org.apache.xmlrpc.XmlRpcException
Return a map of VGPU_type references to VGPU_type records for all VGPU_types known to the system. First published in XenServer 6.2 SP1 Tech-Preview.

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