README.md

Google Cloud Data Loss Prevention Client for Java

Java idiomatic client for Cloud Data Loss Prevention.

• Product Documentation
• Client Library Documentation

Quickstart

If you are using Maven with BOM, add this to your pom.xml file

<dependencyManagement>
  <dependencies>
    <dependency>
      <groupId>com.google.cloud</groupId>
      <artifactId>libraries-bom</artifactId>
      <version>24.1.2</version>
      <type>pom</type>
      <scope>import</scope>
    </dependency>
  </dependencies>
</dependencyManagement>

<dependencies>
  <dependency>
    <groupId>com.google.cloud</groupId>
    <artifactId>google-cloud-dlp</artifactId>
  </dependency>
</dependencies>

If you are using Maven without BOM, add this to your dependencies:

<dependency>
  <groupId>com.google.cloud</groupId>
  <artifactId>google-cloud-dlp</artifactId>
  <version>3.1.0</version>
</dependency>

If you are using Gradle 5.x or later, add this to your dependencies

implementation platform('com.google.cloud:libraries-bom:24.1.2')

implementation 'com.google.cloud:google-cloud-dlp'

If you are using Gradle without BOM, add this to your dependencies

implementation 'com.google.cloud:google-cloud-dlp:3.1.0'

If you are using SBT, add this to your dependencies

libraryDependencies += "com.google.cloud" % "google-cloud-dlp" % "3.1.0"

Authentication

See the Authentication section in the base directory's README.

Authorization

The client application making API calls must be granted authorization scopes required for the desired Cloud Data Loss Prevention APIs, and the authenticated principal must have the IAM role(s) required to access GCP resources using the Cloud Data Loss Prevention API calls.

Getting Started

Prerequisites

You will need a Google Cloud Platform Console project with the Cloud Data Loss Prevention API enabled. You will need to enable billing to use Google Cloud Data Loss Prevention. Follow these instructions to get your project set up. You will also need to set up the local development environment by installing the Google 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 section to add google-cloud-dlp as a dependency in your code.

About Cloud Data Loss Prevention

Cloud Data Loss Prevention 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.

See the Cloud Data Loss Prevention client library docs to learn how to use this Cloud Data Loss Prevention Client Library.

Samples

Samples are in the samples/ directory.

Sample	Source Code	Try it
De Identify Table Bucketing	source code
De Identify Table Condition Info Types	source code
De Identify Table Condition Masking	source code
De Identify Table Info Types	source code
De Identify Table Row Suppress	source code
De Identify Table With Fpe	source code
De Identify Text With Fpe	source code
De Identify With Date Shift	source code
De Identify With Exception List	source code
De Identify With Fpe	source code
De Identify With Info Type	source code
De Identify With Masking	source code
De Identify With Redaction	source code
De Identify With Replacement	source code
De Identify With Simple Word List	source code
Info Types List	source code
Inspect Big Query Table	source code
Inspect Big Query Table With Sampling	source code
Inspect Datastore Entity	source code
Inspect Gcs File	source code
Inspect Gcs File With Sampling	source code
Inspect Image File	source code
Inspect Image File All Info Types	source code
Inspect Image File Listed Info Types	source code
Inspect Phone Number	source code
Inspect String	source code
Inspect String Custom Excluding Substring	source code
Inspect String Custom Hotword	source code
Inspect String Custom Omit Overlap	source code
Inspect String Multiple Rules	source code
Inspect String Omit Overlap	source code
Inspect String With Exclusion Dict	source code
Inspect String With Exclusion Dict Substring	source code
Inspect String With Exclusion Regex	source code
Inspect String Without Overlap	source code
Inspect Table	source code
Inspect Text File	source code
Inspect With Custom Regex	source code
Inspect With Hotword Rules	source code
Jobs Create	source code
Jobs Delete	source code
Jobs Get	source code
Jobs List	source code
Quick Start	source code
Re Identify Table With Fpe	source code
Re Identify Text With Fpe	source code
Re Identify With Fpe	source code
Redact Image File	source code
Redact Image File All Info Types	source code
Redact Image File All Text	source code
Redact Image File Colored Info Types	source code
Redact Image File Listed Info Types	source code
Risk Analysis Categorical Stats	source code
Risk Analysis K Anonymity	source code
Risk Analysis K Map	source code
Risk Analysis L Diversity	source code
Risk Analysis Numerical Stats	source code
Templates Create	source code
Templates Delete	source code
Templates List	source code
Triggers Create	source code
Triggers Delete	source code
Triggers List	source code

Troubleshooting

To get help, follow the instructions in the shared Troubleshooting document.

Transport

Cloud Data Loss Prevention uses gRPC for the transport layer.

Supported Java Versions

Java 8 or above is required for using this client.

Google's Java client libraries, Google Cloud Client Libraries and Google Cloud API Libraries, follow the Oracle Java SE support roadmap (see the Oracle Java SE Product Releases section).

For new development

In general, new feature development occurs with support for the lowest Java LTS version covered by Oracle's Premier Support (which typically lasts 5 years from initial General Availability). If the minimum required JVM for a given library is changed, it is accompanied by a semver major release.

Java 11 and (in September 2021) Java 17 are the best choices for new development.

Keeping production systems current

Google tests its client libraries with all current LTS versions covered by Oracle's Extended Support (which typically lasts 8 years from initial General Availability).

Legacy support

Google's client libraries support legacy versions of Java runtimes with long term stable libraries that don't receive feature updates on a best efforts basis as it may not be possible to backport all patches.

Google provides updates on a best efforts basis to apps that continue to use Java 7, though apps might need to upgrade to current versions of the library that supports their JVM.

Where to find specific information

The latest versions and the supported Java versions are identified on the individual GitHub repository github.com/GoogleAPIs/java-SERVICENAME and on google-cloud-java.

Versioning

This library follows Semantic Versioning.

Contributing

Contributions to this library are always welcome and highly encouraged.

See 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 for more information.

License

Apache 2.0 - See LICENSE for more information.

CI Status

Java Version	Status
Java 8
Java 8 OSX
Java 8 Windows
Java 11

Java is a registered trademark of Oracle and/or its affiliates.