Class: Google::Apis::BillingbudgetsV1::GoogleCloudBillingBudgetsV1ThresholdRule

Inherits:

Object

• Object
• Google::Apis::BillingbudgetsV1::GoogleCloudBillingBudgetsV1ThresholdRule

Includes:

Core::Hashable, Core::JsonObjectSupport

Defined in:

lib/google/apis/billingbudgets_v1/classes.rb,
lib/google/apis/billingbudgets_v1/representations.rb,
lib/google/apis/billingbudgets_v1/representations.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.

Instance Attribute Summary

• #spend_basis ⇒ String

  Optional.

• #threshold_percent ⇒ Float

  Required.

Instance Method Summary

• #initialize(**args) ⇒ GoogleCloudBillingBudgetsV1ThresholdRule constructor

  A new instance of GoogleCloudBillingBudgetsV1ThresholdRule.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ GoogleCloudBillingBudgetsV1ThresholdRule

Returns a new instance of GoogleCloudBillingBudgetsV1ThresholdRule.

# File 'lib/google/apis/billingbudgets_v1/classes.rb', line 420

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#spend_basis ⇒ String

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

Returns:

• (String)

# File 'lib/google/apis/billingbudgets_v1/classes.rb', line 412

def spend_basis
  @spend_basis
end

#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. Corresponds to the JSON property thresholdPercent

Returns:

• (Float)

# File 'lib/google/apis/billingbudgets_v1/classes.rb', line 418

def threshold_percent
  @threshold_percent
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'lib/google/apis/billingbudgets_v1/classes.rb', line 425

def update!(**args)
  @spend_basis = args[:spend_basis] if args.key?(:spend_basis)
  @threshold_percent = args[:threshold_percent] if args.key?(:threshold_percent)
end