models.task_notification module

class models.task_notification.TaskNotification(backup_task=None, bulk_install_app_task=None, clone_task=None, created_time_secs=None, description=None, dismissed=None, dismissed_time_secs=None, field_message_task=None, id=None, recovery_task=None, status=None, task_type=None, visited=None, visited_time_secs=None)

Bases: object

Implementation of the ‘TaskNotification’ model.

Structure that captures Task Notifications for a user.

Attributes:

backup_task (BackupTaskInfo): The notifications details of Backup

Task.

bulk_install_app_task (BulkInstallAppTaskInfo): The notifications

details of BulkInstall Task.

clone_task (CloneTaskInfo): Parameters for a clone op. created_time_secs (long|int): Timestamp at which the notification was

created.

description (string): Description holds the actual notification text

generated for the event.

dismissed (bool): Dismissed keeps track of whether a notification has

been seen or not. User may choose to dismiss individual event or all notifications at once. Nil or 0 value represents false.

dismissed_time_secs (long|int): Timestamp at which user dismissed this

notification event.

field_message_task (BasicTaskInfo): The notification details of Field

Message Task.

id (string): id identifies a user notification event uniquely. This

can also be used to dismiss individual notifications.

recovery_task (RecoveryTaskInfo): Parameters for a recovery op. status (StatusTaskNotificationEnum): Status of the task. Status of the

task. ‘kSuccess’ indicates that task completed successfully. ‘kError’ indicates that task encountered errors.

task_type (TaskTypeEnum): Task type denotes which type of task this

notification is for. This param is used to reflect the taskType. ‘Restore’ notification type is generated upon completion of Restore tasks. ‘Clone’ notification type is generated upon completion of Clone tasks. ‘BackupNow’ notification type is generated upon completion of Backup tasks. ‘FieldMessage’ notification type is generated when field message from Cohesity support is created. ‘bulkInstallApp’ notification type is generated from bulk install app. ‘tiering’ notification type is generated upon completion of tiering tasks. ‘analysis’ notification type is generated upon completion of analysis tasks.

visited (bool): Visited keeps track of whether a notification has been

seen or not.

visited_time_secs (long|int): Timestamp at which user visited this

notification event.

classmethod from_dictionary(dictionary)

Creates an instance of this model from a dictionary

Args:

dictionary (dictionary): A dictionary representation of the object as obtained from the deserialization of the server’s response. The keys MUST match property names in the API description.

Returns:

object: An instance of this structure class.