Package com.google.cloud.billing.budgets.v1

Interface BudgetOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Budget, Budget.Builder
    public interface BudgetOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getName

        String getName()
         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}`.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The name.

      • getNameBytes

        com.google.protobuf.ByteString getNameBytes()
         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}`.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The bytes for name.

      • getDisplayName

        String getDisplayName()
         User data for display name in UI. The name must be less than or equal to 60
 characters.
        string display_name = 2;
        Returns:
        The displayName.

      • getDisplayNameBytes

        com.google.protobuf.ByteString getDisplayNameBytes()
         User data for display name in UI. The name must be less than or equal to 60
 characters.
        string display_name = 2;
        Returns:
        The bytes for displayName.

      • hasBudgetFilter

        boolean hasBudgetFilter()
         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.
        .google.cloud.billing.budgets.v1.Filter budget_filter = 3 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        Whether the budgetFilter field is set.

      • getBudgetFilter

        Filter getBudgetFilter()
         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.
        .google.cloud.billing.budgets.v1.Filter budget_filter = 3 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The budgetFilter.

      • getBudgetFilterOrBuilder

        FilterOrBuilder getBudgetFilterOrBuilder()
         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.
        .google.cloud.billing.budgets.v1.Filter budget_filter = 3 [(.google.api.field_behavior) = OPTIONAL];

      • hasAmount

        boolean hasAmount()
         Required. Budgeted amount.
        .google.cloud.billing.budgets.v1.BudgetAmount amount = 4 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        Whether the amount field is set.

      • getAmount

        BudgetAmount getAmount()
         Required. Budgeted amount.
        .google.cloud.billing.budgets.v1.BudgetAmount amount = 4 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The amount.

      • getAmountOrBuilder

        BudgetAmountOrBuilder getAmountOrBuilder()
         Required. Budgeted amount.
        .google.cloud.billing.budgets.v1.BudgetAmount amount = 4 [(.google.api.field_behavior) = REQUIRED];

      • getThresholdRulesList

        List<ThresholdRule> getThresholdRulesList()
         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.
        repeated .google.cloud.billing.budgets.v1.ThresholdRule threshold_rules = 5 [(.google.api.field_behavior) = OPTIONAL];

      • getThresholdRules

        ThresholdRule getThresholdRules​(int index)
         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.
        repeated .google.cloud.billing.budgets.v1.ThresholdRule threshold_rules = 5 [(.google.api.field_behavior) = OPTIONAL];

      • getThresholdRulesCount

        int getThresholdRulesCount()
         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.
        repeated .google.cloud.billing.budgets.v1.ThresholdRule threshold_rules = 5 [(.google.api.field_behavior) = OPTIONAL];

      • getThresholdRulesOrBuilderList

        List<? extends ThresholdRuleOrBuilder> getThresholdRulesOrBuilderList()
         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.
        repeated .google.cloud.billing.budgets.v1.ThresholdRule threshold_rules = 5 [(.google.api.field_behavior) = OPTIONAL];

      • getThresholdRulesOrBuilder

        ThresholdRuleOrBuilder getThresholdRulesOrBuilder​(int index)
         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.
        repeated .google.cloud.billing.budgets.v1.ThresholdRule threshold_rules = 5 [(.google.api.field_behavior) = OPTIONAL];

      • hasNotificationsRule

        boolean hasNotificationsRule()
         Optional. Rules to apply to notifications sent based on budget spend and
 thresholds.
        .google.cloud.billing.budgets.v1.NotificationsRule notifications_rule = 6 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        Whether the notificationsRule field is set.

      • getNotificationsRule

        NotificationsRule getNotificationsRule()
         Optional. Rules to apply to notifications sent based on budget spend and
 thresholds.
        .google.cloud.billing.budgets.v1.NotificationsRule notifications_rule = 6 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The notificationsRule.

      • getNotificationsRuleOrBuilder

        NotificationsRuleOrBuilder getNotificationsRuleOrBuilder()
         Optional. Rules to apply to notifications sent based on budget spend and
 thresholds.
        .google.cloud.billing.budgets.v1.NotificationsRule notifications_rule = 6 [(.google.api.field_behavior) = OPTIONAL];

      • getEtag

        String getEtag()
         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.
        string etag = 7 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The etag.

      • getEtagBytes

        com.google.protobuf.ByteString getEtagBytes()
         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.
        string etag = 7 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The bytes for etag.