XML element Task

Name: Task

Contains information about asynchronous job operations.

Data Structure

{
   "typeId": "com.tintri.api.rest.v310.dto.Task",
   "createDate": <Date>,
   "isCancelable": <Boolean>,
   "lastUpdatedTime": DateTime,
   "localAlias": <String>,
   "progressDescription": <String>,
   "progressError": <Boolean>,
   "progressPercent": <Number>,
   "progressSecondsRemaining": <Number>,
   "state": 'QUEUED' | 'RUNNING' | 'SUCCESS' | 'FAILED' | 'CANCELLED' | 'CANCEL_PENDING' | 'ACKNOWLEDGED',
   "targetIds": <String>,
   "targetType": 'VM' | 'VDISK' | 'SNAPSHOT' | 'JOB' | 'ALERTS' | 'DATASTORE_STAT' | 'VM_STAT' | 'VDISK_STAT' | 'SERVICE_GROUP',
   "type": 'SNAPSHOT' | 'CLONE' | 'REMOTE_COPY' | 'FAILOVER_TEST' | 'FAILOVER' | 'VM_SNAPSHOT_SYNC' | 'RECREATE_REPL_CONFIG' | 'SYNC_VM' | 'RELOCATE_VM' | 'SNAPSHOT_STORAGE_OBJECT' | 'CLONE_STORAGE_OBJECT' | 'CREATE_STORAGE_OBJECT' | 'UPDATE_STORAGE_OBJECT' | 'DELETE_STORAGE_OBJECT' | 'REVERT_STORAGE_OBJECT' | 'BIND_STORAGE_OBJECT' | 'UNBIND_STORAGE_OBJECT',
   "jobDone": <Boolean>,
   "properties": [TaskProperty],
   "uuid": Uuid,
}

Elements
Name	Type	Description
jobDone	xsd:boolean	'True' represents the job is done and is in the following states: CANCELLED, FAILED, or SUCCESS.
property (wrapped by properties)	xsd:list[TaskProperty]	The list of TaskProperty's represents additional information about the job and target object. For example, In case of "remote copy" operation “replLinkName” gives additional information about "name of datastore replication path"
uuid	Uuid	Unique Tintri UUID for the object

Attributes

Name

Type

Description

createDate

xsd:datetime

Job create date

isCancelable

xsd:boolean

Flag to specify whether a Job is cancelable or not

lastUpdatedTime

DateTime

Last time the entity is updated in the format YYYY-MM-DDThh:mm:ss.ms-/+zz:zz

localAlias

xsd:string

Alias used for the entity instance in this Tintri API server. If an alias is not set, then localAlias is not returned.

progressDescription

xsd:string

Job progress state description. Not all tasks set the progress state.

progressError

xsd:boolean

Flag denoting whether the progress has a progress error or not

progressPercent

xsd:float

Job percentage progress (0 - 100%)

progressSecondsRemaining

xsd:long

Seconds remaining in job

state

Current job state.

QUEUED	Job is queued
RUNNING	Job is running
SUCCESS	Job finished successfully
FAILED	Job finished in failure
CANCELLED	Job was cancelled
CANCEL_PENDING	Job has a cancel pending
ACKNOWLEDGED	Not used at this time

targetIds

xsd:list[xsd:string]

The UUIDs of the target resource

targetType

The type of the job target

VM	Virtual machine
VDISK	Virtual disk
SNAPSHOT	Snapshot
JOB	Job
ALERTS	Alert
DATASTORE_STAT	Datastore statistics
VM_STAT	Virtual Machine statistics
VDISK_STAT	Virtual disk statistics
SERVICE_GROUP	Service group

type

Job type

SNAPSHOT	Snapshot job
CLONE	Clone job
REMOTE_COPY	Remote Copy job
FAILOVER_TEST	Failover test job
FAILOVER	Failover job
VM_SNAPSHOT_SYNC	Deprecated
RECREATE_REPL_CONFIG	Recreate replication configuation job
SYNC_VM	Sync virtual machine job
RELOCATE_VM	Relocate virtual machine job
SNAPSHOT_STORAGE_OBJECT	Snapshot storage object job
CLONE_STORAGE_OBJECT	Clone storage object job
CREATE_STORAGE_OBJECT	Create storage object job
UPDATE_STORAGE_OBJECT	Update storage object job
DELETE_STORAGE_OBJECT	Delete storage object job
REVERT_STORAGE_OBJECT	Revert storage object job
BIND_STORAGE_OBJECT	Bind storage object job
UNBIND_STORAGE_OBJECT	Unbind storage object job