This repository has been archived by the owner on Sep 16, 2023. It is now read-only.
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
feat: promote to beta (#54)
- Loading branch information
Showing
3 changed files
with
113 additions
and
109 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,121 +1,161 @@ | ||
Google Cloud Java Client for Cloud Web Risk | ||
=================================================== | ||
# Google Web Risk Client for Java | ||
|
||
Java idiomatic client for [Cloud Web Risk][product-overview]. | ||
Java idiomatic client for [Web Risk][product-docs]. | ||
|
||
[![Kokoro CI](http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/master.svg)](http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/master.html) | ||
[![Maven](https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-webrisk.svg)](https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-webrisk.svg) | ||
[![Codacy Badge](https://api.codacy.com/project/badge/grade/9da006ad7c3a4fe1abd142e77c003917)](https://www.codacy.com/app/mziccard/google-cloud-java) | ||
[![Maven][maven-version-image]][maven-version-link] | ||
![Stability][stability-image] | ||
|
||
- [Product Documentation][product-docs] | ||
- [Client Library Documentation][lib-docs] | ||
- [Client Library Documentation][javadocs] | ||
|
||
> Note: This client is a work-in-progress, and may occasionally | ||
> make backwards-incompatible changes. | ||
Quickstart | ||
---------- | ||
If you are using Maven with Bom, Add this to your pom.xml file. | ||
## Quickstart | ||
|
||
If you are using Maven with [BOM][libraries-bom], add this to your pom.xml file | ||
```xml | ||
<dependencyManagement> | ||
<dependencies> | ||
<dependency> | ||
<groupId>com.google.cloud</groupId> | ||
<artifactId>libraries-bom</artifactId> | ||
<version>2.8.0</version> | ||
<type>pom</type> | ||
<scope>import</scope> | ||
</dependency> | ||
</dependencies> | ||
<dependencies> | ||
<dependency> | ||
<groupId>com.google.cloud</groupId> | ||
<artifactId>libraries-bom</artifactId> | ||
<version>3.4.0</version> | ||
<type>pom</type> | ||
<scope>import</scope> | ||
</dependency> | ||
</dependencies> | ||
</dependencyManagement> | ||
|
||
<dependency> | ||
<groupId>com.google.cloud</groupId> | ||
<artifactId>google-cloud-webrisk</artifactId> | ||
</dependency> | ||
<dependencies> | ||
<dependency> | ||
<groupId>com.google.cloud</groupId> | ||
<artifactId>google-cloud-webrisk</artifactId> | ||
</dependency> | ||
</dependencies> | ||
``` | ||
If you are using Maven without Bom, Add this to your dependencies. | ||
|
||
[//]: # ({x-version-update-start:google-cloud-webrisk:released}) | ||
|
||
If you are using Maven without BOM, add this to your dependencies: | ||
|
||
```xml | ||
<dependency> | ||
<groupId>com.google.cloud</groupId> | ||
<artifactId>google-cloud-webrisk</artifactId> | ||
<version>0.30.0-alpha</version> | ||
<version>0.31.1-alpha</version> | ||
</dependency> | ||
``` | ||
|
||
If you are using Gradle, add this to your dependencies | ||
```Groovy | ||
compile 'com.google.cloud:google-cloud-webrisk:0.30.0-alpha' | ||
compile 'com.google.cloud:google-cloud-webrisk:0.31.1-alpha' | ||
``` | ||
If you are using SBT, add this to your dependencies | ||
```Scala | ||
libraryDependencies += "com.google.cloud" % "google-cloud-webrisk" % "0.30.0-alpha" | ||
libraryDependencies += "com.google.cloud" % "google-cloud-webrisk" % "0.31.1-alpha" | ||
``` | ||
[//]: # ({x-version-update-end}) | ||
|
||
## Authentication | ||
|
||
See the [Authentication][authentication] section in the base directory's README. | ||
|
||
## Getting Started | ||
|
||
### Prerequisites | ||
|
||
You will need a [Google Cloud Platform Console][developer-console] project with the Web Risk [API enabled][enable-api]. | ||
|
||
Authentication | ||
-------------- | ||
[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]`. | ||
|
||
See the [Authentication](https://github.com/googleapis/google-cloud-java#authentication) section in the base directory's README. | ||
### Installation and setup | ||
|
||
About Cloud Web Risk | ||
---------------------------- | ||
You'll need to obtain the `google-cloud-webrisk` library. See the [Quickstart](#quickstart) section | ||
to add `google-cloud-webrisk` as a dependency in your code. | ||
|
||
[Cloud Web Risk][product-overview] | ||
## About Web Risk | ||
|
||
See the [Cloud Web Risk client library docs][lib-docs] to learn how to use this Cloud Web Risk Client Library. | ||
|
||
Getting Started | ||
--------------- | ||
#### Prerequisites | ||
> Note: Cloud Web Risk is not yet publicly available. You must be whitelisted in order to gain access. | ||
[Web Risk][product-docs] is a Google Cloud service that lets client applications check URLs against Google's constantly updated lists of unsafe web resources. Unsafe web resources include social engineering sites—such as phishing and deceptive sites—and sites that host malware or unwanted software. With the Web Risk API, you can quickly identify known bad sites, warn users before they click infected links, and prevent users from posting links to known infected pages from your site. The Web Risk API includes data on more than a million unsafe URLs and stays up to date by examining billions of URLs each day. | ||
|
||
See [Setting up the Web Risk API][product-docs-quickstart] in the product documentation for a link to the sign-up form. | ||
See the [Web Risk client library docs][javadocs] to learn how to | ||
use this Web Risk Client Library. | ||
|
||
You will need a [Google Developers Console](https://console.developers.google.com/) project with the Cloud Web Risk API enabled. [Follow these instructions](https://cloud.google.com/resource-manager/docs/creating-managing-projects) to get your project set up. You will also need to set up the local development environment by [installing the Google Cloud SDK](https://cloud.google.com/sdk/) and running the following commands in command line: `gcloud auth login` and `gcloud config set project [YOUR PROJECT ID]`. | ||
|
||
#### Installation and setup | ||
You'll need to obtain the `google-cloud-webrisk` library. See the [Quickstart](#quickstart) section to add `google-cloud-webrisk` as a dependency in your code. | ||
|
||
Troubleshooting | ||
--------------- | ||
|
||
To get help, follow the instructions in the [shared Troubleshooting document](https://github.com/googleapis/google-cloud-common/blob/master/troubleshooting/readme.md#troubleshooting). | ||
## Troubleshooting | ||
|
||
Transport | ||
--------- | ||
Cloud Web Risk uses gRPC for the transport layer. | ||
To get help, follow the instructions in the [shared Troubleshooting document][troubleshooting]. | ||
|
||
Java Versions | ||
------------- | ||
## Transport | ||
|
||
Web Risk uses gRPC for the transport layer. | ||
|
||
## Java Versions | ||
|
||
Java 7 or above is required for using this client. | ||
|
||
Versioning | ||
---------- | ||
## Versioning | ||
|
||
This library follows [Semantic Versioning](http://semver.org/). | ||
|
||
It is currently in major version zero (``0.y.z``), which means that anything may change at any time and the public API should not be considered stable. | ||
|
||
Contributing | ||
------------ | ||
It is currently in major version zero (``0.y.z``), which means that anything may change at any time | ||
and the public API should not be considered stable. | ||
|
||
|
||
## Contributing | ||
|
||
|
||
Contributions to this library are always welcome and highly encouraged. | ||
|
||
See `google-cloud`'s [CONTRIBUTING] documentation and the [shared documentation](https://github.com/googleapis/google-cloud-common/blob/master/contributing/readme.md#how-to-contribute-to-gcloud) for more information on how to get started. | ||
See [CONTRIBUTING][contributing] for more information how to get started. | ||
|
||
Please note that this project is released with a Contributor Code of Conduct. By participating in | ||
this project you agree to abide by its terms. See [Code of Conduct][code-of-conduct] for more | ||
information. | ||
|
||
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. See [Code of Conduct][code-of-conduct] for more information. | ||
## License | ||
|
||
License | ||
------- | ||
Apache 2.0 - See [LICENSE][license] for more information. | ||
|
||
Apache 2.0 - See [LICENSE] for more information. | ||
## CI Status | ||
|
||
Java Version | Status | ||
------------ | ------ | ||
Java 7 | [![Kokoro CI][kokoro-badge-image-1]][kokoro-badge-link-1] | ||
Java 8 | [![Kokoro CI][kokoro-badge-image-2]][kokoro-badge-link-2] | ||
Java 8 OSX | [![Kokoro CI][kokoro-badge-image-3]][kokoro-badge-link-3] | ||
Java 8 Windows | [![Kokoro CI][kokoro-badge-image-4]][kokoro-badge-link-4] | ||
Java 11 | [![Kokoro CI][kokoro-badge-image-5]][kokoro-badge-link-5] | ||
|
||
[CONTRIBUTING]:https://github.com/googleapis/google-cloud-java/blob/master/CONTRIBUTING.md | ||
[code-of-conduct]:https://github.com/googleapis/google-cloud-java/blob/master/CODE_OF_CONDUCT.md#contributor-code-of-conduct | ||
[LICENSE]: https://github.com/googleapis/google-cloud-java/blob/master/LICENSE | ||
[cloud-platform]: https://cloud.google.com/ | ||
[product-overview]: https://cloud.google.com/web-risk/ | ||
[product-docs]: https://cloud.google.com/web-risk/docs/ | ||
[lib-docs]: https://googleapis.dev/java/google-cloud-clients/latest/index.html?com/google/cloud/webrisk/v1beta1/package-summary.html | ||
[product-docs-quickstart]:https://cloud.google.com/web-risk/docs/quickstart | ||
[javadocs]: https://googleapis.dev/java/google-cloud-webrisk/latest/ | ||
[kokoro-badge-image-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-webrisk/java7.svg | ||
[kokoro-badge-link-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-webrisk/java7.html | ||
[kokoro-badge-image-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-webrisk/java8.svg | ||
[kokoro-badge-link-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-webrisk/java8.html | ||
[kokoro-badge-image-3]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-webrisk/java8-osx.svg | ||
[kokoro-badge-link-3]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-webrisk/java8-osx.html | ||
[kokoro-badge-image-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-webrisk/java8-win.svg | ||
[kokoro-badge-link-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-webrisk/java8-win.html | ||
[kokoro-badge-image-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-webrisk/java11.svg | ||
[kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-webrisk/java11.html | ||
[stability-image]: https://img.shields.io/badge/stability-beta-yellow | ||
[maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-webrisk.svg | ||
[maven-version-link]: https://search.maven.org/search?q=g:com.google.cloud%20AND%20a:google-cloud-webrisk&core=gav | ||
[authentication]: https://github.com/googleapis/google-cloud-java#authentication | ||
[developer-console]: https://console.developers.google.com/ | ||
[create-project]: https://cloud.google.com/resource-manager/docs/creating-managing-projects | ||
[cloud-sdk]: https://cloud.google.com/sdk/ | ||
[troubleshooting]: https://github.com/googleapis/google-cloud-common/blob/master/troubleshooting/readme.md#troubleshooting | ||
[contributing]: https://github.com/googleapis/java-webrisk/blob/master/CONTRIBUTING.md | ||
[code-of-conduct]: https://github.com/googleapis/java-webrisk/blob/master/CODE_OF_CONDUCT.md#contributor-code-of-conduct | ||
[license]: https://github.com/googleapis/java-webrisk/blob/master/LICENSE | ||
|
||
[enable-api]: https://console.cloud.google.com/flows/enableapi?apiid=webrisk.googleapis.com | ||
[libraries-bom]: https://github.com/GoogleCloudPlatform/cloud-opensource-java/wiki/The-Google-Cloud-Platform-Libraries-BOM |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters