BlockingTaskOperationParams

Element:
BlockingTaskOperationParams
Type:
BlockingTaskOperationParamsType
Namespace:
http://www.vmware.com/vcloud/extension/v1.5
Description:
Parameters to POST with a blocking task action.
Since:
1.5
Schema:
taskExtensionRequest.xsd
Media type(s):
application/vnd.vmware.admin.blockingTaskOperationParams+xml
Extends:
ResourceType
XML Representation:
<BlockingTaskOperationParams 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">
    <vcloud_v1.5:Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
            rel="xs:string"/>
    <Message> xs:string </Message>
</BlockingTaskOperationParams>

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.

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.
Message string 1 always 1.5 Message that will be associated with the action.

Operations

CRUD Operation Description Since
as input 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
as input 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
as input POST /admin/extension/blockingTask/{id}/action/resume Resumes request and continues with executing underlying operation. 1.5