diff --git a/.kokoro/release/publish_javadoc.sh b/.kokoro/release/publish_javadoc.sh index a0e7c0ee..56ff5add 100755 --- a/.kokoro/release/publish_javadoc.sh +++ b/.kokoro/release/publish_javadoc.sh @@ -33,7 +33,7 @@ python3 -m pip install gcp-docuploader # compile all packages mvn clean install -B -DskipTests=true -NAME=billingbudgets +NAME=google-cloud-billingbudgets VERSION=$(grep ${NAME}: versions.txt | cut -d: -f3) # build the docs diff --git a/google-cloud-billingbudgets/src/main/java/com/google/cloud/billing/budgets/v1beta1/BudgetServiceClient.java b/google-cloud-billingbudgets/src/main/java/com/google/cloud/billing/budgets/v1beta1/BudgetServiceClient.java index 3823db08..5f2a1405 100644 --- a/google-cloud-billingbudgets/src/main/java/com/google/cloud/billing/budgets/v1beta1/BudgetServiceClient.java +++ b/google-cloud-billingbudgets/src/main/java/com/google/cloud/billing/budgets/v1beta1/BudgetServiceClient.java @@ -162,7 +162,8 @@ public BudgetServiceStub getStub() { // AUTO-GENERATED DOCUMENTATION AND METHOD /** - * Creates a new budget if none exists. There is a limit of 1,000 budgets per billing account. + * Creates a new budget. See <a href="https://cloud.google.com/billing/quotas">Quotas and + * limits</a> for more information on the limits of the number of budgets you can create. * *

Sample code: * @@ -187,7 +188,8 @@ public final Budget createBudget(CreateBudgetRequest request) { // AUTO-GENERATED DOCUMENTATION AND METHOD /** - * Creates a new budget if none exists. There is a limit of 1,000 budgets per billing account. + * Creates a new budget. See <a href="https://cloud.google.com/billing/quotas">Quotas and + * limits</a> for more information on the limits of the number of budgets you can create. * *

Sample code: * @@ -301,7 +303,7 @@ public final UnaryCallable getBudgetCallable() { // AUTO-GENERATED DOCUMENTATION AND METHOD /** - * Returns the budgets for a billing account. + * Returns a list of budgets for a billing account. * *

Sample code: * @@ -326,7 +328,7 @@ public final ListBudgetsPagedResponse listBudgets(ListBudgetsRequest request) { // AUTO-GENERATED DOCUMENTATION AND METHOD /** - * Returns the budgets for a billing account. + * Returns a list of budgets for a billing account. * *

Sample code: * @@ -351,7 +353,7 @@ public final ListBudgetsPagedResponse listBudgets(ListBudgetsRequest request) { // AUTO-GENERATED DOCUMENTATION AND METHOD /** - * Returns the budgets for a billing account. + * Returns a list of budgets for a billing account. * *

Sample code: * diff --git a/grpc-google-cloud-billingbudgets-v1beta1/src/main/java/com/google/cloud/billing/budgets/v1beta1/BudgetServiceGrpc.java b/grpc-google-cloud-billingbudgets-v1beta1/src/main/java/com/google/cloud/billing/budgets/v1beta1/BudgetServiceGrpc.java index 72863eee..ef566ad7 100644 --- a/grpc-google-cloud-billingbudgets-v1beta1/src/main/java/com/google/cloud/billing/budgets/v1beta1/BudgetServiceGrpc.java +++ b/grpc-google-cloud-billingbudgets-v1beta1/src/main/java/com/google/cloud/billing/budgets/v1beta1/BudgetServiceGrpc.java @@ -355,8 +355,9 @@ public abstract static class BudgetServiceImplBase implements io.grpc.BindableSe * * *

-     * Creates a new budget if none exists. There is a limit of 1,000 budgets
-     * per billing account.
+     * Creates a new budget. See
+     * <a href="https://cloud.google.com/billing/quotas">Quotas and limits</a>
+     * for more information on the limits of the number of budgets you can create.
      * 
*/ public void createBudget( @@ -398,7 +399,7 @@ public void getBudget( * * *
-     * Returns the budgets for a billing account.
+     * Returns a list of budgets for a billing account.
      * 
*/ public void listBudgets( @@ -487,8 +488,9 @@ protected BudgetServiceStub build(io.grpc.Channel channel, io.grpc.CallOptions c * * *
-     * Creates a new budget if none exists. There is a limit of 1,000 budgets
-     * per billing account.
+     * Creates a new budget. See
+     * <a href="https://cloud.google.com/billing/quotas">Quotas and limits</a>
+     * for more information on the limits of the number of budgets you can create.
      * 
*/ public void createBudget( @@ -539,7 +541,7 @@ public void getBudget( * * *
-     * Returns the budgets for a billing account.
+     * Returns a list of budgets for a billing account.
      * 
*/ public void listBudgets( @@ -597,8 +599,9 @@ protected BudgetServiceBlockingStub build( * * *
-     * Creates a new budget if none exists. There is a limit of 1,000 budgets
-     * per billing account.
+     * Creates a new budget. See
+     * <a href="https://cloud.google.com/billing/quotas">Quotas and limits</a>
+     * for more information on the limits of the number of budgets you can create.
      * 
*/ public com.google.cloud.billing.budgets.v1beta1.Budget createBudget( @@ -636,7 +639,7 @@ public com.google.cloud.billing.budgets.v1beta1.Budget getBudget( * * *
-     * Returns the budgets for a billing account.
+     * Returns a list of budgets for a billing account.
      * 
*/ public com.google.cloud.billing.budgets.v1beta1.ListBudgetsResponse listBudgets( @@ -687,8 +690,9 @@ protected BudgetServiceFutureStub build( * * *
-     * Creates a new budget if none exists. There is a limit of 1,000 budgets
-     * per billing account.
+     * Creates a new budget. See
+     * <a href="https://cloud.google.com/billing/quotas">Quotas and limits</a>
+     * for more information on the limits of the number of budgets you can create.
      * 
*/ public com.google.common.util.concurrent.ListenableFuture< @@ -730,7 +734,7 @@ protected BudgetServiceFutureStub build( * * *
-     * Returns the budgets for a billing account.
+     * Returns a list of budgets for a billing account.
      * 
*/ public com.google.common.util.concurrent.ListenableFuture< diff --git a/proto-google-cloud-billingbudgets-v1beta1/src/main/java/com/google/cloud/billing/budgets/v1beta1/AllUpdatesRule.java b/proto-google-cloud-billingbudgets-v1beta1/src/main/java/com/google/cloud/billing/budgets/v1beta1/AllUpdatesRule.java index 858e7a9a..ecc7485e 100644 --- a/proto-google-cloud-billingbudgets-v1beta1/src/main/java/com/google/cloud/billing/budgets/v1beta1/AllUpdatesRule.java +++ b/proto-google-cloud-billingbudgets-v1beta1/src/main/java/com/google/cloud/billing/budgets/v1beta1/AllUpdatesRule.java @@ -124,7 +124,11 @@ public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() { *
    * Required. The name of the Cloud Pub/Sub topic where budget related messages will be
    * published, in the form `projects/{project_id}/topics/{topic_id}`. Updates
-   * are sent at regular intervals to the topic. Caller is expected to have
+   * are sent at regular intervals to the topic.
+   * The topic needs to be created before the budget is created; see
+   * https://cloud.google.com/billing/docs/how-to/budgets#manage-notifications
+   * for more details.
+   * Caller is expected to have
    * `pubsub.topics.setIamPolicy` permission on the topic when it's set for a
    * budget, otherwise, the API call will fail with PERMISSION_DENIED. See
    * https://cloud.google.com/pubsub/docs/access-control for more details on
@@ -150,7 +154,11 @@ public java.lang.String getPubsubTopic() {
    * 
    * Required. The name of the Cloud Pub/Sub topic where budget related messages will be
    * published, in the form `projects/{project_id}/topics/{topic_id}`. Updates
-   * are sent at regular intervals to the topic. Caller is expected to have
+   * are sent at regular intervals to the topic.
+   * The topic needs to be created before the budget is created; see
+   * https://cloud.google.com/billing/docs/how-to/budgets#manage-notifications
+   * for more details.
+   * Caller is expected to have
    * `pubsub.topics.setIamPolicy` permission on the topic when it's set for a
    * budget, otherwise, the API call will fail with PERMISSION_DENIED. See
    * https://cloud.google.com/pubsub/docs/access-control for more details on
@@ -562,7 +570,11 @@ public Builder mergeFrom(
      * 
      * Required. The name of the Cloud Pub/Sub topic where budget related messages will be
      * published, in the form `projects/{project_id}/topics/{topic_id}`. Updates
-     * are sent at regular intervals to the topic. Caller is expected to have
+     * are sent at regular intervals to the topic.
+     * The topic needs to be created before the budget is created; see
+     * https://cloud.google.com/billing/docs/how-to/budgets#manage-notifications
+     * for more details.
+     * Caller is expected to have
      * `pubsub.topics.setIamPolicy` permission on the topic when it's set for a
      * budget, otherwise, the API call will fail with PERMISSION_DENIED. See
      * https://cloud.google.com/pubsub/docs/access-control for more details on
@@ -588,7 +600,11 @@ public java.lang.String getPubsubTopic() {
      * 
      * Required. The name of the Cloud Pub/Sub topic where budget related messages will be
      * published, in the form `projects/{project_id}/topics/{topic_id}`. Updates
-     * are sent at regular intervals to the topic. Caller is expected to have
+     * are sent at regular intervals to the topic.
+     * The topic needs to be created before the budget is created; see
+     * https://cloud.google.com/billing/docs/how-to/budgets#manage-notifications
+     * for more details.
+     * Caller is expected to have
      * `pubsub.topics.setIamPolicy` permission on the topic when it's set for a
      * budget, otherwise, the API call will fail with PERMISSION_DENIED. See
      * https://cloud.google.com/pubsub/docs/access-control for more details on
@@ -614,7 +630,11 @@ public com.google.protobuf.ByteString getPubsubTopicBytes() {
      * 
      * Required. The name of the Cloud Pub/Sub topic where budget related messages will be
      * published, in the form `projects/{project_id}/topics/{topic_id}`. Updates
-     * are sent at regular intervals to the topic. Caller is expected to have
+     * are sent at regular intervals to the topic.
+     * The topic needs to be created before the budget is created; see
+     * https://cloud.google.com/billing/docs/how-to/budgets#manage-notifications
+     * for more details.
+     * Caller is expected to have
      * `pubsub.topics.setIamPolicy` permission on the topic when it's set for a
      * budget, otherwise, the API call will fail with PERMISSION_DENIED. See
      * https://cloud.google.com/pubsub/docs/access-control for more details on
@@ -638,7 +658,11 @@ public Builder setPubsubTopic(java.lang.String value) {
      * 
      * Required. The name of the Cloud Pub/Sub topic where budget related messages will be
      * published, in the form `projects/{project_id}/topics/{topic_id}`. Updates
-     * are sent at regular intervals to the topic. Caller is expected to have
+     * are sent at regular intervals to the topic.
+     * The topic needs to be created before the budget is created; see
+     * https://cloud.google.com/billing/docs/how-to/budgets#manage-notifications
+     * for more details.
+     * Caller is expected to have
      * `pubsub.topics.setIamPolicy` permission on the topic when it's set for a
      * budget, otherwise, the API call will fail with PERMISSION_DENIED. See
      * https://cloud.google.com/pubsub/docs/access-control for more details on
@@ -659,7 +683,11 @@ public Builder clearPubsubTopic() {
      * 
      * Required. The name of the Cloud Pub/Sub topic where budget related messages will be
      * published, in the form `projects/{project_id}/topics/{topic_id}`. Updates
-     * are sent at regular intervals to the topic. Caller is expected to have
+     * are sent at regular intervals to the topic.
+     * The topic needs to be created before the budget is created; see
+     * https://cloud.google.com/billing/docs/how-to/budgets#manage-notifications
+     * for more details.
+     * Caller is expected to have
      * `pubsub.topics.setIamPolicy` permission on the topic when it's set for a
      * budget, otherwise, the API call will fail with PERMISSION_DENIED. See
      * https://cloud.google.com/pubsub/docs/access-control for more details on
diff --git a/proto-google-cloud-billingbudgets-v1beta1/src/main/java/com/google/cloud/billing/budgets/v1beta1/AllUpdatesRuleOrBuilder.java b/proto-google-cloud-billingbudgets-v1beta1/src/main/java/com/google/cloud/billing/budgets/v1beta1/AllUpdatesRuleOrBuilder.java
index f7f5d1bc..d5814637 100644
--- a/proto-google-cloud-billingbudgets-v1beta1/src/main/java/com/google/cloud/billing/budgets/v1beta1/AllUpdatesRuleOrBuilder.java
+++ b/proto-google-cloud-billingbudgets-v1beta1/src/main/java/com/google/cloud/billing/budgets/v1beta1/AllUpdatesRuleOrBuilder.java
@@ -29,7 +29,11 @@ public interface AllUpdatesRuleOrBuilder
    * 
    * Required. The name of the Cloud Pub/Sub topic where budget related messages will be
    * published, in the form `projects/{project_id}/topics/{topic_id}`. Updates
-   * are sent at regular intervals to the topic. Caller is expected to have
+   * are sent at regular intervals to the topic.
+   * The topic needs to be created before the budget is created; see
+   * https://cloud.google.com/billing/docs/how-to/budgets#manage-notifications
+   * for more details.
+   * Caller is expected to have
    * `pubsub.topics.setIamPolicy` permission on the topic when it's set for a
    * budget, otherwise, the API call will fail with PERMISSION_DENIED. See
    * https://cloud.google.com/pubsub/docs/access-control for more details on
@@ -45,7 +49,11 @@ public interface AllUpdatesRuleOrBuilder
    * 
    * Required. The name of the Cloud Pub/Sub topic where budget related messages will be
    * published, in the form `projects/{project_id}/topics/{topic_id}`. Updates
-   * are sent at regular intervals to the topic. Caller is expected to have
+   * are sent at regular intervals to the topic.
+   * The topic needs to be created before the budget is created; see
+   * https://cloud.google.com/billing/docs/how-to/budgets#manage-notifications
+   * for more details.
+   * Caller is expected to have
    * `pubsub.topics.setIamPolicy` permission on the topic when it's set for a
    * budget, otherwise, the API call will fail with PERMISSION_DENIED. See
    * https://cloud.google.com/pubsub/docs/access-control for more details on
diff --git a/proto-google-cloud-billingbudgets-v1beta1/src/main/java/com/google/cloud/billing/budgets/v1beta1/Budget.java b/proto-google-cloud-billingbudgets-v1beta1/src/main/java/com/google/cloud/billing/budgets/v1beta1/Budget.java
index fc351b74..d7129712 100644
--- a/proto-google-cloud-billingbudgets-v1beta1/src/main/java/com/google/cloud/billing/budgets/v1beta1/Budget.java
+++ b/proto-google-cloud-billingbudgets-v1beta1/src/main/java/com/google/cloud/billing/budgets/v1beta1/Budget.java
@@ -22,9 +22,9 @@
  *
  *
  * 
- * A budget is a plan that describes what the user expects to spend on Cloud
- * projects, plus rules to execute as spend is tracked against that plan,
- * e.g. alert at 90% of $100 target.
+ * 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).
  * 
@@ -797,9 +797,9 @@ protected Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.Build * * *
-   * A budget is a plan that describes what the user expects to spend on Cloud
-   * projects, plus rules to execute as spend is tracked against that plan,
-   * e.g. alert at 90% of $100 target.
+   * 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).
    * 
diff --git a/proto-google-cloud-billingbudgets-v1beta1/src/main/java/com/google/cloud/billing/budgets/v1beta1/CreateBudgetRequest.java b/proto-google-cloud-billingbudgets-v1beta1/src/main/java/com/google/cloud/billing/budgets/v1beta1/CreateBudgetRequest.java index bb7bb3f5..df2bc826 100644 --- a/proto-google-cloud-billingbudgets-v1beta1/src/main/java/com/google/cloud/billing/budgets/v1beta1/CreateBudgetRequest.java +++ b/proto-google-cloud-billingbudgets-v1beta1/src/main/java/com/google/cloud/billing/budgets/v1beta1/CreateBudgetRequest.java @@ -128,7 +128,7 @@ public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() { * * *
-   * Required. the name of the billing account to create the budget in. Values
+   * Required. The name of the billing account to create the budget in. Values
    * are of the form `billingAccounts/{billingAccountId}`.
    * 
* @@ -151,7 +151,7 @@ public java.lang.String getParent() { * * *
-   * Required. the name of the billing account to create the budget in. Values
+   * Required. The name of the billing account to create the budget in. Values
    * are of the form `billingAccounts/{billingAccountId}`.
    * 
* @@ -572,7 +572,7 @@ public Builder mergeFrom( * * *
-     * Required. the name of the billing account to create the budget in. Values
+     * Required. The name of the billing account to create the budget in. Values
      * are of the form `billingAccounts/{billingAccountId}`.
      * 
* @@ -595,7 +595,7 @@ public java.lang.String getParent() { * * *
-     * Required. the name of the billing account to create the budget in. Values
+     * Required. The name of the billing account to create the budget in. Values
      * are of the form `billingAccounts/{billingAccountId}`.
      * 
* @@ -618,7 +618,7 @@ public com.google.protobuf.ByteString getParentBytes() { * * *
-     * Required. the name of the billing account to create the budget in. Values
+     * Required. The name of the billing account to create the budget in. Values
      * are of the form `billingAccounts/{billingAccountId}`.
      * 
* @@ -639,7 +639,7 @@ public Builder setParent(java.lang.String value) { * * *
-     * Required. the name of the billing account to create the budget in. Values
+     * Required. The name of the billing account to create the budget in. Values
      * are of the form `billingAccounts/{billingAccountId}`.
      * 
* @@ -657,7 +657,7 @@ public Builder clearParent() { * * *
-     * Required. the name of the billing account to create the budget in. Values
+     * Required. The name of the billing account to create the budget in. Values
      * are of the form `billingAccounts/{billingAccountId}`.
      * 
* diff --git a/proto-google-cloud-billingbudgets-v1beta1/src/main/java/com/google/cloud/billing/budgets/v1beta1/CreateBudgetRequestOrBuilder.java b/proto-google-cloud-billingbudgets-v1beta1/src/main/java/com/google/cloud/billing/budgets/v1beta1/CreateBudgetRequestOrBuilder.java index e09953ff..54aa9c1c 100644 --- a/proto-google-cloud-billingbudgets-v1beta1/src/main/java/com/google/cloud/billing/budgets/v1beta1/CreateBudgetRequestOrBuilder.java +++ b/proto-google-cloud-billingbudgets-v1beta1/src/main/java/com/google/cloud/billing/budgets/v1beta1/CreateBudgetRequestOrBuilder.java @@ -27,7 +27,7 @@ public interface CreateBudgetRequestOrBuilder * * *
-   * Required. the name of the billing account to create the budget in. Values
+   * Required. The name of the billing account to create the budget in. Values
    * are of the form `billingAccounts/{billingAccountId}`.
    * 
* @@ -40,7 +40,7 @@ public interface CreateBudgetRequestOrBuilder * * *
-   * Required. the name of the billing account to create the budget in. Values
+   * Required. The name of the billing account to create the budget in. Values
    * are of the form `billingAccounts/{billingAccountId}`.
    * 
* diff --git a/proto-google-cloud-billingbudgets-v1beta1/src/main/java/com/google/cloud/billing/budgets/v1beta1/LastPeriodAmount.java b/proto-google-cloud-billingbudgets-v1beta1/src/main/java/com/google/cloud/billing/budgets/v1beta1/LastPeriodAmount.java index 97d10ed0..7a8508b6 100644 --- a/proto-google-cloud-billingbudgets-v1beta1/src/main/java/com/google/cloud/billing/budgets/v1beta1/LastPeriodAmount.java +++ b/proto-google-cloud-billingbudgets-v1beta1/src/main/java/com/google/cloud/billing/budgets/v1beta1/LastPeriodAmount.java @@ -22,10 +22,11 @@ * * *
- * Describes a plan to target last period's spend.
- * There are no options yet. The amount is automatically 100% of last period's
- * spend.
- * Future configuration will go here (e.g. configuring the percentage).
+ * Describes a budget amount targeted to last period's spend.
+ * At this time, the amount is automatically 100% of last period's spend;
+ * that is, there are no other options yet.
+ * Future configuration will be described here (for example, configuring a
+ * percentage of last period's spend).
  * 
* * Protobuf type {@code google.cloud.billing.budgets.v1beta1.LastPeriodAmount} @@ -254,10 +255,11 @@ protected Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.Build * * *
-   * Describes a plan to target last period's spend.
-   * There are no options yet. The amount is automatically 100% of last period's
-   * spend.
-   * Future configuration will go here (e.g. configuring the percentage).
+   * Describes a budget amount targeted to last period's spend.
+   * At this time, the amount is automatically 100% of last period's spend;
+   * that is, there are no other options yet.
+   * Future configuration will be described here (for example, configuring a
+   * percentage of last period's spend).
    * 
* * Protobuf type {@code google.cloud.billing.budgets.v1beta1.LastPeriodAmount} diff --git a/proto-google-cloud-billingbudgets-v1beta1/src/main/java/com/google/cloud/billing/budgets/v1beta1/ThresholdRule.java b/proto-google-cloud-billingbudgets-v1beta1/src/main/java/com/google/cloud/billing/budgets/v1beta1/ThresholdRule.java index 13865b30..432e31a2 100644 --- a/proto-google-cloud-billingbudgets-v1beta1/src/main/java/com/google/cloud/billing/budgets/v1beta1/ThresholdRule.java +++ b/proto-google-cloud-billingbudgets-v1beta1/src/main/java/com/google/cloud/billing/budgets/v1beta1/ThresholdRule.java @@ -25,9 +25,10 @@ * ThresholdRule contains a definition of a threshold which triggers * an alert (a notification of a threshold being crossed) to be sent when * spend goes above the specified amount. - * Alerts are automatically e-mailed to the billing users who have - * access to the billing account. The thresholds here have no effect on - * notifications sent to anything configured under `Budget.all_updates_rule`. + * Alerts are automatically e-mailed to users with the Billing Account + * Administrator role or the Billing Account User role. + * The thresholds here have no effect on notifications sent to anything + * configured under `Budget.all_updates_rule`. *
* * Protobuf type {@code google.cloud.billing.budgets.v1beta1.ThresholdRule} @@ -504,9 +505,10 @@ protected Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.Build * ThresholdRule contains a definition of a threshold which triggers * an alert (a notification of a threshold being crossed) to be sent when * spend goes above the specified amount. - * Alerts are automatically e-mailed to the billing users who have - * access to the billing account. The thresholds here have no effect on - * notifications sent to anything configured under `Budget.all_updates_rule`. + * Alerts are automatically e-mailed to users with the Billing Account + * Administrator role or the Billing Account User role. + * The thresholds here have no effect on notifications sent to anything + * configured under `Budget.all_updates_rule`. *
* * Protobuf type {@code google.cloud.billing.budgets.v1beta1.ThresholdRule} diff --git a/proto-google-cloud-billingbudgets-v1beta1/src/main/proto/google/cloud/billing/budgets/v1beta1/budget_model.proto b/proto-google-cloud-billingbudgets-v1beta1/src/main/proto/google/cloud/billing/budgets/v1beta1/budget_model.proto index e7d5ca2b..89e96bea 100644 --- a/proto-google-cloud-billingbudgets-v1beta1/src/main/proto/google/cloud/billing/budgets/v1beta1/budget_model.proto +++ b/proto-google-cloud-billingbudgets-v1beta1/src/main/proto/google/cloud/billing/budgets/v1beta1/budget_model.proto @@ -25,9 +25,9 @@ option go_package = "google.golang.org/genproto/googleapis/cloud/billing/budgets option java_multiple_files = true; option java_package = "com.google.cloud.billing.budgets.v1beta1"; -// A budget is a plan that describes what the user expects to spend on Cloud -// projects, plus rules to execute as spend is tracked against that plan, -// e.g. alert at 90% of $100 target. +// 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). message Budget { @@ -81,10 +81,11 @@ message BudgetAmount { } } -// Describes a plan to target last period's spend. -// There are no options yet. The amount is automatically 100% of last period's -// spend. -// Future configuration will go here (e.g. configuring the percentage). +// Describes a budget amount targeted to last period's spend. +// At this time, the amount is automatically 100% of last period's spend; +// that is, there are no other options yet. +// Future configuration will be described here (for example, configuring a +// percentage of last period's spend). message LastPeriodAmount { } @@ -92,9 +93,10 @@ message LastPeriodAmount { // ThresholdRule contains a definition of a threshold which triggers // an alert (a notification of a threshold being crossed) to be sent when // spend goes above the specified amount. -// Alerts are automatically e-mailed to the billing users who have -// access to the billing account. The thresholds here have no effect on -// notifications sent to anything configured under `Budget.all_updates_rule`. +// Alerts are automatically e-mailed to users with the Billing Account +// Administrator role or the Billing Account User role. +// The thresholds here have no effect on notifications sent to anything +// configured under `Budget.all_updates_rule`. message ThresholdRule { // The type of basis used to determine if spend has passed the threshold. enum Basis { @@ -125,7 +127,11 @@ message ThresholdRule { message AllUpdatesRule { // Required. The name of the Cloud Pub/Sub topic where budget related messages will be // published, in the form `projects/{project_id}/topics/{topic_id}`. Updates - // are sent at regular intervals to the topic. Caller is expected to have + // are sent at regular intervals to the topic. + // The topic needs to be created before the budget is created; see + // https://cloud.google.com/billing/docs/how-to/budgets#manage-notifications + // for more details. + // Caller is expected to have // `pubsub.topics.setIamPolicy` permission on the topic when it's set for a // budget, otherwise, the API call will fail with PERMISSION_DENIED. See // https://cloud.google.com/pubsub/docs/access-control for more details on diff --git a/proto-google-cloud-billingbudgets-v1beta1/src/main/proto/google/cloud/billing/budgets/v1beta1/budget_service.proto b/proto-google-cloud-billingbudgets-v1beta1/src/main/proto/google/cloud/billing/budgets/v1beta1/budget_service.proto index 6c7f3559..d5e0f4bc 100644 --- a/proto-google-cloud-billingbudgets-v1beta1/src/main/proto/google/cloud/billing/budgets/v1beta1/budget_service.proto +++ b/proto-google-cloud-billingbudgets-v1beta1/src/main/proto/google/cloud/billing/budgets/v1beta1/budget_service.proto @@ -35,8 +35,9 @@ service BudgetService { option (google.api.default_host) = "billingbudgets.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform"; - // Creates a new budget if none exists. There is a limit of 1,000 budgets - // per billing account. + // Creates a new budget. See + // Quotas and limits + // for more information on the limits of the number of budgets you can create. rpc CreateBudget(CreateBudgetRequest) returns (Budget) { option (google.api.http) = { post: "/v1beta1/{parent=billingAccounts/*}/budgets" @@ -59,7 +60,7 @@ service BudgetService { }; } - // Returns the budgets for a billing account. + // Returns a list of budgets for a billing account. rpc ListBudgets(ListBudgetsRequest) returns (ListBudgetsResponse) { option (google.api.http) = { get: "/v1beta1/{parent=billingAccounts/*}/budgets" @@ -76,7 +77,7 @@ service BudgetService { // Request for CreateBudget message CreateBudgetRequest { - // Required. the name of the billing account to create the budget in. Values + // Required. The name of the billing account to create the budget in. Values // are of the form `billingAccounts/{billingAccountId}`. string parent = 1 [ (google.api.field_behavior) = REQUIRED, diff --git a/synth.metadata b/synth.metadata index dfd86f48..1e9af722 100644 --- a/synth.metadata +++ b/synth.metadata @@ -1,5 +1,5 @@ { - "updateTime": "2019-11-11T21:10:32.302489Z", + "updateTime": "2019-11-16T08:37:44.456508Z", "sources": [ { "generator": { @@ -12,8 +12,8 @@ "git": { "name": "googleapis", "remote": "https://github.com/googleapis/googleapis.git", - "sha": "f69562be0608904932bdcfbc5ad8b9a22d9dceb8", - "internalRef": "279774957" + "sha": "c89394342a9ef70acaf73a6959e04b943fbc817b", + "internalRef": "280761373" } }, {