docs: Update rules for currency_code in budget_amount (#387)

This PR was generated using Autosynth. 🌈 Synth log will be available here: https://source.cloud.google.com/results/invocations/924801fb-c499-4aac-bc33-f378bfa8d491/targets - [ ] To automatically regenerate this PR, check this box. PiperOrigin-RevId: 357051517 Source-Link: googleapis/googleapis@f3a60f6 PiperOrigin-RevId: 356991675 Source-Link: googleapis/googleapis@dd89b0c
googleapis · Feb 16, 2021 · 15cd344 · 15cd344
1 parent 77ca837
commit 15cd344
Show file tree

Hide file tree

Showing 13 changed files with 239 additions and 146 deletions.
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
@@ -189,9 +189,10 @@ public BudgetAmountCase getBudgetAmountCase() {
    *
    * <pre>
    * A specified amount to use as the budget.
-   * `currency_code` is optional. If specified, it must match the
-   * currency of the billing account. The `currency_code` is provided on
-   * output.
+   * `currency_code` is optional. If specified when creating a budget, it must
+   * match the currency of the billing account. If specified when updating a
+   * budget, it must match the currency_code of the existing budget.
+   * The `currency_code` is provided on output.
    * </pre>
    *
    * <code>.google.type.Money specified_amount = 1;</code>
@@ -207,9 +208,10 @@ public boolean hasSpecifiedAmount() {
    *
    * <pre>
    * A specified amount to use as the budget.
-   * `currency_code` is optional. If specified, it must match the
-   * currency of the billing account. The `currency_code` is provided on
-   * output.
+   * `currency_code` is optional. If specified when creating a budget, it must
+   * match the currency of the billing account. If specified when updating a
+   * budget, it must match the currency_code of the existing budget.
+   * The `currency_code` is provided on output.
    * </pre>
    *
    * <code>.google.type.Money specified_amount = 1;</code>
@@ -228,9 +230,10 @@ public com.google.type.Money getSpecifiedAmount() {
    *
    * <pre>
    * A specified amount to use as the budget.
-   * `currency_code` is optional. If specified, it must match the
-   * currency of the billing account. The `currency_code` is provided on
-   * output.
+   * `currency_code` is optional. If specified when creating a budget, it must
+   * match the currency of the billing account. If specified when updating a
+   * budget, it must match the currency_code of the existing budget.
+   * The `currency_code` is provided on output.
    * </pre>
    *
    * <code>.google.type.Money specified_amount = 1;</code>
@@ -690,9 +693,10 @@ public Builder clearBudgetAmount() {
      *
      * <pre>
      * A specified amount to use as the budget.
-     * `currency_code` is optional. If specified, it must match the
-     * currency of the billing account. The `currency_code` is provided on
-     * output.
+     * `currency_code` is optional. If specified when creating a budget, it must
+     * match the currency of the billing account. If specified when updating a
+     * budget, it must match the currency_code of the existing budget.
+     * The `currency_code` is provided on output.
      * </pre>
      *
      * <code>.google.type.Money specified_amount = 1;</code>
@@ -708,9 +712,10 @@ public boolean hasSpecifiedAmount() {
      *
      * <pre>
      * A specified amount to use as the budget.
-     * `currency_code` is optional. If specified, it must match the
-     * currency of the billing account. The `currency_code` is provided on
-     * output.
+     * `currency_code` is optional. If specified when creating a budget, it must
+     * match the currency of the billing account. If specified when updating a
+     * budget, it must match the currency_code of the existing budget.
+     * The `currency_code` is provided on output.
      * </pre>
      *
      * <code>.google.type.Money specified_amount = 1;</code>
@@ -736,9 +741,10 @@ public com.google.type.Money getSpecifiedAmount() {
      *
      * <pre>
      * A specified amount to use as the budget.
-     * `currency_code` is optional. If specified, it must match the
-     * currency of the billing account. The `currency_code` is provided on
-     * output.
+     * `currency_code` is optional. If specified when creating a budget, it must
+     * match the currency of the billing account. If specified when updating a
+     * budget, it must match the currency_code of the existing budget.
+     * The `currency_code` is provided on output.
      * </pre>
      *
      * <code>.google.type.Money specified_amount = 1;</code>
@@ -761,9 +767,10 @@ public Builder setSpecifiedAmount(com.google.type.Money value) {
      *
      * <pre>
      * A specified amount to use as the budget.
-     * `currency_code` is optional. If specified, it must match the
-     * currency of the billing account. The `currency_code` is provided on
-     * output.
+     * `currency_code` is optional. If specified when creating a budget, it must
+     * match the currency of the billing account. If specified when updating a
+     * budget, it must match the currency_code of the existing budget.
+     * The `currency_code` is provided on output.
      * </pre>
      *
      * <code>.google.type.Money specified_amount = 1;</code>
@@ -783,9 +790,10 @@ public Builder setSpecifiedAmount(com.google.type.Money.Builder builderForValue)
      *
      * <pre>
      * A specified amount to use as the budget.
-     * `currency_code` is optional. If specified, it must match the
-     * currency of the billing account. The `currency_code` is provided on
-     * output.
+     * `currency_code` is optional. If specified when creating a budget, it must
+     * match the currency of the billing account. If specified when updating a
+     * budget, it must match the currency_code of the existing budget.
+     * The `currency_code` is provided on output.
      * </pre>
      *
      * <code>.google.type.Money specified_amount = 1;</code>
@@ -815,9 +823,10 @@ public Builder mergeSpecifiedAmount(com.google.type.Money value) {
      *
      * <pre>
      * A specified amount to use as the budget.
-     * `currency_code` is optional. If specified, it must match the
-     * currency of the billing account. The `currency_code` is provided on
-     * output.
+     * `currency_code` is optional. If specified when creating a budget, it must
+     * match the currency of the billing account. If specified when updating a
+     * budget, it must match the currency_code of the existing budget.
+     * The `currency_code` is provided on output.
      * </pre>
      *
      * <code>.google.type.Money specified_amount = 1;</code>
@@ -843,9 +852,10 @@ public Builder clearSpecifiedAmount() {
      *
      * <pre>
      * A specified amount to use as the budget.
-     * `currency_code` is optional. If specified, it must match the
-     * currency of the billing account. The `currency_code` is provided on
-     * output.
+     * `currency_code` is optional. If specified when creating a budget, it must
+     * match the currency of the billing account. If specified when updating a
+     * budget, it must match the currency_code of the existing budget.
+     * The `currency_code` is provided on output.
      * </pre>
      *
      * <code>.google.type.Money specified_amount = 1;</code>
@@ -858,9 +868,10 @@ public com.google.type.Money.Builder getSpecifiedAmountBuilder() {
      *
      * <pre>
      * A specified amount to use as the budget.
-     * `currency_code` is optional. If specified, it must match the
-     * currency of the billing account. The `currency_code` is provided on
-     * output.
+     * `currency_code` is optional. If specified when creating a budget, it must
+     * match the currency of the billing account. If specified when updating a
+     * budget, it must match the currency_code of the existing budget.
+     * The `currency_code` is provided on output.
      * </pre>
      *
      * <code>.google.type.Money specified_amount = 1;</code>
@@ -881,9 +892,10 @@ public com.google.type.MoneyOrBuilder getSpecifiedAmountOrBuilder() {
      *
      * <pre>
      * A specified amount to use as the budget.
-     * `currency_code` is optional. If specified, it must match the
-     * currency of the billing account. The `currency_code` is provided on
-     * output.
+     * `currency_code` is optional. If specified when creating a budget, it must
+     * match the currency of the billing account. If specified when updating a
+     * budget, it must match the currency_code of the existing budget.
+     * The `currency_code` is provided on output.
      * </pre>
      *
      * <code>.google.type.Money specified_amount = 1;</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
@@ -28,9 +28,10 @@ public interface BudgetAmountOrBuilder
    *
    * <pre>
    * A specified amount to use as the budget.
-   * `currency_code` is optional. If specified, it must match the
-   * currency of the billing account. The `currency_code` is provided on
-   * output.
+   * `currency_code` is optional. If specified when creating a budget, it must
+   * match the currency of the billing account. If specified when updating a
+   * budget, it must match the currency_code of the existing budget.
+   * The `currency_code` is provided on output.
    * </pre>
    *
    * <code>.google.type.Money specified_amount = 1;</code>
@@ -43,9 +44,10 @@ public interface BudgetAmountOrBuilder
    *
    * <pre>
    * A specified amount to use as the budget.
-   * `currency_code` is optional. If specified, it must match the
-   * currency of the billing account. The `currency_code` is provided on
-   * output.
+   * `currency_code` is optional. If specified when creating a budget, it must
+   * match the currency of the billing account. If specified when updating a
+   * budget, it must match the currency_code of the existing budget.
+   * The `currency_code` is provided on output.
    * </pre>
    *
    * <code>.google.type.Money specified_amount = 1;</code>
@@ -58,9 +60,10 @@ public interface BudgetAmountOrBuilder
    *
    * <pre>
    * A specified amount to use as the budget.
-   * `currency_code` is optional. If specified, it must match the
-   * currency of the billing account. The `currency_code` is provided on
-   * output.
+   * `currency_code` is optional. If specified when creating a budget, it must
+   * match the currency of the billing account. If specified when updating a
+   * budget, it must match the currency_code of the existing budget.
+   * The `currency_code` is provided on output.
    * </pre>
    *
    * <code>.google.type.Money specified_amount = 1;</code>

diff --git a/...illingbudgets-v1/src/main/java/com/google/cloud/billing/budgets/v1/NotificationsRule.java b/...illingbudgets-v1/src/main/java/com/google/cloud/billing/budgets/v1/NotificationsRule.java
@@ -215,9 +215,12 @@ public com.google.protobuf.ByteString getPubsubTopicBytes() {
    *
    *
    * <pre>
-   * Optional. The schema version of the notification sent to `pubsub_topic`.
+   * Optional. Required when
+   * [NotificationsRule.pubsub_topic][google.cloud.billing.budgets.v1.NotificationsRule.pubsub_topic]
+   * is set. The schema version of the notification sent to
+   * [NotificationsRule.pubsub_topic][google.cloud.billing.budgets.v1.NotificationsRule.pubsub_topic].
    * Only "1.0" is accepted. It represents the JSON schema as defined in
-   * https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format
+   * https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format.
    * </pre>
    *
    * <code>string schema_version = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
@@ -240,9 +243,12 @@ public java.lang.String getSchemaVersion() {
    *
    *
    * <pre>
-   * Optional. The schema version of the notification sent to `pubsub_topic`.
+   * Optional. Required when
+   * [NotificationsRule.pubsub_topic][google.cloud.billing.budgets.v1.NotificationsRule.pubsub_topic]
+   * is set. The schema version of the notification sent to
+   * [NotificationsRule.pubsub_topic][google.cloud.billing.budgets.v1.NotificationsRule.pubsub_topic].
    * Only "1.0" is accepted. It represents the JSON schema as defined in
-   * https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format
+   * https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format.
    * </pre>
    *
    * <code>string schema_version = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
@@ -931,9 +937,12 @@ public Builder setPubsubTopicBytes(com.google.protobuf.ByteString value) {
      *
      *
      * <pre>
-     * Optional. The schema version of the notification sent to `pubsub_topic`.
+     * Optional. Required when
+     * [NotificationsRule.pubsub_topic][google.cloud.billing.budgets.v1.NotificationsRule.pubsub_topic]
+     * is set. The schema version of the notification sent to
+     * [NotificationsRule.pubsub_topic][google.cloud.billing.budgets.v1.NotificationsRule.pubsub_topic].
      * Only "1.0" is accepted. It represents the JSON schema as defined in
-     * https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format
+     * https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format.
      * </pre>
      *
      * <code>string schema_version = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
@@ -955,9 +964,12 @@ public java.lang.String getSchemaVersion() {
      *
      *
      * <pre>
-     * Optional. The schema version of the notification sent to `pubsub_topic`.
+     * Optional. Required when
+     * [NotificationsRule.pubsub_topic][google.cloud.billing.budgets.v1.NotificationsRule.pubsub_topic]
+     * is set. The schema version of the notification sent to
+     * [NotificationsRule.pubsub_topic][google.cloud.billing.budgets.v1.NotificationsRule.pubsub_topic].
      * Only "1.0" is accepted. It represents the JSON schema as defined in
-     * https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format
+     * https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format.
      * </pre>
      *
      * <code>string schema_version = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
@@ -979,9 +991,12 @@ public com.google.protobuf.ByteString getSchemaVersionBytes() {
      *
      *
      * <pre>
-     * Optional. The schema version of the notification sent to `pubsub_topic`.
+     * Optional. Required when
+     * [NotificationsRule.pubsub_topic][google.cloud.billing.budgets.v1.NotificationsRule.pubsub_topic]
+     * is set. The schema version of the notification sent to
+     * [NotificationsRule.pubsub_topic][google.cloud.billing.budgets.v1.NotificationsRule.pubsub_topic].
      * Only "1.0" is accepted. It represents the JSON schema as defined in
-     * https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format
+     * https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format.
      * </pre>
      *
      * <code>string schema_version = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
@@ -1002,9 +1017,12 @@ public Builder setSchemaVersion(java.lang.String value) {
      *
      *
      * <pre>
-     * Optional. The schema version of the notification sent to `pubsub_topic`.
+     * Optional. Required when
+     * [NotificationsRule.pubsub_topic][google.cloud.billing.budgets.v1.NotificationsRule.pubsub_topic]
+     * is set. The schema version of the notification sent to
+     * [NotificationsRule.pubsub_topic][google.cloud.billing.budgets.v1.NotificationsRule.pubsub_topic].
      * Only "1.0" is accepted. It represents the JSON schema as defined in
-     * https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format
+     * https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format.
      * </pre>
      *
      * <code>string schema_version = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
@@ -1021,9 +1039,12 @@ public Builder clearSchemaVersion() {
      *
      *
      * <pre>
-     * Optional. The schema version of the notification sent to `pubsub_topic`.
+     * Optional. Required when
+     * [NotificationsRule.pubsub_topic][google.cloud.billing.budgets.v1.NotificationsRule.pubsub_topic]
+     * is set. The schema version of the notification sent to
+     * [NotificationsRule.pubsub_topic][google.cloud.billing.budgets.v1.NotificationsRule.pubsub_topic].
      * Only "1.0" is accepted. It represents the JSON schema as defined in
-     * https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format
+     * https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format.
      * </pre>
      *
      * <code>string schema_version = 2 [(.google.api.field_behavior) = OPTIONAL];</code>

diff --git a/...gets-v1/src/main/java/com/google/cloud/billing/budgets/v1/NotificationsRuleOrBuilder.java b/...gets-v1/src/main/java/com/google/cloud/billing/budgets/v1/NotificationsRuleOrBuilder.java
@@ -72,9 +72,12 @@ public interface NotificationsRuleOrBuilder
    *
    *
    * <pre>
-   * Optional. The schema version of the notification sent to `pubsub_topic`.
+   * Optional. Required when
+   * [NotificationsRule.pubsub_topic][google.cloud.billing.budgets.v1.NotificationsRule.pubsub_topic]
+   * is set. The schema version of the notification sent to
+   * [NotificationsRule.pubsub_topic][google.cloud.billing.budgets.v1.NotificationsRule.pubsub_topic].
    * Only "1.0" is accepted. It represents the JSON schema as defined in
-   * https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format
+   * https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format.
    * </pre>
    *
    * <code>string schema_version = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
@@ -86,9 +89,12 @@ public interface NotificationsRuleOrBuilder
    *
    *
    * <pre>
-   * Optional. The schema version of the notification sent to `pubsub_topic`.
+   * Optional. Required when
+   * [NotificationsRule.pubsub_topic][google.cloud.billing.budgets.v1.NotificationsRule.pubsub_topic]
+   * is set. The schema version of the notification sent to
+   * [NotificationsRule.pubsub_topic][google.cloud.billing.budgets.v1.NotificationsRule.pubsub_topic].
    * Only "1.0" is accepted. It represents the JSON schema as defined in
-   * https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format
+   * https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format.
    * </pre>
    *
    * <code>string schema_version = 2 [(.google.api.field_behavior) = OPTIONAL];</code>

diff --git a/...cloud-billingbudgets-v1/src/main/proto/google/cloud/billing/budgets/v1/budget_model.proto b/...cloud-billingbudgets-v1/src/main/proto/google/cloud/billing/budgets/v1/budget_model.proto
@@ -1,4 +1,4 @@
-// Copyright 2020 Google LLC
+// Copyright 2021 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -74,9 +74,10 @@ message BudgetAmount {
   // Specification for what amount to use as the budget.
   oneof budget_amount {
     // A specified amount to use as the budget.
-    // `currency_code` is optional. If specified, it must match the
-    // currency of the billing account. The `currency_code` is provided on
-    // output.
+    // `currency_code` is optional. If specified when creating a budget, it must
+    // match the currency of the billing account. If specified when updating a
+    // budget, it must match the currency_code of the existing budget.
+    // The `currency_code` is provided on output.
     google.type.Money specified_amount = 1;
 
     // Use the last period's actual spend as the budget for the present period.
@@ -138,9 +139,12 @@ message NotificationsRule {
   // for more details on Pub/Sub roles and permissions.
   string pubsub_topic = 1 [(google.api.field_behavior) = OPTIONAL];
 
-  // Optional. The schema version of the notification sent to `pubsub_topic`.
+  // Optional. Required when
+  // [NotificationsRule.pubsub_topic][google.cloud.billing.budgets.v1.NotificationsRule.pubsub_topic]
+  // is set. The schema version of the notification sent to
+  // [NotificationsRule.pubsub_topic][google.cloud.billing.budgets.v1.NotificationsRule.pubsub_topic].
   // Only "1.0" is accepted. It represents the JSON schema as defined in
-  // https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format
+  // https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format.
   string schema_version = 2 [(google.api.field_behavior) = OPTIONAL];
 
   // Optional. Targets to send notifications to when a threshold is exceeded.