1- # Cloud TPU Client for Java
1+ # Google Cloud TPU Client for Java
22
33Java idiomatic client for [ Cloud TPU] [ product-docs ] .
44
@@ -8,9 +8,6 @@ Java idiomatic client for [Cloud TPU][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-tpu</artifactId >
23- <version >0 .0.0</version >
20+ <version >1 .0.0</version >
2421</dependency >
22+
2523```
2624
2725If you are using Gradle without BOM, add this to your dependencies
2826``` Groovy
29- compile 'com.google.cloud:google-cloud-tpu:0 .0.0'
27+ compile 'com.google.cloud:google-cloud-tpu:1 .0.0'
3028```
3129
3230If you are using SBT, add this to your dependencies
3331``` Scala
34- libraryDependencies += " com.google.cloud" % " google-cloud-tpu" % " 0 .0.0"
32+ libraryDependencies += " com.google.cloud" % " google-cloud-tpu" % " 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
4543You will need a [ Google Cloud Platform Console] [ developer-console ] project with the Cloud TPU [ API enabled] [ enable-api ] .
46- You will need to [ enable billing] [ enable-billing ] to use Cloud TPU.
44+ You will need to [ enable billing] [ enable-billing ] to use Google Cloud TPU.
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] ` .
@@ -61,6 +59,11 @@ to add `google-cloud-tpu` as a dependency in your code.
6159See the [ Cloud TPU client library docs] [ javadocs ] to learn how to
6260use this Cloud TPU Client Library.
6361
62+
63+
64+
65+
66+
6467## Troubleshooting
6568
6669To get help, follow the instructions in the [ shared Troubleshooting document] [ troubleshooting ] .
@@ -69,19 +72,56 @@ To get help, follow the instructions in the [shared Troubleshooting document][tr
6972
7073Cloud TPU uses gRPC for the transport layer.
7174
72- ## Java Versions
75+ ## Supported Java Versions
7376
7477Java 7 or above is required for using this client.
7578
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+
76119## Versioning
77120
78121
79122This library follows [ Semantic Versioning] ( http://semver.org/ ) .
80123
81124
82- It is currently in major version zero (`` 0.y.z `` ), which means that anything may change at any time
83- and the public API should not be considered stable.
84-
85125## Contributing
86126
87127
@@ -109,7 +149,7 @@ Java 11 | [![Kokoro CI][kokoro-badge-image-5]][kokoro-badge-link-5]
109149
110150Java is a registered trademark of Oracle and/or its affiliates.
111151
112- [ product-docs ] : https://cloud.google.com/tpu/docs/
152+ [ product-docs ] : https://cloud.google.com/tpu/docs
113153[ javadocs ] : https://googleapis.dev/java/google-cloud-tpu/latest/index.html
114154[ kokoro-badge-image-1 ] : http://storage.googleapis.com/cloud-devrel-public/java/badges/java-tpu/java7.svg
115155[ kokoro-badge-link-1 ] : http://storage.googleapis.com/cloud-devrel-public/java/badges/java-tpu/java7.html
@@ -121,7 +161,7 @@ Java is a registered trademark of Oracle and/or its affiliates.
121161[ kokoro-badge-link-4 ] : http://storage.googleapis.com/cloud-devrel-public/java/badges/java-tpu/java8-win.html
122162[ kokoro-badge-image-5 ] : http://storage.googleapis.com/cloud-devrel-public/java/badges/java-tpu/java11.svg
123163[ kokoro-badge-link-5 ] : http://storage.googleapis.com/cloud-devrel-public/java/badges/java-tpu/java11.html
124- [ stability-image ] : https://img.shields.io/badge/stability-beta-yellow
164+ [ stability-image ] : https://img.shields.io/badge/stability-ga-green
125165[ maven-version-image ] : https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-tpu.svg
126166[ maven-version-link ] : https://search.maven.org/search?q=g:com.google.cloud%20AND%20a:google-cloud-tpu&core=gav
127167[ authentication ] : https://github.com/googleapis/google-cloud-java#authentication
@@ -135,4 +175,10 @@ Java is a registered trademark of Oracle and/or its affiliates.
135175[ enable-billing ] : https://cloud.google.com/apis/docs/getting-started#enabling_billing
136176[ enable-api ] : https://console.cloud.google.com/flows/enableapi?apiid=tpu.googleapis.com
137177[ libraries-bom ] : https://github.com/GoogleCloudPlatform/cloud-opensource-java/wiki/The-Google-Cloud-Platform-Libraries-BOM
138- [ tpu_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