Package com.xensource.xenapi
Class DRTask
java.lang.Object
com.xensource.xenapi.XenAPIObject
com.xensource.xenapi.DRTask
DR task
First published in XenServer 6.0.
- Author:
- Cloud Software Group, Inc.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
Represents all the fields in a DRTask -
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionstatic DRTask
Create a disaster recovery task which will query the supplied list of devices First published in XenServer 6.0.static Task
createAsync
(Connection c, String type, Map<String, String> deviceConfig, Set<String> whitelist) Create a disaster recovery task which will query the supplied list of devices First published in XenServer 6.0.void
Destroy the disaster recovery task, detaching and forgetting any SRs introduced which are no longer required First published in XenServer 6.0.Destroy the disaster recovery task, detaching and forgetting any SRs introduced which are no longer required First published in XenServer 6.0.boolean
If obj is a DRTask, compares XenAPI references for equality.getAll
(Connection c) Return a list of all the DR_tasks known to the system.static Map<DRTask,
DRTask.Record> Return a map of DR_task references to DR_task records for all DR_tasks known to the system.static DRTask
getByUuid
(Connection c, String uuid) Get a reference to the DR_task instance with the specified UUID.Get the introduced_SRs field of the given DR_task.Get a record containing the current state of the given DR_task.Get the uuid field of the given DR_task.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 DRTask, compares XenAPI references for equality. -
hashCode
public int hashCode() -
getRecord
public DRTask.Record getRecord(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Get a record containing the current state of the given DR_task. First published in XenServer 6.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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
getByUuid
public static DRTask getByUuid(Connection c, String uuid) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Get a reference to the DR_task instance with the specified UUID. First published in XenServer 6.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
- 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 DR_task. First published in XenServer 6.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.
-
getIntroducedSRs
public Set<SR> getIntroducedSRs(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Get the introduced_SRs field of the given DR_task. First published in XenServer 6.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.
-
createAsync
public static Task createAsync(Connection c, String type, Map<String, String> deviceConfig, Set<String> whitelist) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcExceptionCreate a disaster recovery task which will query the supplied list of devices First published in XenServer 6.0.- Parameters:
c
- The connection the call is made ontype
- The SR driver type of the SRs to introducedeviceConfig
- The device configuration of the SRs to introducewhitelist
- The devices to use for disaster recovery- Returns:
- Task
- 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.
-
create
public static DRTask create(Connection c, String type, Map<String, String> deviceConfig, Set<String> whitelist) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcExceptionCreate a disaster recovery task which will query the supplied list of devices First published in XenServer 6.0.- Parameters:
c
- The connection the call is made ontype
- The SR driver type of the SRs to introducedeviceConfig
- The device configuration of the SRs to introducewhitelist
- The devices to use for disaster recovery- Returns:
- The reference to the created task
- 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.
-
destroyAsync
public Task destroyAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Destroy the disaster recovery task, detaching and forgetting any SRs introduced which are no longer required First published in XenServer 6.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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-
destroy
public void destroy(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Destroy the disaster recovery task, detaching and forgetting any SRs introduced which are no longer required First published in XenServer 6.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
- 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<DRTask> getAll(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Return a list of all the DR_tasks known to the system. First published in XenServer 6.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
- 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<DRTask,DRTask.Record> getAllRecords(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException Return a map of DR_task references to DR_task records for all DR_tasks known to the system. First published in XenServer 6.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
- Thrown if the call failed.org.apache.xmlrpc.XmlRpcException
- Thrown if the result of an asynchronous call could not be parsed.
-