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

Commit 896a4e6

Browse files
chingor13chingor13
authored
feat: promote to beta (#54)
1 parent 6bcbfec commit 896a4e6

File tree

3 files changed

+113
-109
lines changed

3 files changed

+113
-109
lines changed

‎.repo-metadata.json

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,12 @@
22
"name": "webrisk",
33
"name_pretty": "Web Risk",
44
"product_documentation": "https://cloud.google.com/web-risk/docs/",
5-
"client_documentation": "https://googleapis.dev/java/java-webrisk/latest/",
5+
"client_documentation": "https://googleapis.dev/java/google-cloud-webrisk/latest/",
6+
"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.",
67
"issue_tracker": "",
7-
"release_level": "alpha",
8+
"release_level": "beta",
89
"language": "java",
10+
"transport": "grpc",
911
"repo": "googleapis/java-webrisk",
1012
"repo_short": "java-webrisk",
1113
"distribution_name": "com.google.cloud:google-cloud-webrisk",

‎README.md

Lines changed: 107 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -1,121 +1,161 @@
1-
Google Cloud Java Client for Cloud Web Risk
2-
===================================================
1+
# Google Web Risk Client for Java
32

4-
Java idiomatic client for [Cloud Web Risk][product-overview].
3+
Java idiomatic client for [Web Risk][product-docs].
54

6-
[![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)
7-
[![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)
8-
[![Codacy Badge](https://api.codacy.com/project/badge/grade/9da006ad7c3a4fe1abd142e77c003917)](https://www.codacy.com/app/mziccard/google-cloud-java)
5+
[![Maven][maven-version-image]][maven-version-link]
6+
![Stability][stability-image]
97

108
- [Product Documentation][product-docs]
11-
- [Client Library Documentation][lib-docs]
9+
- [Client Library Documentation][javadocs]
1210

1311
> Note: This client is a work-in-progress, and may occasionally
1412
> make backwards-incompatible changes.
1513
16-
Quickstart
17-
----------
18-
If you are using Maven with Bom, Add this to your pom.xml file.
14+
## Quickstart
15+
16+
If you are using Maven with [BOM][libraries-bom], add this to your pom.xml file
1917
```xml
2018
<dependencyManagement>
21-
<dependencies>
22-
<dependency>
23-
<groupId>com.google.cloud</groupId>
24-
<artifactId>libraries-bom</artifactId>
25-
<version>2.8.0</version>
26-
<type>pom</type>
27-
<scope>import</scope>
28-
</dependency>
29-
</dependencies>
19+
<dependencies>
20+
<dependency>
21+
<groupId>com.google.cloud</groupId>
22+
<artifactId>libraries-bom</artifactId>
23+
<version>3.4.0</version>
24+
<type>pom</type>
25+
<scope>import</scope>
26+
</dependency>
27+
</dependencies>
3028
</dependencyManagement>
3129

32-
<dependency>
33-
<groupId>com.google.cloud</groupId>
34-
<artifactId>google-cloud-webrisk</artifactId>
35-
</dependency>
30+
<dependencies>
31+
<dependency>
32+
<groupId>com.google.cloud</groupId>
33+
<artifactId>google-cloud-webrisk</artifactId>
34+
</dependency>
35+
</dependencies>
3636
```
37-
If you are using Maven without Bom, Add this to your dependencies.
37+
38+
[//]: # ({x-version-update-start:google-cloud-webrisk:released})
39+
40+
If you are using Maven without BOM, add this to your dependencies:
41+
3842
```xml
3943
<dependency>
4044
<groupId>com.google.cloud</groupId>
4145
<artifactId>google-cloud-webrisk</artifactId>
42-
<version>0.30.0-alpha</version>
46+
<version>0.31.1-alpha</version>
4347
</dependency>
4448
```
49+
4550
If you are using Gradle, add this to your dependencies
4651
```Groovy
47-
compile 'com.google.cloud:google-cloud-webrisk:0.30.0-alpha'
52+
compile 'com.google.cloud:google-cloud-webrisk:0.31.1-alpha'
4853
```
4954
If you are using SBT, add this to your dependencies
5055
```Scala
51-
libraryDependencies += "com.google.cloud" % "google-cloud-webrisk" % "0.30.0-alpha"
56+
libraryDependencies += "com.google.cloud" % "google-cloud-webrisk" % "0.31.1-alpha"
5257
```
58+
[//]: # ({x-version-update-end})
59+
60+
## Authentication
61+
62+
See the [Authentication][authentication] section in the base directory's README.
63+
64+
## Getting Started
65+
66+
### Prerequisites
67+
68+
You will need a [Google Cloud Platform Console][developer-console] project with the Web Risk [API enabled][enable-api].
5369

54-
Authentication
55-
--------------
70+
[Follow these instructions][create-project] to get your project set up. You will also need to set up the local development environment by
71+
[installing the Google Cloud SDK][cloud-sdk] and running the following commands in command line:
72+
`gcloud auth login` and `gcloud config set project [YOUR PROJECT ID]`.
5673

57-
See the [Authentication](https://github.com/googleapis/google-cloud-java#authentication) section in the base directory's README.
74+
### Installation and setup
5875

59-
About Cloud Web Risk
60-
----------------------------
76+
You'll need to obtain the `google-cloud-webrisk` library. See the [Quickstart](#quickstart) section
77+
to add `google-cloud-webrisk` as a dependency in your code.
6178

62-
[Cloud Web Risk][product-overview]
79+
## About Web Risk
6380

64-
See the [Cloud Web Risk client library docs][lib-docs] to learn how to use this Cloud Web Risk Client Library.
6581

66-
Getting Started
67-
---------------
68-
#### Prerequisites
69-
> Note: Cloud Web Risk is not yet publicly available. You must be whitelisted in order to gain access.
82+
[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.
7083

71-
See [Setting up the Web Risk API][product-docs-quickstart] in the product documentation for a link to the sign-up form.
84+
See the [Web Risk client library docs][javadocs] to learn how to
85+
use this Web Risk Client Library.
7286

73-
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]`.
7487

75-
#### Installation and setup
76-
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.
7788

78-
Troubleshooting
79-
---------------
8089

81-
To get help, follow the instructions in the [shared Troubleshooting document](https://github.com/googleapis/google-cloud-common/blob/master/troubleshooting/readme.md#troubleshooting).
90+
## Troubleshooting
8291

83-
Transport
84-
---------
85-
Cloud Web Risk uses gRPC for the transport layer.
92+
To get help, follow the instructions in the [shared Troubleshooting document][troubleshooting].
8693

87-
Java Versions
88-
-------------
94+
## Transport
95+
96+
Web Risk uses gRPC for the transport layer.
97+
98+
## Java Versions
8999

90100
Java 7 or above is required for using this client.
91101

92-
Versioning
93-
----------
102+
## Versioning
94103

95104
This library follows [Semantic Versioning](http://semver.org/).
96105

97-
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.
98106

99-
Contributing
100-
------------
107+
It is currently in major version zero (``0.y.z``), which means that anything may change at any time
108+
and the public API should not be considered stable.
109+
110+
111+
## Contributing
112+
101113

102114
Contributions to this library are always welcome and highly encouraged.
103115

104-
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.
116+
See [CONTRIBUTING][contributing] for more information how to get started.
117+
118+
Please note that this project is released with a Contributor Code of Conduct. By participating in
119+
this project you agree to abide by its terms. See [Code of Conduct][code-of-conduct] for more
120+
information.
105121

106-
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.
122+
## License
107123

108-
License
109-
-------
124+
Apache 2.0 - See [LICENSE][license] for more information.
110125

111-
Apache 2.0 - See [LICENSE] for more information.
126+
## CI Status
112127

128+
Java Version | Status
129+
------------ | ------
130+
Java 7 | [![Kokoro CI][kokoro-badge-image-1]][kokoro-badge-link-1]
131+
Java 8 | [![Kokoro CI][kokoro-badge-image-2]][kokoro-badge-link-2]
132+
Java 8 OSX | [![Kokoro CI][kokoro-badge-image-3]][kokoro-badge-link-3]
133+
Java 8 Windows | [![Kokoro CI][kokoro-badge-image-4]][kokoro-badge-link-4]
134+
Java 11 | [![Kokoro CI][kokoro-badge-image-5]][kokoro-badge-link-5]
113135

114-
[CONTRIBUTING]:https://github.com/googleapis/google-cloud-java/blob/master/CONTRIBUTING.md
115-
[code-of-conduct]:https://github.com/googleapis/google-cloud-java/blob/master/CODE_OF_CONDUCT.md#contributor-code-of-conduct
116-
[LICENSE]: https://github.com/googleapis/google-cloud-java/blob/master/LICENSE
117-
[cloud-platform]: https://cloud.google.com/
118-
[product-overview]: https://cloud.google.com/web-risk/
119136
[product-docs]: https://cloud.google.com/web-risk/docs/
120-
[lib-docs]: https://googleapis.dev/java/google-cloud-clients/latest/index.html?com/google/cloud/webrisk/v1beta1/package-summary.html
121-
[product-docs-quickstart]:https://cloud.google.com/web-risk/docs/quickstart
137+
[javadocs]: https://googleapis.dev/java/google-cloud-webrisk/latest/
138+
[kokoro-badge-image-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-webrisk/java7.svg
139+
[kokoro-badge-link-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-webrisk/java7.html
140+
[kokoro-badge-image-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-webrisk/java8.svg
141+
[kokoro-badge-link-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-webrisk/java8.html
142+
[kokoro-badge-image-3]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-webrisk/java8-osx.svg
143+
[kokoro-badge-link-3]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-webrisk/java8-osx.html
144+
[kokoro-badge-image-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-webrisk/java8-win.svg
145+
[kokoro-badge-link-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-webrisk/java8-win.html
146+
[kokoro-badge-image-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-webrisk/java11.svg
147+
[kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-webrisk/java11.html
148+
[stability-image]: https://img.shields.io/badge/stability-beta-yellow
149+
[maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-webrisk.svg
150+
[maven-version-link]: https://search.maven.org/search?q=g:com.google.cloud%20AND%20a:google-cloud-webrisk&core=gav
151+
[authentication]: https://github.com/googleapis/google-cloud-java#authentication
152+
[developer-console]: https://console.developers.google.com/
153+
[create-project]: https://cloud.google.com/resource-manager/docs/creating-managing-projects
154+
[cloud-sdk]: https://cloud.google.com/sdk/
155+
[troubleshooting]: https://github.com/googleapis/google-cloud-common/blob/master/troubleshooting/readme.md#troubleshooting
156+
[contributing]: https://github.com/googleapis/java-webrisk/blob/master/CONTRIBUTING.md
157+
[code-of-conduct]: https://github.com/googleapis/java-webrisk/blob/master/CODE_OF_CONDUCT.md#contributor-code-of-conduct
158+
[license]: https://github.com/googleapis/java-webrisk/blob/master/LICENSE
159+
160+
[enable-api]: https://console.cloud.google.com/flows/enableapi?apiid=webrisk.googleapis.com
161+
[libraries-bom]: https://github.com/GoogleCloudPlatform/cloud-opensource-java/wiki/The-Google-Cloud-Platform-Libraries-BOM

‎synth.metadata

Lines changed: 2 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"updateTime": "2020-01-23T09:08:54.013125Z",
2+
"updateTime": "2020-01-23T22:52:56.670588Z",
33
"sources": [
44
{
55
"generator": {
@@ -12,9 +12,7 @@
1212
"git": {
1313
"name": "googleapis",
1414
"remote": "https://github.com/googleapis/googleapis.git",
15-
"sha": "8d16f76de065f530d395a4c7eabbf766d6a120fd",
16-
"internalRef": "291008516",
17-
"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"
15+
"sha": "46a2d50dd05fe37104e5f66abaa59f6235a3d7c4"
1816
}
1917
},
2018
{
@@ -53,9 +51,6 @@
5351
{
5452
"path": ".github/release-please.yml"
5553
},
56-
{
57-
"path": ".gitignore"
58-
},
5954
{
6055
"path": ".kokoro/build.bat"
6156
},
@@ -221,12 +216,6 @@
221216
{
222217
"path": ".kokoro/trampoline.sh"
223218
},
224-
{
225-
"path": ".repo-metadata.json"
226-
},
227-
{
228-
"path": "CHANGELOG.md"
229-
},
230219
{
231220
"path": "CODE_OF_CONDUCT.md"
232221
},
@@ -236,18 +225,9 @@
236225
{
237226
"path": "LICENSE"
238227
},
239-
{
240-
"path": "README.md"
241-
},
242228
{
243229
"path": "codecov.yaml"
244230
},
245-
{
246-
"path": "google-cloud-webrisk-bom/pom.xml"
247-
},
248-
{
249-
"path": "google-cloud-webrisk/pom.xml"
250-
},
251231
{
252232
"path": "google-cloud-webrisk/src/main/java/com/google/cloud/webrisk/v1beta1/WebRiskServiceV1Beta1Client.java"
253233
},
@@ -278,9 +258,6 @@
278258
{
279259
"path": "google-cloud-webrisk/src/test/java/com/google/cloud/webrisk/v1beta1/WebRiskServiceV1Beta1ClientTest.java"
280260
},
281-
{
282-
"path": "grpc-google-cloud-webrisk-v1beta1/pom.xml"
283-
},
284261
{
285262
"path": "grpc-google-cloud-webrisk-v1beta1/src/main/java/com/google/webrisk/v1beta1/WebRiskServiceV1Beta1Grpc.java"
286263
},
@@ -290,12 +267,6 @@
290267
{
291268
"path": "license-checks.xml"
292269
},
293-
{
294-
"path": "pom.xml"
295-
},
296-
{
297-
"path": "proto-google-cloud-webrisk-v1beta1/pom.xml"
298-
},
299270
{
300271
"path": "proto-google-cloud-webrisk-v1beta1/src/main/java/com/google/webrisk/v1beta1/CompressionType.java"
301272
},
@@ -376,15 +347,6 @@
376347
},
377348
{
378349
"path": "renovate.json"
379-
},
380-
{
381-
"path": "synth.metadata"
382-
},
383-
{
384-
"path": "synth.py"
385-
},
386-
{
387-
"path": "versions.txt"
388350
}
389351
]
390352
}

0 commit comments

Comments
 (0)