Class ThresholdRule (1.7.0)

Version 1.7.0

• 1.15.1 (latest)
• 1.15.0
• 1.14.5
• 1.13.0
• 1.12.0
• 1.11.1
• 1.10.0
• 1.9.1
• 1.8.0
• 1.7.3
• 1.6.2
• 1.5.1
• 1.4.4
• 1.3.0
• 1.2.0
• 1.1.1
• 1.0.1
• 0.4.2
• 0.3.0
• 0.2.0
• 0.1.0

ThresholdRule(mapping=None, *, ignore_unknown_fields=False, **kwargs)

ThresholdRule contains the definition of a threshold. Threshold rules define the triggering events used to generate a budget notification email. When a threshold is crossed (spend exceeds the specified percentages of the budget), budget alert emails are sent to the email recipients you specify in the NotificationsRule <#notificationsrule>__.

Threshold rules also affect the fields included in the JSON data object <https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format>__ sent to a Pub/Sub topic.

Threshold rules are required if using email notifications.

Threshold rules are optional if only setting a `pubsubTopic NotificationsRule <#NotificationsRule>`__, unless you want your JSON data object to include data about the thresholds you set.

For more information, see set budget threshold rules and actions <https://cloud.google.com/billing/docs/how-to/budgets#budget-actions>__.

Attributes

Name	Description
threshold_percent	float Required. Send an alert when this threshold is exceeded. This is a 1.0-based percentage, so 0.5 = 50%. Validation: non-negative number.
spend_basis	google.cloud.billing.budgets_v1beta1.types.ThresholdRule.Basis Optional. The type of basis used to determine if spend has passed the threshold. Behavior defaults to CURRENT_SPEND if not set.

Inheritance

builtins.object > proto.message.Message > ThresholdRule

Classes

Basis

Basis(value)

The type of basis used to determine if spend has passed the threshold.