VMware Cloud Director API - BlockingTaskSettings

BlockingTaskSettingsType

Element:

BlockingTaskSettings

Type:

Namespace:

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

Description:

Represents the settings related to blocking tasks.

Since:

1.5

Schema:

settings.xsd

Media type(s):

application/vnd.vmware.admin.blockingTaskSettings+json
application/vnd.vmware.admin.blockingTaskSettings+xml

Extends:

ResourceType

XML Representation:

<BlockingTaskSettings 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" model="xs:string"/>
    <TimeoutAction> xs:string </TimeoutAction>
    <vcloud_v1.5:BlockingTaskOperations 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" model="xs:string"/>
        <vcloud_v1.5:TaskOperationType>
            <Category> xs:string </Category>
            <Operation> xs:string </Operation>
        </vcloud_v1.5:TaskOperationType>
    </vcloud_v1.5:BlockingTaskOperations>
    <TimeoutInMilliseconds> BlockingTaskSettingsType/TimeoutInMilliseconds </TimeoutInMilliseconds>
</BlockingTaskSettings>

Attributes

Attribute	Type	Required	Modifiable	Since	Deprecated	Description
href	anyURI	No	always	1.5		The URI of the entity.
type	string	No	always	1.5		The MIME type of the entity.

Elements

Element	Type	Required	Modifiable	Since	Description
BlockingTaskOperations	TaskOperationListType	Yes	always	1.5	Task operations which are enabled for blocking. If this element is empty or not supplied no operations will block.
Link	LinkType	No	none	1.5	A reference to an entity or operation associated with this object.
TimeoutAction	string	Yes	always	1.5	Action to be taken by the automatic timeout policy processing when it gets triggered due to timeout. 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.)
TimeoutInMilliseconds	BlockingTaskSettingsType/TimeoutInMilliseconds	Yes	always	1.5	Value in milliseconds that defines how long to wait for a blocking task to be processed before triggering automatic timeout policy.
VCloudExtension	VCloudExtensionType	No	always	1.5	An optional extension element that can contain an arbitrary number of elements and attributes. Not related to extension services.

Operations

CRUD	Operation	Description	Since	Deprecated
read	GET /admin/extension/settings/blockingTask	Retrieve system blocking task settings.	1.5
as input	PUT /admin/extension/settings/blockingTask	Update system blocking task settings.	1.5