feat: Added support for configurable budget time period (#447)

This PR was generated using Autosynth. 🌈 Synth log will be available here: https://source.cloud.google.com/results/invocations/32522ef3-54e3-4f4c-8d06-d9a69bb391c5/targets - [ ] To automatically regenerate this PR, check this box. (May take up to 24 hours.) PiperOrigin-RevId: 368871890 Source-Link: googleapis/googleapis@dd6ba75 PiperOrigin-RevId: 368871882 Source-Link: googleapis/googleapis@24f0828 fix: Updated some documentation links
googleapis · Apr 23, 2021 · df1d0db · df1d0db
1 parent 416a415
commit df1d0db
Show file tree

Hide file tree

Showing 29 changed files with 4,914 additions and 411 deletions.
diff --git a/...gle-cloud-billingbudgets-v1/src/main/java/com/google/cloud/billing/budgets/v1/Budget.java b/...gle-cloud-billingbudgets-v1/src/main/java/com/google/cloud/billing/budgets/v1/Budget.java
@@ -25,8 +25,8 @@
  * 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).
- * Currently all plans are monthly budgets so the usage period(s) tracked are
- * implied (calendar months of usage back-to-back).
+ * The budget time period is configurable, with options such as month (default),
+ * quarter, year, or custom time period.
  * </pre>
  *
  * Protobuf type {@code google.cloud.billing.budgets.v1.Budget}
@@ -308,8 +308,9 @@ public com.google.protobuf.ByteString getDisplayNameBytes() {
    *
    *
    * <pre>
-   * Optional. Filters that define which resources are used to compute
-   * the actual spend against the budget.
+   * 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.
    * </pre>
    *
    * <code>
@@ -326,8 +327,9 @@ public boolean hasBudgetFilter() {
    *
    *
    * <pre>
-   * Optional. Filters that define which resources are used to compute
-   * the actual spend against the budget.
+   * 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.
    * </pre>
    *
    * <code>
@@ -346,8 +348,9 @@ public com.google.cloud.billing.budgets.v1.Filter getBudgetFilter() {
    *
    *
    * <pre>
-   * Optional. Filters that define which resources are used to compute
-   * the actual spend against the budget.
+   * 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.
    * </pre>
    *
    * <code>
@@ -846,8 +849,8 @@ protected Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.Build
    * 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).
-   * Currently all plans are monthly budgets so the usage period(s) tracked are
-   * implied (calendar months of usage back-to-back).
+   * The budget time period is configurable, with options such as month (default),
+   * quarter, year, or custom time period.
    * </pre>
    *
    * Protobuf type {@code google.cloud.billing.budgets.v1.Budget}
@@ -1340,8 +1343,9 @@ public Builder setDisplayNameBytes(com.google.protobuf.ByteString value) {
      *
      *
      * <pre>
-     * Optional. Filters that define which resources are used to compute
-     * the actual spend against the budget.
+     * 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.
      * </pre>
      *
      * <code>
@@ -1357,8 +1361,9 @@ public boolean hasBudgetFilter() {
      *
      *
      * <pre>
-     * Optional. Filters that define which resources are used to compute
-     * the actual spend against the budget.
+     * 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.
      * </pre>
      *
      * <code>
@@ -1380,8 +1385,9 @@ public com.google.cloud.billing.budgets.v1.Filter getBudgetFilter() {
      *
      *
      * <pre>
-     * Optional. Filters that define which resources are used to compute
-     * the actual spend against the budget.
+     * 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.
      * </pre>
      *
      * <code>
@@ -1405,8 +1411,9 @@ public Builder setBudgetFilter(com.google.cloud.billing.budgets.v1.Filter value)
      *
      *
      * <pre>
-     * Optional. Filters that define which resources are used to compute
-     * the actual spend against the budget.
+     * 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.
      * </pre>
      *
      * <code>
@@ -1428,8 +1435,9 @@ public Builder setBudgetFilter(
      *
      *
      * <pre>
-     * Optional. Filters that define which resources are used to compute
-     * the actual spend against the budget.
+     * 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.
      * </pre>
      *
      * <code>
@@ -1457,8 +1465,9 @@ public Builder mergeBudgetFilter(com.google.cloud.billing.budgets.v1.Filter valu
      *
      *
      * <pre>
-     * Optional. Filters that define which resources are used to compute
-     * the actual spend against the budget.
+     * 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.
      * </pre>
      *
      * <code>
@@ -1480,8 +1489,9 @@ public Builder clearBudgetFilter() {
      *
      *
      * <pre>
-     * Optional. Filters that define which resources are used to compute
-     * the actual spend against the budget.
+     * 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.
      * </pre>
      *
      * <code>
@@ -1497,8 +1507,9 @@ public com.google.cloud.billing.budgets.v1.Filter.Builder getBudgetFilterBuilder
      *
      *
      * <pre>
-     * Optional. Filters that define which resources are used to compute
-     * the actual spend against the budget.
+     * 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.
      * </pre>
      *
      * <code>
@@ -1518,8 +1529,9 @@ public com.google.cloud.billing.budgets.v1.FilterOrBuilder getBudgetFilterOrBuil
      *
      *
      * <pre>
-     * Optional. Filters that define which resources are used to compute
-     * the actual spend against the budget.
+     * 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.
      * </pre>
      *
      * <code>

diff --git a/...oud-billingbudgets-v1/src/main/java/com/google/cloud/billing/budgets/v1/BudgetAmount.java b/...oud-billingbudgets-v1/src/main/java/com/google/cloud/billing/budgets/v1/BudgetAmount.java
@@ -252,6 +252,10 @@ public com.google.type.MoneyOrBuilder getSpecifiedAmountOrBuilder() {
    *
    * <pre>
    * Use the last period's actual spend as the budget for the present period.
+   * LastPeriodAmount can only be set when the budget's time period is a
+   * [Filter.calendar_period][google.cloud.billing.budgets.v1.Filter.calendar_period].
+   * It cannot be set in combination with
+   * [Filter.custom_period][google.cloud.billing.budgets.v1.Filter.custom_period].
    * </pre>
    *
    * <code>.google.cloud.billing.budgets.v1.LastPeriodAmount last_period_amount = 2;</code>
@@ -267,6 +271,10 @@ public boolean hasLastPeriodAmount() {
    *
    * <pre>
    * Use the last period's actual spend as the budget for the present period.
+   * LastPeriodAmount can only be set when the budget's time period is a
+   * [Filter.calendar_period][google.cloud.billing.budgets.v1.Filter.calendar_period].
+   * It cannot be set in combination with
+   * [Filter.custom_period][google.cloud.billing.budgets.v1.Filter.custom_period].
    * </pre>
    *
    * <code>.google.cloud.billing.budgets.v1.LastPeriodAmount last_period_amount = 2;</code>
@@ -285,6 +293,10 @@ public com.google.cloud.billing.budgets.v1.LastPeriodAmount getLastPeriodAmount(
    *
    * <pre>
    * Use the last period's actual spend as the budget for the present period.
+   * LastPeriodAmount can only be set when the budget's time period is a
+   * [Filter.calendar_period][google.cloud.billing.budgets.v1.Filter.calendar_period].
+   * It cannot be set in combination with
+   * [Filter.custom_period][google.cloud.billing.budgets.v1.Filter.custom_period].
    * </pre>
    *
    * <code>.google.cloud.billing.budgets.v1.LastPeriodAmount last_period_amount = 2;</code>
@@ -931,6 +943,10 @@ public com.google.type.MoneyOrBuilder getSpecifiedAmountOrBuilder() {
      *
      * <pre>
      * Use the last period's actual spend as the budget for the present period.
+     * LastPeriodAmount can only be set when the budget's time period is a
+     * [Filter.calendar_period][google.cloud.billing.budgets.v1.Filter.calendar_period].
+     * It cannot be set in combination with
+     * [Filter.custom_period][google.cloud.billing.budgets.v1.Filter.custom_period].
      * </pre>
      *
      * <code>.google.cloud.billing.budgets.v1.LastPeriodAmount last_period_amount = 2;</code>
@@ -946,6 +962,10 @@ public boolean hasLastPeriodAmount() {
      *
      * <pre>
      * Use the last period's actual spend as the budget for the present period.
+     * LastPeriodAmount can only be set when the budget's time period is a
+     * [Filter.calendar_period][google.cloud.billing.budgets.v1.Filter.calendar_period].
+     * It cannot be set in combination with
+     * [Filter.custom_period][google.cloud.billing.budgets.v1.Filter.custom_period].
      * </pre>
      *
      * <code>.google.cloud.billing.budgets.v1.LastPeriodAmount last_period_amount = 2;</code>
@@ -971,6 +991,10 @@ public com.google.cloud.billing.budgets.v1.LastPeriodAmount getLastPeriodAmount(
      *
      * <pre>
      * Use the last period's actual spend as the budget for the present period.
+     * LastPeriodAmount can only be set when the budget's time period is a
+     * [Filter.calendar_period][google.cloud.billing.budgets.v1.Filter.calendar_period].
+     * It cannot be set in combination with
+     * [Filter.custom_period][google.cloud.billing.budgets.v1.Filter.custom_period].
      * </pre>
      *
      * <code>.google.cloud.billing.budgets.v1.LastPeriodAmount last_period_amount = 2;</code>
@@ -993,6 +1017,10 @@ public Builder setLastPeriodAmount(com.google.cloud.billing.budgets.v1.LastPerio
      *
      * <pre>
      * Use the last period's actual spend as the budget for the present period.
+     * LastPeriodAmount can only be set when the budget's time period is a
+     * [Filter.calendar_period][google.cloud.billing.budgets.v1.Filter.calendar_period].
+     * It cannot be set in combination with
+     * [Filter.custom_period][google.cloud.billing.budgets.v1.Filter.custom_period].
      * </pre>
      *
      * <code>.google.cloud.billing.budgets.v1.LastPeriodAmount last_period_amount = 2;</code>
@@ -1013,6 +1041,10 @@ public Builder setLastPeriodAmount(
      *
      * <pre>
      * Use the last period's actual spend as the budget for the present period.
+     * LastPeriodAmount can only be set when the budget's time period is a
+     * [Filter.calendar_period][google.cloud.billing.budgets.v1.Filter.calendar_period].
+     * It cannot be set in combination with
+     * [Filter.custom_period][google.cloud.billing.budgets.v1.Filter.custom_period].
      * </pre>
      *
      * <code>.google.cloud.billing.budgets.v1.LastPeriodAmount last_period_amount = 2;</code>
@@ -1046,6 +1078,10 @@ public Builder mergeLastPeriodAmount(
      *
      * <pre>
      * Use the last period's actual spend as the budget for the present period.
+     * LastPeriodAmount can only be set when the budget's time period is a
+     * [Filter.calendar_period][google.cloud.billing.budgets.v1.Filter.calendar_period].
+     * It cannot be set in combination with
+     * [Filter.custom_period][google.cloud.billing.budgets.v1.Filter.custom_period].
      * </pre>
      *
      * <code>.google.cloud.billing.budgets.v1.LastPeriodAmount last_period_amount = 2;</code>
@@ -1071,6 +1107,10 @@ public Builder clearLastPeriodAmount() {
      *
      * <pre>
      * Use the last period's actual spend as the budget for the present period.
+     * LastPeriodAmount can only be set when the budget's time period is a
+     * [Filter.calendar_period][google.cloud.billing.budgets.v1.Filter.calendar_period].
+     * It cannot be set in combination with
+     * [Filter.custom_period][google.cloud.billing.budgets.v1.Filter.custom_period].
      * </pre>
      *
      * <code>.google.cloud.billing.budgets.v1.LastPeriodAmount last_period_amount = 2;</code>
@@ -1084,6 +1124,10 @@ public Builder clearLastPeriodAmount() {
      *
      * <pre>
      * Use the last period's actual spend as the budget for the present period.
+     * LastPeriodAmount can only be set when the budget's time period is a
+     * [Filter.calendar_period][google.cloud.billing.budgets.v1.Filter.calendar_period].
+     * It cannot be set in combination with
+     * [Filter.custom_period][google.cloud.billing.budgets.v1.Filter.custom_period].
      * </pre>
      *
      * <code>.google.cloud.billing.budgets.v1.LastPeriodAmount last_period_amount = 2;</code>
@@ -1105,6 +1149,10 @@ public Builder clearLastPeriodAmount() {
      *
      * <pre>
      * Use the last period's actual spend as the budget for the present period.
+     * LastPeriodAmount can only be set when the budget's time period is a
+     * [Filter.calendar_period][google.cloud.billing.budgets.v1.Filter.calendar_period].
+     * It cannot be set in combination with
+     * [Filter.custom_period][google.cloud.billing.budgets.v1.Filter.custom_period].
      * </pre>
      *
      * <code>.google.cloud.billing.budgets.v1.LastPeriodAmount last_period_amount = 2;</code>

diff --git a/...ngbudgets-v1/src/main/java/com/google/cloud/billing/budgets/v1/BudgetAmountOrBuilder.java b/...ngbudgets-v1/src/main/java/com/google/cloud/billing/budgets/v1/BudgetAmountOrBuilder.java
@@ -75,6 +75,10 @@ public interface BudgetAmountOrBuilder
    *
    * <pre>
    * Use the last period's actual spend as the budget for the present period.
+   * LastPeriodAmount can only be set when the budget's time period is a
+   * [Filter.calendar_period][google.cloud.billing.budgets.v1.Filter.calendar_period].
+   * It cannot be set in combination with
+   * [Filter.custom_period][google.cloud.billing.budgets.v1.Filter.custom_period].
    * </pre>
    *
    * <code>.google.cloud.billing.budgets.v1.LastPeriodAmount last_period_amount = 2;</code>
@@ -87,6 +91,10 @@ public interface BudgetAmountOrBuilder
    *
    * <pre>
    * Use the last period's actual spend as the budget for the present period.
+   * LastPeriodAmount can only be set when the budget's time period is a
+   * [Filter.calendar_period][google.cloud.billing.budgets.v1.Filter.calendar_period].
+   * It cannot be set in combination with
+   * [Filter.custom_period][google.cloud.billing.budgets.v1.Filter.custom_period].
    * </pre>
    *
    * <code>.google.cloud.billing.budgets.v1.LastPeriodAmount last_period_amount = 2;</code>
@@ -99,6 +107,10 @@ public interface BudgetAmountOrBuilder
    *
    * <pre>
    * Use the last period's actual spend as the budget for the present period.
+   * LastPeriodAmount can only be set when the budget's time period is a
+   * [Filter.calendar_period][google.cloud.billing.budgets.v1.Filter.calendar_period].
+   * It cannot be set in combination with
+   * [Filter.custom_period][google.cloud.billing.budgets.v1.Filter.custom_period].
    * </pre>
    *
    * <code>.google.cloud.billing.budgets.v1.LastPeriodAmount last_period_amount = 2;</code>