Reference documentation and code samples for the Google Cloud Billing Budgets V1 Client class ThresholdRule.
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 .
Threshold rules also affect the fields included in the JSON data
object
sent to a Pub/Sub topic.
Threshold rules are required
if using email notifications.
Threshold rules are optional
if only setting a pubsubTopic
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
.
Generated from protobuf message google.cloud.billing.budgets.v1.ThresholdRule
Namespace
Google \ Cloud \ Billing \ Budgets \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ 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
int
Optional. The type of basis used to determine if spend has passed the threshold. Behavior defaults to CURRENT_SPEND if not set.
getThresholdPercent
Required. Send an alert when this threshold is exceeded.
This is a 1.0-based percentage, so 0.5 = 50%. Validation: non-negative number.
float
setThresholdPercent
Required. Send an alert when this threshold is exceeded.
This is a 1.0-based percentage, so 0.5 = 50%. Validation: non-negative number.
var
float
$this
getSpendBasis
Optional. The type of basis used to determine if spend has passed the threshold. Behavior defaults to CURRENT_SPEND if not set.
int
setSpendBasis
Optional. The type of basis used to determine if spend has passed the threshold. Behavior defaults to CURRENT_SPEND if not set.
var
int
$this
