Google Cloud Data Loss Prevention (DLP) API: Node.js Client
Node.js idiomatic client for Data Loss Prevention (DLP) API .
Client API Reference
- About the NPM package
- Classes
- RPC Message Types
- Index of all
Quickstart
Before you begin
-
Select or create a Cloud Platform project.
-
Enable billing for your project.
-
Enable the Google Cloud Data Loss Prevention (DLP) API API.
-
Set up authentication with a service account so you can access the API from your local workstation.
Installing the client library
npm install --save @google-cloud/dlp
Using the client library
// Imports the Google Cloud Data Loss Prevention library
const DLP = require('@google-cloud/dlp');
// Instantiates a client
const dlp = new DLP.DlpServiceClient();
// The string to inspect
const string = 'Robert Frost';
// The project ID to run the API call under
const projectId = process.env.GCLOUD_PROJECT;
// The minimum likelihood required before returning a match
const minLikelihood = 'LIKELIHOOD_UNSPECIFIED';
// The maximum number of findings to report (0 = server maximum)
const maxFindings = 0;
// The infoTypes of information to match
const infoTypes = [{name: 'PERSON_NAME'}, {name: 'US_STATE'}];
// Whether to include the matching string
const includeQuote = true;
// Construct item to inspect
const item = {value: string};
// Construct request
const request = {
parent: dlp.projectPath(projectId),
inspectConfig: {
infoTypes: infoTypes,
minLikelihood: minLikelihood,
limits: {
maxFindingsPerRequest: maxFindings,
},
includeQuote: includeQuote,
},
item: item,
};
// Run request
dlp
.inspectContent(request)
.then(response => {
const findings = response[0].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.`);
}
})
.catch(err => {
console.error(`Error in inspectString: ${err.message || err}`);
});
Samples
Samples are in the
samples/
directory. The samples'
README.md
has instructions for running the samples.
Sample | Source Code | Try it |
---|---|---|
Inspect | source code |
![]() |
Redact | source code |
![]() |
Metadata | source code |
![]() |
DeID | source code |
![]() |
Risk Analysis | source code |
![]() |
Inspect Templates | source code |
![]() |
Job Management | source code |
![]() |
Job Triggers | source code |
![]() |
The Data Loss Prevention (DLP) API Node.js Client API Reference documentation also contains samples.
Versioning
This library follows Semantic Versioning .
This library is considered to be in beta . This means it is expected to be mostly stable while we work toward a general availability release; however, complete stability is not guaranteed. We will address issues and requests against beta libraries with a high priority.
More Information: Google Cloud Platform Launch Stages
Contributing
Contributions welcome! See the Contributing Guide .
License
Apache Version 2.0
See LICENSE