@google-cloud/dlp 5.2.0 → 5.3.0

package/build/protos/google/privacy/dlp/v2/storage.proto

@@ -31,9 +31,11 @@ option ruby_package = "Google::Cloud::Dlp::V2";
 message InfoType {
   // Name of the information type. Either a name of your choosing when
   // creating a CustomInfoType, or one of the names listed
-  // at https://cloud.google.com/dlp/docs/infotypes-reference when specifying
-  // a built-in type.  When sending Cloud DLP results to Data Catalog, infoType
-  // names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`.
+  // at
+  // https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference
+  // when specifying a built-in type.  When sending Cloud DLP results to Data
+  // Catalog, infoType names should conform to the pattern
+  // `[A-Za-z0-9$_-]{1,64}`.
   string name = 1;
 
   // Optional version name for this InfoType.
@@ -87,7 +89,7 @@ message SensitivityScore {
 //
 // For more information about each likelihood level
 // and how likelihood works, see [Match
-// likelihood](https://cloud.google.com/dlp/docs/likelihood).
+// likelihood](https://cloud.google.com/sensitive-data-protection/docs/likelihood).
 enum Likelihood {
   // Default value; same as POSSIBLE.
   LIKELIHOOD_UNSPECIFIED = 0;
@@ -142,10 +144,10 @@ message CustomInfoType {
   // Dictionary words containing a large number of characters that are not
   // letters or digits may result in unexpected findings because such characters
   // are treated as whitespace. The
-  // [limits](https://cloud.google.com/dlp/limits) page contains details about
-  // the size limits of dictionaries. For dictionaries that do not fit within
-  // these constraints, consider using `LargeCustomDictionaryConfig` in the
-  // `StoredInfoType` API.
+  // [limits](https://cloud.google.com/sensitive-data-protection/limits) page
+  // contains details about the size limits of dictionaries. For dictionaries
+  // that do not fit within these constraints, consider using
+  // `LargeCustomDictionaryConfig` in the `StoredInfoType` API.
   message Dictionary {
     // Message defining a list of words or phrases to search for in the data.
     message WordList {
@@ -155,6 +157,7 @@ message CustomInfoType {
       repeated string words = 1;
     }
 
+    // The potential places the data can be read from.
     oneof source {
       // List of words or phrases to search for.
       WordList word_list = 1;
@@ -179,7 +182,7 @@ message CustomInfoType {
 
   // Message for detecting output from deidentification transformations
   // such as
-  // [`CryptoReplaceFfxFpeConfig`](https://cloud.google.com/dlp/docs/reference/rest/v2/organizations.deidentifyTemplates#cryptoreplaceffxfpeconfig).
+  // [`CryptoReplaceFfxFpeConfig`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/organizations.deidentifyTemplates#cryptoreplaceffxfpeconfig).
   // These types of transformations are
   // those that perform pseudonymization, thereby producing a "surrogate" as
   // output. This should be used in conjunction with a field on the
@@ -199,7 +202,7 @@ message CustomInfoType {
       // if you want to modify the likelihood of an entire column of findngs,
       // set this to 1. For more information, see
       // [Hotword example: Set the match likelihood of a table column]
-      // (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values).
+      // (https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values).
       int32 window_before = 1;
 
       // Number of characters after the finding to consider.
@@ -209,6 +212,7 @@ message CustomInfoType {
     // Message for specifying an adjustment to the likelihood of a finding as
     // part of a detection rule.
     message LikelihoodAdjustment {
+      // How the likelihood will be modified.
       oneof adjustment {
         // Set the likelihood of a finding to a fixed value.
         Likelihood fixed_likelihood = 1;
@@ -243,19 +247,21 @@ message CustomInfoType {
       // For tabular data, if you want to modify the likelihood of an entire
       // column of findngs, see
       // [Hotword example: Set the match likelihood of a table column]
-      // (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values).
+      // (https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values).
       Proximity proximity = 2;
 
       // Likelihood adjustment to apply to all matching findings.
       LikelihoodAdjustment likelihood_adjustment = 3;
     }
 
+    // Type of hotword rule.
     oneof type {
       // Hotword-based detection rule.
       HotwordRule hotword_rule = 1;
     }
   }
 
+  // Type of exclusion rule.
   enum ExclusionType {
     // A finding of this custom info type will not be excluded from results.
     EXCLUSION_TYPE_UNSPECIFIED = 0;
@@ -278,6 +284,7 @@ message CustomInfoType {
   // the rule. Defaults to `VERY_LIKELY` if not specified.
   Likelihood likelihood = 6;
 
+  // Type of custom detector.
   oneof type {
     // A list of phrases to detect as a CustomInfoType.
     Dictionary dictionary = 2;
@@ -365,8 +372,9 @@ enum FileType {
   //   dat, dot, eml,, epbub, ged, go, h, hh, hpp, hxx, h++, hs, html, htm,
   //   mkd, markdown, m, ml, mli, perl, pl, plist, pm, php, phtml, pht,
   //   properties, py, pyw, rb, rbw, rs, rss,  rc, scala, sh, sql, swift, tex,
-  //   shtml, shtm, xhtml, lhs, ics, ini, java, js, json, kix, kml, ocaml, md,
-  //   txt, text, tsv, vb, vcard, vcs, wml, xcodeproj, xml, xsl, xsd, yml, yaml.
+  //   shtml, shtm, xhtml, lhs, ics, ini, java, js, json, jsonl, kix, kml,
+  //   ocaml, md, txt, text, tsv, vb, vcard, vcs, wml, xcodeproj, xml, xsl, xsd,
+  //   yml, yaml.
   TEXT_FILE = 2;
 
   // Included file extensions:
@@ -498,6 +506,7 @@ message CloudStorageOptions {
   // in conjunction with bytes_limit_per_file. If not specified, scanning would
   // start from the top.
   enum SampleMethod {
+    // No sampling.
     SAMPLE_METHOD_UNSPECIFIED = 0;
 
     // Scan from the top (default).
@@ -517,7 +526,7 @@ message CloudStorageOptions {
   // This field can't be set if de-identification is requested. For certain file
   // types, setting this field has no effect. For more information, see [Limits
   // on bytes scanned per
-  // file](https://cloud.google.com/dlp/docs/supported-file-types#max-byte-size-per-file).
+  // file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file).
   int64 bytes_limit_per_file = 4;
 
   // Max percentage of bytes to scan from a file. The rest are omitted. The
@@ -527,7 +536,7 @@ message CloudStorageOptions {
   // This field can't be set if de-identification is requested. For certain file
   // types, setting this field has no effect. For more information, see [Limits
   // on bytes scanned per
-  // file](https://cloud.google.com/dlp/docs/supported-file-types#max-byte-size-per-file).
+  // file](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types#max-byte-size-per-file).
   int32 bytes_limit_per_file_percent = 8;
 
   // List of file type groups to include in the scan.
@@ -539,6 +548,7 @@ message CloudStorageOptions {
   // Image inspection is restricted to 'global', 'us', 'asia', and 'europe'.
   repeated FileType file_types = 5;
 
+  // How to sample the data.
   SampleMethod sample_method = 6;
 
   // Limits the number of files to scan to this percentage of the input FileSet.
@@ -556,8 +566,8 @@ message CloudStorageFileSet {
 
 // Message representing a single file or path in Cloud Storage.
 message CloudStoragePath {
-  // A url representing a file or path (no wildcards) in Cloud Storage.
-  // Example: gs://[BUCKET_NAME]/dictionary.txt
+  // A URL representing a file or path (no wildcards) in Cloud Storage.
+  // Example: `gs://[BUCKET_NAME]/dictionary.txt`
   string path = 1;
 }
 
@@ -567,6 +577,7 @@ message BigQueryOptions {
   // in conjunction with either rows_limit or rows_limit_percent. If not
   // specified, rows are scanned in the order BigQuery reads them.
   enum SampleMethod {
+    // No sampling.
     SAMPLE_METHOD_UNSPECIFIED = 0;
 
     // Scan groups of rows in the order BigQuery provides (default). Multiple
@@ -599,8 +610,14 @@ message BigQueryOptions {
   // 100 means no limit. Defaults to 0. Only one of rows_limit and
   // rows_limit_percent can be specified. Cannot be used in conjunction with
   // TimespanConfig.
+  //
+  // Caution: A [known
+  // issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-sampling)
+  // is causing the `rowsLimitPercent` field to behave unexpectedly. We
+  // recommend using `rowsLimit` instead.
   int32 rows_limit_percent = 6;
 
+  // How to sample the data.
   SampleMethod sample_method = 4;
 
   // References to fields excluded from scanning. This allows you to skip
@@ -662,7 +679,8 @@ message StorageConfig {
     // Valid data types of the provided timestamp property are: `TIMESTAMP`.
     //
     // See the
-    // [known issue](https://cloud.google.com/dlp/docs/known-issues#bq-timespan)
+    // [known
+    // issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan)
     // related to this operation.
     FieldId timestamp_field = 3;
 
@@ -674,6 +692,7 @@ message StorageConfig {
     bool enable_auto_population_of_timespan_config = 4;
   }
 
+  // Type of storage system to inspect.
   oneof type {
     // Google Cloud Datastore options.
     DatastoreOptions datastore_options = 2;
@@ -688,6 +707,7 @@ message StorageConfig {
     HybridOptions hybrid_options = 9;
   }
 
+  // Configuration of the timespan of the items to include in scanning.
   TimespanConfig timespan_config = 6;
 }
 
@@ -797,9 +817,12 @@ message Key {
 
 // Message for a unique key indicating a record that contains a finding.
 message RecordKey {
+  // Type of key
   oneof type {
+    // BigQuery key
     DatastoreKey datastore_key = 2;
 
+    // Datastore key
     BigQueryKey big_query_key = 3;
   }