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.
-
Read Prerequisites and How to run a sample first.
-
Install dependencies:
With npm:
npm installWith yarn:
yarn install
View the documentation or the source code.
Usage: node inspect.js --help
Commands:
string <string> Inspect a string using the Data Loss Prevention API.
file <filepath> Inspects a local text, PNG, or JPEG file using the Data Loss Prevention API.
gcsFilePromise <bucketName> <fileName> Inspects a text file stored on Google Cloud Storage using the Data Loss
Prevention API and the promise pattern.
gcsFileEvent <bucketName> <fileName> Inspects a text file stored on Google Cloud Storage using the Data Loss
Prevention API and the event-handler pattern.
datastore <kind> Inspect a Datastore instance using the Data Loss Prevention API.
Options:
--help Show help [boolean]
-m, --minLikelihood
[string] [choices: "LIKELIHOOD_UNSPECIFIED", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY"]
[default: "LIKELIHOOD_UNSPECIFIED"]
-f, --maxFindings [number] [default: 0]
-q, --includeQuote [boolean] [default: true]
-l, --languageCode [string] [default: "en-US"]
-t, --infoTypes [array] [default: []]
Examples:
node inspect.js string "My phone number is (123) 456-7890 and my email address is me@somedomain.com"
node inspect.js file resources/test.txt
node inspect.js gcsFilePromise my-bucket my-file.txt
node inspect.js gcsFileEvent my-bucket my-file.txt
For more information, see https://cloud.google.com/dlp/docs. Optional flags are explained at
https://cloud.google.com/dlp/docs/reference/rest/v2beta1/content/inspect#InspectConfig
View the documentation or the source code.
Usage: node redact.js --help
Commands:
string <string> <replaceString> Redact sensitive data from a string using the Data Loss Prevention API.
Options:
--help Show help [boolean]
-t, --infoTypes [array] [required]
-m, --minLikelihood
[string] [choices: "LIKELIHOOD_UNSPECIFIED", "VERY_UNLIKELY", "UNLIKELY", "POSSIBLE", "LIKELY", "VERY_LIKELY"]
[default: "LIKELIHOOD_UNSPECIFIED"]
Examples:
node redact.js string "My name is Gary" "REDACTED" -t US_MALE_NAME
For more information, see https://cloud.google.com/dlp/docs. Optional flags are explained at
https://cloud.google.com/dlp/docs/reference/rest/v2beta1/content/inspect#InspectConfig
View the documentation or the source code.
Usage: node metadata.js --help
Commands:
infoTypes <category> List types of sensitive information within a category.
categories List root categories of sensitive information.
Options:
--help Show help [boolean]
-l, --languageCode [string] [default: "en-US"]
Examples:
node metadata.js infoTypes GOVERNMENT
node metadata.js categories
For more information, see https://cloud.google.com/dlp/docs
-
Set the GCLOUD_PROJECT and GOOGLE_APPLICATION_CREDENTIALS environment variables.
-
Run the tests:
With npm:
npm testWith yarn:
yarn test