models.alert_document module

class models.alert_document.AlertDocument(alert_cause=None, alert_description=None, alert_help_text=None, alert_name=None)

Bases: object

Implementation of the ‘AlertDocument’ model.

Specifies documentation about the Alert such as name, description, cause and how to resolve the Alert.

Attributes:

alert_cause (string): Specifies cause of the Alert that is included in

the body of the email or any other type of notification.

alert_description (string): Specifies brief description about the

Alert that is used in the subject line when sending a notification email for an Alert.

alert_help_text (string): Specifies instructions describing how to

resolve the Alert that is included in the body of the email or any other type of notification.

alert_name (string): Specifies short name that describes the Alert

type such as DiskBad, HighCpuUsage, FrequentProcessRestarts, etc.

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.