Skip to content
Permalink
Browse files
docs: update generated documentation (#17)
  • Loading branch information
yoshi-automation authored and chingor13 committed Nov 18, 2019
1 parent 91f64e8 commit f86799c18bb28862cf8a26ffa1a9ba6e7408a4b3
@@ -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
@@ -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.
*
* <p>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 &lt;a href="https://cloud.google.com/billing/quotas"&gt;Quotas and
* limits&lt;/a&gt; for more information on the limits of the number of budgets you can create.
*
* <p>Sample code:
*
@@ -301,7 +303,7 @@ public final UnaryCallable<GetBudgetRequest, Budget> getBudgetCallable() {

// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Returns the budgets for a billing account.
* Returns a list of budgets for a billing account.
*
* <p>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.
*
* <p>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.
*
* <p>Sample code:
*
@@ -355,8 +355,9 @@ public abstract static class BudgetServiceImplBase implements io.grpc.BindableSe
*
*
* <pre>
* Creates a new budget if none exists. There is a limit of 1,000 budgets
* per billing account.
* Creates a new budget. See
* &lt;a href="https://cloud.google.com/billing/quotas"&gt;Quotas and limits&lt;/a&gt;
* for more information on the limits of the number of budgets you can create.
* </pre>
*/
public void createBudget(
@@ -398,7 +399,7 @@ public void getBudget(
*
*
* <pre>
* Returns the budgets for a billing account.
* Returns a list of budgets for a billing account.
* </pre>
*/
public void listBudgets(
@@ -487,8 +488,9 @@ protected BudgetServiceStub build(io.grpc.Channel channel, io.grpc.CallOptions c
*
*
* <pre>
* Creates a new budget if none exists. There is a limit of 1,000 budgets
* per billing account.
* Creates a new budget. See
* &lt;a href="https://cloud.google.com/billing/quotas"&gt;Quotas and limits&lt;/a&gt;
* for more information on the limits of the number of budgets you can create.
* </pre>
*/
public void createBudget(
@@ -539,7 +541,7 @@ public void getBudget(
*
*
* <pre>
* Returns the budgets for a billing account.
* Returns a list of budgets for a billing account.
* </pre>
*/
public void listBudgets(
@@ -597,8 +599,9 @@ protected BudgetServiceBlockingStub build(
*
*
* <pre>
* Creates a new budget if none exists. There is a limit of 1,000 budgets
* per billing account.
* Creates a new budget. See
* &lt;a href="https://cloud.google.com/billing/quotas"&gt;Quotas and limits&lt;/a&gt;
* for more information on the limits of the number of budgets you can create.
* </pre>
*/
public com.google.cloud.billing.budgets.v1beta1.Budget createBudget(
@@ -636,7 +639,7 @@ public com.google.cloud.billing.budgets.v1beta1.Budget getBudget(
*
*
* <pre>
* Returns the budgets for a billing account.
* Returns a list of budgets for a billing account.
* </pre>
*/
public com.google.cloud.billing.budgets.v1beta1.ListBudgetsResponse listBudgets(
@@ -687,8 +690,9 @@ protected BudgetServiceFutureStub build(
*
*
* <pre>
* Creates a new budget if none exists. There is a limit of 1,000 budgets
* per billing account.
* Creates a new budget. See
* &lt;a href="https://cloud.google.com/billing/quotas"&gt;Quotas and limits&lt;/a&gt;
* for more information on the limits of the number of budgets you can create.
* </pre>
*/
public com.google.common.util.concurrent.ListenableFuture<
@@ -730,7 +734,7 @@ protected BudgetServiceFutureStub build(
*
*
* <pre>
* Returns the budgets for a billing account.
* Returns a list of budgets for a billing account.
* </pre>
*/
public com.google.common.util.concurrent.ListenableFuture<
@@ -124,7 +124,11 @@ public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() {
* <pre>
* 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() {
* <pre>
* 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(
* <pre>
* 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() {
* <pre>
* 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() {
* <pre>
* 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) {
* <pre>
* 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() {
* <pre>
* 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
@@ -29,7 +29,11 @@
* <pre>
* 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 @@
* <pre>
* 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
@@ -22,9 +22,9 @@
*
*
* <pre>
* 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).
* </pre>
@@ -797,9 +797,9 @@ protected Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.Build
*
*
* <pre>
* 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).
* </pre>
@@ -128,7 +128,7 @@ public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() {
*
*
* <pre>
* 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}`.
* </pre>
*
@@ -151,7 +151,7 @@ public java.lang.String getParent() {
*
*
* <pre>
* 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}`.
* </pre>
*
@@ -572,7 +572,7 @@ public Builder mergeFrom(
*
*
* <pre>
* 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}`.
* </pre>
*
@@ -595,7 +595,7 @@ public java.lang.String getParent() {
*
*
* <pre>
* 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}`.
* </pre>
*
@@ -618,7 +618,7 @@ public com.google.protobuf.ByteString getParentBytes() {
*
*
* <pre>
* 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}`.
* </pre>
*
@@ -639,7 +639,7 @@ public Builder setParent(java.lang.String value) {
*
*
* <pre>
* 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}`.
* </pre>
*
@@ -657,7 +657,7 @@ public Builder clearParent() {
*
*
* <pre>
* 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}`.
* </pre>
*
@@ -27,7 +27,7 @@
*
*
* <pre>
* 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}`.
* </pre>
*
@@ -40,7 +40,7 @@
*
*
* <pre>
* 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}`.
* </pre>
*
@@ -22,10 +22,11 @@
*
*
* <pre>
* 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).
* </pre>
*
* Protobuf type {@code google.cloud.billing.budgets.v1beta1.LastPeriodAmount}
@@ -254,10 +255,11 @@ protected Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.Build
*
*
* <pre>
* 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).
* </pre>
*
* Protobuf type {@code google.cloud.billing.budgets.v1beta1.LastPeriodAmount}

0 comments on commit f86799c

Please sign in to comment.