org.jclouds.vcloud.director.v1_5.domain

Class Task

java.lang.Object

org.jclouds.vcloud.director.v1_5.domain.Resource

org.jclouds.vcloud.director.v1_5.domain.Entity

org.jclouds.vcloud.director.v1_5.domain.Task

public class Task
extends Entity

Represents an asynchronous or long-running task in the vCloud environment.

 <xs:complexType name="TaskType">
 

TODO: this object and the hierarchy is wrong. it is literally a Task with a Task container. please review class diagram

Author:

grkvlt@apache.org

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Task.Builder<B extends Task.Builder<B>>
static class	Task.Status

Field Summary

Fields

Modifier and Type	Field and Description
static String	MEDIA_TYPE

Fields inherited from class org.jclouds.vcloud.director.v1_5.domain.Resource

logger

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Task()
protected	Task(Task.Builder<?> builder)

Method Summary

Methods

Modifier and Type	Method and Description
static Task.Builder<?>	builder()
boolean	equals(Object o)
Reference	get() The organization that started the task.
Date	getEndTime() The date and time that processing of the task was completed.
Error	getError() Represents an error information if the task failed.
Date	getExpiryTime() The date and time at which the task resource will be destroyed and no longer available for retrieval.
String	getOperation() The display name of the operation that is tracked by this task.
String	getOperationName() The name of the operation that is tracked by this task.
Reference	getOwner() Reference to the owner of the task.
Object	getParams() The parameters with which this task has been run.
Integer	getProgress() The progress of a long running asynchronous task.
Date	getStartTime() The date and time the system started executing the task.
Task.Status	getStatus() The execution status of the task.
Reference	getUser() The user who started the task.
int	hashCode()
com.google.common.base.Objects.ToStringHelper	string()
Task.Builder<?>	toBuilder()

Methods inherited from class org.jclouds.vcloud.director.v1_5.domain.Entity

clone, getDescription, getId, getName, getTasks, setDescription, setName

Methods inherited from class org.jclouds.vcloud.director.v1_5.domain.Resource

getHref, getLinks, getType, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

MEDIA_TYPE

public static final String MEDIA_TYPE

See Also:

Constant Field Values

Constructor Detail

Task

protected Task(Task.Builder<?> builder)

Task

protected Task()

Method Detail

builder

public static Task.Builder<?> builder()

toBuilder

public Task.Builder<?> toBuilder()

Overrides:

toBuilder in class Entity

getError

public Error getError()

Represents an error information if the task failed.

get

public Reference get()

The organization that started the task.

getOwner

public Reference getOwner()

Reference to the owner of the task.

getUser

public Reference getUser()

The user who started the task.

getParams

public Object getParams()

The parameters with which this task has been run.

getProgress

public Integer getProgress()

The progress of a long running asynchronous task.

The value is between 0 - 100. Not all tasks have progress, the value is not present for task which progress is not available.

getStatus

public Task.Status getStatus()

The execution status of the task.

getOperation

public String getOperation()

The display name of the operation that is tracked by this task.

getOperationName

public String getOperationName()

The name of the operation that is tracked by this task.

getStartTime

public Date getStartTime()

The date and time the system started executing the task.

May not be present if the task hasn't been executed yet.

getEndTime

public Date getEndTime()

The date and time that processing of the task was completed.

May not be present if the task is still being executed.

getExpiryTime

public Date getExpiryTime()

The date and time at which the task resource will be destroyed and no longer available for retrieval.

May not be present if the task has not been executed or is still being executed.

equals

public boolean equals(Object o)

Overrides:

equals in class Entity

hashCode

public int hashCode()

Overrides:

hashCode in class Entity

string

public com.google.common.base.Objects.ToStringHelper string()

Overrides:

string in class Entity