/*
* Copyright 2020 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/billing/budgets/v1/budget_model.proto
package com.google.cloud.billing.budgets.v1;
public interface BudgetOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.billing.budgets.v1.Budget)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* 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];
*
* @return The name.
*/
java.lang.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];
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* User data for display name in UI. The name must be less than or equal to 60
* characters.
*
*
* string display_name = 2;
*
* @return The displayName.
*/
java.lang.String getDisplayName();
/**
*
*
*
* User data for display name in UI. The name must be less than or equal to 60
* characters.
*
*
* string display_name = 2;
*
* @return The bytes for displayName.
*/
com.google.protobuf.ByteString getDisplayNameBytes();
/**
*
*
*
* 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];
*
*
* @return Whether the budgetFilter field is set.
*/
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];
*
*
* @return The budgetFilter.
*/
com.google.cloud.billing.budgets.v1.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];
*
*/
com.google.cloud.billing.budgets.v1.FilterOrBuilder getBudgetFilterOrBuilder();
/**
*
*
*
* Required. Budgeted amount.
*
*
*
* .google.cloud.billing.budgets.v1.BudgetAmount amount = 4 [(.google.api.field_behavior) = REQUIRED];
*
*
* @return Whether the amount field is set.
*/
boolean hasAmount();
/**
*
*
*
* Required. Budgeted amount.
*
*
*
* .google.cloud.billing.budgets.v1.BudgetAmount amount = 4 [(.google.api.field_behavior) = REQUIRED];
*
*
* @return The amount.
*/
com.google.cloud.billing.budgets.v1.BudgetAmount getAmount();
/**
*
*
*
* Required. Budgeted amount.
*
*
*
* .google.cloud.billing.budgets.v1.BudgetAmount amount = 4 [(.google.api.field_behavior) = REQUIRED];
*
*/
com.google.cloud.billing.budgets.v1.BudgetAmountOrBuilder getAmountOrBuilder();
/**
*
*
*
* Optional. Rules that trigger alerts (notifications of thresholds
* being crossed) when spend exceeds the specified percentages of the budget.
*
*
*
* repeated .google.cloud.billing.budgets.v1.ThresholdRule threshold_rules = 5 [(.google.api.field_behavior) = OPTIONAL];
*
*/
java.util.List getThresholdRulesList();
/**
*
*
*
* Optional. Rules that trigger alerts (notifications of thresholds
* being crossed) when spend exceeds the specified percentages of the budget.
*
*
*
* repeated .google.cloud.billing.budgets.v1.ThresholdRule threshold_rules = 5 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.cloud.billing.budgets.v1.ThresholdRule getThresholdRules(int index);
/**
*
*
*
* Optional. Rules that trigger alerts (notifications of thresholds
* being crossed) when spend exceeds the specified percentages of the budget.
*
*
*
* repeated .google.cloud.billing.budgets.v1.ThresholdRule threshold_rules = 5 [(.google.api.field_behavior) = OPTIONAL];
*
*/
int getThresholdRulesCount();
/**
*
*
*
* Optional. Rules that trigger alerts (notifications of thresholds
* being crossed) when spend exceeds the specified percentages of the budget.
*
*
*
* repeated .google.cloud.billing.budgets.v1.ThresholdRule threshold_rules = 5 [(.google.api.field_behavior) = OPTIONAL];
*
*/
java.util.List
getThresholdRulesOrBuilderList();
/**
*
*
*
* Optional. Rules that trigger alerts (notifications of thresholds
* being crossed) when spend exceeds the specified percentages of the budget.
*
*
*
* repeated .google.cloud.billing.budgets.v1.ThresholdRule threshold_rules = 5 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.cloud.billing.budgets.v1.ThresholdRuleOrBuilder getThresholdRulesOrBuilder(int index);
/**
*
*
*
* 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];
*
*
* @return Whether the notificationsRule field is set.
*/
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];
*
*
* @return The notificationsRule.
*/
com.google.cloud.billing.budgets.v1.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];
*
*/
com.google.cloud.billing.budgets.v1.NotificationsRuleOrBuilder getNotificationsRuleOrBuilder();
/**
*
*
*
* Optional. Etag to validate that the object is unchanged for a
* read-modify-write operation.
* An empty etag will cause an update to overwrite other changes.
*
*
* string etag = 7 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The etag.
*/
java.lang.String getEtag();
/**
*
*
*
* Optional. Etag to validate that the object is unchanged for a
* read-modify-write operation.
* An empty etag will cause an update to overwrite other changes.
*
*
* string etag = 7 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The bytes for etag.
*/
com.google.protobuf.ByteString getEtagBytes();
}