From ba436989cfb88e6403f844aadb990c35b0db282d Mon Sep 17 00:00:00 2001 From: Jeff Ching Date: Fri, 24 Jan 2020 10:16:52 -0800 Subject: [PATCH] feat: promote to beta (#57) --- .repo-metadata.json | 11 +++++-- README.md | 70 +++++++++++++++++++++++++++++++++------------ synth.metadata | 42 ++------------------------- 3 files changed, 62 insertions(+), 61 deletions(-) diff --git a/.repo-metadata.json b/.repo-metadata.json index 564c73f7..fda1b6b9 100644 --- a/.repo-metadata.json +++ b/.repo-metadata.json @@ -1,9 +1,14 @@ { "name": "billingbudgets", - "name_pretty": "Google Cloud Billing Budgets", - "release_level": "alpha", + "name_pretty": "Cloud Billing Budgets", + "product_documentation": "https://cloud.google.com/billing/docs/how-to/budgets", + "client_documentation": "https://googleapis.dev/java/google-cloud-billingbudgets/latest/", + "api_description": "allows you to avoid surprises on your bill by creating budgets to monitor all your Google Cloud charges in one place.", + "release_level": "beta", "language": "java", + "transport": "grpc", "repo": "googleapis/java-billingbudgets", "repo_short": "java-billingbudgets", - "distribution_name": "google-cloud-billingbudgets" + "distribution_name": "com.google.cloud:google-cloud-billingbudgets", + "api_id": "billingbudgets.googleapis.com" } diff --git a/README.md b/README.md index 717713b9..fea08a22 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# Google Cloud Java Client for Google Cloud Billing Budgets +# Google Cloud Billing Budgets Client for Java -Java idiomatic client for [Google Cloud Billing Budgets][api-reference]. +Java idiomatic client for [Cloud Billing Budgets][product-docs]. [![Maven][maven-version-image]][maven-version-link] ![Stability][stability-image] @@ -13,8 +13,32 @@ Java idiomatic client for [Google Cloud Billing Budgets][api-reference]. ## Quickstart +If you are using Maven with [BOM][libraries-bom], add this to your pom.xml file +```xml + + + + com.google.cloud + libraries-bom + 3.4.0 + pom + import + + + + + + + com.google.cloud + google-cloud-billingbudgets + + +``` + [//]: # ({x-version-update-start:google-cloud-billingbudgets:released}) -If you are using Maven, add this to your pom.xml file + +If you are using Maven without BOM, add this to your dependencies: + ```xml com.google.cloud @@ -22,6 +46,7 @@ If you are using Maven, add this to your pom.xml file 0.1.2 ``` + If you are using Gradle, add this to your dependencies ```Groovy compile 'com.google.cloud:google-cloud-billingbudgets:0.1.2' @@ -36,20 +61,13 @@ libraryDependencies += "com.google.cloud" % "google-cloud-billingbudgets" % "0.1 See the [Authentication][authentication] section in the base directory's README. -## About Google Cloud Billing Budgets - -[Google Cloud Billing Budgets][api-reference] is a suite of Machine Learning products. - -See the [Google Cloud Billing Budgets client library docs][javadocs] to learn how to -use this Google Cloud Billing Budgets Client Library. - ## Getting Started ### Prerequisites -You will need a [Google Developers Console][developer-console] project with the -Google Cloud Billing Budgets API enabled. [Follow these instructions][create-project] to get your -project set up. You will also need to set up the local development environment by +You will need a [Google Cloud Platform Console][developer-console] project with the Cloud Billing Budgets [API enabled][enable-api]. + +[Follow these instructions][create-project] to get your project set up. You will also need to set up the local development environment by [installing the Google Cloud SDK][cloud-sdk] and running the following commands in command line: `gcloud auth login` and `gcloud config set project [YOUR PROJECT ID]`. @@ -58,13 +76,24 @@ project set up. You will also need to set up the local development environment b You'll need to obtain the `google-cloud-billingbudgets` library. See the [Quickstart](#quickstart) section to add `google-cloud-billingbudgets` as a dependency in your code. +## About Cloud Billing Budgets + + +[Cloud Billing Budgets][product-docs] allows you to avoid surprises on your bill by creating budgets to monitor all your Google Cloud charges in one place. + +See the [Cloud Billing Budgets client library docs][javadocs] to learn how to +use this Cloud Billing Budgets Client Library. + + + + ## Troubleshooting To get help, follow the instructions in the [shared Troubleshooting document][troubleshooting]. ## Transport -Google Cloud Billing Budgets uses gRPC for the transport layer. +Cloud Billing Budgets uses gRPC for the transport layer. ## Java Versions @@ -74,14 +103,17 @@ Java 7 or above is required for using this client. This library follows [Semantic Versioning](http://semver.org/). + It is currently in major version zero (``0.y.z``), which means that anything may change at any time and the public API should not be considered stable. + ## Contributing + Contributions to this library are always welcome and highly encouraged. -See [CONTRIBUTING.md][contributing] documentation for more information on how to get started. +See [CONTRIBUTING][contributing] for more information how to get started. Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. See [Code of Conduct][code-of-conduct] for more @@ -101,9 +133,8 @@ Java 8 OSX | [![Kokoro CI][kokoro-badge-image-3]][kokoro-badge-link-3] Java 8 Windows | [![Kokoro CI][kokoro-badge-image-4]][kokoro-badge-link-4] Java 11 | [![Kokoro CI][kokoro-badge-image-5]][kokoro-badge-link-5] -[api-reference]: https://googleapis.dev/java/google-cloud-billingbudgets/latest [product-docs]: https://cloud.google.com/billing/docs/how-to/budgets -[javadocs]: https://googleapis.dev/java/google-cloud-billingbudgets/latest +[javadocs]: https://googleapis.dev/java/google-cloud-billingbudgets/latest/ [kokoro-badge-image-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-billingbudgets/java7.svg [kokoro-badge-link-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-billingbudgets/java7.html [kokoro-badge-image-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-billingbudgets/java8.svg @@ -114,7 +145,7 @@ Java 11 | [![Kokoro CI][kokoro-badge-image-5]][kokoro-badge-link-5] [kokoro-badge-link-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-billingbudgets/java8-win.html [kokoro-badge-image-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-billingbudgets/java11.svg [kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-billingbudgets/java11.html -[stability-image]: https://img.shields.io/badge/stability-alpha-orange +[stability-image]: https://img.shields.io/badge/stability-beta-yellow [maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-billingbudgets.svg [maven-version-link]: https://search.maven.org/search?q=g:com.google.cloud%20AND%20a:google-cloud-billingbudgets&core=gav [authentication]: https://github.com/googleapis/google-cloud-java#authentication @@ -125,3 +156,6 @@ Java 11 | [![Kokoro CI][kokoro-badge-image-5]][kokoro-badge-link-5] [contributing]: https://github.com/googleapis/java-billingbudgets/blob/master/CONTRIBUTING.md [code-of-conduct]: https://github.com/googleapis/java-billingbudgets/blob/master/CODE_OF_CONDUCT.md#contributor-code-of-conduct [license]: https://github.com/googleapis/java-billingbudgets/blob/master/LICENSE + +[enable-api]: https://console.cloud.google.com/flows/enableapi?apiid=billingbudgets.googleapis.com +[libraries-bom]: https://github.com/GoogleCloudPlatform/cloud-opensource-java/wiki/The-Google-Cloud-Platform-Libraries-BOM \ No newline at end of file diff --git a/synth.metadata b/synth.metadata index aa2c3d5e..17d6cf3f 100644 --- a/synth.metadata +++ b/synth.metadata @@ -1,5 +1,5 @@ { - "updateTime": "2020-01-23T08:37:40.023764Z", + "updateTime": "2020-01-23T22:59:12.248066Z", "sources": [ { "generator": { @@ -12,9 +12,7 @@ "git": { "name": "googleapis", "remote": "https://github.com/googleapis/googleapis.git", - "sha": "8d16f76de065f530d395a4c7eabbf766d6a120fd", - "internalRef": "291008516", - "log": "8d16f76de065f530d395a4c7eabbf766d6a120fd\nGenerate Memcache v1beta2 API protos and gRPC ServiceConfig files\n\nPiperOrigin-RevId: 291008516\n\n3af1dabd93df9a9f17bf3624d3b875c11235360b\ngrafeas: Add containeranalysis default_host to Grafeas service\n\nPiperOrigin-RevId: 290965849\n\nbe2663fa95e31cba67d0cd62611a6674db9f74b7\nfix(google/maps/roads): add missing opening bracket\n\nPiperOrigin-RevId: 290964086\n\nfacc26550a0af0696e0534bc9cae9df14275aa7c\nUpdating v2 protos with the latest inline documentation (in comments) and adding a per-service .yaml file.\n\nPiperOrigin-RevId: 290952261\n\ncda99c1f7dc5e4ca9b1caeae1dc330838cbc1461\nChange api_name to 'asset' for v1p1beta1\n\nPiperOrigin-RevId: 290800639\n\n94e9e90c303a820ce40643d9129e7f0d2054e8a1\nAdds Google Maps Road service\n\nPiperOrigin-RevId: 290795667\n\na3b23dcb2eaecce98c600c7d009451bdec52dbda\nrpc: new message ErrorInfo, other comment updates\n\nPiperOrigin-RevId: 290781668\n\n26420ef4e46c37f193c0fbe53d6ebac481de460e\nAdd proto definition for Org Policy v1.\n\nPiperOrigin-RevId: 290771923\n\n7f0dab8177cf371ae019a082e2512de7ac102888\nPublish Routes Preferred API v1 service definitions.\n\nPiperOrigin-RevId: 290326986\n\nad6e508d0728e1d1bca6e3f328cd562718cb772d\nFix: Qualify resource type references with \"jobs.googleapis.com/\"\n\nPiperOrigin-RevId: 290285762\n\n58e770d568a2b78168ddc19a874178fee8265a9d\ncts client library\n\nPiperOrigin-RevId: 290146169\n\naf9daa4c3b4c4a8b7133b81588dd9ffd37270af2\nAdd more programming language options to public proto\n\nPiperOrigin-RevId: 290144091\n\nd9f2bbf2df301ef84641d4cec7c828736a0bd907\ntalent: add missing resource.proto dep to Bazel build target\n\nPiperOrigin-RevId: 290143164\n\n3b3968237451d027b42471cd28884a5a1faed6c7\nAnnotate Talent API.\nAdd gRPC service config for retry.\nUpdate bazel file with google.api.resource dependency.\n\nPiperOrigin-RevId: 290125172\n\n" + "sha": "46a2d50dd05fe37104e5f66abaa59f6235a3d7c4" } }, { @@ -53,9 +51,6 @@ { "path": ".github/release-please.yml" }, - { - "path": ".gitignore" - }, { "path": ".kokoro/build.bat" }, @@ -221,12 +216,6 @@ { "path": ".kokoro/trampoline.sh" }, - { - "path": ".repo-metadata.json" - }, - { - "path": "CHANGELOG.md" - }, { "path": "CODE_OF_CONDUCT.md" }, @@ -236,18 +225,9 @@ { "path": "LICENSE" }, - { - "path": "README.md" - }, { "path": "codecov.yaml" }, - { - "path": "google-cloud-billingbudgets-bom/pom.xml" - }, - { - "path": "google-cloud-billingbudgets/pom.xml" - }, { "path": "google-cloud-billingbudgets/src/main/java/com/google/cloud/billing/budgets/v1beta1/BudgetServiceClient.java" }, @@ -278,9 +258,6 @@ { "path": "google-cloud-billingbudgets/src/test/java/com/google/cloud/billing/budgets/v1beta1/MockBudgetServiceImpl.java" }, - { - "path": "grpc-google-cloud-billingbudgets-v1beta1/pom.xml" - }, { "path": "grpc-google-cloud-billingbudgets-v1beta1/src/main/java/com/google/cloud/billing/budgets/v1beta1/BudgetServiceGrpc.java" }, @@ -290,12 +267,6 @@ { "path": "license-checks.xml" }, - { - "path": "pom.xml" - }, - { - "path": "proto-google-cloud-billingbudgets-v1beta1/pom.xml" - }, { "path": "proto-google-cloud-billingbudgets-v1beta1/src/main/java/com/google/cloud/billing/budgets/v1beta1/AllUpdatesRule.java" }, @@ -388,15 +359,6 @@ }, { "path": "renovate.json" - }, - { - "path": "synth.metadata" - }, - { - "path": "synth.py" - }, - { - "path": "versions.txt" } ] } \ No newline at end of file