TaskType

Element:

Task

Type:

TaskType

Namespace:

http://www.vmware.com/vcloud/v1.5

Description:

Represents an asynchronous operation in vCloud Director.

Since:

0.9

Schema:

task.xsd

Media type(s):

None

Extends:

EntityType

XML Representation:

<Task xmlns="http://www.vmware.com/vcloud/v1.5" href="xs:anyURI" type="xs:string" id="xs:string" operationKey="xs:string"
        name="xs:string" status="xs:string" operation="xs:string" operationName="xs:string"
        serviceNamespace="xs:string" startTime="xs:dateTime" endTime="xs:dateTime" expiryTime="xs:dateTime"
        cancelRequested="xs:boolean">
    <VCloudExtension required="xs:boolean"/>
    <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
            rel="xs:string">
        <VCloudExtension required="xs:boolean"/>
    </Link>
    <Description> xs:string </Description>
    <Tasks>
        <VCloudExtension required="xs:boolean"/>
        <Task> TaskType </Task>
    </Tasks>
    <Owner href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string">
        <VCloudExtension required="xs:boolean"/>
    </Owner>
    <Error stackTrace="xs:string" message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string"
            vendorSpecificErrorCode="xs:string">
        <VCloudExtension required="xs:boolean"/>
        <TenantError message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string" vendorSpecificErrorCode="xs:string">
            <VCloudExtension required="xs:boolean"/>
        </TenantError>
    </Error>
    <User href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string">
        <VCloudExtension required="xs:boolean"/>
    </User>
    <Organization href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string">
        <VCloudExtension required="xs:boolean"/>
    </Organization>
    <Progress> xs:int </Progress>
    <Params> ... </Params>
    <Details> xs:string </Details>
</Task>

Attributes

Attribute	Type	Required	Modifiable	Since	Deprecated	Description
href	anyURI	No	always	0.9		The URI of the entity.
type	string	No	always	0.9		The MIME type of the entity.
id	string	No	none	0.9		The entity identifier, expressed in URN format. The value of this attribute uniquely identifies the entity, persists for the life of the entity, and is never reused.
operationKey	string	No	create	5.1		Optional unique identifier to support idempotent semantics for create and delete operations.
name	string	Yes	always	0.9		The name of the entity.
status	string	Yes	none	0.9		The execution status of the task. One of: queued (The task has been queued for execution) preRunning (The task is awaiting preprocessing or administrative action.) running (The task is running.) success (The task completed with a status of success.) error (The task encountered an error while running.) canceled (The task was canceled by the owner or an administrator.) aborted (The task was aborted by an administrative action.)
operation	string	No	always	0.9		A message describing the operation that is tracked by this task.
operationName	string	No	none	0.9		The short name of the operation that is tracked by this task.
serviceNamespace	string	No	create	5.1		Identifier of the service that created the task. It must not start with com.vmware.vcloud and the length must be between 1 and 128 symbols.
startTime	dateTime	No	none	0.9		The date and time the system started executing the task. May not be present if the task has not been executed yet.
endTime	dateTime	No	none	0.9		The date and time that processing of the task was completed. May not be present if the task is still being executed.
expiryTime	dateTime	No	none	0.9		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.
cancelRequested	boolean	No	none	5.1		Whether user has requested this processing to be canceled.

Elements

Element	Type	Required	Modifiable	Since	Deprecated	Description
Description	string	No	always	0.9		Optional description.
Details	string	No	always	5.1		Detailed message about the task. Also contained by the Owner entity when task status is preRunning.
Error	ErrorType	No	always	0.9		Represents error information from a failed task.
Link	LinkType	No	none	0.9		A reference to an entity or operation associated with this object.
Organization	ReferenceType	No	none	1.5		The organization to which the User belongs.
Owner	ReferenceType	No	create	0.9		Reference to the owner of the task. This is typically the object that the task is creating or updating.
Params	anyType	No	none	1.5		The parameters with which this task was started.
Progress	int	No	none	1.5		Read-only indicator of task progress as an approximate percentage between 0 and 100. Not available for all tasks.
Tasks	TasksInProgressType	No	none	0.9		A list of queued, running, or recently completed tasks associated with this entity.
User	ReferenceType	No	create	1.5		The user who started the task.
VCloudExtension	VCloudExtensionType	No	always	0.9		An optional extension element that can contain an arbitrary number of elements and attributes. Not related to extension services.