@google-cloud/dlp - npm Package Compare versions

Comparing version 0.1.1 to 0.1.2

package.json

 {
   "repository": "GoogleCloudPlatform/google-cloud-node",
   "name": "@google-cloud/dlp",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "author": "Google Inc",
@@ -6,0 +6,0 @@ "description": "DLP API client for Node.js",

src/v2beta1/dlp_service_client.js

@@ -56,12 +56,3 @@ /*
  *
- * This will be created through a builder function which can be obtained by the module.
- * See the following example of how to initialize the module and how to access to the builder.
- * @see {@link dlpServiceClient}
  *
- * @example
- * var dlpV2beta1 = require('@google-cloud/dlp').v2beta1({
- *   // optional auth parameters.
- * });
- * var client = dlpV2beta1.dlpServiceClient();
- *
  * @class
@@ -171,3 +162,3 @@ */
 /**
- * Find potentially sensitive info in a list of strings.
+ * Finds potentially sensitive info in a list of strings.
  * This method has limits on input size, processing time, and output size.
@@ -200,3 +191,8 @@ *
  *
- * var client = dlpV2beta1.dlpServiceClient();
+ * var dlp = require('@google-cloud/dlp');
+ *
+ * var client = dlp.v2beta1({
+ *   // optional auth parameters.
+ * });
+ *
  * var inspectConfig = {};
@@ -211,3 +207,4 @@ * var items = [];
  *     // doThingsWith(response)
- * }).catch(function(err) {
+ * })
+ * .catch(function(err) {
  *     console.error(err);
@@ -229,3 +226,3 @@ * });
 /**
- * Redact potentially sensitive info from a list of strings.
+ * Redacts potentially sensitive info from a list of strings.
  * This method has limits on input size, processing time, and output size.
@@ -244,5 +241,10 @@ *
  * @param {Object[]} request.replaceConfigs
- *   The strings to replace findings with. Must specify at least one.
+ *   The strings to replace findings text findings with. Must specify at least
+ *   one of these or one ImageRedactionConfig if redacting images.
  *
  *   This object should have the same structure as [ReplaceConfig]{@link ReplaceConfig}
+ * @param {Object[]=} request.imageRedactionConfigs
+ *   The configuration for specifying what content to redact from images.
+ *
+ *   This object should have the same structure as [ImageRedactionConfig]{@link ImageRedactionConfig}
  * @param {Object=} options
@@ -261,3 +263,8 @@ *   Optional parameters. You can override the default settings for this call, e.g, timeout,
  *
- * var client = dlpV2beta1.dlpServiceClient();
+ * var dlp = require('@google-cloud/dlp');
+ *
+ * var client = dlp.v2beta1({
+ *   // optional auth parameters.
+ * });
+ *
  * var inspectConfig = {};
@@ -274,3 +281,4 @@ * var items = [];
  *     // doThingsWith(response)
- * }).catch(function(err) {
+ * })
+ * .catch(function(err) {
  *     console.error(err);
@@ -292,3 +300,4 @@ * });
 /**
- * Schedule a job scanning content in a Google Cloud Platform data repository.
+ * Schedules a job scanning content in a Google Cloud Platform data
+ * repository.
  *
@@ -309,11 +318,13 @@ * @param {Object} request
  *   write to the given bucket.
- *   Results will be split over multiple csv files with each file name matching
- *   the pattern "[operation_id] + [count].csv".
- *   The operation_id will match the identifier for the Operation,
- *   and the [count] is a counter used for tracking the number of files written.
- *   The CSV file(s) contain the following columns regardless of storage type
- *   scanned: id, info_type, likelihood, byte size of finding, quote, time_stamp
- *   For cloud storage the next two columns are: file_path, start_offset
- *   For datastore the next two columns are: project_id, namespace_id, path,
- *       column_name, offset.
+ *   <p>Results are split over multiple csv files with each file name matching
+ *   the pattern "[operation_id]_[count].csv", for example
+ *   `3094877188788974909_1.csv`. The `operation_id` matches the
+ *   identifier for the Operation, and the `count` is a counter used for
+ *   tracking the number of files written. <p>The CSV file(s) contain the
+ *   following columns regardless of storage type scanned: <li>id <li>info_type
+ *   <li>likelihood <li>byte size of finding <li>quote <li>time_stamp<br/>
+ *   <p>For Cloud Storage the next columns are: <li>file_path
+ *   <li>start_offset<br/>
+ *   <p>For Cloud Datastore the next columns are: <li>project_id
+ *   <li>namespace_id <li>path <li>column_name <li>offset
  *
@@ -334,3 +345,8 @@ *   This object should have the same structure as [OutputStorageConfig]{@link OutputStorageConfig}
  *
- * var client = dlpV2beta1.dlpServiceClient();
+ * var dlp = require('@google-cloud/dlp');
+ *
+ * var client = dlp.v2beta1({
+ *   // optional auth parameters.
+ * });
+ *
  * var inspectConfig = {};
@@ -361,6 +377,16 @@ * var storageConfig = {};
  *     var finalApiResponse = responses[2];
- * }).catch(function(err) {
+ * })
+ * .catch(function(err) {
  *     console.error(err);
  * });
  *
+ * var inspectConfig = {};
+ * var storageConfig = {};
+ * var outputConfig = {};
+ * var request = {
+ *     inspectConfig: inspectConfig,
+ *     storageConfig: storageConfig,
+ *     outputConfig: outputConfig
+ * };
+ *
  * // Handle the operation using the event emitter pattern.
@@ -387,3 +413,4 @@ * client.createInspectOperation(request).then(function(responses) {
  *     })
- * }).catch(function(err) {
+ * })
+ * .catch(function(err) {
  *     console.error(err);
@@ -415,3 +442,3 @@ * });
  *   Maximum number of results to return.
- *   If 0, the implementation will select a reasonable value.
+ *   If 0, the implementation selects a reasonable value.
  * @param {string=} request.pageToken
@@ -421,2 +448,10 @@ *   The value returned by the last `ListInspectFindingsResponse`; indicates
  *   the system should return the next page of data.
+ * @param {string=} request.filter
+ *   Restricts findings to items that match. Supports info_type and likelihood.
+ *   <p>Examples:<br/>
+ *   <li>info_type=EMAIL_ADDRESS
+ *   <li>info_type=PHONE_NUMBER,EMAIL_ADDRESS
+ *   <li>likelihood=VERY_LIKELY
+ *   <li>likelihood=VERY_LIKELY,LIKELY
+ *   <li>info_type=EMAIL_ADDRESS,likelihood=VERY_LIKELY,LIKELY
  * @param {Object=} options
@@ -435,3 +470,8 @@ *   Optional parameters. You can override the default settings for this call, e.g, timeout,
  *
- * var client = dlpV2beta1.dlpServiceClient();
+ * var dlp = require('@google-cloud/dlp');
+ *
+ * var client = dlp.v2beta1({
+ *   // optional auth parameters.
+ * });
+ *
  * var formattedName = client.resultPath("[RESULT]");
@@ -441,3 +481,4 @@ * client.listInspectFindings({name: formattedName}).then(function(responses) {
  *     // doThingsWith(response)
- * }).catch(function(err) {
+ * })
+ * .catch(function(err) {
  *     console.error(err);
@@ -482,3 +523,8 @@ * });
  *
- * var client = dlpV2beta1.dlpServiceClient();
+ * var dlp = require('@google-cloud/dlp');
+ *
+ * var client = dlp.v2beta1({
+ *   // optional auth parameters.
+ * });
+ *
  * var category = '';
@@ -493,3 +539,4 @@ * var languageCode = '';
  *     // doThingsWith(response)
- * }).catch(function(err) {
+ * })
+ * .catch(function(err) {
  *     console.error(err);
@@ -532,3 +579,8 @@ * });
  *
- * var client = dlpV2beta1.dlpServiceClient();
+ * var dlp = require('@google-cloud/dlp');
+ *
+ * var client = dlp.v2beta1({
+ *   // optional auth parameters.
+ * });
+ *
  * var languageCode = '';
@@ -538,3 +590,4 @@ * client.listRootCategories({languageCode: languageCode}).then(function(responses) {
  *     // doThingsWith(response)
- * }).catch(function(err) {
+ * })
+ * .catch(function(err) {
  *     console.error(err);
@@ -541,0 +594,0 @@ * });

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

88231

increased by121.46%

Number of package files

13

increased by62.5%

Lines of code

1938

increased by190.12%

Worsened metrics

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes