From b36db2641c56598ed504c03565a52bc4539c16c2 Mon Sep 17 00:00:00 2001 From: Jeff Ching Date: Fri, 24 Jan 2020 10:20:23 -0800 Subject: [PATCH] feat: promote to GA (#62) Release-As: 1.0.0 --- .repo-metadata.json | 7 +- README.md | 176 ++++++++++++++++++++++++++------------------ synth.metadata | 45 +---------- synth.py | 20 ++--- 4 files changed, 115 insertions(+), 133 deletions(-) diff --git a/.repo-metadata.json b/.repo-metadata.json index e580c1d2..67229619 100644 --- a/.repo-metadata.json +++ b/.repo-metadata.json @@ -2,10 +2,11 @@ "name": "dlp", "name_pretty": "Cloud Data Loss Prevention", "product_documentation": "https://cloud.google.com/dlp/docs/", - "client_documentation": "https://googleapis.dev/java/java-dlp/latest/index.html", - "issue_tracker": "", - "release_level": "beta", + "client_documentation": "https://googleapis.dev/java/google-cloud-dlp/latest/index.html", + "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.", + "release_level": "ga", "language": "java", + "transport": "grpc", "repo": "googleapis/java-dlp", "repo_short": "java-dlp", "distribution_name": "com.google.cloud:google-cloud-dlp", diff --git a/README.md b/README.md index 5c7c433f..393adcd7 100644 --- a/README.md +++ b/README.md @@ -1,42 +1,41 @@ -Google Cloud Java Client for Data Loss Prevention -====================================== +# Google Cloud Data Loss Prevention Client for Java -Java idiomatic client for [Google Cloud Data Loss Prevention][cloud-dlp]. +Java idiomatic client for [Cloud Data Loss Prevention][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-.svg)](https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-video-intelligence.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][dlp-product-docs] -- [Client Library Documentation][dlp-client-lib-docs] +- [Product Documentation][product-docs] +- [Client Library Documentation][javadocs] -> Note: This client is a work-in-progress, and may occasionally -> make backwards-incompatible changes. +## Quickstart -Quickstart ----------- -If you are using Maven with a BOM, add this to your pom.xml file. +If you are using Maven with [BOM][libraries-bom], add this to your pom.xml file ```xml - - - com.google.cloud - libraries-bom - 2.8.0 - pom - import - - + + + com.google.cloud + libraries-bom + 3.4.0 + pom + import + + - - com.google.cloud - google-cloud-dlp - + + + com.google.cloud + google-cloud-dlp + + ``` [//]: # ({x-version-update-start:google-cloud-dlp:released}) -If you are using Maven without a BOM, add this to your dependencies. + +If you are using Maven without BOM, add this to your dependencies: + ```xml com.google.cloud @@ -44,6 +43,7 @@ If you are using Maven without a BOM, add this to your dependencies. 0.118.1-beta ``` + If you are using Gradle, add this to your dependencies ```Groovy 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" ``` [//]: # ({x-version-update-end}) -Authentication --------------- +## Authentication -See the [Authentication](https://github.com/googleapis/google-cloud-java#authentication) section -in the base directory's README. +See the [Authentication][authentication] section in the base directory's README. -About Google Cloud Data Loss Prevention ----------------------------- +## Getting Started -Google [Cloud Data Loss Prevention API][cloud-dlp] -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. +### Prerequisites -See the [Data Loss Prevention client library docs][dlp-client-lib-docs] -to learn how to use this Cloud Data Loss Prevention API Client Library. +You will need a [Google Cloud Platform Console][developer-console] project with the Cloud Data Loss Prevention [API enabled][enable-api]. -Getting Started ---------------- -#### Prerequisites -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]`. +[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]`. -#### Installation and setup -You'll need to obtain the `google-cloud-dlp` library. -See the [Quickstart](#quickstart) section to add `google-cloud-dlp` as a dependency in your code. +### Installation and setup -Troubleshooting ---------------- +You'll need to obtain the `google-cloud-dlp` library. See the [Quickstart](#quickstart) section +to add `google-cloud-dlp` as a dependency in your code. -To get help, follow the instructions in the [shared Troubleshooting document](https://github.com/googleapis/google-cloud-common/blob/master/troubleshooting/readme.md#troubleshooting). +## About Cloud Data Loss Prevention -Transport ---------- -DLP API uses gRPC for the transport layer. -Java Versions -------------- +[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. -Java 7 or above is required for using this client. +See the [Cloud Data Loss Prevention client library docs][javadocs] to learn how to +use this Cloud Data Loss Prevention Client Library. -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 ------------- +## Troubleshooting -Contributions to this library are always welcome and highly encouraged. +To get help, follow the instructions in the [shared Troubleshooting document][troubleshooting]. + +## Transport -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. +Cloud Data Loss Prevention uses gRPC for the transport layer. -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. +## Java Versions -License -------- +Java 7 or above is required for using this client. + +## Versioning -Apache 2.0 - See [LICENSE] for more information. +This library follows [Semantic Versioning](http://semver.org/). -[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/ -[cloud-dlp]: https://cloud.google.com/dlp/ -[dlp-product-docs]: https://cloud.google.com/dlp/docs/ -[dlp-client-lib-docs]: https://googleapis.dev/java/google-cloud-clients/latest/index.html?com/google/cloud/dlp/v2/package-summary.html + +## Contributing + + +Contributions to this library are always welcome and highly encouraged. + +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. + +## License + +Apache 2.0 - See [LICENSE][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] + +[product-docs]: https://cloud.google.com/dlp/docs/ +[javadocs]: https://googleapis.dev/java/google-cloud-dlp/latest/index.html +[kokoro-badge-image-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-dlp/java7.svg +[kokoro-badge-link-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-dlp/java7.html +[kokoro-badge-image-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-dlp/java8.svg +[kokoro-badge-link-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-dlp/java8.html +[kokoro-badge-image-3]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-dlp/java8-osx.svg +[kokoro-badge-link-3]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-dlp/java8-osx.html +[kokoro-badge-image-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-dlp/java8-win.svg +[kokoro-badge-link-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-dlp/java8-win.html +[kokoro-badge-image-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-dlp/java11.svg +[kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-dlp/java11.html +[stability-image]: https://img.shields.io/badge/stability-ga-green +[maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-dlp.svg +[maven-version-link]: https://search.maven.org/search?q=g:com.google.cloud%20AND%20a:google-cloud-dlp&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-dlp/blob/master/CONTRIBUTING.md +[code-of-conduct]: https://github.com/googleapis/java-dlp/blob/master/CODE_OF_CONDUCT.md#contributor-code-of-conduct +[license]: https://github.com/googleapis/java-dlp/blob/master/LICENSE + +[enable-api]: https://console.cloud.google.com/flows/enableapi?apiid=dlp.googleapis.com +[libraries-bom]: https://github.com/GoogleCloudPlatform/cloud-opensource-java/wiki/The-Google-Cloud-Platform-Libraries-BOM \ No newline at end of file diff --git a/synth.metadata b/synth.metadata index c146f58c..91004924 100644 --- a/synth.metadata +++ b/synth.metadata @@ -1,5 +1,5 @@ { - "updateTime": "2020-01-23T08:44:04.211068Z", + "updateTime": "2020-01-23T21:20:37.641926Z", "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": "c2cdcd2b08ca35c5054268f6277ea04713c88e39" } }, { @@ -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-dlp-bom/pom.xml" - }, - { - "path": "google-cloud-dlp/pom.xml" - }, { "path": "google-cloud-dlp/src/main/java/com/google/cloud/dlp/v2/DlpServiceClient.java" }, @@ -278,9 +258,6 @@ { "path": "google-cloud-dlp/src/test/java/com/google/cloud/dlp/v2/MockDlpServiceImpl.java" }, - { - "path": "grpc-google-cloud-dlp-v2/pom.xml" - }, { "path": "grpc-google-cloud-dlp-v2/src/main/java/com/google/privacy/dlp/v2/DlpServiceGrpc.java" }, @@ -290,15 +267,6 @@ { "path": "license-checks.xml" }, - { - "path": "pom.xml" - }, - { - "path": "proto-google-cloud-dlp-v2/clirr-ignored-differences.xml" - }, - { - "path": "proto-google-cloud-dlp-v2/pom.xml" - }, { "path": "proto-google-cloud-dlp-v2/src/main/java/com/google/privacy/dlp/v2/Action.java" }, @@ -1186,15 +1154,6 @@ }, { "path": "renovate.json" - }, - { - "path": "synth.metadata" - }, - { - "path": "synth.py" - }, - { - "path": "versions.txt" } ] } \ No newline at end of file diff --git a/synth.py b/synth.py index 74379392..1a900718 100644 --- a/synth.py +++ b/synth.py @@ -25,23 +25,13 @@ config_pattern = '/google/privacy/dlp/artman_dlp_{version}.yaml' for version in versions: - library = gapic.java_library( + java.gapic_library( service=service, version=version, - config_path=config_pattern.format(version=version), - artman_output_name='') - - package_name = f'com.google.privacy.{service}.{version}' - java.fix_proto_headers(library / f'proto-google-cloud-{service}-{version}') - java.fix_grpc_headers(library / f'grpc-google-cloud-{service}-{version}', package_name) - - s.copy(library / f'gapic-google-cloud-{service}-{version}/src', f'google-cloud-{service}/src') - s.copy(library / f'grpc-google-cloud-{service}-{version}/src', f'grpc-google-cloud-{service}-{version}/src') - s.copy(library / f'proto-google-cloud-{service}-{version}/src', f'proto-google-cloud-{service}-{version}/src') - - java.format_code(f'google-cloud-{service}/src') - java.format_code(f'grpc-google-cloud-{service}-{version}/src') - java.format_code(f'proto-google-cloud-{service}-{version}/src') + config_pattern=config_pattern, + package_pattern='com.google.privacy.{service}.{version}', + gapic=gapic, + ) common_templates = gcp.CommonTemplates() templates = common_templates.java_library()