GoogleCloudBillingBudgetsV1Budget

import type { GoogleCloudBillingBudgetsV1Budget } from "https://googleapis.deno.dev/v1/billingbudgets:v1.ts";

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.

interface GoogleCloudBillingBudgetsV1Budget {

amount?: GoogleCloudBillingBudgetsV1BudgetAmount;

budgetFilter?: GoogleCloudBillingBudgetsV1Filter;

displayName?: string;

etag?: string;

readonly name?: string;

notificationsRule?: GoogleCloudBillingBudgetsV1NotificationsRule;

ownershipScope?: "OWNERSHIP_SCOPE_UNSPECIFIED" | "ALL_USERS" | "BILLING_ACCOUNT";

thresholdRules?: GoogleCloudBillingBudgetsV1ThresholdRule[];

}

§Properties

amount?: GoogleCloudBillingBudgetsV1BudgetAmount

[src]

Required. Budgeted amount.

budgetFilter?: GoogleCloudBillingBudgetsV1Filter

[src]

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?: string

[src]

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

etag?: string

[src]

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.

readonly name?: string

[src]

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?: GoogleCloudBillingBudgetsV1NotificationsRule

[src]

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

ownershipScope?: "OWNERSHIP_SCOPE_UNSPECIFIED" | "ALL_USERS" | "BILLING_ACCOUNT"

[src]

thresholdRules?: GoogleCloudBillingBudgetsV1ThresholdRule[]

[src]

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.