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

Commit 2895d64

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

2 files changed

Lines changed: 62 additions & 17 deletions

File tree

.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 & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# CCAI Insights Client for Java
1+
# Google CCAI Insights Client for Java
22

33
Java idiomatic client for [CCAI Insights][product-docs].
44

@@ -8,9 +8,6 @@ Java idiomatic client for [CCAI Insights][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,18 @@ If you are using Maven, add this to your pom.xml file:
2017
<dependency>
2118
<groupId>com.google.cloud</groupId>
2219
<artifactId>google-cloud-contact-center-insights</artifactId>
23-
<version>0.0.0</version>
20+
<version>1.0.0</version>
2421
</dependency>
2522
```
2623

2724
If you are using Gradle without BOM, add this to your dependencies
2825
```Groovy
29-
compile 'com.google.cloud:google-cloud-contact-center-insights:0.0.0'
26+
compile 'com.google.cloud:google-cloud-contact-center-insights:1.0.0'
3027
```
3128

3229
If you are using SBT, add this to your dependencies
3330
```Scala
34-
libraryDependencies += "com.google.cloud" % "google-cloud-contact-center-insights" % "0.0.0"
31+
libraryDependencies += "com.google.cloud" % "google-cloud-contact-center-insights" % "1.0.0"
3532
```
3633

3734
## Authentication
@@ -43,7 +40,7 @@ See the [Authentication][authentication] section in the base directory's README.
4340
### Prerequisites
4441

4542
You will need a [Google Cloud Platform Console][developer-console] project with the CCAI Insights [API enabled][enable-api].
46-
You will need to [enable billing][enable-billing] to use CCAI Insights.
43+
You will need to [enable billing][enable-billing] to use Google CCAI Insights.
4744
[Follow these instructions][create-project] to get your project set up. You will also need to set up the local development environment by
4845
[installing the Google Cloud SDK][cloud-sdk] and running the following commands in command line:
4946
`gcloud auth login` and `gcloud config set project [YOUR PROJECT ID]`.
@@ -56,11 +53,16 @@ to add `google-cloud-contact-center-insights` as a dependency in your code.
5653
## About CCAI Insights
5754

5855

59-
[CCAI Insights][product-docs] helps users detect and visualize patterns in their contact center data.
56+
[CCAI Insights][product-docs] helps users detect and visualize patterns in their contact center data.
6057

6158
See the [CCAI Insights client library docs][javadocs] to learn how to
6259
use this CCAI Insights Client Library.
6360

61+
62+
63+
64+
65+
6466
## Troubleshooting
6567

6668
To get help, follow the instructions in the [shared Troubleshooting document][troubleshooting].
@@ -69,19 +71,56 @@ To get help, follow the instructions in the [shared Troubleshooting document][tr
6971

7072
CCAI Insights uses gRPC for the transport layer.
7173

72-
## Java Versions
74+
## Supported Java Versions
7375

7476
Java 7 or above is required for using this client.
7577

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

78120

79121
This library follows [Semantic Versioning](http://semver.org/).
80122

81123

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-
85124
## Contributing
86125

87126

@@ -121,7 +160,7 @@ Java is a registered trademark of Oracle and/or its affiliates.
121160
[kokoro-badge-link-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-contact-center-insights/java8-win.html
122161
[kokoro-badge-image-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-contact-center-insights/java11.svg
123162
[kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-contact-center-insights/java11.html
124-
[stability-image]: https://img.shields.io/badge/stability-beta-yellow
163+
[stability-image]: https://img.shields.io/badge/stability-ga-green
125164
[maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-contact-center-insights.svg
126165
[maven-version-link]: https://search.maven.org/search?q=g:com.google.cloud%20AND%20a:google-cloud-contact-center-insights&core=gav
127166
[authentication]: https://github.com/googleapis/google-cloud-java#authentication
@@ -133,6 +172,12 @@ Java is a registered trademark of Oracle and/or its affiliates.
133172
[code-of-conduct]: https://github.com/googleapis/java-contact-center-insights/blob/master/CODE_OF_CONDUCT.md#contributor-code-of-conduct
134173
[license]: https://github.com/googleapis/java-contact-center-insights/blob/master/LICENSE
135174
[enable-billing]: https://cloud.google.com/apis/docs/getting-started#enabling_billing
136-
[enable-api]: https://console.cloud.google.com/flows/enableapi?apiid=contact-center-insights.googleapis.com
175+
[enable-api]: https://console.cloud.google.com/flows/enableapi?apiid=contactcenterinsights.googleapis.com
137176
[libraries-bom]: https://github.com/GoogleCloudPlatform/cloud-opensource-java/wiki/The-Google-Cloud-Platform-Libraries-BOM
138-
[contact-center-insights_img]: https://gstatic.com/cloudssh/images/open-btn.png
177+
[shell_img]: https://gstatic.com/cloudssh/images/open-btn.png
178+
179+
[semver]: https://semver.org/
180+
[cloudlibs]: https://cloud.google.com/apis/docs/client-libraries-explained
181+
[apilibs]: https://cloud.google.com/apis/docs/client-libraries-explained#google_api_client_libraries
182+
[oracle]: https://www.oracle.com/java/technologies/java-se-support-roadmap.html
183+
[g-c-j]: http://github.com/googleapis/google-cloud-java

0 commit comments

Comments
 (0)