Search

Class VclTask

Extends com.vmware.vmo.plugin.vcloud.model.schema.entities.Task
Whenever the result of a request cannot be returned immediately, the server creates a task entity and returns its URL to the client. The client can use this URL in a subsequent GET request to obtain the current status of the task.

Attributes

Name Type Description
cancelRequested boolean TBS
description String TBS
details String Detailed message about the task. Also contained by the Owner entity when task status is preRunning.
endTime VclXMLGregorianCalendar The date and time that processing of the task was completed. May not be present if the task is still being executed.
error VclError Represents error information from a failed task.
expiryTime VclXMLGregorianCalendar The date and time at which the task resource will be destroyed and no longer available for retrieval. May not be present if the task has not been executed or is still being executed.
href String The URI of the entity.
id String The entity identifier, expressed in URN format. The value of this attribute uniquely identifies the entity, persists for the life of the entity, and is never reused.
name String TBS
operation String A message describing the operation that is tracked by this task.
operationKey String Optional unique identifier to support idempotent semantics for create and delete operations.
operationName String The short name of the operation that is tracked by this task.
organization VclReference The organization to which the User belongs.
otherAttributes VclMap TBS Related object types: Key:VclQName Value:String
owner VclReference Reference to the owner of the task. This is typically the object that the task is creating or updating.
params Object The parameters with which this task was started.
progress java.lang.Integer Read-only indicator of task progress as an approximate percentage between 0 and 100. Not available for all tasks.
serviceNamespace String Identifier of the service that created the task. It must not start with com.vmware.vcloud and the length must be between 1 and 128 symbols.
startTime VclXMLGregorianCalendar The date and time the system started executing the task. May not be present if the task has not been executed yet.
status String The execution status of the task. One of:<br> <b>queued</b> (The task has been queued for execution)<br> <b>preRunning</b> (The task is awaiting preprocessing or administrative action.)<br> <b>running</b> (The task is running.)<br> <b>success</b> (The task completed with a status of success.)<br> <b>error</b> (The task encountered an error while running.)<br> <b>canceled</b> (The task was canceled by the owner or an administrator.)<br> <b>aborted</b> (The task was aborted by an administrative action.)
type String The MIME type of the entity.
user VclReference The user who started the task.
vCloudExtension VclObjectList An optional extension element that can contain an arbitrary number of elements and attributes. Not related to extension services. Related object types: VclVCloudExtension

Methods

Name Returns
cancel() void
clone() Object
createEndOfTaskTrigger(Number timeout) Trigger
findRelation(String ) Object[]
getBlockingTask() VclBlockingTask
getContainedObjects() Object[]
getHost() VclHost
getInstance(com.vmware.vcloud.api.rest.schema.TaskType , com.vmware.vmo.plugin.vcloud.VCloudAdaptor ) VclTask
getInstance(com.vmware.vcloud.api.rest.schema.ReferenceType , com.vmware.vmo.plugin.vcloud.VCloudAdaptor ) VclTask
getInstance(com.vmware.vmo.plugin.vcloud.VCloudInventoryObject ) VclTask
getInventoryType() String
getIsBlockingTask() boolean
getParams(Object type) Object
getParent() com.vmware.vmo.plugin.vcloud.VCloudInventoryObject
getRelations() String[]
getTasks() VclTasksInProgress
hasChildrenInRelation(String ) ch.dunes.vso.sdk.api.HasChildrenResult
join(Number timeout, Number period) void
toXml() String
update(VclTaskParams params) VclTask
updateInternalState() void
updateInternalStateFromCache() void

Returned by

Method Returns
com.vmware.vmo.plugin.vcloud.VCloudPluginNotificationMediator.asyncInvalidateCache(VclTask , com.vmware.vmo.plugin.vcloud.VCloudInventoryObject[] ) VclTask
com.vmware.vmo.plugin.vcloud.VCloudPluginNotificationMediator.asyncNotifyDelete(VclTask , com.vmware.vmo.plugin.vcloud.VCloudInventoryObject[] ) VclTask
com.vmware.vmo.plugin.vcloud.VCloudPluginNotificationMediator.asyncNotifyInvalidate(VclTask , com.vmware.vmo.plugin.vcloud.VCloudInventoryObject[] ) VclTask
com.vmware.vmo.plugin.vcloud.VCloudPluginNotificationMediator.asyncNotifyInvalidateAll(VclTask ) VclTask
com.vmware.vmo.plugin.vcloud.VCloudPluginNotificationMediator.asyncNotifyUpdate(VclTask , com.vmware.vmo.plugin.vcloud.VCloudInventoryObject[] ) VclTask
com.vmware.vmo.plugin.vcloud.VCloudPluginNotificationMediator.asyncResumeWatcher(VclTask ) VclTask
com.vmware.vmo.plugin.vcloud.VCloudPluginNotificationMediator.createSuccessfullTask() VclTask
VclAdminExtension.updateLookupService(VclLookupServiceParams params) VclTask
VclAdminOrgVdcNetwork.delete() VclTask
VclAdminOrgVdcNetwork.erase() VclTask
VclAdminOrgVdcNetwork.reset() VclTask
VclAdminOrgVdcNetwork.update() VclTask
VclAdminVdc.delete() VclTask
VclAdminVdc.disableFastProvisioning() VclTask
VclAdminVdc.enableFastProvisioning() VclTask
VclAdminVdc.erase() VclTask
VclAdminVdc.update() VclTask
VclAdminVdc.updateStorageProfiles(VclVdcStorageProfileParams[] classesToAdd, VclReference[] classesToRemove) VclTask
VclCatalog.copyCatalogItem(String name, String description, VclCatalogItem sourceRef) VclTask
VclCatalog.moveCatalogItem(String name, String description, VclCatalogItem sourceRef) VclTask
VclDisk.delete() VclTask
VclDisk.erase() VclTask
VclDisk.updateDisk(String name, String description, VclVdcStorageProfile storageProfile) VclTask
VclExternalNetwork.reset() VclTask
VclGateway.configureServices() VclTask
VclGateway.configureServices(VclGatewayFeatures ) VclTask
VclGateway.delete() VclTask
VclGateway.erase() VclTask
VclGateway.reapplyServices() VclTask
VclGateway.redeploy() VclTask
VclGateway.syncSyslogServer() VclTask
VclGateway.update() VclTask
VclGateway.upgradeConfig() VclTask
VclMedia.delete() VclTask
VclMedia.erase() VclTask
VclMedia.update() VclTask
VclMetadata.deleteTypedEntry(String key) VclTask
VclMetadata.updateMetadataTypedEntries(VclObjectList metadataEntries) VclTask
VclMetadata.updateTypedEntry(VclMetadataEntry value) VclTask
VclOrganization.createTask(VclTaskParams params) VclTask
VclStrandedItem.delete() VclTask
VclStrandedItem.erase() VclTask
VclStrandedItem.forceDelete() VclTask
VclStrandedItem.forceErase() VclTask
VclTask.getInstance(com.vmware.vcloud.api.rest.schema.TaskType , com.vmware.vmo.plugin.vcloud.VCloudAdaptor ) VclTask
VclTask.getInstance(com.vmware.vcloud.api.rest.schema.ReferenceType , com.vmware.vmo.plugin.vcloud.VCloudAdaptor ) VclTask
VclTask.getInstance(com.vmware.vmo.plugin.vcloud.VCloudInventoryObject ) VclTask
VclTask.update(VclTaskParams params) VclTask
VclTasksInProgress.getTasks() VclTask[]
VclVApp.createSnapshot(String name, String description, boolean memory, boolean quiesce) VclTask
VclVApp.delete() VclTask
VclVApp.deploy(boolean powerOn, Number lease, boolean forceCustomization) VclTask
VclVApp.enableDownload() VclTask
VclVApp.erase() VclTask
VclVApp.powerOff() VclTask
VclVApp.powerOn() VclTask
VclVApp.reboot() VclTask
VclVApp.recompose(VclRecomposeVAppParams params) VclTask
VclVApp.removeAllSnapshots() VclTask
VclVApp.reset() VclTask
VclVApp.resetVAppNetwork(String networkName) VclTask
VclVApp.reverToCurrentSnapshot() VclTask
VclVApp.shutdown() VclTask
VclVApp.suspend() VclTask
VclVApp.syncSyslogServer(String vAppNetworkName) VclTask
VclVApp.undeploy(VclUndeployPowerActionType undeployPowerActionType) VclTask
VclVApp.update() VclTask
VclVApp.updateProductSections(VclProductSection[] productSections) VclTask
VclVApp.updateSection(Object section) VclTask
VclVAppNetwork.reset() VclTask
VclVAppTemplate.consolidate() VclTask
VclVAppTemplate.delete() VclTask
VclVAppTemplate.enableDownload() VclTask
VclVAppTemplate.erase() VclTask
VclVAppTemplate.relocate(VclReference datastoreRef) VclTask
VclVAppTemplate.update() VclTask
VclVAppTemplate.updateGoldMaster(boolean value) VclTask
VclVAppTemplate.updateSection(Object section) VclTask
VclVimServer.forceReconnect() VclTask
VclVimServer.importVmIntoVApp(VclImportVmIntoExistingVAppParams params) VclTask
VclVimServer.refresh() VclTask
VclVimServer.refreshStorageProfiles() VclTask
VclVimServer.unregister() VclTask
VclVimServer.update() VclTask
VclVimServer.updateShieldManager(VclShieldManagerParams params) VclTask
VclVM.attachDisk(VclReference diskRef) VclTask
VclVM.checkCompliance() VclTask
VclVM.consolidate() VclTask
VclVM.createSnapshot(String name, String description, boolean memory, boolean quiesce) VclTask
VclVM.delete() VclTask
VclVM.deploy(boolean powerOn, Number lease, boolean forceCustomization) VclTask
VclVM.detachDisk(VclReference diskRef) VclTask
VclVM.disableNestedHypervisor() VclTask
VclVM.ejectMedia(VclMediaInsertOrEjectParams params) VclTask
VclVM.enableNestedHypervisor() VclTask
VclVM.erase() VclTask
VclVM.insertMedia(VclMediaInsertOrEjectParams params) VclTask
VclVM.installVMwareTools() VclTask
VclVM.powerOff() VclTask
VclVM.powerOn() VclTask
VclVM.reboot() VclTask
VclVM.reconfigure(VclVmParams params) VclTask
VclVM.relocate(VclReference datastoreRef) VclTask
VclVM.removeAllSnapshots() VclTask
VclVM.reset() VclTask
VclVM.reverToCurrentSnapshot() VclTask
VclVM.shutdown() VclTask
VclVM.suspend() VclTask
VclVM.undeploy(VclUndeployPowerActionType undeployPowerActionType) VclTask
VclVM.update() VclTask
VclVM.updateCpu(VclVirtualCpu cpu) VclTask
VclVM.updateDisks(VclVirtualDisk[] disks) VclTask
VclVM.updateHotAdd(boolean memoryHotAdd, boolean cpuHotAdd) VclTask
VclVM.updateMemory(VclVirtualMemory memory) VclTask
VclVM.updateNetworkCards(VclVirtualNetworkCard[] nics) VclTask
VclVM.updateProductSections(VclProductSection[] productSections) VclTask
VclVM.updateSection(Object section) VclTask
VclVM.upgradeHardware() VclTask
VclVMWExternalNetwork.delete() VclTask
VclVMWExternalNetwork.erase() VclTask
VclVMWExternalNetwork.reset() VclTask
VclVMWHost.disable() VclTask
VclVMWHost.enable() VclTask
VclVMWHost.prepare(String username, String password) VclTask
VclVMWHost.repair() VclTask
VclVMWHost.unprepare() VclTask
VclVMWHost.upgrade() VclTask
VclVMWNetworkPool.delete() VclTask
VclVMWNetworkPool.erase() VclTask
VclVMWProviderVdc.delete() VclTask
VclVMWProviderVdc.erase() VclTask
VclVMWProviderVdc.mergeProviderVdcs(VclReference[] refs) VclTask
VclVMWProviderVdc.migrateVms(String sourceRpMoRef, VclReference[] vmRefs, VclVimObjectRef targetRpRef) VclTask
VclVMWProviderVdc.updateResourcePools(VclVimObjectRef[] rpsToAdd, VclReference[] rpsToRemove) VclTask
VclVMWProviderVdc.updateStorageProfiles(String[] classesToAdd, VclReference[] classesToRemove) VclTask

Referenced in

Method Returns
com.vmware.vmo.plugin.vcloud.VCloudPluginNotificationMediator.asyncInvalidateCache(VclTask , com.vmware.vmo.plugin.vcloud.VCloudInventoryObject[] ) VclTask
com.vmware.vmo.plugin.vcloud.VCloudPluginNotificationMediator.asyncNotifyDelete(VclTask , com.vmware.vmo.plugin.vcloud.VCloudInventoryObject[] ) VclTask
com.vmware.vmo.plugin.vcloud.VCloudPluginNotificationMediator.asyncNotifyInvalidate(VclTask , com.vmware.vmo.plugin.vcloud.VCloudInventoryObject[] ) VclTask
com.vmware.vmo.plugin.vcloud.VCloudPluginNotificationMediator.asyncNotifyInvalidateAll(VclTask ) VclTask
com.vmware.vmo.plugin.vcloud.VCloudPluginNotificationMediator.asyncNotifyUpdate(VclTask , com.vmware.vmo.plugin.vcloud.VCloudInventoryObject[] ) VclTask
com.vmware.vmo.plugin.vcloud.VCloudPluginNotificationMediator.asyncResumeWatcher(VclTask ) VclTask