The Data Loss Prevention API provides programmatic access to a powerful detection engine for personally identifiable information and other privacy-sensitive data in unstructured data streams.
- Cloud Data Loss Prevention Node.js Client API Reference
- Cloud Data Loss Prevention Documentation
- github.com/googleapis/nodejs-dlp
Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained.
Table of contents:
- Select or create a Cloud Platform project.
- Enable billing for your project.
- Enable the Cloud Data Loss Prevention API.
- Set up authentication with a service account so you can access the API from your local workstation.
npm install @google-cloud/dlp// Instantiates a clientconstdlp=newDLP.DlpServiceClient();// The string to inspectconststring='Robert Frost';// The project ID to run the API call underconstprojectId=process.env.GCLOUD_PROJECT;// The minimum likelihood required before returning a matchconstminLikelihood='LIKELIHOOD_UNSPECIFIED';// The maximum number of findings to report (0 = server maximum)constmaxFindings=0;// The infoTypes of information to matchconstinfoTypes=[{name: 'PERSON_NAME'},{name: 'US_STATE'}];// Whether to include the matching stringconstincludeQuote=true;// Construct item to inspectconstitem={value: string};// Construct requestconstrequest={parent: dlp.projectPath(projectId),inspectConfig: {infoTypes: infoTypes,minLikelihood: minLikelihood,limits: {maxFindingsPerRequest: maxFindings,},includeQuote: includeQuote,},item: item,};// Run requestconst[response]=awaitdlp.inspectContent(request);constfindings=response.result.findings;if(findings.length>0){console.log('Findings:');findings.forEach(finding=>{if(includeQuote){console.log(`\tQuote: ${finding.quote}`);}console.log(`\tInfo type: ${finding.infoType.name}`);console.log(`\tLikelihood: ${finding.likelihood}`);});}else{console.log('No findings.');}Samples are in the samples/ directory. The samples' README.md
has instructions for running the samples.
| Sample | Source Code | Try it |
|---|---|---|
| Deid | source code |  |
| Inspect | source code | |
| Job Management | source code | |
| Metadata | source code | |
| Quickstart | source code | |
| Redact | source code | |
| Risk Analysis | source code | |
| Inspect Templates | source code | |
| Job Triggers | source code | |
The Cloud Data Loss Prevention Node.js Client API Reference documentation also contains samples.
Our client libraries follow the Node.js release schedule. Libraries are compatible with all current active and maintenance versions of Node.js.
Client libraries targetting some end-of-life versions of Node.js are available, and
can be installed via npm dist-tags.
The dist-tags follow the naming convention legacy-(version).
Legacy Node.js versions are supported as a best effort:
- Legacy versions will not be tested in continuous integration.
- Some security patches may not be able to be backported.
- Dependencies will not be kept up-to-date, and features will not be backported.
legacy-8: install client libraries from this dist-tag for versions compatible with Node.js 8.
This library follows Semantic Versioning.
This library is considered to be General Availability (GA). This means it is stable; the code surface will not change in backwards-incompatible ways unless absolutely necessary (e.g. because of critical security issues) or with an extensive deprecation period. Issues and requests against GA libraries are addressed with the highest priority.
More Information: Google Cloud Platform Launch Stages
Contributions welcome! See the Contributing Guide.
Please note that this README.md, the samples/README.md,
and a variety of configuration files in this repository (including .nycrc and tsconfig.json)
are generated from a central template. To edit one of these files, make an edit
to its template in this
directory.
Apache Version 2.0
See LICENSE