SoftLayer Network Storage Backup Evault::deleteTasks
From SoftLayer Development Network Wiki
deleteTasks is a member of the SoftLayer_Network_Storage_Backup_Evault service.
Contents |
Overview
This method can be used to help maintain the storage space on a vault. This method can take two routes. The route taken by the method is based on if the tasks has a related Webcc Job.
When a job is removed from the Webcc, the task and stored usage still exists on the vault. This method can be used to delete the associated task and its usage.
When the time comes to clear the usage for the job WITHOUT deleting the job from the webcc, this method can be used. The method is able to determine if the task to be deleted has a related Webcc Job. If it does, the task will not be deleted, but the usage for the tasks will be cleared. By simply clearing the usage and leaving the tasks on the vault, this allows the Webcc Job to run without any interruptions. This method is especially helpful in avoiding overage charges.
All that is required for the use of the method is to pass in an integer array of task(s). The method itself is smart enough to determine whether to just clear the usage or delete the task altogether.
Return Type
deleteTasks returns the void data type.
Headers
Required Headers
deleteTasks requires the following headers:
Parameters
deleteTasks takes the following parameters:
tasks
Array of tasks to be deleted.
- Type: array of integers
