com.xensource.xenapi
Class Task.Record

java.lang.Object
  com.xensource.xenapi.Task.Record

All Implemented Interfaces:

Types.Record

Enclosing class:

Task

public static class Task.Record
extends Object
implements Types.Record

Represents all the fields in a Task

Field Summary

Set<String>	errorInfo if the task has failed, this field contains the set of associated error strings.
String	nameDescription a notes field containg human-readable description
String	nameLabel a human-readable name
Double	progress if the task is still pending, this field contains the estimated percentage complete (0.-1.).
Host	residentOn the host on which the task is running
String	result if the task has completed successfully, this field contains the result value (either Void or an object reference).
Session	session the session that created the task
com.xensource.xenapi.Types.TaskStatusType	status current status of the task
String	type if the task has completed successfully, this field contains the type of the encoded result (i.e.
String	uuid unique identifier/object reference

Constructor Summary

Task.Record()

Method Summary

Map<String,Object>	toMap() Convert a task.Record to a Map
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

uuid

public String uuid

unique identifier/object reference

nameLabel

public String nameLabel

a human-readable name

nameDescription

public String nameDescription

a notes field containg human-readable description

status

public com.xensource.xenapi.Types.TaskStatusType status

current status of the task

session

public Session session

the session that created the task

residentOn

public Host residentOn

the host on which the task is running

progress

public Double progress

if the task is still pending, this field contains the estimated percentage complete (0.-1.). If task has completed (successfully or unsuccessfully) this should be 1.

type

public String type

if the task has completed successfully, this field contains the type of the encoded result (i.e. name of the class whose reference is in the result field). Undefined otherwise.

result

public String result

if the task has completed successfully, this field contains the result value (either Void or an object reference). Undefined otherwise.

errorInfo

public Set<String> errorInfo

if the task has failed, this field contains the set of associated error strings. Undefined otherwise.

Constructor Detail

Task.Record

public Task.Record()

Method Detail

toString

public String toString()

Overrides:

toString in class Object

toMap

public Map<String,Object> toMap()

Convert a task.Record to a Map

Specified by:

toMap in interface Types.Record