Package com.xensource.xenapi
Class DriverVariant
java.lang.Object
com.xensource.xenapi.XenAPIObject
com.xensource.xenapi.DriverVariant
UNSUPPORTED. Variant of a host driver
First published in .
- Author:
- Cloud Software Group, Inc.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
Represents all the fields in a DriverVariant -
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionboolean
If obj is a DriverVariant, compares XenAPI references for equality.static Set<DriverVariant>
getAll
(Connection c) Return a list of all the Driver_variants known to the system.static Map<DriverVariant,
DriverVariant.Record> Return a map of Driver_variant references to Driver_variant records for all Driver_variants known to the system.static DriverVariant
getByUuid
(Connection c, String uuid) Get a reference to the Driver_variant instance with the specified UUID.Get the driver field of the given Driver_variant.Get the hardware_present field of the given Driver_variant.Get the name field of the given Driver_variant.Get the priority field of the given Driver_variant.Get a record containing the current state of the given Driver_variant.Get the status field of the given Driver_variant.Get the uuid field of the given Driver_variant.Get the version field of the given Driver_variant.int
hashCode()
void
select
(Connection c) UNSUPPORTED Select this variant of a driver to become active after reboot or immediately if currently no version is active Minimum allowed role: pool-admin Experimental.UNSUPPORTED Select this variant of a driver to become active after reboot or immediately if currently no version is active Minimum allowed role: pool-admin Experimental.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 DriverVariant, compares XenAPI references for equality. -
hashCode
public int hashCode() -
getRecord
public DriverVariant.Record getRecord(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get a record containing the current state of the given Driver_variant. Minimum allowed role: read-only Experimental. First published in 25.2.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
public static DriverVariant getByUuid(Connection c, String uuid) throws Types.BadServerResponse, Types.XenAPIException, IOException Get a reference to the Driver_variant instance with the specified UUID. Minimum allowed role: read-only Experimental. First published in 25.2.0.- 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
- 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 Driver_variant. Minimum allowed role: read-only Experimental. First published in 25.2.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.
-
getName
public String getName(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the name field of the given Driver_variant. Minimum allowed role: read-only Experimental. First published in 25.2.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.
-
getDriver
public HostDriver getDriver(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the driver field of the given Driver_variant. Minimum allowed role: read-only Experimental. First published in 25.2.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.
-
getVersion
public String getVersion(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the version field of the given Driver_variant. Minimum allowed role: read-only Experimental. First published in 25.2.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.
-
getHardwarePresent
public Boolean getHardwarePresent(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the hardware_present field of the given Driver_variant. Minimum allowed role: read-only Experimental. First published in 25.2.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.
-
getPriority
public Double getPriority(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the priority field of the given Driver_variant. Minimum allowed role: read-only Experimental. First published in 25.2.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.
-
getStatus
public String getStatus(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the status field of the given Driver_variant. Minimum allowed role: read-only Experimental. First published in 25.2.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.
-
select
UNSUPPORTED Select this variant of a driver to become active after reboot or immediately if currently no version is active Minimum allowed role: pool-admin Experimental. First published in 25.2.0.- Parameters:
c
- The connection the call is made on- 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.
-
selectAsync
public Task selectAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException UNSUPPORTED Select this variant of a driver to become active after reboot or immediately if currently no version is active Minimum allowed role: pool-admin Experimental. First published in 25.2.0.- Parameters:
c
- The connection the call is made on- Returns:
- Task
- 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
public static Set<DriverVariant> getAll(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Return a list of all the Driver_variants known to the system. Minimum allowed role: read-only Experimental. First published in 25.2.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<DriverVariant,DriverVariant.Record> getAllRecords(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Return a map of Driver_variant references to Driver_variant records for all Driver_variants known to the system. Minimum allowed role: read-only Experimental. First published in 25.2.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.
-