AlertDefinition

class q2_sdk.hq.db.alert_definition.AlertDefinitionRow(element, row_class=None, rename_fields=None)[source]

Bases: TableRow

AlertDefinitionID: int

AlertTypeID: int

UserID: int

Enabled: bool

SendSecureMessage: bool

OneTimeAlert: bool

NotificationTypeID: int

NotificationTime: str

LastAlerted: str

CreateDate: str

class q2_sdk.hq.db.alert_definition.AlertDefinition(logger, hq_credentials=None, ret_table_obj=None)[source]

Bases: DbObject

Programmatic access to the Q2 database. Not as flexible as a true ORM, but takes the guesswork out of database schemas and ensures safety in the transactions.

Parameters:

logger – Reference to calling request’s logger (self.logger in your extension)
hq_credentials (Optional[HqCredentials]) – HQ Connectivity Information (Defaults to settings file)
ret_table_obj (Optional[bool]) – Flag to return list of LXML elements if False or TableRow objects from DB calls if True (Defaults to settings file)

NAME = 'AlertDefinition'

REPRESENTATION_ROW_CLASS: alias of AlertDefinitionRow

add_arguments(parser)[source]: Hook for subclassed DbObjects to add custom arguments.

async get(alert_type_short_name, serialize_for_cli=False)[source]

Return type:: Union[List[AlertDefinitionRow], str]

async disable_by_alert_type(alert_type_short_name)[source]