Reference documentation and code samples for the Google Cloud Billing Budgets V1 Client class ThresholdRule.
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.
Generated from protobuf message google.cloud.billing.budgets.v1.ThresholdRule
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSpendBasis
Optional. The type of basis used to determine if spend has passed the threshold. Behavior defaults to CURRENT_SPEND if not set.
| Returns | |
|---|---|
| Type | Description |
int | |
setSpendBasis
Optional. The type of basis used to determine if spend has passed the threshold. Behavior defaults to CURRENT_SPEND if not set.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |