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

Commit b36db26

Browse files
authored
feat: promote to GA (#62)
Release-As: 1.0.0
1 parent 855a944 commit b36db26

4 files changed

Lines changed: 115 additions & 133 deletions

File tree

‎.repo-metadata.json‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,11 @@
22
"name": "dlp",
33
"name_pretty": "Cloud Data Loss Prevention",
44
"product_documentation": "https://cloud.google.com/dlp/docs/",
5-
"client_documentation": "https://googleapis.dev/java/java-dlp/latest/index.html",
6-
"issue_tracker": "",
7-
"release_level": "beta",
5+
"client_documentation": "https://googleapis.dev/java/google-cloud-dlp/latest/index.html",
6+
"api_description": "provides programmatic access to a powerful detection engine for personally identifiable information and other privacy-sensitive data in unstructured data streams, like text blocks and images.",
7+
"release_level": "ga",
88
"language": "java",
9+
"transport": "grpc",
910
"repo": "googleapis/java-dlp",
1011
"repo_short": "java-dlp",
1112
"distribution_name": "com.google.cloud:google-cloud-dlp",

‎README.md‎

Lines changed: 104 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,49 @@
1-
Google Cloud Java Client for Data Loss Prevention
2-
======================================
1+
# Google Cloud Data Loss Prevention Client for Java
32

4-
Java idiomatic client for [Google Cloud Data Loss Prevention][cloud-dlp].
3+
Java idiomatic client for [Cloud Data Loss Prevention][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-.svg)](https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-video-intelligence.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

10-
- [Product Documentation][dlp-product-docs]
11-
- [Client Library Documentation][dlp-client-lib-docs]
8+
- [Product Documentation][product-docs]
9+
- [Client Library Documentation][javadocs]
1210

13-
> Note: This client is a work-in-progress, and may occasionally
14-
> make backwards-incompatible changes.
11+
## Quickstart
1512

16-
Quickstart
17-
----------
18-
If you are using Maven with a BOM, add this to your pom.xml file.
13+
If you are using Maven with [BOM][libraries-bom], add this to your pom.xml file
1914
```xml
2015
<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>
16+
<dependencies>
17+
<dependency>
18+
<groupId>com.google.cloud</groupId>
19+
<artifactId>libraries-bom</artifactId>
20+
<version>3.4.0</version>
21+
<type>pom</type>
22+
<scope>import</scope>
23+
</dependency>
24+
</dependencies>
3025
</dependencyManagement>
3126

32-
<dependency>
33-
<groupId>com.google.cloud</groupId>
34-
<artifactId>google-cloud-dlp</artifactId>
35-
</dependency>
27+
<dependencies>
28+
<dependency>
29+
<groupId>com.google.cloud</groupId>
30+
<artifactId>google-cloud-dlp</artifactId>
31+
</dependency>
32+
</dependencies>
3633
```
3734

3835
[//]: # ({x-version-update-start:google-cloud-dlp:released})
39-
If you are using Maven without a BOM, add this to your dependencies.
36+
37+
If you are using Maven without BOM, add this to your dependencies:
38+
4039
```xml
4140
<dependency>
4241
<groupId>com.google.cloud</groupId>
4342
<artifactId>google-cloud-dlp</artifactId>
4443
<version>0.118.1-beta</version>
4544
</dependency>
4645
```
46+
4747
If you are using Gradle, add this to your dependencies
4848
```Groovy
4949
compile 'com.google.cloud:google-cloud-dlp:0.118.1-beta'
@@ -54,70 +54,102 @@ libraryDependencies += "com.google.cloud" % "google-cloud-dlp" % "0.118.1-beta"
5454
```
5555
[//]: # ({x-version-update-end})
5656

57-
Authentication
58-
--------------
57+
## Authentication
5958

60-
See the [Authentication](https://github.com/googleapis/google-cloud-java#authentication) section
61-
in the base directory's README.
59+
See the [Authentication][authentication] section in the base directory's README.
6260

63-
About Google Cloud Data Loss Prevention
64-
----------------------------
61+
## Getting Started
6562

66-
Google [Cloud Data Loss Prevention API][cloud-dlp]
67-
provides programmatic access to a powerful detection engine for personally identifiable information and other privacy-sensitive data in unstructured data streams, like text blocks and images.
63+
### Prerequisites
6864

69-
See the [Data Loss Prevention client library docs][dlp-client-lib-docs]
70-
to learn how to use this Cloud Data Loss Prevention API Client Library.
65+
You will need a [Google Cloud Platform Console][developer-console] project with the Cloud Data Loss Prevention [API enabled][enable-api].
7166

72-
Getting Started
73-
---------------
74-
#### Prerequisites
75-
You will need a [Google Developers Console](https://console.developers.google.com/) project with the Data Loss Prevention 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]`.
67+
[Follow these instructions][create-project] to get your project set up. You will also need to set up the local development environment by
68+
[installing the Google Cloud SDK][cloud-sdk] and running the following commands in command line:
69+
`gcloud auth login` and `gcloud config set project [YOUR PROJECT ID]`.
7670

77-
#### Installation and setup
78-
You'll need to obtain the `google-cloud-dlp` library.
79-
See the [Quickstart](#quickstart) section to add `google-cloud-dlp` as a dependency in your code.
71+
### Installation and setup
8072

81-
Troubleshooting
82-
---------------
73+
You'll need to obtain the `google-cloud-dlp` library. See the [Quickstart](#quickstart) section
74+
to add `google-cloud-dlp` as a dependency in your code.
8375

84-
To get help, follow the instructions in the [shared Troubleshooting document](https://github.com/googleapis/google-cloud-common/blob/master/troubleshooting/readme.md#troubleshooting).
76+
## About Cloud Data Loss Prevention
8577

86-
Transport
87-
---------
88-
DLP API uses gRPC for the transport layer.
8978

90-
Java Versions
91-
-------------
79+
[Cloud Data Loss Prevention][product-docs] provides programmatic access to a powerful detection engine for personally identifiable information and other privacy-sensitive data in unstructured data streams, like text blocks and images.
9280

93-
Java 7 or above is required for using this client.
81+
See the [Cloud Data Loss Prevention client library docs][javadocs] to learn how to
82+
use this Cloud Data Loss Prevention Client Library.
9483

95-
Versioning
96-
----------
9784

98-
This library follows [Semantic Versioning](http://semver.org/).
9985

100-
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.
10186

102-
Contributing
103-
------------
87+
## Troubleshooting
10488

105-
Contributions to this library are always welcome and highly encouraged.
89+
To get help, follow the instructions in the [shared Troubleshooting document][troubleshooting].
90+
91+
## Transport
10692

107-
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.
93+
Cloud Data Loss Prevention uses gRPC for the transport layer.
10894

109-
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.
95+
## Java Versions
11096

111-
License
112-
-------
97+
Java 7 or above is required for using this client.
98+
99+
## Versioning
113100

114-
Apache 2.0 - See [LICENSE] for more information.
101+
This library follows [Semantic Versioning](http://semver.org/).
115102

116103

117-
[CONTRIBUTING]:https://github.com/googleapis/google-cloud-java/blob/master/CONTRIBUTING.md
118-
[code-of-conduct]:https://github.com/googleapis/google-cloud-java/blob/master/CODE_OF_CONDUCT.md#contributor-code-of-conduct
119-
[LICENSE]: https://github.com/googleapis/google-cloud-java/blob/master/LICENSE
120-
[cloud-platform]: https://cloud.google.com/
121-
[cloud-dlp]: https://cloud.google.com/dlp/
122-
[dlp-product-docs]: https://cloud.google.com/dlp/docs/
123-
[dlp-client-lib-docs]: https://googleapis.dev/java/google-cloud-clients/latest/index.html?com/google/cloud/dlp/v2/package-summary.html
104+
105+
## Contributing
106+
107+
108+
Contributions to this library are always welcome and highly encouraged.
109+
110+
See [CONTRIBUTING][contributing] for more information how to get started.
111+
112+
Please note that this project is released with a Contributor Code of Conduct. By participating in
113+
this project you agree to abide by its terms. See [Code of Conduct][code-of-conduct] for more
114+
information.
115+
116+
## License
117+
118+
Apache 2.0 - See [LICENSE][license] for more information.
119+
120+
## CI Status
121+
122+
Java Version | Status
123+
------------ | ------
124+
Java 7 | [![Kokoro CI][kokoro-badge-image-1]][kokoro-badge-link-1]
125+
Java 8 | [![Kokoro CI][kokoro-badge-image-2]][kokoro-badge-link-2]
126+
Java 8 OSX | [![Kokoro CI][kokoro-badge-image-3]][kokoro-badge-link-3]
127+
Java 8 Windows | [![Kokoro CI][kokoro-badge-image-4]][kokoro-badge-link-4]
128+
Java 11 | [![Kokoro CI][kokoro-badge-image-5]][kokoro-badge-link-5]
129+
130+
[product-docs]: https://cloud.google.com/dlp/docs/
131+
[javadocs]: https://googleapis.dev/java/google-cloud-dlp/latest/index.html
132+
[kokoro-badge-image-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-dlp/java7.svg
133+
[kokoro-badge-link-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-dlp/java7.html
134+
[kokoro-badge-image-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-dlp/java8.svg
135+
[kokoro-badge-link-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-dlp/java8.html
136+
[kokoro-badge-image-3]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-dlp/java8-osx.svg
137+
[kokoro-badge-link-3]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-dlp/java8-osx.html
138+
[kokoro-badge-image-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-dlp/java8-win.svg
139+
[kokoro-badge-link-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-dlp/java8-win.html
140+
[kokoro-badge-image-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-dlp/java11.svg
141+
[kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-dlp/java11.html
142+
[stability-image]: https://img.shields.io/badge/stability-ga-green
143+
[maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-dlp.svg
144+
[maven-version-link]: https://search.maven.org/search?q=g:com.google.cloud%20AND%20a:google-cloud-dlp&core=gav
145+
[authentication]: https://github.com/googleapis/google-cloud-java#authentication
146+
[developer-console]: https://console.developers.google.com/
147+
[create-project]: https://cloud.google.com/resource-manager/docs/creating-managing-projects
148+
[cloud-sdk]: https://cloud.google.com/sdk/
149+
[troubleshooting]: https://github.com/googleapis/google-cloud-common/blob/master/troubleshooting/readme.md#troubleshooting
150+
[contributing]: https://github.com/googleapis/java-dlp/blob/master/CONTRIBUTING.md
151+
[code-of-conduct]: https://github.com/googleapis/java-dlp/blob/master/CODE_OF_CONDUCT.md#contributor-code-of-conduct
152+
[license]: https://github.com/googleapis/java-dlp/blob/master/LICENSE
153+
154+
[enable-api]: https://console.cloud.google.com/flows/enableapi?apiid=dlp.googleapis.com
155+
[libraries-bom]: https://github.com/GoogleCloudPlatform/cloud-opensource-java/wiki/The-Google-Cloud-Platform-Libraries-BOM

‎synth.metadata‎

Lines changed: 2 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"updateTime": "2020-01-23T08:44:04.211068Z",
2+
"updateTime": "2020-01-23T21:20:37.641926Z",
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": "c2cdcd2b08ca35c5054268f6277ea04713c88e39"
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-dlp-bom/pom.xml"
247-
},
248-
{
249-
"path": "google-cloud-dlp/pom.xml"
250-
},
251231
{
252232
"path": "google-cloud-dlp/src/main/java/com/google/cloud/dlp/v2/DlpServiceClient.java"
253233
},
@@ -278,9 +258,6 @@
278258
{
279259
"path": "google-cloud-dlp/src/test/java/com/google/cloud/dlp/v2/MockDlpServiceImpl.java"
280260
},
281-
{
282-
"path": "grpc-google-cloud-dlp-v2/pom.xml"
283-
},
284261
{
285262
"path": "grpc-google-cloud-dlp-v2/src/main/java/com/google/privacy/dlp/v2/DlpServiceGrpc.java"
286263
},
@@ -290,15 +267,6 @@
290267
{
291268
"path": "license-checks.xml"
292269
},
293-
{
294-
"path": "pom.xml"
295-
},
296-
{
297-
"path": "proto-google-cloud-dlp-v2/clirr-ignored-differences.xml"
298-
},
299-
{
300-
"path": "proto-google-cloud-dlp-v2/pom.xml"
301-
},
302270
{
303271
"path": "proto-google-cloud-dlp-v2/src/main/java/com/google/privacy/dlp/v2/Action.java"
304272
},
@@ -1186,15 +1154,6 @@
11861154
},
11871155
{
11881156
"path": "renovate.json"
1189-
},
1190-
{
1191-
"path": "synth.metadata"
1192-
},
1193-
{
1194-
"path": "synth.py"
1195-
},
1196-
{
1197-
"path": "versions.txt"
11981157
}
11991158
]
12001159
}

‎synth.py‎

Lines changed: 5 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -25,23 +25,13 @@
2525
config_pattern = '/google/privacy/dlp/artman_dlp_{version}.yaml'
2626

2727
for version in versions:
28-
library = gapic.java_library(
28+
java.gapic_library(
2929
service=service,
3030
version=version,
31-
config_path=config_pattern.format(version=version),
32-
artman_output_name='')
33-
34-
package_name = f'com.google.privacy.{service}.{version}'
35-
java.fix_proto_headers(library / f'proto-google-cloud-{service}-{version}')
36-
java.fix_grpc_headers(library / f'grpc-google-cloud-{service}-{version}', package_name)
37-
38-
s.copy(library / f'gapic-google-cloud-{service}-{version}/src', f'google-cloud-{service}/src')
39-
s.copy(library / f'grpc-google-cloud-{service}-{version}/src', f'grpc-google-cloud-{service}-{version}/src')
40-
s.copy(library / f'proto-google-cloud-{service}-{version}/src', f'proto-google-cloud-{service}-{version}/src')
41-
42-
java.format_code(f'google-cloud-{service}/src')
43-
java.format_code(f'grpc-google-cloud-{service}-{version}/src')
44-
java.format_code(f'proto-google-cloud-{service}-{version}/src')
31+
config_pattern=config_pattern,
32+
package_pattern='com.google.privacy.{service}.{version}',
33+
gapic=gapic,
34+
)
4535

4636
common_templates = gcp.CommonTemplates()
4737
templates = common_templates.java_library()

0 commit comments

Comments
 (0)