Class ThresholdRule (1.9.1)

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

ThresholdRule contains a definition of a threshold which triggers an alert (a notification of a threshold being crossed) to be sent when spend goes above the specified amount. Alerts are automatically e-mailed to users with the Billing Account Administrator role or the Billing Account User role. The thresholds here have no effect on notifications sent to anything configured under Budget.all_updates_rule.

Attributes

NameDescription
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_v1.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.

Classes

Basis

Basis(value)

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

Values: BASIS_UNSPECIFIED (0): Unspecified threshold basis. CURRENT_SPEND (1): Use current spend as the basis for comparison against the threshold. FORECASTED_SPEND (2): Use forecasted spend for the period as the basis for comparison against the threshold. FORECASTED_SPEND can only be set when the budget's time period is a Filter.calendar_period. It cannot be set in combination with Filter.custom_period.