Class: Google::Cloud::Billing::Budgets::V1::Budget

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

A budget is a plan that describes what you expect to spend on Cloud projects, plus the rules to execute as spend is tracked against that plan, (for example, send an alert when 90% of the target spend is met). The budget time period is configurable, with options such as month (default), quarter, year, or custom time period.

Instance Attribute Summary collapse

Instance Attribute Details

#amount ⇒ ::Google::Cloud::Billing::Budgets::V1::BudgetAmount

Returns Required. Budgeted amount.

Returns:



64
65
66
67
 
# File 'proto_docs/google/cloud/billing/budgets/v1/budget_model.rb', line 64

class Budget
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#budget_filter ⇒ ::Google::Cloud::Billing::Budgets::V1::Filter

Returns Optional. Filters that define which resources are used to compute the actual spend against the budget amount, such as projects, services, and the budget's time period, as well as other filters.

Returns:

  • (::Google::Cloud::Billing::Budgets::V1::Filter) —

    Optional. Filters that define which resources are used to compute the actual spend against the budget amount, such as projects, services, and the budget's time period, as well as other filters.



64
65
66
67
 
# File 'proto_docs/google/cloud/billing/budgets/v1/budget_model.rb', line 64

class Budget
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#display_name ⇒ ::String

Returns User data for display name in UI. The name must be less than or equal to 60 characters.

Returns:

  • (::String) —

    User data for display name in UI. The name must be less than or equal to 60 characters.



64
65
66
67
 
# File 'proto_docs/google/cloud/billing/budgets/v1/budget_model.rb', line 64

class Budget
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#etag ⇒ ::String

Returns Optional. Etag to validate that the object is unchanged for a read-modify-write operation. An empty etag causes an update to overwrite other changes.

Returns:

  • (::String) —

    Optional. Etag to validate that the object is unchanged for a read-modify-write operation. An empty etag causes an update to overwrite other changes.



64
65
66
67
 
# File 'proto_docs/google/cloud/billing/budgets/v1/budget_model.rb', line 64

class Budget
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#name ⇒ ::String (readonly)

Returns Output only. Resource name of the budget. The resource name implies the scope of a budget. Values are of the form billingAccounts/{billingAccountId}/budgets/{budgetId}.

Returns:

  • (::String) —

    Output only. Resource name of the budget. The resource name implies the scope of a budget. Values are of the form billingAccounts/{billingAccountId}/budgets/{budgetId}.



64
65
66
67
 
# File 'proto_docs/google/cloud/billing/budgets/v1/budget_model.rb', line 64

class Budget
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#notifications_rule ⇒ ::Google::Cloud::Billing::Budgets::V1::NotificationsRule

Returns Optional. Rules to apply to notifications sent based on budget spend and thresholds.

Returns:



64
65
66
67
 
# File 'proto_docs/google/cloud/billing/budgets/v1/budget_model.rb', line 64

class Budget
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#threshold_rules ⇒ ::Array<::Google::Cloud::Billing::Budgets::V1::ThresholdRule>

Returns Optional. Rules that trigger alerts (notifications of thresholds being crossed) when spend exceeds the specified percentages of the budget.

Optional for pubsubTopic notifications.

Required if using email notifications.

Returns:

  • (::Array<::Google::Cloud::Billing::Budgets::V1::ThresholdRule>) —

    Optional. Rules that trigger alerts (notifications of thresholds being crossed) when spend exceeds the specified percentages of the budget.

    Optional for pubsubTopic notifications.

    Required if using email notifications.



64
65
66
67
 
# File 'proto_docs/google/cloud/billing/budgets/v1/budget_model.rb', line 64

class Budget
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end