google-cloud-dlp 0.13.0 → 0.13.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 56ff3ceea747a959f8ad69280ac6a57b2eb49117b0adbc69ebda590e7da5866c
4
- data.tar.gz: 357c844cbd49b0f25c25d0a9c488cda24a6a709565495bb27ff6ce6a25cac2f2
3
+ metadata.gz: 22f0af1f4c59308a7104aa6df68280dd7fc64dfb227d4119e29834f7c6779fff
4
+ data.tar.gz: e4c3fede5859c83ba183d0c3ecefe594f932c5d146cbb46304ba7dcd04ed5c97
5
5
  SHA512:
6
- metadata.gz: 35df745b1090610c2f5890e046b1a7c83b1c30d0c0850ce2b2c8fbc9616b527a9fc09e86d0102ff08957cdd93b26d03869e95528be7da4c78cb47721384df53a
7
- data.tar.gz: 5006cdd93665096ebda209c8e46864586f7b4dcf33b0c356c54769412e33809a3016d25d0966499999db6e9e1bfa316f4767c3b931609789cfab1856b1523413
6
+ metadata.gz: 85b208ebb984ef771d0195e2936aec3dddba3dbdefc71a5bc7d92bf39f56085ded3d3bfa4391421ab8b0163568d666078ac78a80943ab1931c3be43296b577fb
7
+ data.tar.gz: a630d7aa772533408fc789c014c0061b3cc385b35af66c9f2cdaa1fbe6fa5f0093147f273927e82f771e59455cb7b47a92852a988d0d8fe3d407ef0e74183a48
@@ -633,7 +633,7 @@ module Google
633
633
  # A hash of the same form as `Google::Privacy::Dlp::V2::ContentItem`
634
634
  # can also be provided.
635
635
  # @param inspect_template_name [String]
636
- # Optional template to use. Any configuration directly specified in
636
+ # Template to use. Any configuration directly specified in
637
637
  # inspect_config will override those set in the template. Singular fields
638
638
  # that are set in this request will replace their corresponding fields in the
639
639
  # template. Repeated fields are appended. Singular sub-messages and groups
@@ -768,13 +768,13 @@ module Google
768
768
  # A hash of the same form as `Google::Privacy::Dlp::V2::ContentItem`
769
769
  # can also be provided.
770
770
  # @param inspect_template_name [String]
771
- # Optional template to use. Any configuration directly specified in
771
+ # Template to use. Any configuration directly specified in
772
772
  # inspect_config will override those set in the template. Singular fields
773
773
  # that are set in this request will replace their corresponding fields in the
774
774
  # template. Repeated fields are appended. Singular sub-messages and groups
775
775
  # are recursively merged.
776
776
  # @param deidentify_template_name [String]
777
- # Optional template to use. Any configuration directly specified in
777
+ # Template to use. Any configuration directly specified in
778
778
  # deidentify_config will override those set in the template. Singular fields
779
779
  # that are set in this request will replace their corresponding fields in the
780
780
  # template. Repeated fields are appended. Singular sub-messages and groups
@@ -849,13 +849,13 @@ module Google
849
849
  # A hash of the same form as `Google::Privacy::Dlp::V2::ContentItem`
850
850
  # can also be provided.
851
851
  # @param inspect_template_name [String]
852
- # Optional template to use. Any configuration directly specified in
852
+ # Template to use. Any configuration directly specified in
853
853
  # `inspect_config` will override those set in the template. Singular fields
854
854
  # that are set in this request will replace their corresponding fields in the
855
855
  # template. Repeated fields are appended. Singular sub-messages and groups
856
856
  # are recursively merged.
857
857
  # @param reidentify_template_name [String]
858
- # Optional template to use. References an instance of `DeidentifyTemplate`.
858
+ # Template to use. References an instance of `DeidentifyTemplate`.
859
859
  # Any configuration directly specified in `reidentify_config` or
860
860
  # `inspect_config` will override those set in the template. Singular fields
861
861
  # that are set in this request will replace their corresponding fields in the
@@ -907,11 +907,11 @@ module Google
907
907
  # learn more.
908
908
  #
909
909
  # @param language_code [String]
910
- # Optional BCP-47 language code for localized infoType friendly
910
+ # BCP-47 language code for localized infoType friendly
911
911
  # names. If omitted, or if localized strings are not available,
912
912
  # en-US strings will be returned.
913
913
  # @param filter [String]
914
- # Optional filter to only return infoTypes supported by certain parts of the
914
+ # filter to only return infoTypes supported by certain parts of the
915
915
  # API. Defaults to supported_by=INSPECT.
916
916
  # @param location_id [String]
917
917
  # The geographic location to list info types. Reserved for future
@@ -953,7 +953,7 @@ module Google
953
953
  # Required. The parent resource name, for example projects/my-project-id or
954
954
  # organizations/my-org-id.
955
955
  # @param inspect_template [Google::Privacy::Dlp::V2::InspectTemplate | Hash]
956
- # The InspectTemplate to create.
956
+ # Required. The InspectTemplate to create.
957
957
  # A hash of the same form as `Google::Privacy::Dlp::V2::InspectTemplate`
958
958
  # can also be provided.
959
959
  # @param template_id [String]
@@ -1086,7 +1086,7 @@ module Google
1086
1086
  # performed per-page, this determines the maximum number of
1087
1087
  # resources in a page.
1088
1088
  # @param order_by [String]
1089
- # Optional comma separated list of fields to order by,
1089
+ # Comma separated list of fields to order by,
1090
1090
  # followed by `asc` or `desc` postfix. This list is case-insensitive,
1091
1091
  # default sorting order is ascending, redundant space characters are
1092
1092
  # insignificant.
@@ -1192,7 +1192,7 @@ module Google
1192
1192
  # Required. The parent resource name, for example projects/my-project-id or
1193
1193
  # organizations/my-org-id.
1194
1194
  # @param deidentify_template [Google::Privacy::Dlp::V2::DeidentifyTemplate | Hash]
1195
- # The DeidentifyTemplate to create.
1195
+ # Required. The DeidentifyTemplate to create.
1196
1196
  # A hash of the same form as `Google::Privacy::Dlp::V2::DeidentifyTemplate`
1197
1197
  # can also be provided.
1198
1198
  # @param template_id [String]
@@ -1329,7 +1329,7 @@ module Google
1329
1329
  # performed per-page, this determines the maximum number of
1330
1330
  # resources in a page.
1331
1331
  # @param order_by [String]
1332
- # Optional comma separated list of fields to order by,
1332
+ # Comma separated list of fields to order by,
1333
1333
  # followed by `asc` or `desc` postfix. This list is case-insensitive,
1334
1334
  # default sorting order is ascending, redundant space characters are
1335
1335
  # insignificant.
@@ -1438,9 +1438,11 @@ module Google
1438
1438
  # @param parent [String]
1439
1439
  # Required. The parent resource name, for example projects/my-project-id.
1440
1440
  # @param inspect_job [Google::Privacy::Dlp::V2::InspectJobConfig | Hash]
1441
+ # Set to control what and how to inspect.
1441
1442
  # A hash of the same form as `Google::Privacy::Dlp::V2::InspectJobConfig`
1442
1443
  # can also be provided.
1443
1444
  # @param risk_job [Google::Privacy::Dlp::V2::RiskAnalysisJobConfig | Hash]
1445
+ # Set to choose what metric to calculate.
1444
1446
  # A hash of the same form as `Google::Privacy::Dlp::V2::RiskAnalysisJobConfig`
1445
1447
  # can also be provided.
1446
1448
  # @param job_id [String]
@@ -1492,14 +1494,14 @@ module Google
1492
1494
  # @param parent [String]
1493
1495
  # Required. The parent resource name, for example projects/my-project-id.
1494
1496
  # @param filter [String]
1495
- # Optional. Allows filtering.
1497
+ # Allows filtering.
1496
1498
  #
1497
1499
  # Supported syntax:
1498
1500
  #
1499
1501
  # * Filter expressions are made up of one or more restrictions.
1500
1502
  # * Restrictions can be combined by `AND` or `OR` logical operators. A
1501
1503
  # sequence of restrictions implicitly uses `AND`.
1502
- # * A restriction has the form of `<field> <operator> <value>`.
1504
+ # * A restriction has the form of `{field} {operator} {value}`.
1503
1505
  # * Supported fields/values for inspect jobs:
1504
1506
  # * `state` - PENDING|RUNNING|CANCELED|FINISHED|FAILED
1505
1507
  # * `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY
@@ -1529,7 +1531,7 @@ module Google
1529
1531
  # @param type [Google::Privacy::Dlp::V2::DlpJobType]
1530
1532
  # The type of job. Defaults to `DlpJobType.INSPECT`
1531
1533
  # @param order_by [String]
1532
- # Optional comma separated list of fields to order by,
1534
+ # Comma separated list of fields to order by,
1533
1535
  # followed by `asc` or `desc` postfix. This list is case-insensitive,
1534
1536
  # default sorting order is ascending, redundant space characters are
1535
1537
  # insignificant.
@@ -1709,7 +1711,7 @@ module Google
1709
1711
  # performed per-page, this determines the maximum number of
1710
1712
  # resources in a page.
1711
1713
  # @param order_by [String]
1712
- # Optional comma separated list of triggeredJob fields to order by,
1714
+ # Comma separated list of triggeredJob fields to order by,
1713
1715
  # followed by `asc` or `desc` postfix. This list is case-insensitive,
1714
1716
  # default sorting order is ascending, redundant space characters are
1715
1717
  # insignificant.
@@ -1725,14 +1727,14 @@ module Google
1725
1727
  # * `display_name`: corresponds to JobTrigger's display name.
1726
1728
  # * `status`: corresponds to JobTrigger's status.
1727
1729
  # @param filter [String]
1728
- # Optional. Allows filtering.
1730
+ # Allows filtering.
1729
1731
  #
1730
1732
  # Supported syntax:
1731
1733
  #
1732
1734
  # * Filter expressions are made up of one or more restrictions.
1733
1735
  # * Restrictions can be combined by `AND` or `OR` logical operators. A
1734
1736
  # sequence of restrictions implicitly uses `AND`.
1735
- # * A restriction has the form of `<field> <operator> <value>`.
1737
+ # * A restriction has the form of `{field} {operator} {value}`.
1736
1738
  # * Supported fields/values for inspect jobs:
1737
1739
  # * `status` - HEALTHY|PAUSED|CANCELLED
1738
1740
  # * `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY
@@ -1919,7 +1921,7 @@ module Google
1919
1921
  # @param parent [String]
1920
1922
  # Required. The parent resource name, for example projects/my-project-id.
1921
1923
  # @param job_trigger [Google::Privacy::Dlp::V2::JobTrigger | Hash]
1922
- # The JobTrigger to create.
1924
+ # Required. The JobTrigger to create.
1923
1925
  # A hash of the same form as `Google::Privacy::Dlp::V2::JobTrigger`
1924
1926
  # can also be provided.
1925
1927
  # @param trigger_id [String]
@@ -1970,7 +1972,7 @@ module Google
1970
1972
  # Required. The parent resource name, for example projects/my-project-id or
1971
1973
  # organizations/my-org-id.
1972
1974
  # @param config [Google::Privacy::Dlp::V2::StoredInfoTypeConfig | Hash]
1973
- # Configuration of the storedInfoType to create.
1975
+ # Required. Configuration of the storedInfoType to create.
1974
1976
  # A hash of the same form as `Google::Privacy::Dlp::V2::StoredInfoTypeConfig`
1975
1977
  # can also be provided.
1976
1978
  # @param stored_info_type_id [String]
@@ -2110,7 +2112,7 @@ module Google
2110
2112
  # performed per-page, this determines the maximum number of
2111
2113
  # resources in a page.
2112
2114
  # @param order_by [String]
2113
- # Optional comma separated list of fields to order by,
2115
+ # Comma separated list of fields to order by,
2114
2116
  # followed by `asc` or `desc` postfix. This list is case-insensitive,
2115
2117
  # default sorting order is ascending, redundant space characters are
2116
2118
  # insignificant.
@@ -89,6 +89,7 @@ module Google
89
89
  # See https://cloud.google.com/dlp/docs/likelihood to learn more.
90
90
  # @!attribute [rw] limits
91
91
  # @return [Google::Privacy::Dlp::V2::InspectConfig::FindingLimits]
92
+ # Configuration to control the number of findings returned.
92
93
  # @!attribute [rw] include_quote
93
94
  # @return [true, false]
94
95
  # When true, a contextual quote from the data that triggered a finding is
@@ -110,6 +111,7 @@ module Google
110
111
  # Exclusion rules, contained in the set are executed in the end, other
111
112
  # rules are executed in the order they are specified for each info type.
112
113
  class InspectConfig
114
+ # Configuration to control the number of findings returned.
113
115
  # @!attribute [rw] max_findings_per_item
114
116
  # @return [Integer]
115
117
  # Max number of findings that will be returned for each item scanned.
@@ -148,21 +150,30 @@ module Google
148
150
  # @return [String]
149
151
  # Content data to inspect or redact.
150
152
  class ByteContentItem
153
+ # The type of data being sent to in data.
151
154
  module BytesType
155
+ # Unused
152
156
  BYTES_TYPE_UNSPECIFIED = 0
153
157
 
158
+ # Any image type.
154
159
  IMAGE = 6
155
160
 
161
+ # jpeg
156
162
  IMAGE_JPEG = 1
157
163
 
164
+ # bmp
158
165
  IMAGE_BMP = 2
159
166
 
167
+ # png
160
168
  IMAGE_PNG = 3
161
169
 
170
+ # svg
162
171
  IMAGE_SVG = 4
163
172
 
173
+ # plain text
164
174
  TEXT_UTF8 = 5
165
175
 
176
+ # avro
166
177
  AVRO = 11
167
178
  end
168
179
  end
@@ -186,11 +197,15 @@ module Google
186
197
  # learn more.
187
198
  # @!attribute [rw] headers
188
199
  # @return [Array<Google::Privacy::Dlp::V2::FieldId>]
200
+ # Headers of the table.
189
201
  # @!attribute [rw] rows
190
202
  # @return [Array<Google::Privacy::Dlp::V2::Table::Row>]
203
+ # Rows of the table.
191
204
  class Table
205
+ # Values of the row.
192
206
  # @!attribute [rw] values
193
207
  # @return [Array<Google::Privacy::Dlp::V2::Value>]
208
+ # Individual cells.
194
209
  class Row; end
195
210
  end
196
211
 
@@ -262,9 +277,9 @@ module Google
262
277
  # The top level name is the source file name or table name. Names of some
263
278
  # common storage containers are formatted as follows:
264
279
  #
265
- # * BigQuery tables: `<project_id>:<dataset_id>.<table_id>`
266
- # * Cloud Storage files: `gs://<bucket>/<path>`
267
- # * Datastore namespace: <namespace>
280
+ # * BigQuery tables: `{project_id}:{dataset_id}.{table_id}`
281
+ # * Cloud Storage files: `gs://{bucket}/{path}`
282
+ # * Datastore namespace: \\{namespace}
268
283
  #
269
284
  # Nested names could be absent if the embedded object has no string
270
285
  # identifier (for an example an image contained within a document).
@@ -430,14 +445,14 @@ module Google
430
445
  # The item to de-identify. Will be treated as text.
431
446
  # @!attribute [rw] inspect_template_name
432
447
  # @return [String]
433
- # Optional template to use. Any configuration directly specified in
448
+ # Template to use. Any configuration directly specified in
434
449
  # inspect_config will override those set in the template. Singular fields
435
450
  # that are set in this request will replace their corresponding fields in the
436
451
  # template. Repeated fields are appended. Singular sub-messages and groups
437
452
  # are recursively merged.
438
453
  # @!attribute [rw] deidentify_template_name
439
454
  # @return [String]
440
- # Optional template to use. Any configuration directly specified in
455
+ # Template to use. Any configuration directly specified in
441
456
  # deidentify_config will override those set in the template. Singular fields
442
457
  # that are set in this request will replace their corresponding fields in the
443
458
  # template. Repeated fields are appended. Singular sub-messages and groups
@@ -481,14 +496,14 @@ module Google
481
496
  # The item to re-identify. Will be treated as text.
482
497
  # @!attribute [rw] inspect_template_name
483
498
  # @return [String]
484
- # Optional template to use. Any configuration directly specified in
499
+ # Template to use. Any configuration directly specified in
485
500
  # `inspect_config` will override those set in the template. Singular fields
486
501
  # that are set in this request will replace their corresponding fields in the
487
502
  # template. Repeated fields are appended. Singular sub-messages and groups
488
503
  # are recursively merged.
489
504
  # @!attribute [rw] reidentify_template_name
490
505
  # @return [String]
491
- # Optional template to use. References an instance of `DeidentifyTemplate`.
506
+ # Template to use. References an instance of `DeidentifyTemplate`.
492
507
  # Any configuration directly specified in `reidentify_config` or
493
508
  # `inspect_config` will override those set in the template. Singular fields
494
509
  # that are set in this request will replace their corresponding fields in the
@@ -522,7 +537,7 @@ module Google
522
537
  # The item to inspect.
523
538
  # @!attribute [rw] inspect_template_name
524
539
  # @return [String]
525
- # Optional template to use. Any configuration directly specified in
540
+ # Template to use. Any configuration directly specified in
526
541
  # inspect_config will override those set in the template. Singular fields
527
542
  # that are set in this request will replace their corresponding fields in the
528
543
  # template. Repeated fields are appended. Singular sub-messages and groups
@@ -570,6 +585,7 @@ module Google
570
585
  class OutputStorageConfig
571
586
  # Predefined schemas for storing findings.
572
587
  module OutputSchema
588
+ # Unused.
573
589
  OUTPUT_SCHEMA_UNSPECIFIED = 0
574
590
 
575
591
  # Basic schema including only `info_type`, `quote`, `certainty`, and
@@ -607,12 +623,14 @@ module Google
607
623
  # @return [Google::Privacy::Dlp::V2::InspectDataSourceDetails::Result]
608
624
  # A summary of the outcome of this inspect job.
609
625
  class InspectDataSourceDetails
626
+ # Snapshot of the inspection configuration.
610
627
  # @!attribute [rw] snapshot_inspect_template
611
628
  # @return [Google::Privacy::Dlp::V2::InspectTemplate]
612
629
  # If run with an InspectTemplate, a snapshot of its state at the time of
613
630
  # this run.
614
631
  # @!attribute [rw] job_config
615
632
  # @return [Google::Privacy::Dlp::V2::InspectJobConfig]
633
+ # Inspect config.
616
634
  class RequestedOptions; end
617
635
 
618
636
  # All result fields mentioned below are updated while the job is processing.
@@ -648,12 +666,12 @@ module Google
648
666
  # Request for the list of infoTypes.
649
667
  # @!attribute [rw] language_code
650
668
  # @return [String]
651
- # Optional BCP-47 language code for localized infoType friendly
669
+ # BCP-47 language code for localized infoType friendly
652
670
  # names. If omitted, or if localized strings are not available,
653
671
  # en-US strings will be returned.
654
672
  # @!attribute [rw] filter
655
673
  # @return [String]
656
- # Optional filter to only return infoTypes supported by certain parts of the
674
+ # filter to only return infoTypes supported by certain parts of the
657
675
  # API. Defaults to supported_by=INSPECT.
658
676
  # @!attribute [rw] location_id
659
677
  # @return [String]
@@ -684,7 +702,7 @@ module Google
684
702
  # A column with a semantic tag attached.
685
703
  # @!attribute [rw] field
686
704
  # @return [Google::Privacy::Dlp::V2::FieldId]
687
- # Identifies the column. [required]
705
+ # Required. Identifies the column.
688
706
  # @!attribute [rw] info_type
689
707
  # @return [Google::Privacy::Dlp::V2::InfoType]
690
708
  # A column can be tagged with a InfoType to use the relevant public
@@ -712,38 +730,47 @@ module Google
712
730
  # tuple is highly reidentifiable).
713
731
  # @!attribute [rw] table
714
732
  # @return [Google::Privacy::Dlp::V2::BigQueryTable]
715
- # Auxiliary table location. [required]
733
+ # Required. Auxiliary table location.
716
734
  # @!attribute [rw] quasi_ids
717
735
  # @return [Array<Google::Privacy::Dlp::V2::StatisticalTable::QuasiIdentifierField>]
718
- # Quasi-identifier columns. [required]
736
+ # Required. Quasi-identifier columns.
719
737
  # @!attribute [rw] relative_frequency
720
738
  # @return [Google::Privacy::Dlp::V2::FieldId]
721
- # The relative frequency column must contain a floating-point number
739
+ # Required. The relative frequency column must contain a floating-point number
722
740
  # between 0 and 1 (inclusive). Null values are assumed to be zero.
723
- # [required]
724
741
  class StatisticalTable
725
742
  # A quasi-identifier column has a custom_tag, used to know which column
726
743
  # in the data corresponds to which column in the statistical model.
727
744
  # @!attribute [rw] field
728
745
  # @return [Google::Privacy::Dlp::V2::FieldId]
746
+ # Identifies the column.
729
747
  # @!attribute [rw] custom_tag
730
748
  # @return [String]
749
+ # A column can be tagged with a custom tag. In this case, the user must
750
+ # indicate an auxiliary table that contains statistical information on
751
+ # the possible values of this column (below).
731
752
  class QuasiIdentifierField; end
732
753
  end
733
754
 
734
755
  # Privacy metric to compute for reidentification risk analysis.
735
756
  # @!attribute [rw] numerical_stats_config
736
757
  # @return [Google::Privacy::Dlp::V2::PrivacyMetric::NumericalStatsConfig]
758
+ # Numerical stats
737
759
  # @!attribute [rw] categorical_stats_config
738
760
  # @return [Google::Privacy::Dlp::V2::PrivacyMetric::CategoricalStatsConfig]
761
+ # Categorical stats
739
762
  # @!attribute [rw] k_anonymity_config
740
763
  # @return [Google::Privacy::Dlp::V2::PrivacyMetric::KAnonymityConfig]
764
+ # K-anonymity
741
765
  # @!attribute [rw] l_diversity_config
742
766
  # @return [Google::Privacy::Dlp::V2::PrivacyMetric::LDiversityConfig]
767
+ # l-diversity
743
768
  # @!attribute [rw] k_map_estimation_config
744
769
  # @return [Google::Privacy::Dlp::V2::PrivacyMetric::KMapEstimationConfig]
770
+ # k-map
745
771
  # @!attribute [rw] delta_presence_estimation_config
746
772
  # @return [Google::Privacy::Dlp::V2::PrivacyMetric::DeltaPresenceEstimationConfig]
773
+ # delta-presence
747
774
  class PrivacyMetric
748
775
  # Compute numerical stats over an individual column, including
749
776
  # min, max, and quantiles.
@@ -773,7 +800,7 @@ module Google
773
800
  # a repeated field.
774
801
  # @!attribute [rw] entity_id
775
802
  # @return [Google::Privacy::Dlp::V2::EntityId]
776
- # Optional message indicating that multiple rows might be associated to a
803
+ # Message indicating that multiple rows might be associated to a
777
804
  # single individual. If the same entity_id is associated to multiple
778
805
  # quasi-identifier tuples over distinct rows, we consider the entire
779
806
  # collection of tuples as the composite quasi-identifier. This collection
@@ -802,15 +829,14 @@ module Google
802
829
  # using publicly available data (like the US Census), or using a custom
803
830
  # statistical model (indicated as one or several BigQuery tables), or by
804
831
  # extrapolating from the distribution of values in the input dataset.
805
- # A column with a semantic tag attached.
806
832
  # @!attribute [rw] quasi_ids
807
833
  # @return [Array<Google::Privacy::Dlp::V2::PrivacyMetric::KMapEstimationConfig::TaggedField>]
808
- # Fields considered to be quasi-identifiers. No two columns can have the
809
- # same tag. [required]
834
+ # Required. Fields considered to be quasi-identifiers. No two columns can have the
835
+ # same tag.
810
836
  # @!attribute [rw] region_code
811
837
  # @return [String]
812
838
  # ISO 3166-1 alpha-2 region code to use in the statistical modeling.
813
- # Required if no column is tagged with a region-specific InfoType (like
839
+ # Set if no column is tagged with a region-specific InfoType (like
814
840
  # US_ZIP_5) or a region code.
815
841
  # @!attribute [rw] auxiliary_tables
816
842
  # @return [Array<Google::Privacy::Dlp::V2::PrivacyMetric::KMapEstimationConfig::AuxiliaryTable>]
@@ -818,9 +844,10 @@ module Google
818
844
  # used to tag a quasi-identifiers column must appear in exactly one column
819
845
  # of one auxiliary table.
820
846
  class KMapEstimationConfig
847
+ # A column with a semantic tag attached.
821
848
  # @!attribute [rw] field
822
849
  # @return [Google::Privacy::Dlp::V2::FieldId]
823
- # Identifies the column. [required]
850
+ # Required. Identifies the column.
824
851
  # @!attribute [rw] info_type
825
852
  # @return [Google::Privacy::Dlp::V2::InfoType]
826
853
  # A column can be tagged with a InfoType to use the relevant public
@@ -848,22 +875,23 @@ module Google
848
875
  # tuple is highly reidentifiable).
849
876
  # @!attribute [rw] table
850
877
  # @return [Google::Privacy::Dlp::V2::BigQueryTable]
851
- # Auxiliary table location. [required]
878
+ # Required. Auxiliary table location.
852
879
  # @!attribute [rw] quasi_ids
853
880
  # @return [Array<Google::Privacy::Dlp::V2::PrivacyMetric::KMapEstimationConfig::AuxiliaryTable::QuasiIdField>]
854
- # Quasi-identifier columns. [required]
881
+ # Required. Quasi-identifier columns.
855
882
  # @!attribute [rw] relative_frequency
856
883
  # @return [Google::Privacy::Dlp::V2::FieldId]
857
- # The relative frequency column must contain a floating-point number
884
+ # Required. The relative frequency column must contain a floating-point number
858
885
  # between 0 and 1 (inclusive). Null values are assumed to be zero.
859
- # [required]
860
886
  class AuxiliaryTable
861
887
  # A quasi-identifier column has a custom_tag, used to know which column
862
888
  # in the data corresponds to which column in the statistical model.
863
889
  # @!attribute [rw] field
864
890
  # @return [Google::Privacy::Dlp::V2::FieldId]
891
+ # Identifies the column.
865
892
  # @!attribute [rw] custom_tag
866
893
  # @return [String]
894
+ # A auxiliary field.
867
895
  class QuasiIdField; end
868
896
  end
869
897
  end
@@ -874,12 +902,12 @@ module Google
874
902
  # knowing the attack dataset, so we use a statistical model instead.
875
903
  # @!attribute [rw] quasi_ids
876
904
  # @return [Array<Google::Privacy::Dlp::V2::QuasiId>]
877
- # Fields considered to be quasi-identifiers. No two fields can have the
878
- # same tag. [required]
905
+ # Required. Fields considered to be quasi-identifiers. No two fields can have the
906
+ # same tag.
879
907
  # @!attribute [rw] region_code
880
908
  # @return [String]
881
909
  # ISO 3166-1 alpha-2 region code to use in the statistical modeling.
882
- # Required if no column is tagged with a region-specific InfoType (like
910
+ # Set if no column is tagged with a region-specific InfoType (like
883
911
  # US_ZIP_5) or a region code.
884
912
  # @!attribute [rw] auxiliary_tables
885
913
  # @return [Array<Google::Privacy::Dlp::V2::StatisticalTable>]
@@ -898,16 +926,22 @@ module Google
898
926
  # Input dataset to compute metrics over.
899
927
  # @!attribute [rw] numerical_stats_result
900
928
  # @return [Google::Privacy::Dlp::V2::AnalyzeDataSourceRiskDetails::NumericalStatsResult]
929
+ # Numerical stats result
901
930
  # @!attribute [rw] categorical_stats_result
902
931
  # @return [Google::Privacy::Dlp::V2::AnalyzeDataSourceRiskDetails::CategoricalStatsResult]
932
+ # Categorical stats result
903
933
  # @!attribute [rw] k_anonymity_result
904
934
  # @return [Google::Privacy::Dlp::V2::AnalyzeDataSourceRiskDetails::KAnonymityResult]
935
+ # K-anonymity result
905
936
  # @!attribute [rw] l_diversity_result
906
937
  # @return [Google::Privacy::Dlp::V2::AnalyzeDataSourceRiskDetails::LDiversityResult]
938
+ # L-divesity result
907
939
  # @!attribute [rw] k_map_estimation_result
908
940
  # @return [Google::Privacy::Dlp::V2::AnalyzeDataSourceRiskDetails::KMapEstimationResult]
941
+ # K-map result
909
942
  # @!attribute [rw] delta_presence_estimation_result
910
943
  # @return [Google::Privacy::Dlp::V2::AnalyzeDataSourceRiskDetails::DeltaPresenceEstimationResult]
944
+ # Delta-presence result
911
945
  class AnalyzeDataSourceRiskDetails
912
946
  # Result of the numerical stats computation.
913
947
  # @!attribute [rw] min_value
@@ -927,6 +961,7 @@ module Google
927
961
  # @return [Array<Google::Privacy::Dlp::V2::AnalyzeDataSourceRiskDetails::CategoricalStatsResult::CategoricalStatsHistogramBucket>]
928
962
  # Histogram of value frequencies in the column.
929
963
  class CategoricalStatsResult
964
+ # Histogram of value frequencies in the column.
930
965
  # @!attribute [rw] value_frequency_lower_bound
931
966
  # @return [Integer]
932
967
  # Lower bound on the value frequency of the values in this bucket.
@@ -963,6 +998,7 @@ module Google
963
998
  # above set of values.
964
999
  class KAnonymityEquivalenceClass; end
965
1000
 
1001
+ # Histogram of k-anonymity equivalence classes.
966
1002
  # @!attribute [rw] equivalence_class_size_lower_bound
967
1003
  # @return [Integer]
968
1004
  # Lower bound on the size of the equivalence classes in this bucket.
@@ -1003,6 +1039,7 @@ module Google
1003
1039
  # Estimated frequencies of top sensitive values.
1004
1040
  class LDiversityEquivalenceClass; end
1005
1041
 
1042
+ # Histogram of l-diversity equivalence class sensitive value frequencies.
1006
1043
  # @!attribute [rw] sensitive_value_frequency_lower_bound
1007
1044
  # @return [Integer]
1008
1045
  # Lower bound on the sensitive value frequencies of the equivalence
@@ -1148,20 +1185,28 @@ module Google
1148
1185
  # int64 only holds up to 8 bytes of data.
1149
1186
  # @!attribute [rw] integer_value
1150
1187
  # @return [Integer]
1188
+ # integer
1151
1189
  # @!attribute [rw] float_value
1152
1190
  # @return [Float]
1191
+ # float
1153
1192
  # @!attribute [rw] string_value
1154
1193
  # @return [String]
1194
+ # string
1155
1195
  # @!attribute [rw] boolean_value
1156
1196
  # @return [true, false]
1197
+ # boolean
1157
1198
  # @!attribute [rw] timestamp_value
1158
1199
  # @return [Google::Protobuf::Timestamp]
1200
+ # timestamp
1159
1201
  # @!attribute [rw] time_value
1160
1202
  # @return [Google::Type::TimeOfDay]
1203
+ # time of day
1161
1204
  # @!attribute [rw] date_value
1162
1205
  # @return [Google::Type::Date]
1206
+ # date
1163
1207
  # @!attribute [rw] day_of_week_value
1164
1208
  # @return [Google::Type::DayOfWeek]
1209
+ # day of week
1165
1210
  class Value; end
1166
1211
 
1167
1212
  # Message for infoType-dependent details parsed from quote.
@@ -1174,15 +1219,19 @@ module Google
1174
1219
  # e.g. 2018-01-01, 5th August.
1175
1220
  # @!attribute [rw] date
1176
1221
  # @return [Google::Type::Date]
1177
- # One or more of the following must be set. All fields are optional, but
1178
- # when set must be valid date or time values.
1222
+ # One or more of the following must be set.
1223
+ # Must be a valid date or time value.
1179
1224
  # @!attribute [rw] day_of_week
1180
1225
  # @return [Google::Type::DayOfWeek]
1226
+ # Day of week
1181
1227
  # @!attribute [rw] time
1182
1228
  # @return [Google::Type::TimeOfDay]
1229
+ # Time of day
1183
1230
  # @!attribute [rw] time_zone
1184
1231
  # @return [Google::Privacy::Dlp::V2::DateTime::TimeZone]
1232
+ # Time zone
1185
1233
  class DateTime
1234
+ # Time zone of the date time object.
1186
1235
  # @!attribute [rw] offset_minutes
1187
1236
  # @return [Integer]
1188
1237
  # Set only if the offset can be determined. Positive for time ahead of UTC.
@@ -1205,34 +1254,48 @@ module Google
1205
1254
  # A rule for transforming a value.
1206
1255
  # @!attribute [rw] replace_config
1207
1256
  # @return [Google::Privacy::Dlp::V2::ReplaceValueConfig]
1257
+ # Replace
1208
1258
  # @!attribute [rw] redact_config
1209
1259
  # @return [Google::Privacy::Dlp::V2::RedactConfig]
1260
+ # Redact
1210
1261
  # @!attribute [rw] character_mask_config
1211
1262
  # @return [Google::Privacy::Dlp::V2::CharacterMaskConfig]
1263
+ # Mask
1212
1264
  # @!attribute [rw] crypto_replace_ffx_fpe_config
1213
1265
  # @return [Google::Privacy::Dlp::V2::CryptoReplaceFfxFpeConfig]
1266
+ # Ffx-Fpe
1214
1267
  # @!attribute [rw] fixed_size_bucketing_config
1215
1268
  # @return [Google::Privacy::Dlp::V2::FixedSizeBucketingConfig]
1269
+ # Fixed size bucketing
1216
1270
  # @!attribute [rw] bucketing_config
1217
1271
  # @return [Google::Privacy::Dlp::V2::BucketingConfig]
1272
+ # Bucketing
1218
1273
  # @!attribute [rw] replace_with_info_type_config
1219
1274
  # @return [Google::Privacy::Dlp::V2::ReplaceWithInfoTypeConfig]
1275
+ # Replace with infotype
1220
1276
  # @!attribute [rw] time_part_config
1221
1277
  # @return [Google::Privacy::Dlp::V2::TimePartConfig]
1278
+ # Time extraction
1222
1279
  # @!attribute [rw] crypto_hash_config
1223
1280
  # @return [Google::Privacy::Dlp::V2::CryptoHashConfig]
1281
+ # Crypto
1224
1282
  # @!attribute [rw] date_shift_config
1225
1283
  # @return [Google::Privacy::Dlp::V2::DateShiftConfig]
1284
+ # Date Shift
1226
1285
  # @!attribute [rw] crypto_deterministic_config
1227
1286
  # @return [Google::Privacy::Dlp::V2::CryptoDeterministicConfig]
1287
+ # Deterministic Crypto
1228
1288
  class PrimitiveTransformation; end
1229
1289
 
1230
1290
  # For use with `Date`, `Timestamp`, and `TimeOfDay`, extract or preserve a
1231
1291
  # portion of the value.
1232
1292
  # @!attribute [rw] part_to_extract
1233
1293
  # @return [Google::Privacy::Dlp::V2::TimePartConfig::TimePart]
1294
+ # The part of the time to keep.
1234
1295
  class TimePartConfig
1296
+ # Components that make up time.
1235
1297
  module TimePart
1298
+ # Unused
1236
1299
  TIME_PART_UNSPECIFIED = 0
1237
1300
 
1238
1301
  # [0-9999]
@@ -1279,7 +1342,7 @@ module Google
1279
1342
  # This annotation will be applied to the surrogate by prefixing it with
1280
1343
  # the name of the custom info type followed by the number of
1281
1344
  # characters comprising the surrogate. The following scheme defines the
1282
- # format: <info type name>(<surrogate character count>):<surrogate>
1345
+ # format: {info type name}({surrogate character count}):\\{surrogate}
1283
1346
  #
1284
1347
  # For example, if the name of custom info type is 'MY_TOKEN_INFO_TYPE' and
1285
1348
  # the surrogate is 'abc', the full replacement value
@@ -1290,7 +1353,7 @@ module Google
1290
1353
  # surrogate when it occurs in free text.
1291
1354
  #
1292
1355
  # Note: For record transformations where the entire cell in a table is being
1293
- # transformed, surrogates are optional to use. Surrogates are used to denote
1356
+ # transformed, surrogates are not mandatory. Surrogates are used to denote
1294
1357
  # the location of the token and are necessary for re-identification in free
1295
1358
  # form text.
1296
1359
  #
@@ -1309,7 +1372,7 @@ module Google
1309
1372
  # ⧝MY_TOKEN_TYPE.
1310
1373
  # @!attribute [rw] context
1311
1374
  # @return [Google::Privacy::Dlp::V2::FieldId]
1312
- # Optional. A context may be used for higher security and maintaining
1375
+ # A context may be used for higher security and maintaining
1313
1376
  # referential integrity such that the same identifier in two different
1314
1377
  # contexts will be given a distinct surrogate. The context is appended to
1315
1378
  # plaintext value being encrypted. On decryption the provided context is
@@ -1347,10 +1410,15 @@ module Google
1347
1410
  # alone and skipped.
1348
1411
  # @!attribute [rw] characters_to_skip
1349
1412
  # @return [String]
1413
+ # Characters to not transform when masking.
1350
1414
  # @!attribute [rw] common_characters_to_ignore
1351
1415
  # @return [Google::Privacy::Dlp::V2::CharsToIgnore::CommonCharsToIgnore]
1416
+ # Common characters to not transform when masking. Useful to avoid removing
1417
+ # punctuation.
1352
1418
  class CharsToIgnore
1419
+ # Convenience enum for indication common characters to not transform.
1353
1420
  module CommonCharsToIgnore
1421
+ # Unused.
1354
1422
  COMMON_CHARS_TO_IGNORE_UNSPECIFIED = 0
1355
1423
 
1356
1424
  # 0-9
@@ -1407,7 +1475,7 @@ module Google
1407
1475
  # the user for simple bucketing strategies.
1408
1476
  #
1409
1477
  # The transformed value will be a hyphenated string of
1410
- # <lower_bound>-<upper_bound>, i.e if lower_bound = 10 and upper_bound = 20
1478
+ # \\{lower_bound}-\\{upper_bound}, i.e if lower_bound = 10 and upper_bound = 20
1411
1479
  # all values that are within this bucket will be replaced with "10-20".
1412
1480
  #
1413
1481
  # This can be used on data of type: double, long.
@@ -1419,21 +1487,20 @@ module Google
1419
1487
  # See https://cloud.google.com/dlp/docs/concepts-bucketing to learn more.
1420
1488
  # @!attribute [rw] lower_bound
1421
1489
  # @return [Google::Privacy::Dlp::V2::Value]
1422
- # Lower bound value of buckets. All values less than `lower_bound` are
1490
+ # Required. Lower bound value of buckets. All values less than `lower_bound` are
1423
1491
  # grouped together into a single bucket; for example if `lower_bound` = 10,
1424
- # then all values less than 10 are replaced with the value “-10”. [Required].
1492
+ # then all values less than 10 are replaced with the value “-10”.
1425
1493
  # @!attribute [rw] upper_bound
1426
1494
  # @return [Google::Privacy::Dlp::V2::Value]
1427
- # Upper bound value of buckets. All values greater than upper_bound are
1495
+ # Required. Upper bound value of buckets. All values greater than upper_bound are
1428
1496
  # grouped together into a single bucket; for example if `upper_bound` = 89,
1429
1497
  # then all values greater than 89 are replaced with the value “89+”.
1430
- # [Required].
1431
1498
  # @!attribute [rw] bucket_size
1432
1499
  # @return [Float]
1433
- # Size of each bucket (except for minimum and maximum buckets). So if
1500
+ # Required. Size of each bucket (except for minimum and maximum buckets). So if
1434
1501
  # `lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the
1435
1502
  # following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60,
1436
- # 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. [Required].
1503
+ # 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works.
1437
1504
  class FixedSizeBucketingConfig; end
1438
1505
 
1439
1506
  # Generalization function that buckets values based on ranges. The ranges and
@@ -1479,7 +1546,7 @@ module Google
1479
1546
  # referential integrity.
1480
1547
  # @!attribute [rw] crypto_key
1481
1548
  # @return [Google::Privacy::Dlp::V2::CryptoKey]
1482
- # The key used by the encryption algorithm. [required]
1549
+ # Required. The key used by the encryption algorithm.
1483
1550
  # @!attribute [rw] context
1484
1551
  # @return [Google::Privacy::Dlp::V2::FieldId]
1485
1552
  # The 'tweak', a context may be used for higher security since the same
@@ -1504,6 +1571,7 @@ module Google
1504
1571
  # * a string is encoded in UTF-8 format followed by a single byte of value 2
1505
1572
  # @!attribute [rw] common_alphabet
1506
1573
  # @return [Google::Privacy::Dlp::V2::CryptoReplaceFfxFpeConfig::FfxCommonNativeAlphabet]
1574
+ # Common alphabets.
1507
1575
  # @!attribute [rw] custom_alphabet
1508
1576
  # @return [String]
1509
1577
  # This is supported by mapping these to the alphanumeric characters
@@ -1548,6 +1616,7 @@ module Google
1548
1616
  # natively supports. In the algorithm, the alphabet is selected using
1549
1617
  # the "radix". Therefore each corresponds to particular radix.
1550
1618
  module FfxCommonNativeAlphabet
1619
+ # Unused.
1551
1620
  FFX_COMMON_NATIVE_ALPHABET_UNSPECIFIED = 0
1552
1621
 
1553
1622
  # [0-9] (radix of 10)
@@ -1571,17 +1640,20 @@ module Google
1571
1640
  # unwrap the data crypto key.
1572
1641
  # @!attribute [rw] transient
1573
1642
  # @return [Google::Privacy::Dlp::V2::TransientCryptoKey]
1643
+ # Transient crypto key
1574
1644
  # @!attribute [rw] unwrapped
1575
1645
  # @return [Google::Privacy::Dlp::V2::UnwrappedCryptoKey]
1646
+ # Unwrapped crypto key
1576
1647
  # @!attribute [rw] kms_wrapped
1577
1648
  # @return [Google::Privacy::Dlp::V2::KmsWrappedCryptoKey]
1649
+ # Kms wrapped key
1578
1650
  class CryptoKey; end
1579
1651
 
1580
1652
  # Use this to have a random data crypto key generated.
1581
1653
  # It will be discarded after the request finishes.
1582
1654
  # @!attribute [rw] name
1583
1655
  # @return [String]
1584
- # Name of the key. [required]
1656
+ # Required. Name of the key.
1585
1657
  # This is an arbitrary string used to differentiate different keys.
1586
1658
  # A unique key is generated per name: two separate `TransientCryptoKey`
1587
1659
  # protos share the same generated key if their names are the same.
@@ -1593,7 +1665,7 @@ module Google
1593
1665
  # leaking the key. Choose another type of key if possible.
1594
1666
  # @!attribute [rw] key
1595
1667
  # @return [String]
1596
- # A 128/192/256 bit key. [required]
1668
+ # Required. A 128/192/256 bit key.
1597
1669
  class UnwrappedCryptoKey; end
1598
1670
 
1599
1671
  # Include to use an existing data crypto key wrapped by KMS.
@@ -1603,10 +1675,10 @@ module Google
1603
1675
  # dlp.kms.encrypt
1604
1676
  # @!attribute [rw] wrapped_key
1605
1677
  # @return [String]
1606
- # The wrapped data crypto key. [required]
1678
+ # Required. The wrapped data crypto key.
1607
1679
  # @!attribute [rw] crypto_key_name
1608
1680
  # @return [String]
1609
- # The resource name of the KMS CryptoKey to use for unwrapping. [required]
1681
+ # Required. The resource name of the KMS CryptoKey to use for unwrapping.
1610
1682
  class KmsWrappedCryptoKey; end
1611
1683
 
1612
1684
  # Shifts dates by random number of days, with option to be consistent for the
@@ -1614,16 +1686,14 @@ module Google
1614
1686
  # to learn more.
1615
1687
  # @!attribute [rw] upper_bound_days
1616
1688
  # @return [Integer]
1617
- # Range of shift in days. Actual shift will be selected at random within this
1689
+ # Required. Range of shift in days. Actual shift will be selected at random within this
1618
1690
  # range (inclusive ends). Negative means shift to earlier in time. Must not
1619
1691
  # be more than 365250 days (1000 years) each direction.
1620
1692
  #
1621
1693
  # For example, 3 means shift date to at most 3 days into the future.
1622
- # [Required]
1623
1694
  # @!attribute [rw] lower_bound_days
1624
1695
  # @return [Integer]
1625
- # For example, -5 means shift date to at most 5 days back in the past.
1626
- # [Required]
1696
+ # Required. For example, -5 means shift date to at most 5 days back in the past.
1627
1697
  # @!attribute [rw] context
1628
1698
  # @return [Google::Privacy::Dlp::V2::FieldId]
1629
1699
  # Points to the field that contains the context, for example, an entity id.
@@ -1642,8 +1712,8 @@ module Google
1642
1712
  # info_type.
1643
1713
  # @!attribute [rw] transformations
1644
1714
  # @return [Array<Google::Privacy::Dlp::V2::InfoTypeTransformations::InfoTypeTransformation>]
1645
- # Transformation for each infoType. Cannot specify more than one
1646
- # for a given infoType. [required]
1715
+ # Required. Transformation for each infoType. Cannot specify more than one
1716
+ # for a given infoType.
1647
1717
  class InfoTypeTransformations
1648
1718
  # A transformation to apply to text that is identified as a specific
1649
1719
  # info_type.
@@ -1654,19 +1724,19 @@ module Google
1654
1724
  # infoTypes that were requested in `InspectConfig`.
1655
1725
  # @!attribute [rw] primitive_transformation
1656
1726
  # @return [Google::Privacy::Dlp::V2::PrimitiveTransformation]
1657
- # Primitive transformation to apply to the infoType. [required]
1727
+ # Required. Primitive transformation to apply to the infoType.
1658
1728
  class InfoTypeTransformation; end
1659
1729
  end
1660
1730
 
1661
1731
  # The transformation to apply to the field.
1662
1732
  # @!attribute [rw] fields
1663
1733
  # @return [Array<Google::Privacy::Dlp::V2::FieldId>]
1664
- # Input field(s) to apply the transformation to. [required]
1734
+ # Required. Input field(s) to apply the transformation to.
1665
1735
  # @!attribute [rw] condition
1666
1736
  # @return [Google::Privacy::Dlp::V2::RecordCondition]
1667
1737
  # Only apply the transformation if the condition evaluates to true for the
1668
1738
  # given `RecordCondition`. The conditions are allowed to reference fields
1669
- # that are not used in the actual transformation. [optional]
1739
+ # that are not used in the actual transformation.
1670
1740
  #
1671
1741
  # Example Use Cases:
1672
1742
  #
@@ -1690,7 +1760,7 @@ module Google
1690
1760
  # @!attribute [rw] record_suppressions
1691
1761
  # @return [Array<Google::Privacy::Dlp::V2::RecordSuppression>]
1692
1762
  # Configuration defining which records get suppressed entirely. Records that
1693
- # match any suppression rule are omitted from the output [optional].
1763
+ # match any suppression rule are omitted from the output.
1694
1764
  class RecordTransformations; end
1695
1765
 
1696
1766
  # Configuration to suppress records whose suppression conditions evaluate to
@@ -1728,18 +1798,19 @@ module Google
1728
1798
  # the condition will evaluate to false.
1729
1799
  # @!attribute [rw] field
1730
1800
  # @return [Google::Privacy::Dlp::V2::FieldId]
1731
- # Field within the record this condition is evaluated against. [required]
1801
+ # Required. Field within the record this condition is evaluated against.
1732
1802
  # @!attribute [rw] operator
1733
1803
  # @return [Google::Privacy::Dlp::V2::RelationalOperator]
1734
- # Operator used to compare the field or infoType to the value. [required]
1804
+ # Required. Operator used to compare the field or infoType to the value.
1735
1805
  # @!attribute [rw] value
1736
1806
  # @return [Google::Privacy::Dlp::V2::Value]
1737
- # Value to compare against. [Required, except for `EXISTS` tests.]
1807
+ # Value to compare against. [Mandatory, except for `EXISTS` tests.]
1738
1808
  class Condition; end
1739
1809
 
1740
1810
  # A collection of conditions.
1741
1811
  # @!attribute [rw] conditions
1742
1812
  # @return [Array<Google::Privacy::Dlp::V2::RecordCondition::Condition>]
1813
+ # A collection of conditions.
1743
1814
  class Conditions; end
1744
1815
 
1745
1816
  # An expression, consisting or an operator and conditions.
@@ -1749,10 +1820,14 @@ module Google
1749
1820
  # only supported value is `AND`.
1750
1821
  # @!attribute [rw] conditions
1751
1822
  # @return [Google::Privacy::Dlp::V2::RecordCondition::Conditions]
1823
+ # Conditions to apply to the expression.
1752
1824
  class Expressions
1825
+ # Logical operators for conditional checks.
1753
1826
  module LogicalOperator
1827
+ # Unused
1754
1828
  LOGICAL_OPERATOR_UNSPECIFIED = 0
1755
1829
 
1830
+ # Conditional AND
1756
1831
  AND = 1
1757
1832
  end
1758
1833
  end
@@ -1789,6 +1864,7 @@ module Google
1789
1864
  # The specific suppression option these stats apply to.
1790
1865
  # @!attribute [rw] results
1791
1866
  # @return [Array<Google::Privacy::Dlp::V2::TransformationSummary::SummaryResult>]
1867
+ # Collection of all transformations that took place or had an error.
1792
1868
  # @!attribute [rw] transformed_bytes
1793
1869
  # @return [Integer]
1794
1870
  # Total size in bytes that were transformed in some way.
@@ -1797,8 +1873,10 @@ module Google
1797
1873
  # `TransformationResultCode` and error details occurred.
1798
1874
  # @!attribute [rw] count
1799
1875
  # @return [Integer]
1876
+ # Number of transformations counted by this result.
1800
1877
  # @!attribute [rw] code
1801
1878
  # @return [Google::Privacy::Dlp::V2::TransformationSummary::TransformationResultCode]
1879
+ # Outcome of the transformation.
1802
1880
  # @!attribute [rw] details
1803
1881
  # @return [String]
1804
1882
  # A place for warnings or errors to show up if a transformation didn't
@@ -1807,10 +1885,13 @@ module Google
1807
1885
 
1808
1886
  # Possible outcomes of transformations.
1809
1887
  module TransformationResultCode
1888
+ # Unused
1810
1889
  TRANSFORMATION_RESULT_CODE_UNSPECIFIED = 0
1811
1890
 
1891
+ # Transformation completed without an error.
1812
1892
  SUCCESS = 1
1813
1893
 
1894
+ # Transformation had an error.
1814
1895
  ERROR = 2
1815
1896
  end
1816
1897
  end
@@ -1834,11 +1915,11 @@ module Google
1834
1915
  # to learn more.
1835
1916
  # @!attribute [rw] name
1836
1917
  # @return [String]
1837
- # The template name. Output only.
1918
+ # Output only. The template name.
1838
1919
  #
1839
1920
  # The template will have one of the following formats:
1840
1921
  # `projects/PROJECT_ID/inspectTemplates/TEMPLATE_ID` OR
1841
- # `organizations/ORGANIZATION_ID/inspectTemplates/TEMPLATE_ID`
1922
+ # `organizations/ORGANIZATION_ID/inspectTemplates/TEMPLATE_ID`;
1842
1923
  # @!attribute [rw] display_name
1843
1924
  # @return [String]
1844
1925
  # Display name (max 256 chars).
@@ -1847,10 +1928,10 @@ module Google
1847
1928
  # Short description (max 256 chars).
1848
1929
  # @!attribute [rw] create_time
1849
1930
  # @return [Google::Protobuf::Timestamp]
1850
- # The creation timestamp of an inspectTemplate, output only field.
1931
+ # Output only. The creation timestamp of an inspectTemplate.
1851
1932
  # @!attribute [rw] update_time
1852
1933
  # @return [Google::Protobuf::Timestamp]
1853
- # The last update timestamp of an inspectTemplate, output only field.
1934
+ # Output only. The last update timestamp of an inspectTemplate.
1854
1935
  # @!attribute [rw] inspect_config
1855
1936
  # @return [Google::Privacy::Dlp::V2::InspectConfig]
1856
1937
  # The core content of the template. Configuration of the scanning process.
@@ -1860,7 +1941,7 @@ module Google
1860
1941
  # See https://cloud.google.com/dlp/docs/concepts-templates to learn more.
1861
1942
  # @!attribute [rw] name
1862
1943
  # @return [String]
1863
- # The template name. Output only.
1944
+ # Output only. The template name.
1864
1945
  #
1865
1946
  # The template will have one of the following formats:
1866
1947
  # `projects/PROJECT_ID/deidentifyTemplates/TEMPLATE_ID` OR
@@ -1873,10 +1954,10 @@ module Google
1873
1954
  # Short description (max 256 chars).
1874
1955
  # @!attribute [rw] create_time
1875
1956
  # @return [Google::Protobuf::Timestamp]
1876
- # The creation timestamp of an inspectTemplate, output only field.
1957
+ # Output only. The creation timestamp of an inspectTemplate.
1877
1958
  # @!attribute [rw] update_time
1878
1959
  # @return [Google::Protobuf::Timestamp]
1879
- # The last update timestamp of an inspectTemplate, output only field.
1960
+ # Output only. The last update timestamp of an inspectTemplate.
1880
1961
  # @!attribute [rw] deidentify_config
1881
1962
  # @return [Google::Privacy::Dlp::V2::DeidentifyConfig]
1882
1963
  # ///////////// // The core content of the template // ///////////////
@@ -1884,9 +1965,9 @@ module Google
1884
1965
 
1885
1966
  # Details information about an error encountered during job execution or
1886
1967
  # the results of an unsuccessful activation of the JobTrigger.
1887
- # Output only field.
1888
1968
  # @!attribute [rw] details
1889
1969
  # @return [Google::Rpc::Status]
1970
+ # Detailed error codes and messages.
1890
1971
  # @!attribute [rw] timestamps
1891
1972
  # @return [Array<Google::Protobuf::Timestamp>]
1892
1973
  # The times the error occurred.
@@ -1907,6 +1988,7 @@ module Google
1907
1988
  # User provided description (max 256 chars)
1908
1989
  # @!attribute [rw] inspect_job
1909
1990
  # @return [Google::Privacy::Dlp::V2::InspectJobConfig]
1991
+ # For inspect jobs, a snapshot of the configuration.
1910
1992
  # @!attribute [rw] triggers
1911
1993
  # @return [Array<Google::Privacy::Dlp::V2::JobTrigger::Trigger>]
1912
1994
  # A list of triggers which will be OR'ed together. Only one in the list
@@ -1914,22 +1996,22 @@ module Google
1914
1996
  # a single Schedule trigger and must have at least one object.
1915
1997
  # @!attribute [rw] errors
1916
1998
  # @return [Array<Google::Privacy::Dlp::V2::Error>]
1917
- # A stream of errors encountered when the trigger was activated. Repeated
1999
+ # Output only. A stream of errors encountered when the trigger was activated. Repeated
1918
2000
  # errors may result in the JobTrigger automatically being paused.
1919
2001
  # Will return the last 100 errors. Whenever the JobTrigger is modified
1920
- # this list will be cleared. Output only field.
2002
+ # this list will be cleared.
1921
2003
  # @!attribute [rw] create_time
1922
2004
  # @return [Google::Protobuf::Timestamp]
1923
- # The creation timestamp of a triggeredJob, output only field.
2005
+ # Output only. The creation timestamp of a triggeredJob.
1924
2006
  # @!attribute [rw] update_time
1925
2007
  # @return [Google::Protobuf::Timestamp]
1926
- # The last update timestamp of a triggeredJob, output only field.
2008
+ # Output only. The last update timestamp of a triggeredJob.
1927
2009
  # @!attribute [rw] last_run_time
1928
2010
  # @return [Google::Protobuf::Timestamp]
1929
- # The timestamp of the last time this trigger executed, output only field.
2011
+ # Output only. The timestamp of the last time this trigger executed.
1930
2012
  # @!attribute [rw] status
1931
2013
  # @return [Google::Privacy::Dlp::V2::JobTrigger::Status]
1932
- # A status for this trigger. [required]
2014
+ # Required. A status for this trigger.
1933
2015
  class JobTrigger
1934
2016
  # What event needs to occur for a new job to be started.
1935
2017
  # @!attribute [rw] schedule
@@ -1942,6 +2024,7 @@ module Google
1942
2024
  # pause triggers experiencing frequent errors. To restart a job, set the
1943
2025
  # status to HEALTHY after correcting user errors.
1944
2026
  module Status
2027
+ # Unused.
1945
2028
  STATUS_UNSPECIFIED = 0
1946
2029
 
1947
2030
  # Trigger is healthy.
@@ -1971,7 +2054,7 @@ module Google
1971
2054
  # Publish findings to Cloud Datahub.
1972
2055
  # @!attribute [rw] job_notification_emails
1973
2056
  # @return [Google::Privacy::Dlp::V2::Action::JobNotificationEmails]
1974
- # Enable email notification to project owners and editors on job's
2057
+ # Enable email notification for project owners and editors on job's
1975
2058
  # completion/failure.
1976
2059
  # @!attribute [rw] publish_to_stackdriver
1977
2060
  # @return [Google::Privacy::Dlp::V2::Action::PublishToStackdriver]
@@ -1983,6 +2066,7 @@ module Google
1983
2066
  # Compatible with: Inspect, Risk
1984
2067
  # @!attribute [rw] output_config
1985
2068
  # @return [Google::Privacy::Dlp::V2::OutputStorageConfig]
2069
+ # Location to store findings outside of DLP.
1986
2070
  class SaveFindings; end
1987
2071
 
1988
2072
  # Publish a message into given Pub/Sub topic when DlpJob has completed. The
@@ -2040,7 +2124,7 @@ module Google
2040
2124
  # organizations/my-org-id.
2041
2125
  # @!attribute [rw] inspect_template
2042
2126
  # @return [Google::Privacy::Dlp::V2::InspectTemplate]
2043
- # The InspectTemplate to create.
2127
+ # Required. The InspectTemplate to create.
2044
2128
  # @!attribute [rw] template_id
2045
2129
  # @return [String]
2046
2130
  # The template id can contain uppercase and lowercase letters,
@@ -2082,15 +2166,15 @@ module Google
2082
2166
  # organizations/my-org-id.
2083
2167
  # @!attribute [rw] page_token
2084
2168
  # @return [String]
2085
- # Optional page token to continue retrieval. Comes from previous call
2169
+ # Page token to continue retrieval. Comes from previous call
2086
2170
  # to `ListInspectTemplates`.
2087
2171
  # @!attribute [rw] page_size
2088
2172
  # @return [Integer]
2089
- # Optional size of the page, can be limited by server. If zero server returns
2173
+ # Size of the page, can be limited by server. If zero server returns
2090
2174
  # a page of max size 100.
2091
2175
  # @!attribute [rw] order_by
2092
2176
  # @return [String]
2093
- # Optional comma separated list of fields to order by,
2177
+ # Comma separated list of fields to order by,
2094
2178
  # followed by `asc` or `desc` postfix. This list is case-insensitive,
2095
2179
  # default sorting order is ascending, redundant space characters are
2096
2180
  # insignificant.
@@ -2133,7 +2217,7 @@ module Google
2133
2217
  # Required. The parent resource name, for example projects/my-project-id.
2134
2218
  # @!attribute [rw] job_trigger
2135
2219
  # @return [Google::Privacy::Dlp::V2::JobTrigger]
2136
- # The JobTrigger to create.
2220
+ # Required. The JobTrigger to create.
2137
2221
  # @!attribute [rw] trigger_id
2138
2222
  # @return [String]
2139
2223
  # The trigger id can contain uppercase and lowercase letters,
@@ -2181,8 +2265,10 @@ module Google
2181
2265
  # Required. The parent resource name, for example projects/my-project-id.
2182
2266
  # @!attribute [rw] inspect_job
2183
2267
  # @return [Google::Privacy::Dlp::V2::InspectJobConfig]
2268
+ # Set to control what and how to inspect.
2184
2269
  # @!attribute [rw] risk_job
2185
2270
  # @return [Google::Privacy::Dlp::V2::RiskAnalysisJobConfig]
2271
+ # Set to choose what metric to calculate.
2186
2272
  # @!attribute [rw] job_id
2187
2273
  # @return [String]
2188
2274
  # The job id can contain uppercase and lowercase letters,
@@ -2201,15 +2287,15 @@ module Google
2201
2287
  # Required. The parent resource name, for example `projects/my-project-id`.
2202
2288
  # @!attribute [rw] page_token
2203
2289
  # @return [String]
2204
- # Optional page token to continue retrieval. Comes from previous call
2290
+ # Page token to continue retrieval. Comes from previous call
2205
2291
  # to ListJobTriggers. `order_by` field must not
2206
2292
  # change for subsequent calls.
2207
2293
  # @!attribute [rw] page_size
2208
2294
  # @return [Integer]
2209
- # Optional size of the page, can be limited by a server.
2295
+ # Size of the page, can be limited by a server.
2210
2296
  # @!attribute [rw] order_by
2211
2297
  # @return [String]
2212
- # Optional comma separated list of triggeredJob fields to order by,
2298
+ # Comma separated list of triggeredJob fields to order by,
2213
2299
  # followed by `asc` or `desc` postfix. This list is case-insensitive,
2214
2300
  # default sorting order is ascending, redundant space characters are
2215
2301
  # insignificant.
@@ -2226,14 +2312,14 @@ module Google
2226
2312
  # * `status`: corresponds to JobTrigger's status.
2227
2313
  # @!attribute [rw] filter
2228
2314
  # @return [String]
2229
- # Optional. Allows filtering.
2315
+ # Allows filtering.
2230
2316
  #
2231
2317
  # Supported syntax:
2232
2318
  #
2233
2319
  # * Filter expressions are made up of one or more restrictions.
2234
2320
  # * Restrictions can be combined by `AND` or `OR` logical operators. A
2235
2321
  # sequence of restrictions implicitly uses `AND`.
2236
- # * A restriction has the form of `<field> <operator> <value>`.
2322
+ # * A restriction has the form of `{field} {operator} {value}`.
2237
2323
  # * Supported fields/values for inspect jobs:
2238
2324
  # * `status` - HEALTHY|PAUSED|CANCELLED
2239
2325
  # * `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY
@@ -2273,6 +2359,7 @@ module Google
2273
2359
  # `projects/dlp-test-project/jobTriggers/53234423`.
2274
2360
  class DeleteJobTriggerRequest; end
2275
2361
 
2362
+ # Controls what and how to inspect for findings.
2276
2363
  # @!attribute [rw] storage_config
2277
2364
  # @return [Google::Privacy::Dlp::V2::StorageConfig]
2278
2365
  # The data to scan.
@@ -2322,7 +2409,9 @@ module Google
2322
2409
  # @return [Array<Google::Privacy::Dlp::V2::Error>]
2323
2410
  # A stream of errors encountered running the job.
2324
2411
  class DlpJob
2412
+ # Possible states of a job.
2325
2413
  module JobState
2414
+ # Unused.
2326
2415
  JOB_STATE_UNSPECIFIED = 0
2327
2416
 
2328
2417
  # The job has not yet started.
@@ -2354,14 +2443,14 @@ module Google
2354
2443
  # Required. The parent resource name, for example projects/my-project-id.
2355
2444
  # @!attribute [rw] filter
2356
2445
  # @return [String]
2357
- # Optional. Allows filtering.
2446
+ # Allows filtering.
2358
2447
  #
2359
2448
  # Supported syntax:
2360
2449
  #
2361
2450
  # * Filter expressions are made up of one or more restrictions.
2362
2451
  # * Restrictions can be combined by `AND` or `OR` logical operators. A
2363
2452
  # sequence of restrictions implicitly uses `AND`.
2364
- # * A restriction has the form of `<field> <operator> <value>`.
2453
+ # * A restriction has the form of `{field} {operator} {value}`.
2365
2454
  # * Supported fields/values for inspect jobs:
2366
2455
  # * `state` - PENDING|RUNNING|CANCELED|FINISHED|FAILED
2367
2456
  # * `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY
@@ -2393,7 +2482,7 @@ module Google
2393
2482
  # The type of job. Defaults to `DlpJobType.INSPECT`
2394
2483
  # @!attribute [rw] order_by
2395
2484
  # @return [String]
2396
- # Optional comma separated list of fields to order by,
2485
+ # Comma separated list of fields to order by,
2397
2486
  # followed by `asc` or `desc` postfix. This list is case-insensitive,
2398
2487
  # default sorting order is ascending, redundant space characters are
2399
2488
  # insignificant.
@@ -2440,7 +2529,7 @@ module Google
2440
2529
  # organizations/my-org-id.
2441
2530
  # @!attribute [rw] deidentify_template
2442
2531
  # @return [Google::Privacy::Dlp::V2::DeidentifyTemplate]
2443
- # The DeidentifyTemplate to create.
2532
+ # Required. The DeidentifyTemplate to create.
2444
2533
  # @!attribute [rw] template_id
2445
2534
  # @return [String]
2446
2535
  # The template id can contain uppercase and lowercase letters,
@@ -2482,15 +2571,15 @@ module Google
2482
2571
  # organizations/my-org-id.
2483
2572
  # @!attribute [rw] page_token
2484
2573
  # @return [String]
2485
- # Optional page token to continue retrieval. Comes from previous call
2574
+ # Page token to continue retrieval. Comes from previous call
2486
2575
  # to `ListDeidentifyTemplates`.
2487
2576
  # @!attribute [rw] page_size
2488
2577
  # @return [Integer]
2489
- # Optional size of the page, can be limited by server. If zero server returns
2578
+ # Size of the page, can be limited by server. If zero server returns
2490
2579
  # a page of max size 100.
2491
2580
  # @!attribute [rw] order_by
2492
2581
  # @return [String]
2493
- # Optional comma separated list of fields to order by,
2582
+ # Comma separated list of fields to order by,
2494
2583
  # followed by `asc` or `desc` postfix. This list is case-insensitive,
2495
2584
  # default sorting order is ascending, redundant space characters are
2496
2585
  # insignificant.
@@ -2593,10 +2682,12 @@ module Google
2593
2682
  # anomalies detected in the storedInfoType data that render it unusable. Only
2594
2683
  # the five most recent errors will be displayed, with the most recent error
2595
2684
  # appearing first.
2596
- # <p>For example, some of the data for stored custom dictionaries is put in
2685
+ #
2686
+ # For example, some of the data for stored custom dictionaries is put in
2597
2687
  # the user's Google Cloud Storage bucket, and if this data is modified or
2598
2688
  # deleted by the user or another system, the dictionary becomes invalid.
2599
- # <p>If any errors occur, fix the problem indicated by the error message and
2689
+ #
2690
+ # If any errors occur, fix the problem indicated by the error message and
2600
2691
  # use the UpdateStoredInfoType API method to create another version of the
2601
2692
  # storedInfoType to continue using it, reusing the same `config` if it was
2602
2693
  # not the source of the error.
@@ -2626,7 +2717,7 @@ module Google
2626
2717
  # organizations/my-org-id.
2627
2718
  # @!attribute [rw] config
2628
2719
  # @return [Google::Privacy::Dlp::V2::StoredInfoTypeConfig]
2629
- # Configuration of the storedInfoType to create.
2720
+ # Required. Configuration of the storedInfoType to create.
2630
2721
  # @!attribute [rw] stored_info_type_id
2631
2722
  # @return [String]
2632
2723
  # The storedInfoType ID can contain uppercase and lowercase letters,
@@ -2670,15 +2761,15 @@ module Google
2670
2761
  # organizations/my-org-id.
2671
2762
  # @!attribute [rw] page_token
2672
2763
  # @return [String]
2673
- # Optional page token to continue retrieval. Comes from previous call
2764
+ # Page token to continue retrieval. Comes from previous call
2674
2765
  # to `ListStoredInfoTypes`.
2675
2766
  # @!attribute [rw] page_size
2676
2767
  # @return [Integer]
2677
- # Optional size of the page, can be limited by server. If zero server returns
2768
+ # Size of the page, can be limited by server. If zero server returns
2678
2769
  # a page of max size 100.
2679
2770
  # @!attribute [rw] order_by
2680
2771
  # @return [String]
2681
- # Optional comma separated list of fields to order by,
2772
+ # Comma separated list of fields to order by,
2682
2773
  # followed by `asc` or `desc` postfix. This list is case-insensitive,
2683
2774
  # default sorting order is ascending, redundant space characters are
2684
2775
  # insignificant.
@@ -2728,8 +2819,9 @@ module Google
2728
2819
  CONTENT_IMAGE = 2
2729
2820
  end
2730
2821
 
2731
- # An enum to represent the various type of DLP jobs.
2822
+ # An enum to represent the various types of DLP jobs.
2732
2823
  module DlpJobType
2824
+ # Unused
2733
2825
  DLP_JOB_TYPE_UNSPECIFIED = 0
2734
2826
 
2735
2827
  # The job inspected Google Cloud for sensitive data.
@@ -2741,6 +2833,7 @@ module Google
2741
2833
 
2742
2834
  # Parts of the APIs which use certain infoTypes.
2743
2835
  module InfoTypeSupportedBy
2836
+ # Unused.
2744
2837
  ENUM_TYPE_UNSPECIFIED = 0
2745
2838
 
2746
2839
  # Supported by the inspect operations.
@@ -2781,6 +2874,7 @@ module Google
2781
2874
 
2782
2875
  # Operators available for comparing the value of fields.
2783
2876
  module RelationalOperator
2877
+ # Unused
2784
2878
  RELATIONAL_OPERATOR_UNSPECIFIED = 0
2785
2879
 
2786
2880
  # Equal. Attempts to match even with incompatible types.
@@ -2807,6 +2901,7 @@ module Google
2807
2901
 
2808
2902
  # State of a StoredInfoType version.
2809
2903
  module StoredInfoTypeState
2904
+ # Unused
2810
2905
  STORED_INFO_TYPE_STATE_UNSPECIFIED = 0
2811
2906
 
2812
2907
  # StoredInfoType version is being created.