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

Commit 04f3834

Browse files
fix: owlbot post-processor should generate README (#1154) (#33)
Fixes #1146 Fixes #1147 Source-Link: googleapis/synthtool@387851d Post-Processor: gcr.io/repo-automation-bots/owlbot-java:latest@sha256:69045edb77ff7c78fdfad02eae2b4493b2c358cd9778ab5b6dba0c2b578df0ec
1 parent 21daef4 commit 04f3834

File tree

2 files changed

+62
-19
lines changed

2 files changed

+62
-19
lines changed

.github/.OwlBot.lock.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
docker:
22
image: gcr.io/repo-automation-bots/owlbot-java:latest
3-
digest: sha256:2e88a4a7fe3377cf8de1fa5982134f6ef2768980fa2f94edcc1ba6604ae2e7ca
3+
digest: sha256:69045edb77ff7c78fdfad02eae2b4493b2c358cd9778ab5b6dba0c2b578df0ec

README.md

+61-18
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Serverless VPC Access Client for Java
1+
# Google Serverless VPC Access Client for Java
22

33
Java idiomatic client for [Serverless VPC Access][product-docs].
44

@@ -8,9 +8,6 @@ Java idiomatic client for [Serverless VPC Access][product-docs].
88
- [Product Documentation][product-docs]
99
- [Client Library Documentation][javadocs]
1010

11-
> Note: This client is a work-in-progress, and may occasionally
12-
> make backwards-incompatible changes.
13-
1411
## Quickstart
1512

1613

@@ -20,18 +17,19 @@ If you are using Maven, add this to your pom.xml file:
2017
<dependency>
2118
<groupId>com.google.cloud</groupId>
2219
<artifactId>google-cloud-vpcaccess</artifactId>
23-
<version>0.0.0</version>
20+
<version>1.0.0</version>
2421
</dependency>
22+
2523
```
2624

2725
If you are using Gradle without BOM, add this to your dependencies
2826
```Groovy
29-
compile 'com.google.cloud:google-cloud-vpcaccess:0.0.0'
27+
compile 'com.google.cloud:google-cloud-vpcaccess:1.0.0'
3028
```
3129

3230
If you are using SBT, add this to your dependencies
3331
```Scala
34-
libraryDependencies += "com.google.cloud" % "google-cloud-vpcaccess" % "0.0.0"
32+
libraryDependencies += "com.google.cloud" % "google-cloud-vpcaccess" % "1.0.0"
3533
```
3634

3735
## Authentication
@@ -43,7 +41,7 @@ See the [Authentication][authentication] section in the base directory's README.
4341
### Prerequisites
4442

4543
You will need a [Google Cloud Platform Console][developer-console] project with the Serverless VPC Access [API enabled][enable-api].
46-
You will need to [enable billing][enable-billing] to use Serverless VPC Access.
44+
You will need to [enable billing][enable-billing] to use Google Serverless VPC Access.
4745
[Follow these instructions][create-project] to get your project set up. You will also need to set up the local development environment by
4846
[installing the Google Cloud SDK][cloud-sdk] and running the following commands in command line:
4947
`gcloud auth login` and `gcloud config set project [YOUR PROJECT ID]`.
@@ -56,14 +54,16 @@ to add `google-cloud-vpcaccess` as a dependency in your code.
5654
## About Serverless VPC Access
5755

5856

59-
[Serverless VPC Access][product-docs] enables you to connect from a serverless environment
60-
on Google Cloud directly to your VPC network. This connection makes it possible for your
61-
serverless environment to access resources in your VPC network via internal IP addresses.
62-
57+
[Serverless VPC Access][product-docs] enables you to connect from a serverless environment on Google Cloud directly to your VPC network. This connection makes it possible for your serverless environment to access resources in your VPC network via internal IP addresses.
6358

6459
See the [Serverless VPC Access client library docs][javadocs] to learn how to
6560
use this Serverless VPC Access Client Library.
6661

62+
63+
64+
65+
66+
6767
## Troubleshooting
6868

6969
To get help, follow the instructions in the [shared Troubleshooting document][troubleshooting].
@@ -72,19 +72,56 @@ To get help, follow the instructions in the [shared Troubleshooting document][tr
7272

7373
Serverless VPC Access uses gRPC for the transport layer.
7474

75-
## Java Versions
75+
## Supported Java Versions
7676

7777
Java 7 or above is required for using this client.
7878

79+
Google's Java client libraries,
80+
[Google Cloud Client Libraries][cloudlibs]
81+
and
82+
[Google Cloud API Libraries][apilibs],
83+
follow the
84+
[Oracle Java SE support roadmap][oracle]
85+
(see the Oracle Java SE Product Releases section).
86+
87+
### For new development
88+
89+
In general, new feature development occurs with support for the lowest Java
90+
LTS version covered by Oracle's Premier Support (which typically lasts 5 years
91+
from initial General Availability). If the minimum required JVM for a given
92+
library is changed, it is accompanied by a [semver][semver] major release.
93+
94+
Java 11 and (in September 2021) Java 17 are the best choices for new
95+
development.
96+
97+
### Keeping production systems current
98+
99+
Google tests its client libraries with all current LTS versions covered by
100+
Oracle's Extended Support (which typically lasts 8 years from initial
101+
General Availability).
102+
103+
#### Legacy support
104+
105+
Google's client libraries support legacy versions of Java runtimes with long
106+
term stable libraries that don't receive feature updates on a best efforts basis
107+
as it may not be possible to backport all patches.
108+
109+
Google provides updates on a best efforts basis to apps that continue to use
110+
Java 7, though apps might need to upgrade to current versions of the library
111+
that supports their JVM.
112+
113+
#### Where to find specific information
114+
115+
The latest versions and the supported Java versions are identified on
116+
the individual GitHub repository `github.com/GoogleAPIs/java-SERVICENAME`
117+
and on [google-cloud-java][g-c-j].
118+
79119
## Versioning
80120

81121

82122
This library follows [Semantic Versioning](http://semver.org/).
83123

84124

85-
It is currently in major version zero (``0.y.z``), which means that anything may change at any time
86-
and the public API should not be considered stable.
87-
88125
## Contributing
89126

90127

@@ -124,7 +161,7 @@ Java is a registered trademark of Oracle and/or its affiliates.
124161
[kokoro-badge-link-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-vpcaccess/java8-win.html
125162
[kokoro-badge-image-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-vpcaccess/java11.svg
126163
[kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-vpcaccess/java11.html
127-
[stability-image]: https://img.shields.io/badge/stability-beta-yellow
164+
[stability-image]: https://img.shields.io/badge/stability-ga-green
128165
[maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-vpcaccess.svg
129166
[maven-version-link]: https://search.maven.org/search?q=g:com.google.cloud%20AND%20a:google-cloud-vpcaccess&core=gav
130167
[authentication]: https://github.com/googleapis/google-cloud-java#authentication
@@ -138,4 +175,10 @@ Java is a registered trademark of Oracle and/or its affiliates.
138175
[enable-billing]: https://cloud.google.com/apis/docs/getting-started#enabling_billing
139176
[enable-api]: https://console.cloud.google.com/flows/enableapi?apiid=vpcaccess.googleapis.com
140177
[libraries-bom]: https://github.com/GoogleCloudPlatform/cloud-opensource-java/wiki/The-Google-Cloud-Platform-Libraries-BOM
141-
[shell_img]: https://gstatic.com/cloudssh/images/open-btn.png
178+
[shell_img]: https://gstatic.com/cloudssh/images/open-btn.png
179+
180+
[semver]: https://semver.org/
181+
[cloudlibs]: https://cloud.google.com/apis/docs/client-libraries-explained
182+
[apilibs]: https://cloud.google.com/apis/docs/client-libraries-explained#google_api_client_libraries
183+
[oracle]: https://www.oracle.com/java/technologies/java-se-support-roadmap.html
184+
[g-c-j]: http://github.com/googleapis/google-cloud-java

0 commit comments

Comments
 (0)