com.xensource.xenapi

Class DRTask

java.lang.Object

com.xensource.xenapi.XenAPIObject

com.xensource.xenapi.DRTask

public class DRTask
extends XenAPIObject

DR task First published in XenServer 6.0.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DRTask.Record Represents all the fields in a DRTask

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	ref The XenAPI reference (OpaqueRef) to this object.

Method Summary

Methods

Modifier and Type	Method and Description
static DRTask	create(Connection c, java.lang.String type, java.util.Map<java.lang.String,java.lang.String> deviceConfig, java.util.Set<java.lang.String> whitelist) Create a disaster recovery task which will query the supplied list of devices First published in XenServer 6.0.
static Task	createAsync(Connection c, java.lang.String type, java.util.Map<java.lang.String,java.lang.String> deviceConfig, java.util.Set<java.lang.String> whitelist) Create a disaster recovery task which will query the supplied list of devices First published in XenServer 6.0.
void	destroy(Connection c) Destroy the disaster recovery task, detaching and forgetting any SRs introduced which are no longer required First published in XenServer 6.0.
Task	destroyAsync(Connection c) Destroy the disaster recovery task, detaching and forgetting any SRs introduced which are no longer required First published in XenServer 6.0.
boolean	equals(java.lang.Object obj) If obj is a DRTask, compares XenAPI references for equality.
static java.util.Set<DRTask>	getAll(Connection c) Return a list of all the DR_tasks known to the system.
static java.util.Map<DRTask,DRTask.Record>	getAllRecords(Connection c) Return a map of DR_task references to DR_task records for all DR_tasks known to the system.
static DRTask	getByUuid(Connection c, java.lang.String uuid) Get a reference to the DR_task instance with the specified UUID.
java.util.Set<SR>	getIntroducedSRs(Connection c) Get the introduced_SRs field of the given DR_task.
DRTask.Record	getRecord(Connection c) Get a record containing the current state of the given DR_task.
java.lang.String	getUuid(Connection c) Get the uuid field of the given DR_task.
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 DRTask, 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 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.

Returns:

all fields from the object

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getByUuid

public static DRTask getByUuid(Connection c,
               java.lang.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:

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 DR_task. First published in XenServer 6.0.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getIntroducedSRs

public java.util.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.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

createAsync

public static Task createAsync(Connection c,
               java.lang.String type,
               java.util.Map<java.lang.String,java.lang.String> deviceConfig,
               java.util.Set<java.lang.String> whitelist)
                        throws Types.BadServerResponse,
                               Types.XenAPIException,
                               org.apache.xmlrpc.XmlRpcException

Create a disaster recovery task which will query the supplied list of devices First published in XenServer 6.0.

Parameters:

type - The SR driver type of the SRs to introduce

deviceConfig - The device configuration of the SRs to introduce

whitelist - The devices to use for disaster recovery

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

create

public static DRTask create(Connection c,
            java.lang.String type,
            java.util.Map<java.lang.String,java.lang.String> deviceConfig,
            java.util.Set<java.lang.String> whitelist)
                     throws Types.BadServerResponse,
                            Types.XenAPIException,
                            org.apache.xmlrpc.XmlRpcException

Create a disaster recovery task which will query the supplied list of devices First published in XenServer 6.0.

Parameters:

type - The SR driver type of the SRs to introduce

deviceConfig - The device configuration of the SRs to introduce

whitelist - The devices to use for disaster recovery

Returns:

The reference to the created task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

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.

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

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.

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getAll

public static java.util.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.

Returns:

references to all objects

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getAllRecords

public static java.util.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.

Returns:

records of all objects

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException