NotificationsRule(mapping=None, *, ignore_unknown_fields=False, **kwargs)NotificationsRule defines notifications that are sent based on budget spend and thresholds.
Attributes |
|
|---|---|
| Name | Description |
pubsub_topic |
str
Optional. The name of the Pub/Sub topic where budget-related messages are published, in the form projects/{project_id}/topics/{topic_id}. Updates are
sent to the topic at regular intervals; the timing of the
updates is not dependent on the `threshold
rules <#thresholdrule>`__ you've set.
Note that if you want your `Pub/Sub JSON
object |
schema_version |
str
Optional. Required when NotificationsRule.pubsub_topic is set. The schema version of the notification sent to NotificationsRule.pubsub_topic. Only "1.0" is accepted. It represents the JSON schema as defined in https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format. |
monitoring_notification_channels |
MutableSequence[str]
Optional. Email targets to send notifications to when a threshold is exceeded. This is in addition to the DefaultIamRecipients who receive alert emails based on
their billing account IAM role. The value is the full REST
resource name of a Cloud Monitoring email notification
channel with the form
projects/{project_id}/notificationChannels/{channel_id}.
A maximum of 5 email notifications are allowed.
To customize budget alert email recipients with monitoring
notification channels, you *must create the monitoring
notification channels before you link them to a budget*. For
guidance on setting up notification channels to use with
budgets, see `Customize budget alert email
recipients |
disable_default_iam_recipients |
bool
Optional. When set to true, disables default notifications sent when a threshold is exceeded. Default notifications are sent to those with Billing Account Administrator and Billing Account User IAM roles for the target account. |
enable_project_level_recipients |
bool
Optional. When set to true, and when the budget has a single project configured, notifications will be sent to project level recipients of that project. This field will be ignored if the budget has multiple or no project configured. Currently, project level recipients are the users with Owner role on a cloud project.
|