Billing Budgets V1 API - Class Google::Cloud::Billing::Budgets::V1::ThresholdRule (v1.0.1)

Reference documentation and code samples for the Billing Budgets V1 API class Google::Cloud::Billing::Budgets::V1::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.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#spend_basis

def spend_basis() -> ::Google::Cloud::Billing::Budgets::V1::ThresholdRule::Basis

Returns

(::Google::Cloud::Billing::Budgets::V1::ThresholdRule::Basis) — Optional. The type of basis used to determine if spend has passed the threshold. Behavior defaults to CURRENT_SPEND if not set.

#spend_basis=

def spend_basis=(value) -> ::Google::Cloud::Billing::Budgets::V1::ThresholdRule::Basis

Parameter

value (::Google::Cloud::Billing::Budgets::V1::ThresholdRule::Basis) — Optional. The type of basis used to determine if spend has passed the threshold. Behavior defaults to CURRENT_SPEND if not set.

Returns

(::Google::Cloud::Billing::Budgets::V1::ThresholdRule::Basis) — Optional. The type of basis used to determine if spend has passed the threshold. Behavior defaults to CURRENT_SPEND if not set.

#threshold_percent

def threshold_percent() -> ::Float

Returns

(::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.

#threshold_percent=

def threshold_percent=(value) -> ::Float

Parameter

value (::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.

Returns

(::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.