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

Commit 67f27d9

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

File tree

2 files changed

+62
-11
lines changed

2 files changed

+62
-11
lines changed

.github/.OwlBot.lock.yaml

Lines changed: 1 addition & 1 deletion
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

Lines changed: 61 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Cloud Filestore API Client for Java
1+
# Google Cloud Filestore API Client for Java
22

33
Java idiomatic client for [Cloud Filestore API][product-docs].
44

@@ -20,18 +20,19 @@ If you are using Maven, add this to your pom.xml file:
2020
<dependency>
2121
<groupId>com.google.cloud</groupId>
2222
<artifactId>google-cloud-filestore</artifactId>
23-
<version>0.0.0</version>
23+
<version>0.1.0</version>
2424
</dependency>
25+
2526
```
2627

2728
If you are using Gradle without BOM, add this to your dependencies
2829
```Groovy
29-
compile 'com.google.cloud:google-cloud-filestore:0.0.0'
30+
compile 'com.google.cloud:google-cloud-filestore:0.1.0'
3031
```
3132

3233
If you are using SBT, add this to your dependencies
3334
```Scala
34-
libraryDependencies += "com.google.cloud" % "google-cloud-filestore" % "0.0.0"
35+
libraryDependencies += "com.google.cloud" % "google-cloud-filestore" % "0.1.0"
3536
```
3637

3738
## Authentication
@@ -43,7 +44,7 @@ See the [Authentication][authentication] section in the base directory's README.
4344
### Prerequisites
4445

4546
You will need a [Google Cloud Platform Console][developer-console] project with the Cloud Filestore API [API enabled][enable-api].
46-
You will need to [enable billing][enable-billing] to use Cloud Filestore API.
47+
You will need to [enable billing][enable-billing] to use Google Cloud Filestore API.
4748
[Follow these instructions][create-project] to get your project set up. You will also need to set up the local development environment by
4849
[installing the Google Cloud SDK][cloud-sdk] and running the following commands in command line:
4950
`gcloud auth login` and `gcloud config set project [YOUR PROJECT ID]`.
@@ -58,10 +59,14 @@ to add `google-cloud-filestore` as a dependency in your code.
5859

5960
[Cloud Filestore API][product-docs] instances are fully managed NFS file servers on Google Cloud for use with applications running on Compute Engine virtual machines (VMs) instances or Google Kubernetes Engine clusters.
6061

61-
6262
See the [Cloud Filestore API client library docs][javadocs] to learn how to
6363
use this Cloud Filestore API Client Library.
6464

65+
66+
67+
68+
69+
6570
## Troubleshooting
6671

6772
To get help, follow the instructions in the [shared Troubleshooting document][troubleshooting].
@@ -70,10 +75,50 @@ To get help, follow the instructions in the [shared Troubleshooting document][tr
7075

7176
Cloud Filestore API uses gRPC for the transport layer.
7277

73-
## Java Versions
78+
## Supported Java Versions
7479

7580
Java 7 or above is required for using this client.
7681

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

79124

@@ -110,7 +155,7 @@ Java 11 | [![Kokoro CI][kokoro-badge-image-5]][kokoro-badge-link-5]
110155

111156
Java is a registered trademark of Oracle and/or its affiliates.
112157

113-
[product-docs]: https://cloud.google.com/filestore/docs/
158+
[product-docs]: https://cloud.google.com/filestore/docs
114159
[javadocs]: https://googleapis.dev/java/google-cloud-filestore/latest/index.html
115160
[kokoro-badge-image-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-filestore/java7.svg
116161
[kokoro-badge-link-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-filestore/java7.html
@@ -134,6 +179,12 @@ Java is a registered trademark of Oracle and/or its affiliates.
134179
[code-of-conduct]: https://github.com/googleapis/java-filestore/blob/master/CODE_OF_CONDUCT.md#contributor-code-of-conduct
135180
[license]: https://github.com/googleapis/java-filestore/blob/master/LICENSE
136181
[enable-billing]: https://cloud.google.com/apis/docs/getting-started#enabling_billing
137-
[enable-api]: https://console.cloud.google.com/flows/enableapi?apiid=filestore.googleapis.com
182+
[enable-api]: https://console.cloud.google.com/flows/enableapi?apiid=file.googleapis.com
138183
[libraries-bom]: https://github.com/GoogleCloudPlatform/cloud-opensource-java/wiki/The-Google-Cloud-Platform-Libraries-BOM
139-
[shell_img]: https://gstatic.com/cloudssh/images/open-btn.png
184+
[shell_img]: https://gstatic.com/cloudssh/images/open-btn.png
185+
186+
[semver]: https://semver.org/
187+
[cloudlibs]: https://cloud.google.com/apis/docs/client-libraries-explained
188+
[apilibs]: https://cloud.google.com/apis/docs/client-libraries-explained#google_api_client_libraries
189+
[oracle]: https://www.oracle.com/java/technologies/java-se-support-roadmap.html
190+
[g-c-j]: http://github.com/googleapis/google-cloud-java

0 commit comments

Comments
 (0)