Skip to content

Latest commit

 

History

History
52 lines (34 loc) · 1.82 KB

File metadata and controls

52 lines (34 loc) · 1.82 KB

AlarmNotificationRuleTriggerConfig

tb_ce_client.models.AlarmNotificationRuleTriggerConfig

Extends: NotificationRuleTriggerConfig

Properties

Name Type Description Notes
alarm_types List[str] [optional]
alarm_severities List[AlarmSeverity] [optional]
notify_on List[AlarmAction]
clear_rule ClearRule [optional]

Referenced Types

NotificationRuleTriggerConfig

Name Type Description Notes
trigger_type NotificationRuleTriggerType

AlarmSeverity (enum)

CRITICAL | MAJOR | MINOR | WARNING | INDETERMINATE

AlarmAction (enum)

CREATED | SEVERITY_CHANGED | ACKNOWLEDGED | CLEARED

ClearRule

Name Type Description Notes
alarm_statuses List[AlarmSearchStatus] [optional]

NotificationRuleTriggerType (enum)

ENTITY_ACTION | ALARM | ALARM_COMMENT | ALARM_ASSIGNMENT | DEVICE_ACTIVITY | RULE_ENGINE_COMPONENT_LIFECYCLE_EVENT | EDGE_CONNECTION | EDGE_COMMUNICATION_FAILURE | NEW_PLATFORM_VERSION | ENTITIES_LIMIT | … (14 values total)

AlarmSearchStatus (enum)

ANY | ACTIVE | CLEARED | ACK | UNACK


Conventions

  • Package: tb_ce_client.models
  • Attribute access: obj.alarm_types, obj.name, etc.
  • Serialize: obj.model_dump() or obj.model_dump(by_alias=True) for camelCase JSON
  • Deserialize: AlarmNotificationRuleTriggerConfig.model_validate(data) or AlarmNotificationRuleTriggerConfig.model_validate_json(json_str)
  • None fields: Optional attributes default to None; accessing them never raises exceptions