Package com.xensource.xenapi
Class VGPUType
java.lang.Object
com.xensource.xenapi.XenAPIObject
com.xensource.xenapi.VGPUType
A type of virtual GPU
First published in XenServer 6.2 SP1 Tech-Preview.
- Author:
- Cloud Software Group, Inc.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
Represents all the fields in a VGPUType -
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionboolean
If obj is a VGPUType, compares XenAPI references for equality.getAll
(Connection c) Return a list of all the VGPU_types known to the system.static Map<VGPUType,
VGPUType.Record> Return a map of VGPU_type references to VGPU_type records for all VGPU_types known to the system.static VGPUType
getByUuid
(Connection c, String uuid) Get a reference to the VGPU_type instance with the specified UUID.Get the compatible_types_in_vm field of the given VGPU_type.Get the enabled_on_GPU_groups field of the given VGPU_type.Get the enabled_on_PGPUs field of the given VGPU_type.Get the experimental field of the given VGPU_type.Get the framebuffer_size field of the given VGPU_type.Get the identifier field of the given VGPU_type.Get the implementation field of the given VGPU_type.Get the max_heads field of the given VGPU_type.Get the max_resolution_x field of the given VGPU_type.Get the max_resolution_y field of the given VGPU_type.Get the model_name field of the given VGPU_type.Get a record containing the current state of the given VGPU_type.Get the supported_on_GPU_groups field of the given VGPU_type.Get the supported_on_PGPUs field of the given VGPU_type.Get the uuid field of the given VGPU_type.Get the vendor_name field of the given VGPU_type.Get the VGPUs field of the given VGPU_type.int
hashCode()
Methods inherited from class com.xensource.xenapi.XenAPIObject
isNull
-
Field Details
-
ref
The XenAPI reference (OpaqueRef) to this object.
-
-
Method Details
-
toWireString
- Specified by:
toWireString
in classXenAPIObject
- Returns:
- The XenAPI reference (OpaqueRef) to this object.
-
equals
If obj is a VGPUType, compares XenAPI references for equality. -
hashCode
public int hashCode() -
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. Minimum allowed role: read-only First published in XenServer 6.2 SP1 Tech-Preview.- 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getByUuid
public static VGPUType getByUuid(Connection c, String uuid) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Get a reference to the VGPU_type instance with the specified UUID. Minimum allowed role: read-only First published in XenServer 6.2 SP1 Tech-Preview.- Parameters:
c
- The connection the call is made onuuid
- 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getUuid
public String getUuid(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Get the uuid field of the given VGPU_type. Minimum allowed role: read-only First published in XenServer 6.2 SP1 Tech-Preview.- 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getVendorName
public String getVendorName(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Get the vendor_name field of the given VGPU_type. Minimum allowed role: read-only First published in XenServer 6.2 SP1 Tech-Preview.- 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getModelName
public String getModelName(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Get the model_name field of the given VGPU_type. Minimum allowed role: read-only First published in XenServer 6.2 SP1 Tech-Preview.- 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getFramebufferSize
public Long getFramebufferSize(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Get the framebuffer_size field of the given VGPU_type. Minimum allowed role: read-only First published in XenServer 6.2 SP1 Tech-Preview.- 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getMaxHeads
public Long getMaxHeads(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Get the max_heads field of the given VGPU_type. Minimum allowed role: read-only First published in XenServer 6.2 SP1 Tech-Preview.- 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getMaxResolutionX
public Long getMaxResolutionX(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Get the max_resolution_x field of the given VGPU_type. Minimum allowed role: read-only First published in XenServer 6.2 SP1.- 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getMaxResolutionY
public Long getMaxResolutionY(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Get the max_resolution_y field of the given VGPU_type. Minimum allowed role: read-only First published in XenServer 6.2 SP1.- 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getSupportedOnPGPUs
public 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. Minimum allowed role: read-only First published in XenServer 6.2 SP1 Tech-Preview.- 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getEnabledOnPGPUs
public 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. Minimum allowed role: read-only First published in XenServer 6.2 SP1 Tech-Preview.- 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getVGPUs
public Set<VGPU> getVGPUs(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Get the VGPUs field of the given VGPU_type. Minimum allowed role: read-only First published in XenServer 6.2 SP1 Tech-Preview.- 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getSupportedOnGPUGroups
public 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. Minimum allowed role: read-only First published in XenServer 6.2 SP1.- 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getEnabledOnGPUGroups
public 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. Minimum allowed role: read-only First published in XenServer 6.2 SP1.- 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getImplementation
public Types.VgpuTypeImplementation getImplementation(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Get the implementation field of the given VGPU_type. Minimum allowed role: read-only First published in XenServer 7.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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getIdentifier
public String getIdentifier(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Get the identifier field of the given VGPU_type. Minimum allowed role: read-only First published in XenServer 7.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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getExperimental
public Boolean getExperimental(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Get the experimental field of the given VGPU_type. Minimum allowed role: read-only First published in XenServer 7.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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getCompatibleTypesInVm
public Set<VGPUType> getCompatibleTypesInVm(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Get the compatible_types_in_vm field of the given VGPU_type. Minimum allowed role: read-only First published in Citrix Hypervisor 8.1.- 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getAll
public static 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. Minimum allowed role: read-only First published in XenServer 6.2 SP1 Tech-Preview.- 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getAllRecords
public static 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. Minimum allowed role: read-only First published in XenServer 6.2 SP1 Tech-Preview.- 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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-