Tasks_Info

Tasks_Info
Tasks_Info

The Info structure contains information about a task.

JSON Example
{
    "progress": {
        "total": 0,
        "completed": 0,
        "message": {
            "id": "string",
            "default_message": "string",
            "args": [
                "string"
            ],
            "params": {
                "params": {
                    "s": "string",
                    "dt": "string",
                    "i": 0,
                    "d": "number",
                    "l": {
                        "id": "string",
                        "params": {
                            "params": "Std_LocalizationParam Object"
                        }
                    },
                    "format": "string",
                    "precision": 0
                }
            },
            "localized": "string"
        }
    },
    "vc_task": "string",
    "description": {
        "id": "string",
        "default_message": "string",
        "args": [
            "string"
        ],
        "params": {
            "params": {
                "s": "string",
                "dt": "string",
                "i": 0,
                "d": "number",
                "l": {
                    "id": "string",
                    "params": {
                        "params": "Std_LocalizationParam Object"
                    }
                },
                "format": "string",
                "precision": 0
            }
        },
        "localized": "string"
    },
    "service": "string",
    "operation": "string",
    "parent": "string",
    "target": {
        "type": "string",
        "id": "string"
    },
    "status": "string",
    "cancelable": false,
    "error": {},
    "start_time": "string",
    "end_time": "string",
    "user": "string"
}
progress
Optional

The Progress structure contains information describe the progress of an operation.

AnyType
result
Optional

Result of the operation.

This field will be unset if the operation does not return a result or if the result is not available at the current step of the operation.

string
vc_task
Optional

Associated vCenter task for the given task. This field will be unset if there is no corresponding VC task created.

description
Required

The LocalizableMessage structure represents localizable string and message template. Services include one or more localizable message templates in the errors they report so that clients can display diagnostic messages in the native language of the user. Services can include localizable strings in the data returned from operations to allow clients to display localized status information in the native language of the user.

string
service
Required

Identifier of the service containing the operation. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.snapservice.service. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.snapservice.service.

string
operation
Required

Identifier of the operation associated with the task. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.snapservice.operation. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.snapservice.operation.

string
parent
Optional

Parent of the current task. This field will be unset if the task has no parent. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.snapservice.task. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.snapservice.task.

target
Optional

The DynamicID structure represents an identifier for a resource of an arbitrary type.

status
Required

The Status enumerated type defines the status values that can be reported for an operation.
PENDING : The operation is in pending state.
RUNNING : The operation is in progress.
BLOCKED : The operation is blocked. The operation could be blocked if the system is waiting for resources to be available to perform the operation.
SUCCEEDED : The operation completed successfully.
FAILED : The operation failed.

boolean
cancelable
Required

Flag to indicate whether or not the operation can be cancelled. The value may change as the operation progresses.

object
error
Optional

Description of the error if the operation status is "FAILED". If unset the description of why the operation failed will be included in the result of the operation (see Info.result).

string As date-time
start_time
Optional

Time when the operation is started. This field is optional and it is only relevant when the value of CommonInfo.status is one of RUNNING, BLOCKED, SUCCEEDED, or FAILED.

string As date-time
end_time
Optional

Time when the operation is completed. This field is optional and it is only relevant when the value of CommonInfo.status is one of SUCCEEDED or FAILED.

string
user
Optional

Name of the user who performed the operation. This field will be unset if the operation is performed by the system.