google-cloud-dlp-v2 0.1.0 → 0.3.2

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.
@@ -23,36 +23,36 @@ module Google
23
23
  module V2
24
24
  # Type of information detected by the API.
25
25
  # @!attribute [rw] name
26
- # @return [String]
26
+ # @return [::String]
27
27
  # Name of the information type. Either a name of your choosing when
28
28
  # creating a CustomInfoType, or one of the names listed
29
29
  # at https://cloud.google.com/dlp/docs/infotypes-reference when specifying
30
30
  # a built-in type. InfoType names should conform to the pattern
31
31
  # `[a-zA-Z0-9_]{1,64}`.
32
32
  class InfoType
33
- include Google::Protobuf::MessageExts
34
- extend Google::Protobuf::MessageExts::ClassMethods
33
+ include ::Google::Protobuf::MessageExts
34
+ extend ::Google::Protobuf::MessageExts::ClassMethods
35
35
  end
36
36
 
37
37
  # A reference to a StoredInfoType to use with scanning.
38
38
  # @!attribute [rw] name
39
- # @return [String]
39
+ # @return [::String]
40
40
  # Resource name of the requested `StoredInfoType`, for example
41
41
  # `organizations/433245324/storedInfoTypes/432452342` or
42
42
  # `projects/project-id/storedInfoTypes/432452342`.
43
43
  # @!attribute [rw] create_time
44
- # @return [Google::Protobuf::Timestamp]
44
+ # @return [::Google::Protobuf::Timestamp]
45
45
  # Timestamp indicating when the version of the `StoredInfoType` used for
46
46
  # inspection was created. Output-only field, populated by the system.
47
47
  class StoredType
48
- include Google::Protobuf::MessageExts
49
- extend Google::Protobuf::MessageExts::ClassMethods
48
+ include ::Google::Protobuf::MessageExts
49
+ extend ::Google::Protobuf::MessageExts::ClassMethods
50
50
  end
51
51
 
52
52
  # Custom information type provided by the user. Used to find domain-specific
53
53
  # sensitive information configurable to the data in question.
54
54
  # @!attribute [rw] info_type
55
- # @return [Google::Cloud::Dlp::V2::InfoType]
55
+ # @return [::Google::Cloud::Dlp::V2::InfoType]
56
56
  # CustomInfoType can either be a new infoType, or an extension of built-in
57
57
  # infoType, when the name matches one of existing infoTypes and that infoType
58
58
  # is specified in `InspectContent.info_types` field. Specifying the latter
@@ -60,36 +60,36 @@ module Google
60
60
  # not specified in `InspectContent.info_types` list then the name is treated
61
61
  # as a custom info type.
62
62
  # @!attribute [rw] likelihood
63
- # @return [Google::Cloud::Dlp::V2::Likelihood]
63
+ # @return [::Google::Cloud::Dlp::V2::Likelihood]
64
64
  # Likelihood to return for this CustomInfoType. This base value can be
65
65
  # altered by a detection rule if the finding meets the criteria specified by
66
66
  # the rule. Defaults to `VERY_LIKELY` if not specified.
67
67
  # @!attribute [rw] dictionary
68
- # @return [Google::Cloud::Dlp::V2::CustomInfoType::Dictionary]
68
+ # @return [::Google::Cloud::Dlp::V2::CustomInfoType::Dictionary]
69
69
  # A list of phrases to detect as a CustomInfoType.
70
70
  # @!attribute [rw] regex
71
- # @return [Google::Cloud::Dlp::V2::CustomInfoType::Regex]
71
+ # @return [::Google::Cloud::Dlp::V2::CustomInfoType::Regex]
72
72
  # Regular expression based CustomInfoType.
73
73
  # @!attribute [rw] surrogate_type
74
- # @return [Google::Cloud::Dlp::V2::CustomInfoType::SurrogateType]
74
+ # @return [::Google::Cloud::Dlp::V2::CustomInfoType::SurrogateType]
75
75
  # Message for detecting output from deidentification transformations that
76
76
  # support reversing.
77
77
  # @!attribute [rw] stored_type
78
- # @return [Google::Cloud::Dlp::V2::StoredType]
78
+ # @return [::Google::Cloud::Dlp::V2::StoredType]
79
79
  # Load an existing `StoredInfoType` resource for use in
80
80
  # `InspectDataSource`. Not currently supported in `InspectContent`.
81
81
  # @!attribute [rw] detection_rules
82
- # @return [Array<Google::Cloud::Dlp::V2::CustomInfoType::DetectionRule>]
82
+ # @return [::Array<::Google::Cloud::Dlp::V2::CustomInfoType::DetectionRule>]
83
83
  # Set of detection rules to apply to all findings of this CustomInfoType.
84
84
  # Rules are applied in order that they are specified. Not supported for the
85
85
  # `surrogate_type` CustomInfoType.
86
86
  # @!attribute [rw] exclusion_type
87
- # @return [Google::Cloud::Dlp::V2::CustomInfoType::ExclusionType]
87
+ # @return [::Google::Cloud::Dlp::V2::CustomInfoType::ExclusionType]
88
88
  # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding
89
89
  # to be returned. It still can be used for rules matching.
90
90
  class CustomInfoType
91
- include Google::Protobuf::MessageExts
92
- extend Google::Protobuf::MessageExts::ClassMethods
91
+ include ::Google::Protobuf::MessageExts
92
+ extend ::Google::Protobuf::MessageExts::ClassMethods
93
93
 
94
94
  # Custom information type based on a dictionary of words or phrases. This can
95
95
  # be used to match sensitive information specific to the data, such as a list
@@ -115,54 +115,54 @@ module Google
115
115
  # these constraints, consider using `LargeCustomDictionaryConfig` in the
116
116
  # `StoredInfoType` API.
117
117
  # @!attribute [rw] word_list
118
- # @return [Google::Cloud::Dlp::V2::CustomInfoType::Dictionary::WordList]
118
+ # @return [::Google::Cloud::Dlp::V2::CustomInfoType::Dictionary::WordList]
119
119
  # List of words or phrases to search for.
120
120
  # @!attribute [rw] cloud_storage_path
121
- # @return [Google::Cloud::Dlp::V2::CloudStoragePath]
121
+ # @return [::Google::Cloud::Dlp::V2::CloudStoragePath]
122
122
  # Newline-delimited file of words in Cloud Storage. Only a single file
123
123
  # is accepted.
124
124
  class Dictionary
125
- include Google::Protobuf::MessageExts
126
- extend Google::Protobuf::MessageExts::ClassMethods
125
+ include ::Google::Protobuf::MessageExts
126
+ extend ::Google::Protobuf::MessageExts::ClassMethods
127
127
 
128
128
  # Message defining a list of words or phrases to search for in the data.
129
129
  # @!attribute [rw] words
130
- # @return [Array<String>]
130
+ # @return [::Array<::String>]
131
131
  # Words or phrases defining the dictionary. The dictionary must contain
132
132
  # at least one phrase and every phrase must contain at least 2 characters
133
133
  # that are letters or digits. [required]
134
134
  class WordList
135
- include Google::Protobuf::MessageExts
136
- extend Google::Protobuf::MessageExts::ClassMethods
135
+ include ::Google::Protobuf::MessageExts
136
+ extend ::Google::Protobuf::MessageExts::ClassMethods
137
137
  end
138
138
  end
139
139
 
140
140
  # Message defining a custom regular expression.
141
141
  # @!attribute [rw] pattern
142
- # @return [String]
142
+ # @return [::String]
143
143
  # Pattern defining the regular expression. Its syntax
144
144
  # (https://github.com/google/re2/wiki/Syntax) can be found under the
145
145
  # google/re2 repository on GitHub.
146
146
  # @!attribute [rw] group_indexes
147
- # @return [Array<Integer>]
147
+ # @return [::Array<::Integer>]
148
148
  # The index of the submatch to extract as findings. When not
149
149
  # specified, the entire match is returned. No more than 3 may be included.
150
150
  class Regex
151
- include Google::Protobuf::MessageExts
152
- extend Google::Protobuf::MessageExts::ClassMethods
151
+ include ::Google::Protobuf::MessageExts
152
+ extend ::Google::Protobuf::MessageExts::ClassMethods
153
153
  end
154
154
 
155
155
  # Message for detecting output from deidentification transformations
156
156
  # such as
157
- # [`CryptoReplaceFfxFpeConfig`](/dlp/docs/reference/rest/v2/organizations.deidentifyTemplates#cryptoreplaceffxfpeconfig).
157
+ # [`CryptoReplaceFfxFpeConfig`](https://cloud.google.com/dlp/docs/reference/rest/v2/organizations.deidentifyTemplates#cryptoreplaceffxfpeconfig).
158
158
  # These types of transformations are
159
159
  # those that perform pseudonymization, thereby producing a "surrogate" as
160
160
  # output. This should be used in conjunction with a field on the
161
161
  # transformation such as `surrogate_info_type`. This CustomInfoType does
162
162
  # not support the use of `detection_rules`.
163
163
  class SurrogateType
164
- include Google::Protobuf::MessageExts
165
- extend Google::Protobuf::MessageExts::ClassMethods
164
+ include ::Google::Protobuf::MessageExts
165
+ extend ::Google::Protobuf::MessageExts::ClassMethods
166
166
  end
167
167
 
168
168
  # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a
@@ -170,32 +170,32 @@ module Google
170
170
  # on the specific details of the rule. Not supported for the `surrogate_type`
171
171
  # custom infoType.
172
172
  # @!attribute [rw] hotword_rule
173
- # @return [Google::Cloud::Dlp::V2::CustomInfoType::DetectionRule::HotwordRule]
173
+ # @return [::Google::Cloud::Dlp::V2::CustomInfoType::DetectionRule::HotwordRule]
174
174
  # Hotword-based detection rule.
175
175
  class DetectionRule
176
- include Google::Protobuf::MessageExts
177
- extend Google::Protobuf::MessageExts::ClassMethods
176
+ include ::Google::Protobuf::MessageExts
177
+ extend ::Google::Protobuf::MessageExts::ClassMethods
178
178
 
179
179
  # Message for specifying a window around a finding to apply a detection
180
180
  # rule.
181
181
  # @!attribute [rw] window_before
182
- # @return [Integer]
182
+ # @return [::Integer]
183
183
  # Number of characters before the finding to consider.
184
184
  # @!attribute [rw] window_after
185
- # @return [Integer]
185
+ # @return [::Integer]
186
186
  # Number of characters after the finding to consider.
187
187
  class Proximity
188
- include Google::Protobuf::MessageExts
189
- extend Google::Protobuf::MessageExts::ClassMethods
188
+ include ::Google::Protobuf::MessageExts
189
+ extend ::Google::Protobuf::MessageExts::ClassMethods
190
190
  end
191
191
 
192
192
  # Message for specifying an adjustment to the likelihood of a finding as
193
193
  # part of a detection rule.
194
194
  # @!attribute [rw] fixed_likelihood
195
- # @return [Google::Cloud::Dlp::V2::Likelihood]
195
+ # @return [::Google::Cloud::Dlp::V2::Likelihood]
196
196
  # Set the likelihood of a finding to a fixed value.
197
197
  # @!attribute [rw] relative_likelihood
198
- # @return [Integer]
198
+ # @return [::Integer]
199
199
  # Increase or decrease the likelihood by the specified number of
200
200
  # levels. For example, if a finding would be `POSSIBLE` without the
201
201
  # detection rule and `relative_likelihood` is 1, then it is upgraded to
@@ -205,17 +205,17 @@ module Google
205
205
  # adjustment of -1 when base likelihood is `VERY_LIKELY` will result in
206
206
  # a final likelihood of `LIKELY`.
207
207
  class LikelihoodAdjustment
208
- include Google::Protobuf::MessageExts
209
- extend Google::Protobuf::MessageExts::ClassMethods
208
+ include ::Google::Protobuf::MessageExts
209
+ extend ::Google::Protobuf::MessageExts::ClassMethods
210
210
  end
211
211
 
212
212
  # The rule that adjusts the likelihood of findings within a certain
213
213
  # proximity of hotwords.
214
214
  # @!attribute [rw] hotword_regex
215
- # @return [Google::Cloud::Dlp::V2::CustomInfoType::Regex]
215
+ # @return [::Google::Cloud::Dlp::V2::CustomInfoType::Regex]
216
216
  # Regular expression pattern defining what qualifies as a hotword.
217
217
  # @!attribute [rw] proximity
218
- # @return [Google::Cloud::Dlp::V2::CustomInfoType::DetectionRule::Proximity]
218
+ # @return [::Google::Cloud::Dlp::V2::CustomInfoType::DetectionRule::Proximity]
219
219
  # Proximity of the finding within which the entire hotword must reside.
220
220
  # The total length of the window cannot exceed 1000 characters. Note that
221
221
  # the finding itself will be included in the window, so that hotwords may
@@ -225,11 +225,11 @@ module Google
225
225
  # a company office using the hotword regex "\(xxx\)", where "xxx"
226
226
  # is the area code in question.
227
227
  # @!attribute [rw] likelihood_adjustment
228
- # @return [Google::Cloud::Dlp::V2::CustomInfoType::DetectionRule::LikelihoodAdjustment]
228
+ # @return [::Google::Cloud::Dlp::V2::CustomInfoType::DetectionRule::LikelihoodAdjustment]
229
229
  # Likelihood adjustment to apply to all matching findings.
230
230
  class HotwordRule
231
- include Google::Protobuf::MessageExts
232
- extend Google::Protobuf::MessageExts::ClassMethods
231
+ include ::Google::Protobuf::MessageExts
232
+ extend ::Google::Protobuf::MessageExts::ClassMethods
233
233
  end
234
234
  end
235
235
 
@@ -245,11 +245,11 @@ module Google
245
245
 
246
246
  # General identifier of a data field in a storage service.
247
247
  # @!attribute [rw] name
248
- # @return [String]
248
+ # @return [::String]
249
249
  # Name describing the field.
250
250
  class FieldId
251
- include Google::Protobuf::MessageExts
252
- extend Google::Protobuf::MessageExts::ClassMethods
251
+ include ::Google::Protobuf::MessageExts
252
+ extend ::Google::Protobuf::MessageExts::ClassMethods
253
253
  end
254
254
 
255
255
  # Datastore partition ID.
@@ -259,36 +259,36 @@ module Google
259
259
  # A partition ID contains several dimensions:
260
260
  # project ID and namespace ID.
261
261
  # @!attribute [rw] project_id
262
- # @return [String]
262
+ # @return [::String]
263
263
  # The ID of the project to which the entities belong.
264
264
  # @!attribute [rw] namespace_id
265
- # @return [String]
265
+ # @return [::String]
266
266
  # If not empty, the ID of the namespace to which the entities belong.
267
267
  class PartitionId
268
- include Google::Protobuf::MessageExts
269
- extend Google::Protobuf::MessageExts::ClassMethods
268
+ include ::Google::Protobuf::MessageExts
269
+ extend ::Google::Protobuf::MessageExts::ClassMethods
270
270
  end
271
271
 
272
272
  # A representation of a Datastore kind.
273
273
  # @!attribute [rw] name
274
- # @return [String]
274
+ # @return [::String]
275
275
  # The name of the kind.
276
276
  class KindExpression
277
- include Google::Protobuf::MessageExts
278
- extend Google::Protobuf::MessageExts::ClassMethods
277
+ include ::Google::Protobuf::MessageExts
278
+ extend ::Google::Protobuf::MessageExts::ClassMethods
279
279
  end
280
280
 
281
281
  # Options defining a data set within Google Cloud Datastore.
282
282
  # @!attribute [rw] partition_id
283
- # @return [Google::Cloud::Dlp::V2::PartitionId]
283
+ # @return [::Google::Cloud::Dlp::V2::PartitionId]
284
284
  # A partition ID identifies a grouping of entities. The grouping is always
285
285
  # by project and namespace, however the namespace ID may be empty.
286
286
  # @!attribute [rw] kind
287
- # @return [Google::Cloud::Dlp::V2::KindExpression]
287
+ # @return [::Google::Cloud::Dlp::V2::KindExpression]
288
288
  # The kind to process.
289
289
  class DatastoreOptions
290
- include Google::Protobuf::MessageExts
291
- extend Google::Protobuf::MessageExts::ClassMethods
290
+ include ::Google::Protobuf::MessageExts
291
+ extend ::Google::Protobuf::MessageExts::ClassMethods
292
292
  end
293
293
 
294
294
  # Message representing a set of files in a Cloud Storage bucket. Regular
@@ -324,10 +324,10 @@ module Google
324
324
  # include all files directly under `gs://mybucket/directory/`, without matching
325
325
  # across `/`
326
326
  # @!attribute [rw] bucket_name
327
- # @return [String]
327
+ # @return [::String]
328
328
  # The name of a Cloud Storage bucket. Required.
329
329
  # @!attribute [rw] include_regex
330
- # @return [Array<String>]
330
+ # @return [::Array<::String>]
331
331
  # A list of regular expressions matching file paths to include. All files in
332
332
  # the bucket that match at least one of these regular expressions will be
333
333
  # included in the set of files, except for those that also match an item in
@@ -338,7 +338,7 @@ module Google
338
338
  # [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found
339
339
  # under the google/re2 repository on GitHub.
340
340
  # @!attribute [rw] exclude_regex
341
- # @return [Array<String>]
341
+ # @return [::Array<::String>]
342
342
  # A list of regular expressions matching file paths to exclude. All files in
343
343
  # the bucket that match at least one of these regular expressions will be
344
344
  # excluded from the scan.
@@ -347,46 +347,49 @@ module Google
347
347
  # [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found
348
348
  # under the google/re2 repository on GitHub.
349
349
  class CloudStorageRegexFileSet
350
- include Google::Protobuf::MessageExts
351
- extend Google::Protobuf::MessageExts::ClassMethods
350
+ include ::Google::Protobuf::MessageExts
351
+ extend ::Google::Protobuf::MessageExts::ClassMethods
352
352
  end
353
353
 
354
354
  # Options defining a file or a set of files within a Google Cloud Storage
355
355
  # bucket.
356
356
  # @!attribute [rw] file_set
357
- # @return [Google::Cloud::Dlp::V2::CloudStorageOptions::FileSet]
357
+ # @return [::Google::Cloud::Dlp::V2::CloudStorageOptions::FileSet]
358
358
  # The set of one or more files to scan.
359
359
  # @!attribute [rw] bytes_limit_per_file
360
- # @return [Integer]
360
+ # @return [::Integer]
361
361
  # Max number of bytes to scan from a file. If a scanned file's size is bigger
362
362
  # than this value then the rest of the bytes are omitted. Only one
363
363
  # of bytes_limit_per_file and bytes_limit_per_file_percent can be specified.
364
364
  # @!attribute [rw] bytes_limit_per_file_percent
365
- # @return [Integer]
365
+ # @return [::Integer]
366
366
  # Max percentage of bytes to scan from a file. The rest are omitted. The
367
367
  # number of bytes scanned is rounded down. Must be between 0 and 100,
368
368
  # inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one
369
369
  # of bytes_limit_per_file and bytes_limit_per_file_percent can be specified.
370
370
  # @!attribute [rw] file_types
371
- # @return [Array<Google::Cloud::Dlp::V2::FileType>]
371
+ # @return [::Array<::Google::Cloud::Dlp::V2::FileType>]
372
372
  # List of file type groups to include in the scan.
373
373
  # If empty, all files are scanned and available data format processors
374
374
  # are applied. In addition, the binary content of the selected files
375
375
  # is always scanned as well.
376
+ # Images are scanned only as binary if the specified region
377
+ # does not support image inspection and no file_types were specified.
378
+ # Image inspection is restricted to 'global', 'us', 'asia', and 'europe'.
376
379
  # @!attribute [rw] sample_method
377
- # @return [Google::Cloud::Dlp::V2::CloudStorageOptions::SampleMethod]
380
+ # @return [::Google::Cloud::Dlp::V2::CloudStorageOptions::SampleMethod]
378
381
  # @!attribute [rw] files_limit_percent
379
- # @return [Integer]
382
+ # @return [::Integer]
380
383
  # Limits the number of files to scan to this percentage of the input FileSet.
381
384
  # Number of files scanned is rounded down. Must be between 0 and 100,
382
385
  # inclusively. Both 0 and 100 means no limit. Defaults to 0.
383
386
  class CloudStorageOptions
384
- include Google::Protobuf::MessageExts
385
- extend Google::Protobuf::MessageExts::ClassMethods
387
+ include ::Google::Protobuf::MessageExts
388
+ extend ::Google::Protobuf::MessageExts::ClassMethods
386
389
 
387
390
  # Set of files to scan.
388
391
  # @!attribute [rw] url
389
- # @return [String]
392
+ # @return [::String]
390
393
  # The Cloud Storage url of the file(s) to scan, in the format
391
394
  # `gs://<bucket>/<path>`. Trailing wildcard in the path is allowed.
392
395
  #
@@ -398,12 +401,12 @@ module Google
398
401
  #
399
402
  # Exactly one of `url` or `regex_file_set` must be set.
400
403
  # @!attribute [rw] regex_file_set
401
- # @return [Google::Cloud::Dlp::V2::CloudStorageRegexFileSet]
404
+ # @return [::Google::Cloud::Dlp::V2::CloudStorageRegexFileSet]
402
405
  # The regex-filtered set of files to scan. Exactly one of `url` or
403
406
  # `regex_file_set` must be set.
404
407
  class FileSet
405
- include Google::Protobuf::MessageExts
406
- extend Google::Protobuf::MessageExts::ClassMethods
408
+ include ::Google::Protobuf::MessageExts
409
+ extend ::Google::Protobuf::MessageExts::ClassMethods
407
410
  end
408
411
 
409
412
  # How to sample bytes if not all bytes are scanned. Meaningful only when used
@@ -423,57 +426,57 @@ module Google
423
426
 
424
427
  # Message representing a set of files in Cloud Storage.
425
428
  # @!attribute [rw] url
426
- # @return [String]
429
+ # @return [::String]
427
430
  # The url, in the format `gs://<bucket>/<path>`. Trailing wildcard in the
428
431
  # path is allowed.
429
432
  class CloudStorageFileSet
430
- include Google::Protobuf::MessageExts
431
- extend Google::Protobuf::MessageExts::ClassMethods
433
+ include ::Google::Protobuf::MessageExts
434
+ extend ::Google::Protobuf::MessageExts::ClassMethods
432
435
  end
433
436
 
434
437
  # Message representing a single file or path in Cloud Storage.
435
438
  # @!attribute [rw] path
436
- # @return [String]
439
+ # @return [::String]
437
440
  # A url representing a file or path (no wildcards) in Cloud Storage.
438
441
  # Example: gs://[BUCKET_NAME]/dictionary.txt
439
442
  class CloudStoragePath
440
- include Google::Protobuf::MessageExts
441
- extend Google::Protobuf::MessageExts::ClassMethods
443
+ include ::Google::Protobuf::MessageExts
444
+ extend ::Google::Protobuf::MessageExts::ClassMethods
442
445
  end
443
446
 
444
447
  # Options defining BigQuery table and row identifiers.
445
448
  # @!attribute [rw] table_reference
446
- # @return [Google::Cloud::Dlp::V2::BigQueryTable]
449
+ # @return [::Google::Cloud::Dlp::V2::BigQueryTable]
447
450
  # Complete BigQuery table reference.
448
451
  # @!attribute [rw] identifying_fields
449
- # @return [Array<Google::Cloud::Dlp::V2::FieldId>]
452
+ # @return [::Array<::Google::Cloud::Dlp::V2::FieldId>]
450
453
  # Table fields that may uniquely identify a row within the table. When
451
454
  # `actions.saveFindings.outputConfig.table` is specified, the values of
452
455
  # columns specified here are available in the output table under
453
456
  # `location.content_locations.record_location.record_key.id_values`. Nested
454
457
  # fields such as `person.birthdate.year` are allowed.
455
458
  # @!attribute [rw] rows_limit
456
- # @return [Integer]
459
+ # @return [::Integer]
457
460
  # Max number of rows to scan. If the table has more rows than this value, the
458
461
  # rest of the rows are omitted. If not set, or if set to 0, all rows will be
459
462
  # scanned. Only one of rows_limit and rows_limit_percent can be specified.
460
463
  # Cannot be used in conjunction with TimespanConfig.
461
464
  # @!attribute [rw] rows_limit_percent
462
- # @return [Integer]
465
+ # @return [::Integer]
463
466
  # Max percentage of rows to scan. The rest are omitted. The number of rows
464
467
  # scanned is rounded down. Must be between 0 and 100, inclusively. Both 0 and
465
468
  # 100 means no limit. Defaults to 0. Only one of rows_limit and
466
469
  # rows_limit_percent can be specified. Cannot be used in conjunction with
467
470
  # TimespanConfig.
468
471
  # @!attribute [rw] sample_method
469
- # @return [Google::Cloud::Dlp::V2::BigQueryOptions::SampleMethod]
472
+ # @return [::Google::Cloud::Dlp::V2::BigQueryOptions::SampleMethod]
470
473
  # @!attribute [rw] excluded_fields
471
- # @return [Array<Google::Cloud::Dlp::V2::FieldId>]
474
+ # @return [::Array<::Google::Cloud::Dlp::V2::FieldId>]
472
475
  # References to fields excluded from scanning. This allows you to skip
473
476
  # inspection of entire columns which you know have no findings.
474
477
  class BigQueryOptions
475
- include Google::Protobuf::MessageExts
476
- extend Google::Protobuf::MessageExts::ClassMethods
478
+ include ::Google::Protobuf::MessageExts
479
+ extend ::Google::Protobuf::MessageExts::ClassMethods
477
480
 
478
481
  # How to sample rows if not all rows are scanned. Meaningful only when used
479
482
  # in conjunction with either rows_limit or rows_limit_percent. If not
@@ -491,37 +494,37 @@ module Google
491
494
 
492
495
  # Shared message indicating Cloud storage type.
493
496
  # @!attribute [rw] datastore_options
494
- # @return [Google::Cloud::Dlp::V2::DatastoreOptions]
497
+ # @return [::Google::Cloud::Dlp::V2::DatastoreOptions]
495
498
  # Google Cloud Datastore options.
496
499
  # @!attribute [rw] cloud_storage_options
497
- # @return [Google::Cloud::Dlp::V2::CloudStorageOptions]
500
+ # @return [::Google::Cloud::Dlp::V2::CloudStorageOptions]
498
501
  # Google Cloud Storage options.
499
502
  # @!attribute [rw] big_query_options
500
- # @return [Google::Cloud::Dlp::V2::BigQueryOptions]
503
+ # @return [::Google::Cloud::Dlp::V2::BigQueryOptions]
501
504
  # BigQuery options.
502
505
  # @!attribute [rw] hybrid_options
503
- # @return [Google::Cloud::Dlp::V2::HybridOptions]
506
+ # @return [::Google::Cloud::Dlp::V2::HybridOptions]
504
507
  # Hybrid inspection options.
505
508
  # Early access feature is in a pre-release state and might change or have
506
509
  # limited support. For more information, see
507
510
  # https://cloud.google.com/products#product-launch-stages.
508
511
  # @!attribute [rw] timespan_config
509
- # @return [Google::Cloud::Dlp::V2::StorageConfig::TimespanConfig]
512
+ # @return [::Google::Cloud::Dlp::V2::StorageConfig::TimespanConfig]
510
513
  class StorageConfig
511
- include Google::Protobuf::MessageExts
512
- extend Google::Protobuf::MessageExts::ClassMethods
514
+ include ::Google::Protobuf::MessageExts
515
+ extend ::Google::Protobuf::MessageExts::ClassMethods
513
516
 
514
517
  # Configuration of the timespan of the items to include in scanning.
515
518
  # Currently only supported when inspecting Google Cloud Storage and BigQuery.
516
519
  # @!attribute [rw] start_time
517
- # @return [Google::Protobuf::Timestamp]
520
+ # @return [::Google::Protobuf::Timestamp]
518
521
  # Exclude files or rows older than this value.
519
522
  # @!attribute [rw] end_time
520
- # @return [Google::Protobuf::Timestamp]
523
+ # @return [::Google::Protobuf::Timestamp]
521
524
  # Exclude files or rows newer than this value.
522
525
  # If set to zero, no upper time limit is applied.
523
526
  # @!attribute [rw] timestamp_field
524
- # @return [Google::Cloud::Dlp::V2::FieldId]
527
+ # @return [::Google::Cloud::Dlp::V2::FieldId]
525
528
  # Specification of the field containing the timestamp of scanned items.
526
529
  # Used for data sources like Datastore and BigQuery.
527
530
  #
@@ -537,25 +540,25 @@ module Google
537
540
  # Datastore entity will be scanned if the timestamp property does not
538
541
  # exist or its value is empty or invalid.
539
542
  # @!attribute [rw] enable_auto_population_of_timespan_config
540
- # @return [Boolean]
543
+ # @return [::Boolean]
541
544
  # When the job is started by a JobTrigger we will automatically figure out
542
545
  # a valid start_time to avoid scanning files that have not been modified
543
546
  # since the last time the JobTrigger executed. This will be based on the
544
547
  # time of the execution of the last run of the JobTrigger.
545
548
  class TimespanConfig
546
- include Google::Protobuf::MessageExts
547
- extend Google::Protobuf::MessageExts::ClassMethods
549
+ include ::Google::Protobuf::MessageExts
550
+ extend ::Google::Protobuf::MessageExts::ClassMethods
548
551
  end
549
552
  end
550
553
 
551
554
  # Configuration to control jobs where the content being inspected is outside
552
555
  # of Google Cloud Platform.
553
556
  # @!attribute [rw] description
554
- # @return [String]
557
+ # @return [::String]
555
558
  # A short description of where the data is coming from. Will be stored once
556
559
  # in the job. 256 max length.
557
560
  # @!attribute [rw] required_finding_label_keys
558
- # @return [Array<String>]
561
+ # @return [::Array<::String>]
559
562
  # These are labels that each inspection request must include within their
560
563
  # 'finding_labels' map. Request may contain others, but any missing one of
561
564
  # these will be rejected.
@@ -565,7 +568,7 @@ module Google
565
568
  #
566
569
  # No more than 10 keys can be required.
567
570
  # @!attribute [rw] labels
568
- # @return [Google::Protobuf::Map{String => String}]
571
+ # @return [::Google::Protobuf::Map{::String => ::String}]
569
572
  # To organize findings, these labels will be added to each finding.
570
573
  #
571
574
  # Label keys must be between 1 and 63 characters long and must conform
@@ -580,46 +583,46 @@ module Google
580
583
  # * `"environment" : "production"`
581
584
  # * `"pipeline" : "etl"`
582
585
  # @!attribute [rw] table_options
583
- # @return [Google::Cloud::Dlp::V2::TableOptions]
586
+ # @return [::Google::Cloud::Dlp::V2::TableOptions]
584
587
  # If the container is a table, additional information to make findings
585
588
  # meaningful such as the columns that are primary keys.
586
589
  class HybridOptions
587
- include Google::Protobuf::MessageExts
588
- extend Google::Protobuf::MessageExts::ClassMethods
590
+ include ::Google::Protobuf::MessageExts
591
+ extend ::Google::Protobuf::MessageExts::ClassMethods
589
592
 
590
593
  # @!attribute [rw] key
591
- # @return [String]
594
+ # @return [::String]
592
595
  # @!attribute [rw] value
593
- # @return [String]
596
+ # @return [::String]
594
597
  class LabelsEntry
595
- include Google::Protobuf::MessageExts
596
- extend Google::Protobuf::MessageExts::ClassMethods
598
+ include ::Google::Protobuf::MessageExts
599
+ extend ::Google::Protobuf::MessageExts::ClassMethods
597
600
  end
598
601
  end
599
602
 
600
603
  # Row key for identifying a record in BigQuery table.
601
604
  # @!attribute [rw] table_reference
602
- # @return [Google::Cloud::Dlp::V2::BigQueryTable]
605
+ # @return [::Google::Cloud::Dlp::V2::BigQueryTable]
603
606
  # Complete BigQuery table reference.
604
607
  # @!attribute [rw] row_number
605
- # @return [Integer]
608
+ # @return [::Integer]
606
609
  # Row number inferred at the time the table was scanned. This value is
607
610
  # nondeterministic, cannot be queried, and may be null for inspection
608
611
  # jobs. To locate findings within a table, specify
609
612
  # `inspect_job.storage_config.big_query_options.identifying_fields` in
610
613
  # `CreateDlpJobRequest`.
611
614
  class BigQueryKey
612
- include Google::Protobuf::MessageExts
613
- extend Google::Protobuf::MessageExts::ClassMethods
615
+ include ::Google::Protobuf::MessageExts
616
+ extend ::Google::Protobuf::MessageExts::ClassMethods
614
617
  end
615
618
 
616
619
  # Record key for a finding in Cloud Datastore.
617
620
  # @!attribute [rw] entity_key
618
- # @return [Google::Cloud::Dlp::V2::Key]
621
+ # @return [::Google::Cloud::Dlp::V2::Key]
619
622
  # Datastore entity key.
620
623
  class DatastoreKey
621
- include Google::Protobuf::MessageExts
622
- extend Google::Protobuf::MessageExts::ClassMethods
624
+ include ::Google::Protobuf::MessageExts
625
+ extend ::Google::Protobuf::MessageExts::ClassMethods
623
626
  end
624
627
 
625
628
  # A unique identifier for a Datastore entity.
@@ -627,12 +630,12 @@ module Google
627
630
  # reserved/read-only, the key is reserved/read-only.
628
631
  # A reserved/read-only key is forbidden in certain documented contexts.
629
632
  # @!attribute [rw] partition_id
630
- # @return [Google::Cloud::Dlp::V2::PartitionId]
633
+ # @return [::Google::Cloud::Dlp::V2::PartitionId]
631
634
  # Entities are partitioned into subsets, currently identified by a project
632
635
  # ID and namespace ID.
633
636
  # Queries are scoped to a single partition.
634
637
  # @!attribute [rw] path
635
- # @return [Array<Google::Cloud::Dlp::V2::Key::PathElement>]
638
+ # @return [::Array<::Google::Cloud::Dlp::V2::Key::PathElement>]
636
639
  # The entity path.
637
640
  # An entity path consists of one or more elements composed of a kind and a
638
641
  # string or numerical identifier, which identify entities. The first
@@ -643,48 +646,48 @@ module Google
643
646
  #
644
647
  # A path can never be empty, and a path can have at most 100 elements.
645
648
  class Key
646
- include Google::Protobuf::MessageExts
647
- extend Google::Protobuf::MessageExts::ClassMethods
649
+ include ::Google::Protobuf::MessageExts
650
+ extend ::Google::Protobuf::MessageExts::ClassMethods
648
651
 
649
652
  # A (kind, ID/name) pair used to construct a key path.
650
653
  #
651
654
  # If either name or ID is set, the element is complete.
652
655
  # If neither is set, the element is incomplete.
653
656
  # @!attribute [rw] kind
654
- # @return [String]
657
+ # @return [::String]
655
658
  # The kind of the entity.
656
659
  # A kind matching regex `__.*__` is reserved/read-only.
657
660
  # A kind must not contain more than 1500 bytes when UTF-8 encoded.
658
661
  # Cannot be `""`.
659
662
  # @!attribute [rw] id
660
- # @return [Integer]
663
+ # @return [::Integer]
661
664
  # The auto-allocated ID of the entity.
662
665
  # Never equal to zero. Values less than zero are discouraged and may not
663
666
  # be supported in the future.
664
667
  # @!attribute [rw] name
665
- # @return [String]
668
+ # @return [::String]
666
669
  # The name of the entity.
667
670
  # A name matching regex `__.*__` is reserved/read-only.
668
671
  # A name must not be more than 1500 bytes when UTF-8 encoded.
669
672
  # Cannot be `""`.
670
673
  class PathElement
671
- include Google::Protobuf::MessageExts
672
- extend Google::Protobuf::MessageExts::ClassMethods
674
+ include ::Google::Protobuf::MessageExts
675
+ extend ::Google::Protobuf::MessageExts::ClassMethods
673
676
  end
674
677
  end
675
678
 
676
679
  # Message for a unique key indicating a record that contains a finding.
677
680
  # @!attribute [rw] datastore_key
678
- # @return [Google::Cloud::Dlp::V2::DatastoreKey]
681
+ # @return [::Google::Cloud::Dlp::V2::DatastoreKey]
679
682
  # @!attribute [rw] big_query_key
680
- # @return [Google::Cloud::Dlp::V2::BigQueryKey]
683
+ # @return [::Google::Cloud::Dlp::V2::BigQueryKey]
681
684
  # @!attribute [rw] id_values
682
- # @return [Array<String>]
685
+ # @return [::Array<::String>]
683
686
  # Values of identifying columns in the given row. Order of values matches
684
687
  # the order of `identifying_fields` specified in the scanning request.
685
688
  class RecordKey
686
- include Google::Protobuf::MessageExts
687
- extend Google::Protobuf::MessageExts::ClassMethods
689
+ include ::Google::Protobuf::MessageExts
690
+ extend ::Google::Protobuf::MessageExts::ClassMethods
688
691
  end
689
692
 
690
693
  # Message defining the location of a BigQuery table. A table is uniquely
@@ -693,30 +696,30 @@ module Google
693
696
  # `<project_id>:<dataset_id>.<table_id>` or
694
697
  # `<project_id>.<dataset_id>.<table_id>`.
695
698
  # @!attribute [rw] project_id
696
- # @return [String]
699
+ # @return [::String]
697
700
  # The Google Cloud Platform project ID of the project containing the table.
698
701
  # If omitted, project ID is inferred from the API call.
699
702
  # @!attribute [rw] dataset_id
700
- # @return [String]
703
+ # @return [::String]
701
704
  # Dataset ID of the table.
702
705
  # @!attribute [rw] table_id
703
- # @return [String]
706
+ # @return [::String]
704
707
  # Name of the table.
705
708
  class BigQueryTable
706
- include Google::Protobuf::MessageExts
707
- extend Google::Protobuf::MessageExts::ClassMethods
709
+ include ::Google::Protobuf::MessageExts
710
+ extend ::Google::Protobuf::MessageExts::ClassMethods
708
711
  end
709
712
 
710
713
  # Message defining a field of a BigQuery table.
711
714
  # @!attribute [rw] table
712
- # @return [Google::Cloud::Dlp::V2::BigQueryTable]
715
+ # @return [::Google::Cloud::Dlp::V2::BigQueryTable]
713
716
  # Source table of the field.
714
717
  # @!attribute [rw] field
715
- # @return [Google::Cloud::Dlp::V2::FieldId]
718
+ # @return [::Google::Cloud::Dlp::V2::FieldId]
716
719
  # Designated field in the BigQuery table.
717
720
  class BigQueryField
718
- include Google::Protobuf::MessageExts
719
- extend Google::Protobuf::MessageExts::ClassMethods
721
+ include ::Google::Protobuf::MessageExts
722
+ extend ::Google::Protobuf::MessageExts::ClassMethods
720
723
  end
721
724
 
722
725
  # An entity in a dataset is a field or set of fields that correspond to a
@@ -725,23 +728,23 @@ module Google
725
728
  # identifier. This message is used when generalizations or analysis must take
726
729
  # into account that multiple rows correspond to the same entity.
727
730
  # @!attribute [rw] field
728
- # @return [Google::Cloud::Dlp::V2::FieldId]
731
+ # @return [::Google::Cloud::Dlp::V2::FieldId]
729
732
  # Composite key indicating which field contains the entity identifier.
730
733
  class EntityId
731
- include Google::Protobuf::MessageExts
732
- extend Google::Protobuf::MessageExts::ClassMethods
734
+ include ::Google::Protobuf::MessageExts
735
+ extend ::Google::Protobuf::MessageExts::ClassMethods
733
736
  end
734
737
 
735
738
  # Instructions regarding the table content being inspected.
736
739
  # @!attribute [rw] identifying_fields
737
- # @return [Array<Google::Cloud::Dlp::V2::FieldId>]
740
+ # @return [::Array<::Google::Cloud::Dlp::V2::FieldId>]
738
741
  # The columns that are the primary keys for table objects included in
739
742
  # ContentItem. A copy of this cell's value will stored alongside alongside
740
743
  # each finding so that the finding can be traced to the specific row it came
741
744
  # from. No more than 3 may be provided.
742
745
  class TableOptions
743
- include Google::Protobuf::MessageExts
744
- extend Google::Protobuf::MessageExts::ClassMethods
746
+ include ::Google::Protobuf::MessageExts
747
+ extend ::Google::Protobuf::MessageExts::ClassMethods
745
748
  end
746
749
 
747
750
  # Categorization of results based on how likely they are to represent a match,
@@ -783,8 +786,17 @@ module Google
783
786
  # Included file extensions:
784
787
  # bmp, gif, jpg, jpeg, jpe, png.
785
788
  # bytes_limit_per_file has no effect on image files.
789
+ # Image inspection is restricted to 'global', 'us', 'asia', and 'europe'.
786
790
  IMAGE = 3
787
791
 
792
+ # Included file extensions:
793
+ # docx, dotx, docm, dotm
794
+ WORD = 5
795
+
796
+ # Included file extensions:
797
+ # pdf
798
+ PDF = 6
799
+
788
800
  # Included file extensions:
789
801
  # avro
790
802
  AVRO = 7