Documentation
¶
Overview ¶
Package tasks contains methods related to Tasks
Index ¶
- type TasksV1
- func (t *TasksV1) ListTasks(limit *int64, start *string, filter *string) (*models.ListTasksResponse, *apiutils.APIError)
- func (t *TasksV1) ReadTask(taskId string) (*models.ReadTaskResponse, *apiutils.APIError)
- func (t *TasksV1) UpdateTask(taskId string, body *models.UpdateTaskV1Request) (*models.UpdateTaskResponse, *apiutils.APIError)
- type TasksV1Client
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type TasksV1 ¶
type TasksV1 struct {
// contains filtered or unexported fields
}
TasksV1 represents a custom type struct
func (*TasksV1) ListTasks ¶
func (t *TasksV1) ListTasks( limit *int64, start *string, filter *string) ( *models.ListTasksResponse, *apiutils.APIError)
ListTasks Returns a list of tasks. Tasks include scheduled backup and on-demand restore related tasks.
The following table describes the supported task types. +-----------------------------------+------------------------------------------+ | Task Type | Description | +===================================+==========================================+ | vmware_vm_file_restore | A restore task for a file within a VM. | +-----------------------------------+------------------------------------------+ | vmware_vm_backup_seeding | The initial backup task of a VM - future | | | backups are incremental. | +-----------------------------------+------------------------------------------+ | vmware_vm_incremental_backup | A scheduled incremental backup task for | | | a VM. | +-----------------------------------+------------------------------------------+ | vmware_vm_backup_indexing | A post-processing task that indexes the | | | contents | | | of a VM disk in preparation for file- | | | level indexing and restores. | | | The vmware_vm_backup_indexing task | | | cannot be aborted. | +-----------------------------------+------------------------------------------+ | vmware_vm_restore | A restore task for a VM. | +-----------------------------------+------------------------------------------+ | aws_ebs_volume_file_restore | A restore task for a file within an EBS | | | volume. | +-----------------------------------+------------------------------------------+ | aws_ebs_volume_backup_seeding | The initial backup task of an EBS Volume | | | - future backups are incremental. | +-----------------------------------+------------------------------------------+ | aws_ebs_volume_incremental_backup | A scheduled incremental backup task for | | | an EBS volume. | +-----------------------------------+------------------------------------------+ | aws_ebs_volume_backup_indexing | A post-processing task that indexes the | | | contents | | | of an EBS volume in preparation for | | | file-level indexing and restores. | | | The aws_ebs_volume_backup_indexing task | | | cannot be aborted. | +-----------------------------------+------------------------------------------+ | aws_ebs_volume_restore | A restore task for an EBS Volume. | +-----------------------------------+------------------------------------------+ | microsoft365_mailbox_seeding | The initial backup task of a mailbox - | | | future backups are incremental. | +-----------------------------------+------------------------------------------+ | microsoft365_mailbox_backup | A scheduled incremental backup task for | | | a mailbox. | +-----------------------------------+------------------------------------------+ | microsoft365_inventory_sync | A task that synchronizes Clumio with the | | | Microsoft 365 domain by gathering | | | mailbox information and other data, such | | | as usage and sizing statistics. | | | The microsoft365_inventory_sync task | | | cannot be aborted. | +-----------------------------------+------------------------------------------+ | microsoft365_mail_restore | A restore task for a microsoft365 | | | mailbox. | +-----------------------------------+------------------------------------------+ The following table describes the supported task statuses. +-------------+----------------------------------------------------------------+ | Task Status | Description | +=============+================================================================+ | queued | A task that is waiting to begin. A task that is in queue can | | | be aborted at any time. | +-------------+----------------------------------------------------------------+ | in_progress | A task that is currently running. Once the task has | | | successfully completed, | | | the task status changes to completed. | | | A task that is in progress can be aborted at any time. | +-------------+----------------------------------------------------------------+ | completed | A task that has successfully completed. | +-------------+----------------------------------------------------------------+ | failed | A task that has failed to complete. | +-------------+----------------------------------------------------------------+ | aborting | A task that is in the process of aborting. | | | Only tasks that are queued or in progress can be aborted. | | | Once a task has successfully aborted, the task status changes | | | to aborted. | +-------------+----------------------------------------------------------------+ | aborted | A task that has fully aborted. | +-------------+----------------------------------------------------------------+
func (*TasksV1) ReadTask ¶
func (t *TasksV1) ReadTask( taskId string) ( *models.ReadTaskResponse, *apiutils.APIError)
ReadTask Returns a representation of the specified task.
func (*TasksV1) UpdateTask ¶
func (t *TasksV1) UpdateTask( taskId string, body *models.UpdateTaskV1Request) ( *models.UpdateTaskResponse, *apiutils.APIError)
UpdateTask Manages the specified task. Managing a task includes aborting a task that is in queue or in progress.
type TasksV1Client ¶
type TasksV1Client interface {
// ListTasks Returns a list of tasks. Tasks include scheduled backup and on-demand restore related tasks.
//
// The following table describes the supported task types.
//
// +-----------------------------------+------------------------------------------+
// | Task Type | Description |
// +===================================+==========================================+
// | vmware_vm_file_restore | A restore task for a file within a VM. |
// +-----------------------------------+------------------------------------------+
// | vmware_vm_backup_seeding | The initial backup task of a VM - future |
// | | backups are incremental. |
// +-----------------------------------+------------------------------------------+
// | vmware_vm_incremental_backup | A scheduled incremental backup task for |
// | | a VM. |
// +-----------------------------------+------------------------------------------+
// | vmware_vm_backup_indexing | A post-processing task that indexes the |
// | | contents |
// | | of a VM disk in preparation for file- |
// | | level indexing and restores. |
// | | The vmware_vm_backup_indexing task |
// | | cannot be aborted. |
// +-----------------------------------+------------------------------------------+
// | vmware_vm_restore | A restore task for a VM. |
// +-----------------------------------+------------------------------------------+
// | aws_ebs_volume_file_restore | A restore task for a file within an EBS |
// | | volume. |
// +-----------------------------------+------------------------------------------+
// | aws_ebs_volume_backup_seeding | The initial backup task of an EBS Volume |
// | | - future backups are incremental. |
// +-----------------------------------+------------------------------------------+
// | aws_ebs_volume_incremental_backup | A scheduled incremental backup task for |
// | | an EBS volume. |
// +-----------------------------------+------------------------------------------+
// | aws_ebs_volume_backup_indexing | A post-processing task that indexes the |
// | | contents |
// | | of an EBS volume in preparation for |
// | | file-level indexing and restores. |
// | | The aws_ebs_volume_backup_indexing task |
// | | cannot be aborted. |
// +-----------------------------------+------------------------------------------+
// | aws_ebs_volume_restore | A restore task for an EBS Volume. |
// +-----------------------------------+------------------------------------------+
// | microsoft365_mailbox_seeding | The initial backup task of a mailbox - |
// | | future backups are incremental. |
// +-----------------------------------+------------------------------------------+
// | microsoft365_mailbox_backup | A scheduled incremental backup task for |
// | | a mailbox. |
// +-----------------------------------+------------------------------------------+
// | microsoft365_inventory_sync | A task that synchronizes Clumio with the |
// | | Microsoft 365 domain by gathering |
// | | mailbox information and other data, such |
// | | as usage and sizing statistics. |
// | | The microsoft365_inventory_sync task |
// | | cannot be aborted. |
// +-----------------------------------+------------------------------------------+
// | microsoft365_mail_restore | A restore task for a microsoft365 |
// | | mailbox. |
// +-----------------------------------+------------------------------------------+
//
//
// The following table describes the supported task statuses.
//
// +-------------+----------------------------------------------------------------+
// | Task Status | Description |
// +=============+================================================================+
// | queued | A task that is waiting to begin. A task that is in queue can |
// | | be aborted at any time. |
// +-------------+----------------------------------------------------------------+
// | in_progress | A task that is currently running. Once the task has |
// | | successfully completed, |
// | | the task status changes to completed. |
// | | A task that is in progress can be aborted at any time. |
// +-------------+----------------------------------------------------------------+
// | completed | A task that has successfully completed. |
// +-------------+----------------------------------------------------------------+
// | failed | A task that has failed to complete. |
// +-------------+----------------------------------------------------------------+
// | aborting | A task that is in the process of aborting. |
// | | Only tasks that are queued or in progress can be aborted. |
// | | Once a task has successfully aborted, the task status changes |
// | | to aborted. |
// +-------------+----------------------------------------------------------------+
// | aborted | A task that has fully aborted. |
// +-------------+----------------------------------------------------------------+
//
ListTasks(
limit *int64,
start *string,
filter *string) (
*models.ListTasksResponse, *apiutils.APIError)
// ReadTask Returns a representation of the specified task.
ReadTask(
taskId string) (
*models.ReadTaskResponse, *apiutils.APIError)
// UpdateTask Manages the specified task. Managing a task includes aborting a task that is in queue or in progress.
UpdateTask(
taskId string,
body *models.UpdateTaskV1Request) (
*models.UpdateTaskResponse, *apiutils.APIError)
}
TasksV1Client represents a custom type interface
func NewTasksV1 ¶
func NewTasksV1(config config.Config) TasksV1Client
NewTasksV1 returns TasksV1Client
Source Files
Click to show internal directories.
Click to hide internal directories.