Cloud Data Loss Prevention: Node.js Client

DLP API client for Node.js

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

Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained .

Table of contents:

Quickstart
Samples
Versioning
Contributing
License

Quickstart

Before you begin

Select or create a Cloud Platform project .
Enable billing for your project .
Enable the Cloud Data Loss Prevention API .
Set up authentication so you can access the API from your local workstation.

Installing the client library

 npm install @google-cloud/dlp

Using the client library

 // 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(`\tQuote: ${finding.quote}`);
      }
      console.log(`\tInfo type: ${finding.infoType.name}`);
      console.log(`\tLikelihood: ${finding.likelihood}`);
    });
  } else {
    console.log('No findings.');
  }
}
quickStart();

Samples

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

Sample	Source Code	Try it
Dlp_service.activate_job_trigger	source code
Dlp_service.cancel_dlp_job	source code
Dlp_service.create_connection	source code
Dlp_service.create_deidentify_template	source code
Dlp_service.create_discovery_config	source code
Dlp_service.create_dlp_job	source code
Dlp_service.create_inspect_template	source code
Dlp_service.create_job_trigger	source code
Dlp_service.create_stored_info_type	source code
Dlp_service.deidentify_content	source code
Dlp_service.delete_connection	source code
Dlp_service.delete_deidentify_template	source code
Dlp_service.delete_discovery_config	source code
Dlp_service.delete_dlp_job	source code
Dlp_service.delete_file_store_data_profile	source code
Dlp_service.delete_inspect_template	source code
Dlp_service.delete_job_trigger	source code
Dlp_service.delete_stored_info_type	source code
Dlp_service.delete_table_data_profile	source code
Dlp_service.finish_dlp_job	source code
Dlp_service.get_column_data_profile	source code
Dlp_service.get_connection	source code
Dlp_service.get_deidentify_template	source code
Dlp_service.get_discovery_config	source code
Dlp_service.get_dlp_job	source code
Dlp_service.get_file_store_data_profile	source code
Dlp_service.get_inspect_template	source code
Dlp_service.get_job_trigger	source code
Dlp_service.get_project_data_profile	source code
Dlp_service.get_stored_info_type	source code
Dlp_service.get_table_data_profile	source code
Dlp_service.hybrid_inspect_dlp_job	source code
Dlp_service.hybrid_inspect_job_trigger	source code
Dlp_service.inspect_content	source code
Dlp_service.list_column_data_profiles	source code
Dlp_service.list_connections	source code
Dlp_service.list_deidentify_templates	source code
Dlp_service.list_discovery_configs	source code
Dlp_service.list_dlp_jobs	source code
Dlp_service.list_file_store_data_profiles	source code
Dlp_service.list_info_types	source code
Dlp_service.list_inspect_templates	source code
Dlp_service.list_job_triggers	source code
Dlp_service.list_project_data_profiles	source code
Dlp_service.list_stored_info_types	source code
Dlp_service.list_table_data_profiles	source code
Dlp_service.redact_image	source code
Dlp_service.reidentify_content	source code
Dlp_service.search_connections	source code
Dlp_service.update_connection	source code
Dlp_service.update_deidentify_template	source code
Dlp_service.update_discovery_config	source code
Dlp_service.update_inspect_template	source code
Dlp_service.update_job_trigger	source code
Dlp_service.update_stored_info_type	source code
Quickstart	source code

The Cloud Data Loss Prevention Node.js Client API Reference documentation also contains samples.

Supported Node.js Versions

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.

Versioning

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 stablelibraries are addressed with the highest priority.

More Information: Google Cloud Platform Launch Stages

Contributing

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 .

License

Apache Version 2.0

See LICENSE