View Source GoogleApi.BillingBudgets.V1.Model.GoogleCloudBillingBudgetsV1Budget (google_api_billing_budgets v0.14.0)

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.

Attributes

  • amount (type: GoogleApi.BillingBudgets.V1.Model.GoogleCloudBillingBudgetsV1BudgetAmount.t, default: nil) - Required. Budgeted amount.
  • budgetFilter (type: GoogleApi.BillingBudgets.V1.Model.GoogleCloudBillingBudgetsV1Filter.t, default: nil) - 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.
  • displayName (type: String.t, default: nil) - User data for display name in UI. The name must be less than or equal to 60 characters.
  • etag (type: String.t, default: nil) - 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.
  • name (type: String.t, default: nil) - 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}.
  • notificationsRule (type: GoogleApi.BillingBudgets.V1.Model.GoogleCloudBillingBudgetsV1NotificationsRule.t, default: nil) - Optional. Rules to apply to notifications sent based on budget spend and thresholds.
  • ownershipScope (type: String.t, default: nil) -
  • thresholdRules (type: list(GoogleApi.BillingBudgets.V1.Model.GoogleCloudBillingBudgetsV1ThresholdRule.t), default: nil) - 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.

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

@type t() :: %GoogleApi.BillingBudgets.V1.Model.GoogleCloudBillingBudgetsV1Budget{
  amount:
    GoogleApi.BillingBudgets.V1.Model.GoogleCloudBillingBudgetsV1BudgetAmount.t()
    | nil,
  budgetFilter:
    GoogleApi.BillingBudgets.V1.Model.GoogleCloudBillingBudgetsV1Filter.t()
    | nil,
  displayName: String.t() | nil,
  etag: String.t() | nil,
  name: String.t() | nil,
  notificationsRule:
    GoogleApi.BillingBudgets.V1.Model.GoogleCloudBillingBudgetsV1NotificationsRule.t()
    | nil,
  ownershipScope: String.t() | nil,
  thresholdRules:
    [
      GoogleApi.BillingBudgets.V1.Model.GoogleCloudBillingBudgetsV1ThresholdRule.t()
    ]
    | nil
}

Functions

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.