models.delivery_rule_proto_delivery_target module

class models.delivery_rule_proto_delivery_target.DeliveryRuleProtoDeliveryTarget(email_address=None, email_recipient_type=None, external_api_curl_options=None, external_api_url=None, locale=None, snmp_notification=None, syslog_notification=None, tenant_id=None)

Bases: object

Implementation of the ‘DeliveryRuleProto_DeliveryTarget’ model.

Delivery targets for the notifications. For now only email delivery is supported. In future, we can potentially add other delivery targets such as paging, SMS, etc.

Attributes:

email_address (string): List of email addresses to send

notifications.

email_recipient_type (int): TODO: Type description here. external_api_curl_options (string): Specifies the curl options used to

invoke above rest external api.

external_api_url (string): Specifies the external api to be invoked

when an alert matching this rule is raised.

locale (string): Locale for the delivery target. snmp_notification (bool): Need to send snmp notification for matched

alerts.

syslog_notification (bool): Need to write syslog for matched alerts. tenant_id (string): Tenant who has been assigned this target. This

field is not populated within AlertsDataProto persisted in Gandalf. This is a convenience field and is populated on the fly by the Alerts component for delivery targets in the delivery_target_list within AlertProto. This field is utilized by NotificationDeliveryHelper to group delivery targets so that we could send out a single email to all the email addresses registered with the same locale by a given tenant or by the SP admin. Another approach could have been to use an internal object, but since the AlertProto contains a list of type DeliveryTarget, this field has been added to make it convenient to pass around an AlertProto object.

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.