Skip to content
This repository has been archived by the owner on Sep 18, 2023. It is now read-only.

docs: update generated documentation #17

Merged
merged 1 commit into from Nov 18, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion .kokoro/release/publish_javadoc.sh
Expand Up @@ -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
Expand Down
Expand Up @@ -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:
*
Expand All @@ -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:
*
Expand Down Expand Up @@ -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:
*
Expand All @@ -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:
*
Expand All @@ -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:
*
Expand Down
Expand Up @@ -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(
Expand Down Expand Up @@ -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(
Expand Down Expand Up @@ -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(
Expand Down Expand Up @@ -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(
Expand Down Expand Up @@ -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(
Expand Down Expand Up @@ -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(
Expand Down Expand Up @@ -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<
Expand Down Expand Up @@ -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<
Expand Down
Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand Down
Expand Up @@ -29,7 +29,11 @@ public interface AllUpdatesRuleOrBuilder
* <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
Expand All @@ -45,7 +49,11 @@ public interface AllUpdatesRuleOrBuilder
* <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
Expand Down
Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand Down
Expand Up @@ -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>
*
Expand All @@ -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>
*
Expand Down Expand Up @@ -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>
*
Expand All @@ -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>
*
Expand All @@ -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>
*
Expand All @@ -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>
*
Expand All @@ -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>
*
Expand Down
Expand Up @@ -27,7 +27,7 @@ public interface CreateBudgetRequestOrBuilder
*
*
* <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>
*
Expand All @@ -40,7 +40,7 @@ public interface CreateBudgetRequestOrBuilder
*
*
* <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>
*
Expand Down
Expand Up @@ -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}
Expand Down Expand Up @@ -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}
Expand Down