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

Commit 77b39de

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

File tree

2 files changed

+61
-14
lines changed

2 files changed

+61
-14
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

+60-13
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Connect Gateway API Client for Java
1+
# Google Connect Gateway API Client for Java
22

33
Java idiomatic client for [Connect Gateway API][product-docs].
44

@@ -20,18 +20,18 @@ If you are using Maven, add this to your pom.xml file:
2020
<dependency>
2121
<groupId>com.google.cloud</groupId>
2222
<artifactId>google-cloud-gke-connect-gateway</artifactId>
23-
<version>0.0.0</version>
23+
<version>0.1.0</version>
2424
</dependency>
2525
```
2626

2727
If you are using Gradle without BOM, add this to your dependencies
2828
```Groovy
29-
compile 'com.google.cloud:google-cloud-gke-connect-gateway:0.0.0'
29+
compile 'com.google.cloud:google-cloud-gke-connect-gateway:0.1.0'
3030
```
3131

3232
If you are using SBT, add this to your dependencies
3333
```Scala
34-
libraryDependencies += "com.google.cloud" % "google-cloud-gke-connect-gateway" % "0.0.0"
34+
libraryDependencies += "com.google.cloud" % "google-cloud-gke-connect-gateway" % "0.1.0"
3535
```
3636

3737
## Authentication
@@ -43,7 +43,7 @@ See the [Authentication][authentication] section in the base directory's README.
4343
### Prerequisites
4444

4545
You will need a [Google Cloud Platform Console][developer-console] project with the Connect Gateway API [API enabled][enable-api].
46-
You will need to [enable billing][enable-billing] to use Connect Gateway API.
46+
You will need to [enable billing][enable-billing] to use Google Connect Gateway API.
4747
[Follow these instructions][create-project] to get your project set up. You will also need to set up the local development environment by
4848
[installing the Google Cloud SDK][cloud-sdk] and running the following commands in command line:
4949
`gcloud auth login` and `gcloud config set project [YOUR PROJECT ID]`.
@@ -56,15 +56,16 @@ to add `google-cloud-gke-connect-gateway` as a dependency in your code.
5656
## About Connect Gateway API
5757

5858

59-
[Connect Gateway API][product-docs] builds on the power of fleets to let Anthos users
60-
connect to and run commands against registered Anthos clusters in a simple, consistent,
61-
and secured way, whether the clusters are on Google Cloud, other public clouds, or on
62-
premises, and makes it easier to automate DevOps processes across all your clusters.
63-
59+
[Connect Gateway API][product-docs] builds on the power of fleets to let Anthos users connect to and run commands against registered Anthos clusters in a simple, consistent, and secured way, whether the clusters are on Google Cloud, other public clouds, or on premises, and makes it easier to automate DevOps processes across all your clusters.
6460

6561
See the [Connect Gateway API client library docs][javadocs] to learn how to
6662
use this Connect Gateway API Client Library.
6763

64+
65+
66+
67+
68+
6869
## Troubleshooting
6970

7071
To get help, follow the instructions in the [shared Troubleshooting document][troubleshooting].
@@ -73,10 +74,50 @@ To get help, follow the instructions in the [shared Troubleshooting document][tr
7374

7475
Connect Gateway API uses gRPC for the transport layer.
7576

76-
## Java Versions
77+
## Supported Java Versions
7778

7879
Java 7 or above is required for using this client.
7980

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

82123

@@ -137,6 +178,12 @@ Java is a registered trademark of Oracle and/or its affiliates.
137178
[code-of-conduct]: https://github.com/googleapis/java-gke-connect-gateway/blob/master/CODE_OF_CONDUCT.md#contributor-code-of-conduct
138179
[license]: https://github.com/googleapis/java-gke-connect-gateway/blob/master/LICENSE
139180
[enable-billing]: https://cloud.google.com/apis/docs/getting-started#enabling_billing
140-
[enable-api]: https://console.cloud.google.com/flows/enableapi?apiid=gke-connect-gateway.googleapis.com
181+
[enable-api]: https://console.cloud.google.com/flows/enableapi?apiid=connectgateway.googleapis.com
141182
[libraries-bom]: https://github.com/GoogleCloudPlatform/cloud-opensource-java/wiki/The-Google-Cloud-Platform-Libraries-BOM
142-
[shell_img]: https://gstatic.com/cloudssh/images/open-btn.png
183+
[shell_img]: https://gstatic.com/cloudssh/images/open-btn.png
184+
185+
[semver]: https://semver.org/
186+
[cloudlibs]: https://cloud.google.com/apis/docs/client-libraries-explained
187+
[apilibs]: https://cloud.google.com/apis/docs/client-libraries-explained#google_api_client_libraries
188+
[oracle]: https://www.oracle.com/java/technologies/java-se-support-roadmap.html
189+
[g-c-j]: http://github.com/googleapis/google-cloud-java

0 commit comments

Comments
 (0)