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

Commit

Permalink
Browse files Browse the repository at this point in the history
fix: owlbot post-processor should generate README (#1154) (#14)
Fixes #1146
Fixes #1147
Source-Link: googleapis/synthtool@387851d
Post-Processor: gcr.io/repo-automation-bots/owlbot-java:latest@sha256:69045edb77ff7c78fdfad02eae2b4493b2c358cd9778ab5b6dba0c2b578df0ec
  • Loading branch information
gcf-owl-bot[bot] committed Jul 14, 2021
1 parent c70d920 commit 4556ed1
Show file tree
Hide file tree
Showing 2 changed files with 61 additions and 11 deletions.
2 changes: 1 addition & 1 deletion .github/.OwlBot.lock.yaml
@@ -1,3 +1,3 @@
docker:
image: gcr.io/repo-automation-bots/owlbot-java:latest
digest: sha256:2e88a4a7fe3377cf8de1fa5982134f6ef2768980fa2f94edcc1ba6604ae2e7ca
digest: sha256:69045edb77ff7c78fdfad02eae2b4493b2c358cd9778ab5b6dba0c2b578df0ec
70 changes: 60 additions & 10 deletions README.md
@@ -1,4 +1,4 @@
# Service Control API Client for Java
# Google Service Control API Client for Java

Java idiomatic client for [Service Control API][product-docs].

Expand All @@ -20,18 +20,18 @@ If you are using Maven, add this to your pom.xml file:
<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>google-cloud-service-control</artifactId>
<version>0.0.0</version>
<version>0.1.0</version>
</dependency>
```

If you are using Gradle without BOM, add this to your dependencies
```Groovy
compile 'com.google.cloud:google-cloud-service-control:0.0.0'
compile 'com.google.cloud:google-cloud-service-control:0.1.0'
```

If you are using SBT, add this to your dependencies
```Scala
libraryDependencies += "com.google.cloud" % "google-cloud-service-control" % "0.0.0"
libraryDependencies += "com.google.cloud" % "google-cloud-service-control" % "0.1.0"
```

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

You will need a [Google Cloud Platform Console][developer-console] project with the Service Control API [API enabled][enable-api].
You will need to [enable billing][enable-billing] to use Service Control API.
You will need to [enable billing][enable-billing] to use Google Service Control API.
[Follow these instructions][create-project] to get your project set up. You will also need to set up the local development environment by
[installing the Google Cloud SDK][cloud-sdk] and running the following commands in command line:
`gcloud auth login` and `gcloud config set project [YOUR PROJECT ID]`.
Expand All @@ -56,12 +56,16 @@ to add `google-cloud-service-control` as a dependency in your code.
## About Service Control API


[Service Control API][product-docs] is a foundational platform for creating, managing, securing, and consuming APIs and services across organizations. It is used by Google APIs, Cloud APIs, Cloud Endpoints, and API Gateway.

[Service Control API][product-docs] is a foundational platform for creating, managing, securing, and consuming APIs and services across organizations. It is used by Google APIs, Cloud APIs, Cloud Endpoints, and API Gateway.

See the [Service Control API client library docs][javadocs] to learn how to
use this Service Control API Client Library.






## Troubleshooting

To get help, follow the instructions in the [shared Troubleshooting document][troubleshooting].
Expand All @@ -70,10 +74,50 @@ To get help, follow the instructions in the [shared Troubleshooting document][tr

Service Control API uses gRPC for the transport layer.

## Java Versions
## Supported Java Versions

Java 7 or above is required for using this client.

Google's Java client libraries,
[Google Cloud Client Libraries][cloudlibs]
and
[Google Cloud API Libraries][apilibs],
follow the
[Oracle Java SE support roadmap][oracle]
(see the Oracle Java SE Product Releases section).

### For new development

In general, new feature development occurs with support for the lowest Java
LTS version covered by Oracle's Premier Support (which typically lasts 5 years
from initial General Availability). If the minimum required JVM for a given
library is changed, it is accompanied by a [semver][semver] major release.

Java 11 and (in September 2021) Java 17 are the best choices for new
development.

### Keeping production systems current

Google tests its client libraries with all current LTS versions covered by
Oracle's Extended Support (which typically lasts 8 years from initial
General Availability).

#### Legacy support

Google's client libraries support legacy versions of Java runtimes with long
term stable libraries that don't receive feature updates on a best efforts basis
as it may not be possible to backport all patches.

Google provides updates on a best efforts basis to apps that continue to use
Java 7, though apps might need to upgrade to current versions of the library
that supports their JVM.

#### Where to find specific information

The latest versions and the supported Java versions are identified on
the individual GitHub repository `github.com/GoogleAPIs/java-SERVICENAME`
and on [google-cloud-java][g-c-j].

## Versioning


Expand Down Expand Up @@ -134,6 +178,12 @@ Java is a registered trademark of Oracle and/or its affiliates.
[code-of-conduct]: https://github.com/googleapis/java-service-control/blob/master/CODE_OF_CONDUCT.md#contributor-code-of-conduct
[license]: https://github.com/googleapis/java-service-control/blob/master/LICENSE
[enable-billing]: https://cloud.google.com/apis/docs/getting-started#enabling_billing
[enable-api]: https://console.cloud.google.com/flows/enableapi?apiid=service-control.googleapis.com
[enable-api]: https://console.cloud.google.com/flows/enableapi?apiid=servicecontrol.googleapis.com
[libraries-bom]: https://github.com/GoogleCloudPlatform/cloud-opensource-java/wiki/The-Google-Cloud-Platform-Libraries-BOM
[shell_img]: https://gstatic.com/cloudssh/images/open-btn.png
[shell_img]: https://gstatic.com/cloudssh/images/open-btn.png

[semver]: https://semver.org/
[cloudlibs]: https://cloud.google.com/apis/docs/client-libraries-explained
[apilibs]: https://cloud.google.com/apis/docs/client-libraries-explained#google_api_client_libraries
[oracle]: https://www.oracle.com/java/technologies/java-se-support-roadmap.html
[g-c-j]: http://github.com/googleapis/google-cloud-java

0 comments on commit 4556ed1

Please sign in to comment.