Show / Hide Table of Contents

Class GoogleCloudBillingBudgetsV1Budget

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, or pause usage of the specified service when a spend cap budget is enforced). For alerts-only budgets, the budget time period is configurable, with options such as month (default), quarter, year, or custom time period. For spend cap budgets, the budget time period is limited to month.

Inheritance
object
GoogleCloudBillingBudgetsV1Budget
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.CloudBillingBudget.v1.Data
Assembly: Google.Apis.CloudBillingBudget.v1.dll
Syntax
public class GoogleCloudBillingBudgetsV1Budget : IDirectResponseSchema

Properties

Amount

Required. Budgeted amount. When spend_cap is set, specified_amount must be set to a non-negative amount (>= 0); last_period_amount is not supported.

Declaration
[JsonProperty("amount")]
public virtual GoogleCloudBillingBudgetsV1BudgetAmount Amount { get; set; }
Property Value
Type Description
GoogleCloudBillingBudgetsV1BudgetAmount

BudgetFilter

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. Must be set when spend_cap is set. See Filter fields for spend cap restrictions.

Declaration
[JsonProperty("budgetFilter")]
public virtual GoogleCloudBillingBudgetsV1Filter BudgetFilter { get; set; }
Property Value
Type Description
GoogleCloudBillingBudgetsV1Filter

DisplayName

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

Declaration
[JsonProperty("displayName")]
public virtual string DisplayName { get; set; }
Property Value
Type Description
string

ETag

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.

Declaration
[JsonProperty("etag")]
public virtual string ETag { get; set; }
Property Value
Type Description
string

Name

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

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

NotificationsRule

Optional. Rules to apply to notifications sent based on budget spend and thresholds. Must be set when spend_cap is set. For spend caps, enable_project_level_recipients must be set to true, disable_default_iam_recipients must be false (or unset), and pubsub_topic and monitoring_notification_channels must be empty.

Declaration
[JsonProperty("notificationsRule")]
public virtual GoogleCloudBillingBudgetsV1NotificationsRule NotificationsRule { get; set; }
Property Value
Type Description
GoogleCloudBillingBudgetsV1NotificationsRule

OwnershipScope

Optional. When spend_cap is set, must be OWNERSHIP_SCOPE_UNSPECIFIED or ALL_USERS. BILLING_ACCOUNT is not supported for spend caps.

Declaration
[JsonProperty("ownershipScope")]
public virtual string OwnershipScope { get; set; }
Property Value
Type Description
string

SpendCap

Optional. The spend cap configured for this budget. When spend_cap is set, strict field restrictions apply to the budget (see field-level comments on ownership_scope, budget_filter, amount, threshold_rules, and notifications_rule). When spend_cap.output_state is ENFORCED, only spend_cap.input_state can be modified in an UpdateBudget request (e.g., setting input_state to AWAITING_NEXT_PERIOD to lift the cap); modifying any other budget field while enforced will fail with FAILED_PRECONDITION.

Declaration
[JsonProperty("spendCap")]
public virtual GoogleCloudBillingBudgetsV1SpendCap SpendCap { get; set; }
Property Value
Type Description
GoogleCloudBillingBudgetsV1SpendCap

ThresholdRules

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. Must be set when spend_cap is set. Spend caps must have exactly three CURRENT_SPEND threshold rules with threshold_percent values of 0.5, 0.8, and 1.0 (50%, 80%, and 100%). FORECASTED_SPEND threshold rules are not supported for spend caps.

Declaration
[JsonProperty("thresholdRules")]
public virtual IList<GoogleCloudBillingBudgetsV1ThresholdRule> ThresholdRules { get; set; }
Property Value
Type Description
IList<GoogleCloudBillingBudgetsV1ThresholdRule>

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX