Package 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.

Author:

Cloud Software Group, Inc.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
DRTask(String ref)	Creates an object from a given XenAPI reference (OpaqueRef)

Method Summary

Modifier and Type	Method	Description
static DRTask	create(Connection c, String type, Map<String,String> deviceConfig, Set<String> whitelist)	Create a disaster recovery task which will query the supplied list of devices Minimum allowed role: pool-operator 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 Minimum allowed role: pool-operator 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 Minimum allowed role: pool-operator 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 Minimum allowed role: pool-operator First published in XenServer 6.0.
boolean	equals(Object obj)	If obj is a DRTask, compares XenAPI references for equality.
static Set<DRTask>	getAll(Connection c)	Return a list of all the DR_tasks known to the system.
static 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, String uuid)	Get a reference to the DR_task instance with the specified UUID.
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.
String	getUuid(Connection c)	Get the uuid field of the given DR_task.
int	hashCode()
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 Details

ref

protected final String ref

The XenAPI reference (OpaqueRef) to this object.

Constructor Details

DRTask

public DRTask(String ref)

Creates an object from a given XenAPI reference (OpaqueRef)

Parameters:

ref - The OpaqueRef from which to create the object.

Method Details

toWireString

public String toWireString()

Specified by:

toWireString in class XenAPIObject

Returns:

The XenAPI reference (OpaqueRef) to this object.

equals

public boolean equals(Object obj)

If obj is a DRTask, compares XenAPI references for equality.

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getRecord

public DRTask.Record getRecord(Connection c)
                        throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get a record containing the current state of the given DR_task. Minimum allowed role: read-only 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 - 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 DRTask getByUuid(Connection c,
 String uuid)
                        throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get a reference to the DR_task instance with the specified UUID. Minimum allowed role: read-only First published in XenServer 6.0.

Parameters:

c - The connection the call is made on

uuid - 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 DR_task. Minimum allowed role: read-only 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 - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getIntroducedSRs

public Set<SR> getIntroducedSRs(Connection c)
                         throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get the introduced_SRs field of the given DR_task. Minimum allowed role: read-only 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 - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

create

public static DRTask create(Connection c,
 String type,
 Map<String,String> deviceConfig,
 Set<String> whitelist)
                     throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Create a disaster recovery task which will query the supplied list of devices Minimum allowed role: pool-operator First published in XenServer 6.0.

Parameters:

c - The connection the call is made on

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 of the created DR_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.

createAsync

public static Task createAsync(Connection c,
 String type,
 Map<String,String> deviceConfig,
 Set<String> whitelist)
                        throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Create a disaster recovery task which will query the supplied list of devices Minimum allowed role: pool-operator First published in XenServer 6.0.

Parameters:

c - The connection the call is made on

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 - 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.

destroy

public void destroy(Connection c)
             throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Destroy the disaster recovery task, detaching and forgetting any SRs introduced which are no longer required Minimum allowed role: pool-operator 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 - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

destroyAsync

public Task destroyAsync(Connection c)
                  throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Destroy the disaster recovery task, detaching and forgetting any SRs introduced which are no longer required Minimum allowed role: pool-operator 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 - 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<DRTask> getAll(Connection c)
                          throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Return a list of all the DR_tasks known to the system. Minimum allowed role: read-only 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 - 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<DRTask,DRTask.Record> getAllRecords(Connection c)
                                               throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Return a map of DR_task references to DR_task records for all DR_tasks known to the system. Minimum allowed role: read-only 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 - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.