BlockingTask

Element:

BlockingTask

Type:

BlockingTaskType

Namespace:

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

Description:

Describes a blocking task request. Contains references to objects involved in the task.

Since:

1.5

Schema:

taskExtensionRequest.xsd

Media type(s):

application/vnd.vmware.admin.blockingTask+xml

Extends:

TaskRequestBaseType

XML Representation:

<BlockingTask xmlns="http://www.vmware.com/vcloud/extension/v1.5" xmlns:vcloud_v1.5="http://www.vmware.com/vcloud/v1.5" href="xs:anyURI" type="xs:string" name="xs:string" id="xs:string"
        createdTime="xs:dateTime" timeoutDate="xs:dateTime" timeoutAction="xs:string" status="xs:string">
    <vcloud_v1.5:Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
            rel="xs:string"/>
    <Description> xs:string </Description>
    <vcloud_v1.5:Tasks>
        <vcloud_v1.5:Task href="xs:anyURI" type="xs:string" name="xs:string" id="xs:string"
                status="xs:string" operation="xs:string" operationName="xs:string" startTime="xs:dateTime"
                endTime="xs:dateTime" expiryTime="xs:dateTime">
            <vcloud_v1.5:Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                    rel="xs:string"/>
            <Description> xs:string </Description>
            <vcloud_v1.5:Tasks> vcloud_v1.5:TasksInProgressType </vcloud_v1.5:Tasks>
            <vcloud_v1.5:Owner href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            <vcloud_v1.5:Error message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string" vendorSpecificErrorCode="xs:string"
                    stackTrace="xs:string"/>
            <vcloud_v1.5:User href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            <vcloud_v1.5:Organization href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            <Progress> xs:int </Progress>
            <Params> ... </Params>
        </vcloud_v1.5:Task>
    </vcloud_v1.5:Tasks>
    <vcloud_v1.5:Organization href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    <vcloud_v1.5:User href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    <vcloud_v1.5:TaskOwner href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
</BlockingTask>

Attributes

Attribute	Type	Required	Modifiable	Since	Description
href	anyURI	No	always	1.5	Contains the URI to the entity.
type	string	No	always	1.5	Contains the type of the entity.
name	string	Yes	always	1.5	The name of the entity.
id	string	No	none	1.5	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.
createdTime	dateTime	Yes	none	1.5	The creation date/time of the request itself.
timeoutDate	dateTime	Yes	none	1.5	The date/time at which this request times out. Requests time out if is not acted upon within a configured interval. When a request times out, it is automatically resumed, aborted or failed.
timeoutAction	string	Yes	none	1.5	Action that is automatically taken when a request times out. One of: resume (The task will be resumed.), abort (The task will be aborted. Transient objects are cleaned up. Task status is set to ABORTED.), fail (The task will be failed. Transient object status and task status are set to ERROR.)
status	string	Yes	none	1.5	Status of the blocking task.

Elements

Element	Type	Occurrence	Modifiable	Since	Description
VCloudExtension	VCloudExtensionType	0..*	always	1.5	An optional extension element that can contain an arbitrary number of elements and attributes.
Link	LinkType	0..*	none	1.5	Optional link to an entity or operation associated with this object.
Description	string	0..1	always	1.5	Optional description.
Tasks	TasksInProgressType	0..1	none	1.5	A list of queued, running, or recently completed tasks associated with this entity.
Organization	ReferenceType	1	none	1.5	The organization in which the blocking task runs.
User	ReferenceType	0..1	none	1.5	The user who triggered the blocking task.
TaskOwner	ReferenceType	0..1	none	1.5	The owner of the blocking task.

Operations

CRUD	Operation	Description	Since
create	POST /admin/extension/blockingTask/{id}/action/updateProgress	This operation updates: the message appended to task log the timeout date - the new value is calculated as the current time plus the new timeout period passed to this method The new timeout date value is calculated as the current time plus the new timeout period passed to this method.	1.5
read	GET /admin/extension/blockingTask/{id}	Gets the representation of a task extension request.	1.5
action	POST /admin/extension/blockingTask/{id}/action/abort	This operation: Aborts request (sets it to {@link TaskExtensionRequestStatusType#ABORTED} Cancels/stops task execution (unlocking any busy object) Cleans/deletes any newly created objects Sets underlying task status to {@link TaskStatus#ABORTED} This operation is considered successful, if requests exists and: Request is in status {@link TaskExtensionRequestStatusType#ACTIVE}, OR Request is in status {@link TaskExtensionRequestStatusType#ABORTED}.	1.5
action	POST /admin/extension/blockingTask/{id}/action/fail	This operation: Fails request (sets it to {@link TaskExtensionRequestStatusType#FAILED} Cancels/stops task execution (unlocking any busy object) Sets any newly created objects to error state Sets underlying task status to error This operation is considered successful, if requests exists and: Request is in status {@link TaskExtensionRequestStatusType#ACTIVE}, OR Request is in status {@link TaskExtensionRequestStatusType#FAILED}.	1.5
action	POST /admin/extension/blockingTask/{id}/action/resume	Resumes request and continues with executing underlying operation.	1.5