TaskSummary

TaskSummary
TaskSummary

Represents a hierarchical task structure supporting nested sub-tasks and execution steps. For complete examples demonstrating the hierarchical task model with sub-tasks, steps, and various execution scenarios, see: classpath:sample-task-example.yaml

JSON Example
{
    "resourceId": "af6ef462-e192-4fe1-9522-67a50a2b3392",
    "updatedBy": "admin",
    "parentTaskId": "f81ec638-4452-4ae6-bffe-2ff284b43710",
    "description": {
        "args": {
            "cloudProxyFqdn": "cloudProxy1.vsphere.local"
        },
        "localizedMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
        "defaultMessage": "Started upgrade for Cloud Proxy `cloudProxy1.vsphere.local`",
        "id": "com.broadcom.lcm.ops.cloudproxy.upgrade.started"
    },
    "updateTime": "2000-01-23T04:56:07.000Z",
    "type": "type",
    "cancellable": true,
    "retriable": true,
    "createdBy": "admin",
    "createTime": "2000-01-23T04:56:07.000Z",
    "name": "vcfa_90_to_91_upgrade",
    "startTime": "2000-01-23T04:56:07.000Z",
    "correlationId": "39ab89c8-a945-4290-9327-13c5bd3f595c",
    "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "endTime": "2000-01-23T04:56:07.000Z",
    "status": "PENDING",
    "resourceType": "COMPONENT"
}
string
id
Required

Unique identifier for the task (UUID format)

string
name
Optional

Unique name of the task

LocalizableMessage
description
Optional

description

TaskStatus
status
Optional

A common status object to define the lifecycle state of an operation

Possible values are : PENDING, SCHEDULED, RUNNING, SUCCEEDED, FAILED, CANCELED,
string
type
Optional

Type of the task, example precheck, apply, validate, etc.

string
createdBy
Optional

username or service account that triggered the task.

string
updatedBy
Optional

username or service account that updated the task.

string
resourceId
Optional

ID of resource on which the task is triggered

string
resourceType
Optional

Type of resource on which the task is triggered

string As date-time As date-time
createTime
Optional

ISO 8601 timestamp when this Task was created

string As date-time As date-time
startTime
Optional

ISO 8601 timestamp when this Task was started

string As date-time As date-time
updateTime
Optional

ISO 8601 timestamp when this Task was updated

string As date-time As date-time
endTime
Optional

ISO 8601 timestamp when this Task was completed

string
correlationId
Optional

ID used to correlate the task with other systems

string
parentTaskId
Optional

ID of parent task

boolean
retriable
Optional

Indicates if this task is in a state that can be retried

boolean
cancellable
Optional

Indicates if this task is in a state that can be cancelled

Property Of