THIS REPOSITORY IS DEPRECATED. ALL OF ITS CONTENT AND HISTORY HAS BEEN MOVED TO GOOGLE-CLOUD-NODE

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.

A comprehensive list of changes in each version may be found in the CHANGELOG.

• 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:

• Quickstart
  • Before you begin
  • Installing the client library
  • Using the client library
• Samples
• Versioning
• Contributing
• License

1. Select or create a Cloud Platform project.
2. Enable billing for your project.
3. Enable the Cloud Data Loss Prevention API.
4. Set up authentication with a service account so you can access the API from your local workstation.

npm install @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 = 'my-project';

async function quickStart() {
  // 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: `projects/${projectId}/locations/global`,
    inspectConfig: {
      infoTypes: infoTypes,
      minLikelihood: minLikelihood,
      limits: {
        maxFindingsPerRequest: maxFindings,
      },
      includeQuote: includeQuote,
    },
    item: item,
  };

  // Run request
  const [response] = await dlp.inspectContent(request);
  const findings = response.result.findings;
  if (findings.length > 0) {
    console.log('Findings:');
    findings.forEach(finding => {
      if (includeQuote) {
        console.log(`	Quote: ${finding.quote}`);
      }
      console.log(`	Info type: ${finding.infoType.name}`);
      console.log(`	Likelihood: ${finding.likelihood}`);
    });
  } else {
    console.log('No findings.');
  }
}
quickStart();

Samples are in the samples/ directory. Each sample's README.md has instructions for running its sample.

Sample	Source Code	Try it
Categorical Risk Analysis	source code
Inspect Templates	source code
Job Triggers	source code
Deidentify with Date Shift	source code
Deidentify with FPE	source code
Deidentify with Mask	source code
Deidentify with Replacement	source code
Delete Inspect Templates	source code
Delete Job	source code
Delete Trigger	source code
Inspect Bigquery	source code
Inspect Datastore	source code
Inspect File	source code
Inspect GCS File	source code
Inspects strings	source code
kAnonymity Analysis	source code
kMap Estimation Analysis	source code
l Diversity Analysis	source code
List Inspect Templates	source code
List jobs	source code
List Triggers	source code
Metadata	source code
Numerical Risk Analysis	source code
Quickstart	source code
Redact Image	source code
Redact Text	source code
Reidentify with FPE	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. If you are using an end-of-life version of Node.js, we recommend that you update as soon as possible to an actively supported LTS version.

Google's client libraries support legacy versions of Node.js runtimes on a best-efforts basis with the following warnings:

• Legacy versions are not tested in continuous integration.
• Some security patches and features cannot be backported.
• Dependencies cannot be kept up-to-date.

Client libraries targeting some end-of-life versions of Node.js are available, and can be installed through npm dist-tags. The dist-tags follow the naming convention legacy-(version). For example, npm install @google-cloud/dlp@legacy-8 installs client libraries for versions compatible with Node.js 8.

This library follows Semantic Versioning.

This library is considered to be 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 stable 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 templates in directory.

Apache Version 2.0

See LICENSE