Skip to content
Permalink
Browse files
feat: promote to beta (#54)
  • Loading branch information
chingor13 committed Jan 24, 2020
1 parent 6bcbfec commit 896a4e6b19a58d3b0470b54dbb0afc61da422234
Showing with 113 additions and 109 deletions.
  1. +4 −2 .repo-metadata.json
  2. +107 −67 README.md
  3. +2 −40 synth.metadata
@@ -2,10 +2,12 @@
"name": "webrisk",
"name_pretty": "Web Risk",
"product_documentation": "https://cloud.google.com/web-risk/docs/",
"client_documentation": "https://googleapis.dev/java/java-webrisk/latest/",
"client_documentation": "https://googleapis.dev/java/google-cloud-webrisk/latest/",
"api_description": "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.",
"issue_tracker": "",
"release_level": "alpha",
"release_level": "beta",
"language": "java",
"transport": "grpc",
"repo": "googleapis/java-webrisk",
"repo_short": "java-webrisk",
"distribution_name": "com.google.cloud:google-cloud-webrisk",
174 README.md
@@ -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
@@ -1,5 +1,5 @@
{
"updateTime": "2020-01-23T09:08:54.013125Z",
"updateTime": "2020-01-23T22:52:56.670588Z",
"sources": [
{
"generator": {
@@ -12,9 +12,7 @@
"git": {
"name": "googleapis",
"remote": "https://github.com/googleapis/googleapis.git",
"sha": "8d16f76de065f530d395a4c7eabbf766d6a120fd",
"internalRef": "291008516",
"log": "8d16f76de065f530d395a4c7eabbf766d6a120fd\nGenerate Memcache v1beta2 API protos and gRPC ServiceConfig files\n\nPiperOrigin-RevId: 291008516\n\n3af1dabd93df9a9f17bf3624d3b875c11235360b\ngrafeas: Add containeranalysis default_host to Grafeas service\n\nPiperOrigin-RevId: 290965849\n\nbe2663fa95e31cba67d0cd62611a6674db9f74b7\nfix(google/maps/roads): add missing opening bracket\n\nPiperOrigin-RevId: 290964086\n\nfacc26550a0af0696e0534bc9cae9df14275aa7c\nUpdating v2 protos with the latest inline documentation (in comments) and adding a per-service .yaml file.\n\nPiperOrigin-RevId: 290952261\n\ncda99c1f7dc5e4ca9b1caeae1dc330838cbc1461\nChange api_name to 'asset' for v1p1beta1\n\nPiperOrigin-RevId: 290800639\n\n94e9e90c303a820ce40643d9129e7f0d2054e8a1\nAdds Google Maps Road service\n\nPiperOrigin-RevId: 290795667\n\na3b23dcb2eaecce98c600c7d009451bdec52dbda\nrpc: new message ErrorInfo, other comment updates\n\nPiperOrigin-RevId: 290781668\n\n26420ef4e46c37f193c0fbe53d6ebac481de460e\nAdd proto definition for Org Policy v1.\n\nPiperOrigin-RevId: 290771923\n\n"
"sha": "46a2d50dd05fe37104e5f66abaa59f6235a3d7c4"
}
},
{
@@ -53,9 +51,6 @@
{
"path": ".github/release-please.yml"
},
{
"path": ".gitignore"
},
{
"path": ".kokoro/build.bat"
},
@@ -221,12 +216,6 @@
{
"path": ".kokoro/trampoline.sh"
},
{
"path": ".repo-metadata.json"
},
{
"path": "CHANGELOG.md"
},
{
"path": "CODE_OF_CONDUCT.md"
},
@@ -236,18 +225,9 @@
{
"path": "LICENSE"
},
{
"path": "README.md"
},
{
"path": "codecov.yaml"
},
{
"path": "google-cloud-webrisk-bom/pom.xml"
},
{
"path": "google-cloud-webrisk/pom.xml"
},
{
"path": "google-cloud-webrisk/src/main/java/com/google/cloud/webrisk/v1beta1/WebRiskServiceV1Beta1Client.java"
},
@@ -278,9 +258,6 @@
{
"path": "google-cloud-webrisk/src/test/java/com/google/cloud/webrisk/v1beta1/WebRiskServiceV1Beta1ClientTest.java"
},
{
"path": "grpc-google-cloud-webrisk-v1beta1/pom.xml"
},
{
"path": "grpc-google-cloud-webrisk-v1beta1/src/main/java/com/google/webrisk/v1beta1/WebRiskServiceV1Beta1Grpc.java"
},
@@ -290,12 +267,6 @@
{
"path": "license-checks.xml"
},
{
"path": "pom.xml"
},
{
"path": "proto-google-cloud-webrisk-v1beta1/pom.xml"
},
{
"path": "proto-google-cloud-webrisk-v1beta1/src/main/java/com/google/webrisk/v1beta1/CompressionType.java"
},
@@ -376,15 +347,6 @@
},
{
"path": "renovate.json"
},
{
"path": "synth.metadata"
},
{
"path": "synth.py"
},
{
"path": "versions.txt"
}
]
}

0 comments on commit 896a4e6

Please sign in to comment.