Class: Google::Cloud::Billing::Budgets::V1::ThresholdRule

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/billing/budgets/v1/budget_model.rb

Overview

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.

Defined Under Namespace

Modules: Basis

Instance Attribute Summary collapse

Instance Attribute Details

#spend_basis ⇒ ::Google::Cloud::Billing::Budgets::V1::ThresholdRule::Basis

Returns Optional. The type of basis used to determine if spend has passed the threshold. Behavior defaults to CURRENT_SPEND if not set.

Returns:



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'proto_docs/google/cloud/billing/budgets/v1/budget_model.rb', line 132

class ThresholdRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The type of basis used to determine if spend has passed the threshold.
  module Basis
    # Unspecified threshold basis.
    BASIS_UNSPECIFIED = 0

    # Use current spend as the basis for comparison against the threshold.
    CURRENT_SPEND = 1

    # 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
    # {::Google::Cloud::Billing::Budgets::V1::Filter#calendar_period Filter.calendar_period}.
    # It cannot be set in combination with
    # {::Google::Cloud::Billing::Budgets::V1::Filter#custom_period Filter.custom_period}.
    FORECASTED_SPEND = 2
  end
end

#threshold_percent ⇒ ::Float

Returns 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.



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'proto_docs/google/cloud/billing/budgets/v1/budget_model.rb', line 132

class ThresholdRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The type of basis used to determine if spend has passed the threshold.
  module Basis
    # Unspecified threshold basis.
    BASIS_UNSPECIFIED = 0

    # Use current spend as the basis for comparison against the threshold.
    CURRENT_SPEND = 1

    # 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
    # {::Google::Cloud::Billing::Budgets::V1::Filter#calendar_period Filter.calendar_period}.
    # It cannot be set in combination with
    # {::Google::Cloud::Billing::Budgets::V1::Filter#custom_period Filter.custom_period}.
    FORECASTED_SPEND = 2
  end
end