Have ideas to improve npm?Join in the discussion! »

    @google-cloud/dlp
    TypeScript icon, indicating that this package has built-in type declarations

    3.1.2 • Public • Published

    Google Cloud Platform logo

    Cloud Data Loss Prevention: Node.js Client

    release level npm version codecov

    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.

    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

    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.

    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
    Categorical Risk Analysis source code Open in Cloud Shell
    Inspect Templates source code Open in Cloud Shell
    Job Triggers source code Open in Cloud Shell
    Deidentify with Date Shift source code Open in Cloud Shell
    Deidentify with FPE source code Open in Cloud Shell
    Deidentify with Mask source code Open in Cloud Shell
    Deidentify with Replacement source code Open in Cloud Shell
    Delete Inspect Templates source code Open in Cloud Shell
    Delete Job source code Open in Cloud Shell
    Delete Trigger source code Open in Cloud Shell
    Inspect Bigquery source code Open in Cloud Shell
    Inspect Datastore source code Open in Cloud Shell
    Inspect File source code Open in Cloud Shell
    Inspect GCS File source code Open in Cloud Shell
    Inspects strings source code Open in Cloud Shell
    kAnonymity Analysis source code Open in Cloud Shell
    kMap Estimation Analysis source code Open in Cloud Shell
    l Diversity Analysis source code Open in Cloud Shell
    List Inspect Templates source code Open in Cloud Shell
    List jobs source code Open in Cloud Shell
    List Triggers source code Open in Cloud Shell
    Metadata source code Open in Cloud Shell
    Numerical Risk Analysis source code Open in Cloud Shell
    Quickstart source code Open in Cloud Shell
    Redact Image source code Open in Cloud Shell
    Redact Text source code Open in Cloud Shell
    Reidentify with FPE source code Open in Cloud Shell

    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.

    Client libraries targeting 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 tags available

    • legacy-8: install client libraries from this dist-tag for versions compatible with Node.js 8.

    Versioning

    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

    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 template in this directory.

    License

    Apache Version 2.0

    See LICENSE

    Install

    npm i @google-cloud/dlp

    DownloadsWeekly Downloads

    5,200

    Version

    3.1.2

    License

    Apache-2.0

    Unpacked Size

    6.43 MB

    Total Files

    20

    Last publish

    Collaborators

    • avatar