Snapservice Tasks Info

Snapservice Tasks Info
Snapservice Tasks Info

The Snapservice Tasks Info schema contains information about a task.

This schema was added in vSphere API 8.0.3.0.

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": "Vapi Std NestedLocalizableMessage 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": "Vapi Std NestedLocalizableMessage 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

Progress of the operation.

This property was added in vSphere API 8.0.3.0.

This property is optional and it is only relevant when the value of status is one of Snapservice Tasks Status.RUNNING, Snapservice Tasks Status.BLOCKED, Snapservice Tasks Status.SUCCEEDED, or Snapservice Tasks Status.FAILED.

result
Optional

Result of the operation.

This property was added in vSphere API 8.0.3.0.

This property will be missing or null 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 property was added in vSphere API 8.0.3.0.

This property will be missing or null if there is no corresponding VC task created.

description
Required

Description of the operation associated with the task.

This property was added in vSphere API 8.0.3.0.

string
service
Required

Identifier of the service containing the operation.

This property was added in vSphere API 8.0.3.0.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.snapservice.service. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.snapservice.service.

string
operation
Required

Identifier of the operation associated with the task.

This property was added in vSphere API 8.0.3.0.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.snapservice.operation. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.snapservice.operation.

string
parent
Optional

Parent of the current task.

This property was added in vSphere API 8.0.3.0.

This property will be missing or null if the task has no parent.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.snapservice.task. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.snapservice.task.

target
Optional

Identifier of the target created by the operation or an existing one the operation performed on.

This property was added in vSphere API 8.0.3.0.

This property will be missing or null if the operation has no target or multiple targets.

string
status
Required

Status of the operation associated with the task.

For more information see: Snapservice Tasks Status.

This property was added in vSphere API 8.0.3.0.

boolean
cancelable
Required

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

This property was added in vSphere API 8.0.3.0.

object
error
Optional

Description of the error if the operation status is "FAILED".

This property was added in vSphere API 8.0.3.0.

If missing or null the description of why the operation failed will be included in the result of the operation (see Snapservice Tasks Info.result).

string As date-time As date-time
start_time
Optional

Time when the operation is started.

This property was added in vSphere API 8.0.3.0.

This property is optional and it is only relevant when the value of status is one of Snapservice Tasks Status.RUNNING, Snapservice Tasks Status.BLOCKED, Snapservice Tasks Status.SUCCEEDED, or Snapservice Tasks Status.FAILED.

string As date-time As date-time
end_time
Optional

Time when the operation is completed.

This property was added in vSphere API 8.0.3.0.

This property is optional and it is only relevant when the value of status is one of Snapservice Tasks Status.SUCCEEDED or Snapservice Tasks Status.FAILED.

string
user
Optional

Name of the user who performed the operation.

This property was added in vSphere API 8.0.3.0.

This property will be missing or null if the operation is performed by the system.

Returned By