@google-cloud/dlp 5.1.1 → 5.3.0

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.
@@ -55,7 +55,7 @@ option (google.api.resource_definition) = {
55
55
  // scheduling of data scans on Google Cloud Platform based data sets.
56
56
  //
57
57
  // To learn more about concepts and find how-to guides see
58
- // https://cloud.google.com/dlp/docs/.
58
+ // https://cloud.google.com/sensitive-data-protection/docs/.
59
59
  service DlpService {
60
60
  option (google.api.default_host) = "dlp.googleapis.com";
61
61
  option (google.api.oauth_scopes) =
@@ -68,8 +68,10 @@ service DlpService {
68
68
  // system will automatically choose what detectors to run. By default this may
69
69
  // be all types, but may change over time as detectors are updated.
70
70
  //
71
- // For how to guides, see https://cloud.google.com/dlp/docs/inspecting-images
72
- // and https://cloud.google.com/dlp/docs/inspecting-text,
71
+ // For how to guides, see
72
+ // https://cloud.google.com/sensitive-data-protection/docs/inspecting-images
73
+ // and
74
+ // https://cloud.google.com/sensitive-data-protection/docs/inspecting-text,
73
75
  rpc InspectContent(InspectContentRequest) returns (InspectContentResponse) {
74
76
  option (google.api.http) = {
75
77
  post: "/v2/{parent=projects/*}/content:inspect"
@@ -83,8 +85,9 @@ service DlpService {
83
85
 
84
86
  // Redacts potentially sensitive info from an image.
85
87
  // This method has limits on input size, processing time, and output size.
86
- // See https://cloud.google.com/dlp/docs/redacting-sensitive-data-images to
87
- // learn more.
88
+ // See
89
+ // https://cloud.google.com/sensitive-data-protection/docs/redacting-sensitive-data-images
90
+ // to learn more.
88
91
  //
89
92
  // When no InfoTypes or CustomInfoTypes are specified in this request, the
90
93
  // system will automatically choose what detectors to run. By default this may
@@ -102,8 +105,9 @@ service DlpService {
102
105
 
103
106
  // De-identifies potentially sensitive info from a ContentItem.
104
107
  // This method has limits on input size and output size.
105
- // See https://cloud.google.com/dlp/docs/deidentify-sensitive-data to
106
- // learn more.
108
+ // See
109
+ // https://cloud.google.com/sensitive-data-protection/docs/deidentify-sensitive-data
110
+ // to learn more.
107
111
  //
108
112
  // When no InfoTypes or CustomInfoTypes are specified in this request, the
109
113
  // system will automatically choose what detectors to run. By default this may
@@ -122,7 +126,7 @@ service DlpService {
122
126
 
123
127
  // Re-identifies content that has been de-identified.
124
128
  // See
125
- // https://cloud.google.com/dlp/docs/pseudonymization#re-identification_in_free_text_code_example
129
+ // https://cloud.google.com/sensitive-data-protection/docs/pseudonymization#re-identification_in_free_text_code_example
126
130
  // to learn more.
127
131
  rpc ReidentifyContent(ReidentifyContentRequest)
128
132
  returns (ReidentifyContentResponse) {
@@ -137,8 +141,9 @@ service DlpService {
137
141
  }
138
142
 
139
143
  // Returns a list of the sensitive information types that DLP API
140
- // supports. See https://cloud.google.com/dlp/docs/infotypes-reference to
141
- // learn more.
144
+ // supports. See
145
+ // https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference
146
+ // to learn more.
142
147
  rpc ListInfoTypes(ListInfoTypesRequest) returns (ListInfoTypesResponse) {
143
148
  option (google.api.http) = {
144
149
  get: "/v2/infoTypes"
@@ -149,7 +154,9 @@ service DlpService {
149
154
 
150
155
  // Creates an InspectTemplate for reusing frequently used configuration
151
156
  // for inspecting content, images, and storage.
152
- // See https://cloud.google.com/dlp/docs/creating-templates to learn more.
157
+ // See
158
+ // https://cloud.google.com/sensitive-data-protection/docs/creating-templates
159
+ // to learn more.
153
160
  rpc CreateInspectTemplate(CreateInspectTemplateRequest)
154
161
  returns (InspectTemplate) {
155
162
  option (google.api.http) = {
@@ -172,7 +179,9 @@ service DlpService {
172
179
  }
173
180
 
174
181
  // Updates the InspectTemplate.
175
- // See https://cloud.google.com/dlp/docs/creating-templates to learn more.
182
+ // See
183
+ // https://cloud.google.com/sensitive-data-protection/docs/creating-templates
184
+ // to learn more.
176
185
  rpc UpdateInspectTemplate(UpdateInspectTemplateRequest)
177
186
  returns (InspectTemplate) {
178
187
  option (google.api.http) = {
@@ -195,7 +204,9 @@ service DlpService {
195
204
  }
196
205
 
197
206
  // Gets an InspectTemplate.
198
- // See https://cloud.google.com/dlp/docs/creating-templates to learn more.
207
+ // See
208
+ // https://cloud.google.com/sensitive-data-protection/docs/creating-templates
209
+ // to learn more.
199
210
  rpc GetInspectTemplate(GetInspectTemplateRequest) returns (InspectTemplate) {
200
211
  option (google.api.http) = {
201
212
  get: "/v2/{name=organizations/*/inspectTemplates/*}"
@@ -211,7 +222,9 @@ service DlpService {
211
222
  }
212
223
 
213
224
  // Lists InspectTemplates.
214
- // See https://cloud.google.com/dlp/docs/creating-templates to learn more.
225
+ // See
226
+ // https://cloud.google.com/sensitive-data-protection/docs/creating-templates
227
+ // to learn more.
215
228
  rpc ListInspectTemplates(ListInspectTemplatesRequest)
216
229
  returns (ListInspectTemplatesResponse) {
217
230
  option (google.api.http) = {
@@ -228,7 +241,9 @@ service DlpService {
228
241
  }
229
242
 
230
243
  // Deletes an InspectTemplate.
231
- // See https://cloud.google.com/dlp/docs/creating-templates to learn more.
244
+ // See
245
+ // https://cloud.google.com/sensitive-data-protection/docs/creating-templates
246
+ // to learn more.
232
247
  rpc DeleteInspectTemplate(DeleteInspectTemplateRequest)
233
248
  returns (google.protobuf.Empty) {
234
249
  option (google.api.http) = {
@@ -246,8 +261,9 @@ service DlpService {
246
261
 
247
262
  // Creates a DeidentifyTemplate for reusing frequently used configuration
248
263
  // for de-identifying content, images, and storage.
249
- // See https://cloud.google.com/dlp/docs/creating-templates-deid to learn
250
- // more.
264
+ // See
265
+ // https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid
266
+ // to learn more.
251
267
  rpc CreateDeidentifyTemplate(CreateDeidentifyTemplateRequest)
252
268
  returns (DeidentifyTemplate) {
253
269
  option (google.api.http) = {
@@ -270,8 +286,9 @@ service DlpService {
270
286
  }
271
287
 
272
288
  // Updates the DeidentifyTemplate.
273
- // See https://cloud.google.com/dlp/docs/creating-templates-deid to learn
274
- // more.
289
+ // See
290
+ // https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid
291
+ // to learn more.
275
292
  rpc UpdateDeidentifyTemplate(UpdateDeidentifyTemplateRequest)
276
293
  returns (DeidentifyTemplate) {
277
294
  option (google.api.http) = {
@@ -295,8 +312,9 @@ service DlpService {
295
312
  }
296
313
 
297
314
  // Gets a DeidentifyTemplate.
298
- // See https://cloud.google.com/dlp/docs/creating-templates-deid to learn
299
- // more.
315
+ // See
316
+ // https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid
317
+ // to learn more.
300
318
  rpc GetDeidentifyTemplate(GetDeidentifyTemplateRequest)
301
319
  returns (DeidentifyTemplate) {
302
320
  option (google.api.http) = {
@@ -313,8 +331,9 @@ service DlpService {
313
331
  }
314
332
 
315
333
  // Lists DeidentifyTemplates.
316
- // See https://cloud.google.com/dlp/docs/creating-templates-deid to learn
317
- // more.
334
+ // See
335
+ // https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid
336
+ // to learn more.
318
337
  rpc ListDeidentifyTemplates(ListDeidentifyTemplatesRequest)
319
338
  returns (ListDeidentifyTemplatesResponse) {
320
339
  option (google.api.http) = {
@@ -331,8 +350,9 @@ service DlpService {
331
350
  }
332
351
 
333
352
  // Deletes a DeidentifyTemplate.
334
- // See https://cloud.google.com/dlp/docs/creating-templates-deid to learn
335
- // more.
353
+ // See
354
+ // https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid
355
+ // to learn more.
336
356
  rpc DeleteDeidentifyTemplate(DeleteDeidentifyTemplateRequest)
337
357
  returns (google.protobuf.Empty) {
338
358
  option (google.api.http) = {
@@ -352,7 +372,9 @@ service DlpService {
352
372
 
353
373
  // Creates a job trigger to run DLP actions such as scanning storage for
354
374
  // sensitive information on a set schedule.
355
- // See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.
375
+ // See
376
+ // https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers
377
+ // to learn more.
356
378
  rpc CreateJobTrigger(CreateJobTriggerRequest) returns (JobTrigger) {
357
379
  option (google.api.http) = {
358
380
  post: "/v2/{parent=projects/*}/jobTriggers"
@@ -370,7 +392,9 @@ service DlpService {
370
392
  }
371
393
 
372
394
  // Updates a job trigger.
373
- // See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.
395
+ // See
396
+ // https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers
397
+ // to learn more.
374
398
  rpc UpdateJobTrigger(UpdateJobTriggerRequest) returns (JobTrigger) {
375
399
  option (google.api.http) = {
376
400
  patch: "/v2/{name=projects/*/jobTriggers/*}"
@@ -400,7 +424,9 @@ service DlpService {
400
424
  }
401
425
 
402
426
  // Gets a job trigger.
403
- // See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.
427
+ // See
428
+ // https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers
429
+ // to learn more.
404
430
  rpc GetJobTrigger(GetJobTriggerRequest) returns (JobTrigger) {
405
431
  option (google.api.http) = {
406
432
  get: "/v2/{name=projects/*/jobTriggers/*}"
@@ -415,7 +441,9 @@ service DlpService {
415
441
  }
416
442
 
417
443
  // Lists job triggers.
418
- // See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.
444
+ // See
445
+ // https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers
446
+ // to learn more.
419
447
  rpc ListJobTriggers(ListJobTriggersRequest)
420
448
  returns (ListJobTriggersResponse) {
421
449
  option (google.api.http) = {
@@ -431,7 +459,9 @@ service DlpService {
431
459
  }
432
460
 
433
461
  // Deletes a job trigger.
434
- // See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.
462
+ // See
463
+ // https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers
464
+ // to learn more.
435
465
  rpc DeleteJobTrigger(DeleteJobTriggerRequest)
436
466
  returns (google.protobuf.Empty) {
437
467
  option (google.api.http) = {
@@ -523,8 +553,11 @@ service DlpService {
523
553
  }
524
554
 
525
555
  // Creates a new job to inspect storage or calculate risk metrics.
526
- // See https://cloud.google.com/dlp/docs/inspecting-storage and
527
- // https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.
556
+ // See
557
+ // https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage
558
+ // and
559
+ // https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis
560
+ // to learn more.
528
561
  //
529
562
  // When no InfoTypes or CustomInfoTypes are specified in inspect jobs, the
530
563
  // system will automatically choose what detectors to run. By default this may
@@ -543,8 +576,11 @@ service DlpService {
543
576
  }
544
577
 
545
578
  // Lists DlpJobs that match the specified filter in the request.
546
- // See https://cloud.google.com/dlp/docs/inspecting-storage and
547
- // https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.
579
+ // See
580
+ // https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage
581
+ // and
582
+ // https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis
583
+ // to learn more.
548
584
  rpc ListDlpJobs(ListDlpJobsRequest) returns (ListDlpJobsResponse) {
549
585
  option (google.api.http) = {
550
586
  get: "/v2/{parent=projects/*}/dlpJobs"
@@ -557,8 +593,11 @@ service DlpService {
557
593
  }
558
594
 
559
595
  // Gets the latest state of a long-running DlpJob.
560
- // See https://cloud.google.com/dlp/docs/inspecting-storage and
561
- // https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.
596
+ // See
597
+ // https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage
598
+ // and
599
+ // https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis
600
+ // to learn more.
562
601
  rpc GetDlpJob(GetDlpJobRequest) returns (DlpJob) {
563
602
  option (google.api.http) = {
564
603
  get: "/v2/{name=projects/*/dlpJobs/*}"
@@ -570,8 +609,11 @@ service DlpService {
570
609
  // Deletes a long-running DlpJob. This method indicates that the client is
571
610
  // no longer interested in the DlpJob result. The job will be canceled if
572
611
  // possible.
573
- // See https://cloud.google.com/dlp/docs/inspecting-storage and
574
- // https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.
612
+ // See
613
+ // https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage
614
+ // and
615
+ // https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis
616
+ // to learn more.
575
617
  rpc DeleteDlpJob(DeleteDlpJobRequest) returns (google.protobuf.Empty) {
576
618
  option (google.api.http) = {
577
619
  delete: "/v2/{name=projects/*/dlpJobs/*}"
@@ -585,8 +627,11 @@ service DlpService {
585
627
  // Starts asynchronous cancellation on a long-running DlpJob. The server
586
628
  // makes a best effort to cancel the DlpJob, but success is not
587
629
  // guaranteed.
588
- // See https://cloud.google.com/dlp/docs/inspecting-storage and
589
- // https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.
630
+ // See
631
+ // https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage
632
+ // and
633
+ // https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis
634
+ // to learn more.
590
635
  rpc CancelDlpJob(CancelDlpJobRequest) returns (google.protobuf.Empty) {
591
636
  option (google.api.http) = {
592
637
  post: "/v2/{name=projects/*/dlpJobs/*}:cancel"
@@ -599,8 +644,9 @@ service DlpService {
599
644
  }
600
645
 
601
646
  // Creates a pre-built stored infoType to be used for inspection.
602
- // See https://cloud.google.com/dlp/docs/creating-stored-infotypes to
603
- // learn more.
647
+ // See
648
+ // https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes
649
+ // to learn more.
604
650
  rpc CreateStoredInfoType(CreateStoredInfoTypeRequest)
605
651
  returns (StoredInfoType) {
606
652
  option (google.api.http) = {
@@ -624,8 +670,9 @@ service DlpService {
624
670
 
625
671
  // Updates the stored infoType by creating a new version. The existing version
626
672
  // will continue to be used until the new version is ready.
627
- // See https://cloud.google.com/dlp/docs/creating-stored-infotypes to
628
- // learn more.
673
+ // See
674
+ // https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes
675
+ // to learn more.
629
676
  rpc UpdateStoredInfoType(UpdateStoredInfoTypeRequest)
630
677
  returns (StoredInfoType) {
631
678
  option (google.api.http) = {
@@ -648,8 +695,9 @@ service DlpService {
648
695
  }
649
696
 
650
697
  // Gets a stored infoType.
651
- // See https://cloud.google.com/dlp/docs/creating-stored-infotypes to
652
- // learn more.
698
+ // See
699
+ // https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes
700
+ // to learn more.
653
701
  rpc GetStoredInfoType(GetStoredInfoTypeRequest) returns (StoredInfoType) {
654
702
  option (google.api.http) = {
655
703
  get: "/v2/{name=organizations/*/storedInfoTypes/*}"
@@ -665,8 +713,9 @@ service DlpService {
665
713
  }
666
714
 
667
715
  // Lists stored infoTypes.
668
- // See https://cloud.google.com/dlp/docs/creating-stored-infotypes to
669
- // learn more.
716
+ // See
717
+ // https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes
718
+ // to learn more.
670
719
  rpc ListStoredInfoTypes(ListStoredInfoTypesRequest)
671
720
  returns (ListStoredInfoTypesResponse) {
672
721
  option (google.api.http) = {
@@ -683,8 +732,9 @@ service DlpService {
683
732
  }
684
733
 
685
734
  // Deletes a stored infoType.
686
- // See https://cloud.google.com/dlp/docs/creating-stored-infotypes to
687
- // learn more.
735
+ // See
736
+ // https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes
737
+ // to learn more.
688
738
  rpc DeleteStoredInfoType(DeleteStoredInfoTypeRequest)
689
739
  returns (google.protobuf.Empty) {
690
740
  option (google.api.http) = {
@@ -700,6 +750,78 @@ service DlpService {
700
750
  option (google.api.method_signature) = "name";
701
751
  }
702
752
 
753
+ // Lists data profiles for an organization.
754
+ rpc ListProjectDataProfiles(ListProjectDataProfilesRequest)
755
+ returns (ListProjectDataProfilesResponse) {
756
+ option (google.api.http) = {
757
+ get: "/v2/{parent=organizations/*/locations/*}/projectDataProfiles"
758
+ additional_bindings {
759
+ get: "/v2/{parent=projects/*/locations/*}/projectDataProfiles"
760
+ }
761
+ };
762
+ option (google.api.method_signature) = "parent";
763
+ }
764
+
765
+ // Lists data profiles for an organization.
766
+ rpc ListTableDataProfiles(ListTableDataProfilesRequest)
767
+ returns (ListTableDataProfilesResponse) {
768
+ option (google.api.http) = {
769
+ get: "/v2/{parent=organizations/*/locations/*}/tableDataProfiles"
770
+ additional_bindings {
771
+ get: "/v2/{parent=projects/*/locations/*}/tableDataProfiles"
772
+ }
773
+ };
774
+ option (google.api.method_signature) = "parent";
775
+ }
776
+
777
+ // Lists data profiles for an organization.
778
+ rpc ListColumnDataProfiles(ListColumnDataProfilesRequest)
779
+ returns (ListColumnDataProfilesResponse) {
780
+ option (google.api.http) = {
781
+ get: "/v2/{parent=organizations/*/locations/*}/columnDataProfiles"
782
+ additional_bindings {
783
+ get: "/v2/{parent=projects/*/locations/*}/columnDataProfiles"
784
+ }
785
+ };
786
+ option (google.api.method_signature) = "parent";
787
+ }
788
+
789
+ // Gets a project data profile.
790
+ rpc GetProjectDataProfile(GetProjectDataProfileRequest)
791
+ returns (ProjectDataProfile) {
792
+ option (google.api.http) = {
793
+ get: "/v2/{name=organizations/*/locations/*/projectDataProfiles/*}"
794
+ additional_bindings {
795
+ get: "/v2/{name=projects/*/locations/*/projectDataProfiles/*}"
796
+ }
797
+ };
798
+ option (google.api.method_signature) = "name";
799
+ }
800
+
801
+ // Gets a table data profile.
802
+ rpc GetTableDataProfile(GetTableDataProfileRequest)
803
+ returns (TableDataProfile) {
804
+ option (google.api.http) = {
805
+ get: "/v2/{name=organizations/*/locations/*/tableDataProfiles/*}"
806
+ additional_bindings {
807
+ get: "/v2/{name=projects/*/locations/*/tableDataProfiles/*}"
808
+ }
809
+ };
810
+ option (google.api.method_signature) = "name";
811
+ }
812
+
813
+ // Gets a column data profile.
814
+ rpc GetColumnDataProfile(GetColumnDataProfileRequest)
815
+ returns (ColumnDataProfile) {
816
+ option (google.api.http) = {
817
+ get: "/v2/{name=organizations/*/locations/*/columnDataProfiles/*}"
818
+ additional_bindings {
819
+ get: "/v2/{name=projects/*/locations/*/columnDataProfiles/*}"
820
+ }
821
+ };
822
+ option (google.api.method_signature) = "name";
823
+ }
824
+
703
825
  // Inspect hybrid content and store findings to a job.
704
826
  // To review the findings, inspect the job. Inspection will occur
705
827
  // asynchronously.
@@ -869,7 +991,7 @@ message InspectConfig {
869
991
 
870
992
  // Restricts what info_types to look for. The values must correspond to
871
993
  // InfoType values returned by ListInfoTypes or listed at
872
- // https://cloud.google.com/dlp/docs/infotypes-reference.
994
+ // https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference.
873
995
  //
874
996
  // When no InfoTypes or CustomInfoTypes are specified in a request, the
875
997
  // system may automatically choose a default list of detectors to run, which
@@ -885,7 +1007,8 @@ message InspectConfig {
885
1007
  //
886
1008
  // In general, the highest likelihood setting yields the fewest findings in
887
1009
  // results and the lowest chance of a false positive. For more information,
888
- // see [Match likelihood](https://cloud.google.com/dlp/docs/likelihood).
1010
+ // see [Match
1011
+ // likelihood](https://cloud.google.com/sensitive-data-protection/docs/likelihood).
889
1012
  Likelihood min_likelihood = 2;
890
1013
 
891
1014
  // Minimum likelihood per infotype. For each infotype, a user can specify a
@@ -922,7 +1045,8 @@ message InspectConfig {
922
1045
  bool exclude_info_types = 5;
923
1046
 
924
1047
  // CustomInfoTypes provided by the user. See
925
- // https://cloud.google.com/dlp/docs/creating-custom-infotypes to learn more.
1048
+ // https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes
1049
+ // to learn more.
926
1050
  repeated CustomInfoType custom_info_types = 6;
927
1051
 
928
1052
  // Deprecated and unused.
@@ -938,7 +1062,7 @@ message InspectConfig {
938
1062
  message ByteContentItem {
939
1063
  // The type of data being sent for inspection. To learn more, see
940
1064
  // [Supported file
941
- // types](https://cloud.google.com/dlp/docs/supported-file-types).
1065
+ // types](https://cloud.google.com/sensitive-data-protection/docs/supported-file-types).
942
1066
  enum BytesType {
943
1067
  // Unused
944
1068
  BYTES_TYPE_UNSPECIFIED = 0;
@@ -990,6 +1114,7 @@ message ByteContentItem {
990
1114
  bytes data = 2;
991
1115
  }
992
1116
 
1117
+ // Type of content to inspect.
993
1118
  message ContentItem {
994
1119
  // Data of the item either in the byte array or UTF-8 string form, or table.
995
1120
  oneof data_item {
@@ -997,8 +1122,8 @@ message ContentItem {
997
1122
  string value = 3;
998
1123
 
999
1124
  // Structured content for inspection. See
1000
- // https://cloud.google.com/dlp/docs/inspecting-text#inspecting_a_table to
1001
- // learn more.
1125
+ // https://cloud.google.com/sensitive-data-protection/docs/inspecting-text#inspecting_a_table
1126
+ // to learn more.
1002
1127
  Table table = 4;
1003
1128
 
1004
1129
  // Content data to inspect or redact. Replaces `type` and `data`.
@@ -1007,7 +1132,7 @@ message ContentItem {
1007
1132
  }
1008
1133
 
1009
1134
  // Structured content to inspect. Up to 50,000 `Value`s per request allowed. See
1010
- // https://cloud.google.com/dlp/docs/inspecting-structured-text#inspecting_a_table
1135
+ // https://cloud.google.com/sensitive-data-protection/docs/inspecting-structured-text#inspecting_a_table
1011
1136
  // to learn more.
1012
1137
  message Table {
1013
1138
  // Values of the row.
@@ -1187,6 +1312,7 @@ message MetadataLocation {
1187
1312
 
1188
1313
  // Storage metadata label to indicate which metadata entry contains findings.
1189
1314
  message StorageMetadataLabel {
1315
+ // Label name.
1190
1316
  string key = 1;
1191
1317
  }
1192
1318
 
@@ -1322,7 +1448,7 @@ message RedactImageRequest {
1322
1448
  //
1323
1449
  // The format of this value varies depending on whether you have [specified a
1324
1450
  // processing
1325
- // location](https://cloud.google.com/dlp/docs/specifying-location):
1451
+ // location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location):
1326
1452
  //
1327
1453
  // + Projects scope, location specified:<br/>
1328
1454
  // `projects/`<var>PROJECT_ID</var>`/locations/`<var>LOCATION_ID</var>
@@ -1387,7 +1513,7 @@ message DeidentifyContentRequest {
1387
1513
  //
1388
1514
  // The format of this value varies depending on whether you have [specified a
1389
1515
  // processing
1390
- // location](https://cloud.google.com/dlp/docs/specifying-location):
1516
+ // location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location):
1391
1517
  //
1392
1518
  // + Projects scope, location specified:<br/>
1393
1519
  // `projects/`<var>PROJECT_ID</var>`/locations/`<var>LOCATION_ID</var>
@@ -1456,7 +1582,7 @@ message ReidentifyContentRequest {
1456
1582
  //
1457
1583
  // The format of this value varies depending on whether you have [specified a
1458
1584
  // processing
1459
- // location](https://cloud.google.com/dlp/docs/specifying-location):
1585
+ // location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location):
1460
1586
  //
1461
1587
  // + Projects scope, location specified:<br/>
1462
1588
  // `projects/`<var>PROJECT_ID</var>`/locations/`<var>LOCATION_ID</var>
@@ -1528,7 +1654,7 @@ message InspectContentRequest {
1528
1654
  //
1529
1655
  // The format of this value varies depending on whether you have [specified a
1530
1656
  // processing
1531
- // location](https://cloud.google.com/dlp/docs/specifying-location):
1657
+ // location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location):
1532
1658
  //
1533
1659
  // + Projects scope, location specified:<br/>
1534
1660
  // `projects/`<var>PROJECT_ID</var>`/locations/`<var>LOCATION_ID</var>
@@ -1672,6 +1798,7 @@ message InspectDataSourceDetails {
1672
1798
  // The schema of data to be saved to the BigQuery table when the
1673
1799
  // `DataProfileAction` is enabled.
1674
1800
  message DataProfileBigQueryRowSchema {
1801
+ // Data profile type.
1675
1802
  oneof data_profile {
1676
1803
  // Table data profile column
1677
1804
  TableDataProfile table_profile = 1;
@@ -1958,6 +2085,7 @@ message InfoTypeCategory {
1958
2085
  CONTEXTUAL_INFORMATION = 7;
1959
2086
  }
1960
2087
 
2088
+ // Categories of infotypes.
1961
2089
  oneof category {
1962
2090
  // The region or country that issued the ID or document represented by the
1963
2091
  // infoType.
@@ -2009,7 +2137,8 @@ message ListInfoTypesResponse {
2009
2137
  }
2010
2138
 
2011
2139
  // Configuration for a risk analysis job. See
2012
- // https://cloud.google.com/dlp/docs/concepts-risk-analysis to learn more.
2140
+ // https://cloud.google.com/sensitive-data-protection/docs/concepts-risk-analysis
2141
+ // to learn more.
2013
2142
  message RiskAnalysisJobConfig {
2014
2143
  // Privacy metric to compute.
2015
2144
  PrivacyMetric privacy_metric = 1;
@@ -2600,6 +2729,7 @@ message DateTime {
2600
2729
 
2601
2730
  // The configuration that controls how the data will change.
2602
2731
  message DeidentifyConfig {
2732
+ // Type of transformation
2603
2733
  oneof transformation {
2604
2734
  // Treat the dataset as free-form text and apply the same free text
2605
2735
  // transformation everywhere.
@@ -2636,6 +2766,7 @@ message ImageTransformations {
2636
2766
  // Apply to all text.
2637
2767
  message AllText {}
2638
2768
 
2769
+ // Part of the image to transform.
2639
2770
  oneof target {
2640
2771
  // Apply transformation to the selected info_types.
2641
2772
  SelectedInfoTypes selected_info_types = 4;
@@ -2655,6 +2786,7 @@ message ImageTransformations {
2655
2786
  Color redaction_color = 3;
2656
2787
  }
2657
2788
 
2789
+ // List of transforms to make.
2658
2790
  repeated ImageTransformation transforms = 2;
2659
2791
  }
2660
2792
 
@@ -2688,6 +2820,7 @@ message TransformationErrorHandling {
2688
2820
 
2689
2821
  // A rule for transforming a value.
2690
2822
  message PrimitiveTransformation {
2823
+ // Type of transformation.
2691
2824
  oneof transformation {
2692
2825
  // Replace with a specified value.
2693
2826
  ReplaceValueConfig replace_config = 1;
@@ -2764,7 +2897,8 @@ message TimePartConfig {
2764
2897
  // Outputs a base64 encoded representation of the hashed output
2765
2898
  // (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=).
2766
2899
  // Currently, only string and integer values can be hashed.
2767
- // See https://cloud.google.com/dlp/docs/pseudonymization to learn more.
2900
+ // See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization
2901
+ // to learn more.
2768
2902
  message CryptoHashConfig {
2769
2903
  // The key used by the hash function.
2770
2904
  CryptoKey crypto_key = 1;
@@ -2842,10 +2976,11 @@ message ReplaceValueConfig {
2842
2976
 
2843
2977
  // Replace each input value with a value randomly selected from the dictionary.
2844
2978
  message ReplaceDictionaryConfig {
2979
+ // Type of dictionary.
2845
2980
  oneof type {
2846
2981
  // A list of words to select from for random replacement. The
2847
- // [limits](https://cloud.google.com/dlp/limits) page contains details about
2848
- // the size limits of dictionaries.
2982
+ // [limits](https://cloud.google.com/sensitive-data-protection/limits) page
2983
+ // contains details about the size limits of dictionaries.
2849
2984
  CustomInfoType.Dictionary.WordList word_list = 1;
2850
2985
  }
2851
2986
  }
@@ -2882,6 +3017,7 @@ message CharsToIgnore {
2882
3017
  WHITESPACE = 5;
2883
3018
  }
2884
3019
 
3020
+ // Type of characters to skip.
2885
3021
  oneof characters {
2886
3022
  // Characters to not transform when masking.
2887
3023
  string characters_to_skip = 1;
@@ -2953,7 +3089,9 @@ message CharacterMaskConfig {
2953
3089
  // being transformed, we will first attempt converting the type of the data to
2954
3090
  // be transformed to match the type of the bound before comparing.
2955
3091
  //
2956
- // See https://cloud.google.com/dlp/docs/concepts-bucketing to learn more.
3092
+ // See
3093
+ // https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to
3094
+ // learn more.
2957
3095
  message FixedSizeBucketingConfig {
2958
3096
  // Required. Lower bound value of buckets. All values less than `lower_bound`
2959
3097
  // are grouped together into a single bucket; for example if `lower_bound` =
@@ -2980,7 +3118,9 @@ message FixedSizeBucketingConfig {
2980
3118
  // If the bound `Value` type differs from the type of data being transformed, we
2981
3119
  // will first attempt converting the type of the data to be transformed to match
2982
3120
  // the type of the bound before comparing.
2983
- // See https://cloud.google.com/dlp/docs/concepts-bucketing to learn more.
3121
+ // See
3122
+ // https://cloud.google.com/sensitive-data-protection/docs/concepts-bucketing to
3123
+ // learn more.
2984
3124
  message BucketingConfig {
2985
3125
  // Bucket is represented as a range, along with replacement values.
2986
3126
  message Bucket {
@@ -3006,8 +3146,9 @@ message BucketingConfig {
3006
3146
  // encoded as ASCII. For a given crypto key and context, the same identifier
3007
3147
  // will be replaced with the same surrogate. Identifiers must be at least two
3008
3148
  // characters long. In the case that the identifier is the empty string, it will
3009
- // be skipped. See https://cloud.google.com/dlp/docs/pseudonymization to learn
3010
- // more.
3149
+ // be skipped. See
3150
+ // https://cloud.google.com/sensitive-data-protection/docs/pseudonymization to
3151
+ // learn more.
3011
3152
  //
3012
3153
  // Note: We recommend using CryptoDeterministicConfig for all use cases which
3013
3154
  // do not require preserving the input alphabet space and size, plus warrant
@@ -3091,7 +3232,7 @@ message CryptoReplaceFfxFpeConfig {
3091
3232
  //
3092
3233
  // This annotation identifies the surrogate when inspecting content using the
3093
3234
  // custom infoType
3094
- // [`SurrogateType`](https://cloud.google.com/dlp/docs/reference/rest/v2/InspectConfig#surrogatetype).
3235
+ // [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype).
3095
3236
  // This facilitates reversal of the surrogate when it occurs in free text.
3096
3237
  //
3097
3238
  // In order for inspection to work properly, the name of this infoType must
@@ -3153,7 +3294,7 @@ message UnwrappedCryptoKey {
3153
3294
  // dlp.kms.encrypt
3154
3295
  //
3155
3296
  // For more information, see [Creating a wrapped key]
3156
- // (https://cloud.google.com/dlp/docs/create-wrapped-key).
3297
+ // (https://cloud.google.com/sensitive-data-protection/docs/create-wrapped-key).
3157
3298
  //
3158
3299
  // Note: When you use Cloud KMS for cryptographic operations,
3159
3300
  // [charges apply](https://cloud.google.com/kms/pricing).
@@ -3166,7 +3307,8 @@ message KmsWrappedCryptoKey {
3166
3307
  }
3167
3308
 
3168
3309
  // Shifts dates by random number of days, with option to be consistent for the
3169
- // same context. See https://cloud.google.com/dlp/docs/concepts-date-shifting
3310
+ // same context. See
3311
+ // https://cloud.google.com/sensitive-data-protection/docs/concepts-date-shifting
3170
3312
  // to learn more.
3171
3313
  message DateShiftConfig {
3172
3314
  // Required. Range of shift in days. Actual shift will be selected at random
@@ -3459,6 +3601,7 @@ message TransformationDetails {
3459
3601
 
3460
3602
  // Specifies the location of a transformation.
3461
3603
  message TransformationLocation {
3604
+ // Location type.
3462
3605
  oneof location_type {
3463
3606
  // For infotype transformations, link to the corresponding findings ID so
3464
3607
  // that location information does not need to be duplicated. Each findings
@@ -3476,6 +3619,7 @@ message TransformationLocation {
3476
3619
  TransformationContainerType container_type = 3;
3477
3620
  }
3478
3621
 
3622
+ // The field in a record to transform.
3479
3623
  message RecordTransformation {
3480
3624
  // For record transformations, provide a field.
3481
3625
  FieldId field_id = 1;
@@ -3487,6 +3631,7 @@ message RecordTransformation {
3487
3631
  string container_version = 3;
3488
3632
  }
3489
3633
 
3634
+ // The outcome of a transformation.
3490
3635
  message TransformationResultStatus {
3491
3636
  // Transformation result status type, this will be either SUCCESS, or it will
3492
3637
  // be the reason for why the transformation was not completely successful.
@@ -3500,6 +3645,7 @@ message TransformationResultStatus {
3500
3645
  // storing of transformation was successful, otherwise, reason for not
3501
3646
  // transforming.
3502
3647
  enum TransformationResultStatusType {
3648
+ // Unused.
3503
3649
  STATE_TYPE_UNSPECIFIED = 0;
3504
3650
 
3505
3651
  // This will be set when a finding could not be transformed (i.e. outside user
@@ -3522,12 +3668,16 @@ enum TransformationResultStatusType {
3522
3668
 
3523
3669
  // Describes functionality of a given container in its original format.
3524
3670
  enum TransformationContainerType {
3671
+ // Unused.
3525
3672
  TRANSFORM_UNKNOWN_CONTAINER = 0;
3526
3673
 
3674
+ // Body of a file.
3527
3675
  TRANSFORM_BODY = 1;
3528
3676
 
3677
+ // Metadata for a file.
3529
3678
  TRANSFORM_METADATA = 2;
3530
3679
 
3680
+ // A table.
3531
3681
  TRANSFORM_TABLE = 3;
3532
3682
  }
3533
3683
 
@@ -3597,6 +3747,7 @@ message TransformationDetailsStorageConfig {
3597
3747
 
3598
3748
  // Schedule for inspect job triggers.
3599
3749
  message Schedule {
3750
+ // Type of schedule.
3600
3751
  oneof option {
3601
3752
  // With this option a job is started on a regular periodic basis. For
3602
3753
  // example: every day (86400 seconds).
@@ -3616,8 +3767,9 @@ message Manual {}
3616
3767
 
3617
3768
  // The inspectTemplate contains a configuration (set of types of sensitive data
3618
3769
  // to be detected) to be used anywhere you otherwise would normally specify
3619
- // InspectConfig. See https://cloud.google.com/dlp/docs/concepts-templates
3620
- // to learn more.
3770
+ // InspectConfig. See
3771
+ // https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to
3772
+ // learn more.
3621
3773
  message InspectTemplate {
3622
3774
  option (google.api.resource) = {
3623
3775
  type: "dlp.googleapis.com/InspectTemplate"
@@ -3653,7 +3805,9 @@ message InspectTemplate {
3653
3805
  }
3654
3806
 
3655
3807
  // DeidentifyTemplates contains instructions on how to de-identify content.
3656
- // See https://cloud.google.com/dlp/docs/concepts-templates to learn more.
3808
+ // See
3809
+ // https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to
3810
+ // learn more.
3657
3811
  message DeidentifyTemplate {
3658
3812
  option (google.api.resource) = {
3659
3813
  type: "dlp.googleapis.com/DeidentifyTemplate"
@@ -3700,7 +3854,9 @@ message Error {
3700
3854
  }
3701
3855
 
3702
3856
  // Contains a configuration to make dlp api calls on a repeating basis.
3703
- // See https://cloud.google.com/dlp/docs/concepts-job-triggers to learn more.
3857
+ // See
3858
+ // https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers
3859
+ // to learn more.
3704
3860
  message JobTrigger {
3705
3861
  option (google.api.resource) = {
3706
3862
  type: "dlp.googleapis.com/JobTrigger"
@@ -3710,6 +3866,7 @@ message JobTrigger {
3710
3866
 
3711
3867
  // What event needs to occur for a new job to be started.
3712
3868
  message Trigger {
3869
+ // What event needs to occur for a new job to be started.
3713
3870
  oneof trigger {
3714
3871
  // Create a job on a repeating basis based on the elapse of time.
3715
3872
  Schedule schedule = 1;
@@ -3782,7 +3939,8 @@ message JobTrigger {
3782
3939
  }
3783
3940
 
3784
3941
  // A task to execute on the completion of a job.
3785
- // See https://cloud.google.com/dlp/docs/concepts-actions to learn more.
3942
+ // See https://cloud.google.com/sensitive-data-protection/docs/concepts-actions
3943
+ // to learn more.
3786
3944
  message Action {
3787
3945
  // If set, the detailed findings will be persisted to the specified
3788
3946
  // OutputStorageConfig. Only a single instance of this action can be
@@ -3796,7 +3954,7 @@ message Action {
3796
3954
  // Publish a message into a given Pub/Sub topic when DlpJob has completed. The
3797
3955
  // message contains a single field, `DlpJobName`, which is equal to the
3798
3956
  // finished job's
3799
- // [`DlpJob.name`](https://cloud.google.com/dlp/docs/reference/rest/v2/projects.dlpJobs#DlpJob).
3957
+ // [`DlpJob.name`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob).
3800
3958
  // Compatible with: Inspect, Risk
3801
3959
  message PublishToPubSub {
3802
3960
  // Cloud Pub/Sub topic to send notifications to. The topic must have given
@@ -3865,6 +4023,7 @@ message Action {
3865
4023
  TransformationDetailsStorageConfig transformation_details_storage_config =
3866
4024
  3;
3867
4025
 
4026
+ // Where to store the output.
3868
4027
  oneof output {
3869
4028
  // Required. User settable Cloud Storage bucket and folders to store
3870
4029
  // de-identified files. This field must be set for cloud storage
@@ -3897,6 +4056,7 @@ message Action {
3897
4056
  // as 'Custom' under the Stackdriver label 'info_type'.
3898
4057
  message PublishToStackdriver {}
3899
4058
 
4059
+ // Extra events to execute after the job has finished.
3900
4060
  oneof action {
3901
4061
  // Save resulting findings in a provided location.
3902
4062
  SaveFindings save_findings = 1;
@@ -3958,7 +4118,7 @@ message CreateInspectTemplateRequest {
3958
4118
  //
3959
4119
  // The format of this value varies depending on the scope of the request
3960
4120
  // (project or organization) and whether you have [specified a processing
3961
- // location](https://cloud.google.com/dlp/docs/specifying-location):
4121
+ // location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location):
3962
4122
  //
3963
4123
  // + Projects scope, location specified:<br/>
3964
4124
  // `projects/`<var>PROJECT_ID</var>`/locations/`<var>LOCATION_ID</var>
@@ -4032,7 +4192,7 @@ message ListInspectTemplatesRequest {
4032
4192
  //
4033
4193
  // The format of this value varies depending on the scope of the request
4034
4194
  // (project or organization) and whether you have [specified a processing
4035
- // location](https://cloud.google.com/dlp/docs/specifying-location):
4195
+ // location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location):
4036
4196
  //
4037
4197
  // + Projects scope, location specified:<br/>
4038
4198
  // `projects/`<var>PROJECT_ID</var>`/locations/`<var>LOCATION_ID</var>
@@ -4111,7 +4271,7 @@ message CreateJobTriggerRequest {
4111
4271
  //
4112
4272
  // The format of this value varies depending on whether you have [specified a
4113
4273
  // processing
4114
- // location](https://cloud.google.com/dlp/docs/specifying-location):
4274
+ // location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location):
4115
4275
  //
4116
4276
  // + Projects scope, location specified:<br/>
4117
4277
  // `projects/`<var>PROJECT_ID</var>`/locations/`<var>LOCATION_ID</var>
@@ -4310,7 +4470,7 @@ message CreateDlpJobRequest {
4310
4470
  //
4311
4471
  // The format of this value varies depending on whether you have [specified a
4312
4472
  // processing
4313
- // location](https://cloud.google.com/dlp/docs/specifying-location):
4473
+ // location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location):
4314
4474
  //
4315
4475
  // + Projects scope, location specified:<br/>
4316
4476
  // `projects/`<var>PROJECT_ID</var>`/locations/`<var>LOCATION_ID</var>
@@ -4355,7 +4515,7 @@ message ListJobTriggersRequest {
4355
4515
  //
4356
4516
  // The format of this value varies depending on whether you have [specified a
4357
4517
  // processing
4358
- // location](https://cloud.google.com/dlp/docs/specifying-location):
4518
+ // location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location):
4359
4519
  //
4360
4520
  // + Projects scope, location specified:<br/>
4361
4521
  // `projects/`<var>PROJECT_ID</var>`/locations/`<var>LOCATION_ID</var>
@@ -4538,6 +4698,7 @@ message DataProfileAction {
4538
4698
  ERROR_CHANGED = 4;
4539
4699
  }
4540
4700
 
4701
+ // Type of action to execute when a profile is generated.
4541
4702
  oneof action {
4542
4703
  // Export data profiles into a provided location.
4543
4704
  Export export_data = 1;
@@ -4553,7 +4714,7 @@ message DataProfileAction {
4553
4714
  //
4554
4715
  // The generated data profiles are retained according to the
4555
4716
  // [data retention policy]
4556
- // (https://cloud.google.com/dlp/docs/data-profiles#retention).
4717
+ // (https://cloud.google.com/sensitive-data-protection/docs/data-profiles#retention).
4557
4718
  message DataProfileJobConfig {
4558
4719
  // The data to scan.
4559
4720
  DataProfileLocation location = 1;
@@ -4578,7 +4739,7 @@ message DataProfileJobConfig {
4578
4739
  // scanned.
4579
4740
  //
4580
4741
  // For more information, see
4581
- // https://cloud.google.com/dlp/docs/data-profiles#data-residency.
4742
+ // https://cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency.
4582
4743
  repeated string inspect_templates = 7;
4583
4744
 
4584
4745
  // Actions to execute at the completion of the job.
@@ -4685,7 +4846,7 @@ message DataProfileLocation {
4685
4846
  //
4686
4847
  // The generated data profiles are retained according to the
4687
4848
  // [data retention policy]
4688
- // (https://cloud.google.com/dlp/docs/data-profiles#retention).
4849
+ // (https://cloud.google.com/sensitive-data-protection/docs/data-profiles#retention).
4689
4850
  message DiscoveryConfig {
4690
4851
  option (google.api.resource) = {
4691
4852
  type: "dlp.googleapis.com/DiscoveryConfig"
@@ -4742,7 +4903,7 @@ message DiscoveryConfig {
4742
4903
  // scanned.
4743
4904
  //
4744
4905
  // For more information, see
4745
- // https://cloud.google.com/dlp/docs/data-profiles#data-residency.
4906
+ // https://cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency.
4746
4907
  repeated string inspect_templates = 3;
4747
4908
 
4748
4909
  // Actions to execute at the completion of scanning.
@@ -5001,6 +5162,7 @@ message DlpJob {
5001
5162
  // State of a job.
5002
5163
  JobState state = 3;
5003
5164
 
5165
+ // Job details.
5004
5166
  oneof details {
5005
5167
  // Results from analyzing risk of a data source.
5006
5168
  AnalyzeDataSourceRiskDetails risk_details = 4;
@@ -5047,7 +5209,7 @@ message ListDlpJobsRequest {
5047
5209
  //
5048
5210
  // The format of this value varies depending on whether you have [specified a
5049
5211
  // processing
5050
- // location](https://cloud.google.com/dlp/docs/specifying-location):
5212
+ // location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location):
5051
5213
  //
5052
5214
  // + Projects scope, location specified:<br/>
5053
5215
  // `projects/`<var>PROJECT_ID</var>`/locations/`<var>LOCATION_ID</var>
@@ -5144,7 +5306,7 @@ message CancelDlpJobRequest {
5144
5306
 
5145
5307
  // The request message for finishing a DLP hybrid job.
5146
5308
  message FinishDlpJobRequest {
5147
- // Required. The name of the DlpJob resource to be cancelled.
5309
+ // Required. The name of the DlpJob resource to be finished.
5148
5310
  string name = 1 [
5149
5311
  (google.api.field_behavior) = REQUIRED,
5150
5312
  (google.api.resource_reference) = { type: "dlp.googleapis.com/DlpJob" }
@@ -5166,7 +5328,7 @@ message CreateDeidentifyTemplateRequest {
5166
5328
  //
5167
5329
  // The format of this value varies depending on the scope of the request
5168
5330
  // (project or organization) and whether you have [specified a processing
5169
- // location](https://cloud.google.com/dlp/docs/specifying-location):
5331
+ // location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location):
5170
5332
  //
5171
5333
  // + Projects scope, location specified:<br/>
5172
5334
  // `projects/`<var>PROJECT_ID</var>`/locations/`<var>LOCATION_ID</var>
@@ -5242,7 +5404,7 @@ message ListDeidentifyTemplatesRequest {
5242
5404
  //
5243
5405
  // The format of this value varies depending on the scope of the request
5244
5406
  // (project or organization) and whether you have [specified a processing
5245
- // location](https://cloud.google.com/dlp/docs/specifying-location):
5407
+ // location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location):
5246
5408
  //
5247
5409
  // + Projects scope, location specified:<br/>
5248
5410
  // `projects/`<var>PROJECT_ID</var>`/locations/`<var>LOCATION_ID</var>
@@ -5319,8 +5481,8 @@ message DeleteDeidentifyTemplateRequest {
5319
5481
 
5320
5482
  // Configuration for a custom dictionary created from a data source of any size
5321
5483
  // up to the maximum size defined in the
5322
- // [limits](https://cloud.google.com/dlp/limits) page. The artifacts of
5323
- // dictionary creation are stored in the specified Cloud Storage
5484
+ // [limits](https://cloud.google.com/sensitive-data-protection/limits) page. The
5485
+ // artifacts of dictionary creation are stored in the specified Cloud Storage
5324
5486
  // location. Consider using `CustomInfoType.Dictionary` for smaller dictionaries
5325
5487
  // that satisfy the size requirements.
5326
5488
  message LargeCustomDictionaryConfig {
@@ -5330,6 +5492,7 @@ message LargeCustomDictionaryConfig {
5330
5492
  // longer be used.
5331
5493
  CloudStoragePath output_path = 1;
5332
5494
 
5495
+ // Source of the dictionary.
5333
5496
  oneof source {
5334
5497
  // Set of files containing newline-delimited lists of dictionary phrases.
5335
5498
  CloudStorageFileSet cloud_storage_file_set = 2;
@@ -5347,7 +5510,7 @@ message LargeCustomDictionaryStats {
5347
5510
 
5348
5511
  // Configuration for stored infoTypes. All fields and subfield are provided
5349
5512
  // by the user. For more information, see
5350
- // https://cloud.google.com/dlp/docs/creating-custom-infotypes.
5513
+ // https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes.
5351
5514
  message StoredInfoTypeConfig {
5352
5515
  // Display name of the StoredInfoType (max 256 characters).
5353
5516
  string display_name = 1;
@@ -5438,7 +5601,7 @@ message CreateStoredInfoTypeRequest {
5438
5601
  //
5439
5602
  // The format of this value varies depending on the scope of the request
5440
5603
  // (project or organization) and whether you have [specified a processing
5441
- // location](https://cloud.google.com/dlp/docs/specifying-location):
5604
+ // location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location):
5442
5605
  //
5443
5606
  // + Projects scope, location specified:<br/>
5444
5607
  // `projects/`<var>PROJECT_ID</var>`/locations/`<var>LOCATION_ID</var>
@@ -5514,7 +5677,7 @@ message ListStoredInfoTypesRequest {
5514
5677
  //
5515
5678
  // The format of this value varies depending on the scope of the request
5516
5679
  // (project or organization) and whether you have [specified a processing
5517
- // location](https://cloud.google.com/dlp/docs/specifying-location):
5680
+ // location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location):
5518
5681
  //
5519
5682
  // + Projects scope, location specified:<br/>
5520
5683
  // `projects/`<var>PROJECT_ID</var>`/locations/`<var>LOCATION_ID</var>
@@ -5787,6 +5950,237 @@ enum StoredInfoTypeState {
5787
5950
  INVALID = 4;
5788
5951
  }
5789
5952
 
5953
+ // Request to list the profiles generated for a given organization or project.
5954
+ message ListProjectDataProfilesRequest {
5955
+ // Required. organizations/{org_id}/locations/{loc_id}
5956
+ string parent = 1 [
5957
+ (google.api.field_behavior) = REQUIRED,
5958
+ (google.api.resource_reference) = {
5959
+ child_type: "dlp.googleapis.com/ProjectDataProfile"
5960
+ }
5961
+ ];
5962
+
5963
+ // Page token to continue retrieval.
5964
+ string page_token = 2;
5965
+
5966
+ // Size of the page. This value can be limited by the server. If zero, server
5967
+ // returns a page of max size 100.
5968
+ int32 page_size = 3;
5969
+
5970
+ // Comma separated list of fields to order by, followed by `asc` or `desc`
5971
+ // postfix. This list is case insensitive. The default sorting order is
5972
+ // ascending. Redundant space characters are insignificant. Only one order
5973
+ // field at a time is allowed.
5974
+ //
5975
+ // Examples:
5976
+ // * `project_id`
5977
+ // * `sensitivity_level desc`
5978
+ //
5979
+ // Supported fields are:
5980
+ //
5981
+ // - `project_id`: GCP project ID
5982
+ // - `sensitivity_level`: How sensitive the data in a project is, at most.
5983
+ // - `data_risk_level`: How much risk is associated with this data.
5984
+ // - `profile_last_generated`: When the profile was last updated in epoch
5985
+ // seconds.
5986
+ string order_by = 4;
5987
+
5988
+ // Allows filtering.
5989
+ //
5990
+ // Supported syntax:
5991
+ //
5992
+ // * Filter expressions are made up of one or more restrictions.
5993
+ // * Restrictions can be combined by `AND` or `OR` logical operators. A
5994
+ // sequence of restrictions implicitly uses `AND`.
5995
+ // * A restriction has the form of `{field} {operator} {value}`.
5996
+ // * Supported fields/values:
5997
+ // - `sensitivity_level` - HIGH|MODERATE|LOW
5998
+ // - `data_risk_level` - HIGH|MODERATE|LOW
5999
+ // - `status_code` - an RPC status code as defined in
6000
+ // https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto
6001
+ // * The operator must be `=` or `!=`.
6002
+ //
6003
+ // Examples:
6004
+ //
6005
+ // * `project_id = 12345 AND status_code = 1`
6006
+ // * `project_id = 12345 AND sensitivity_level = HIGH`
6007
+ //
6008
+ // The length of this field should be no more than 500 characters.
6009
+ string filter = 5;
6010
+ }
6011
+
6012
+ // List of profiles generated for a given organization or project.
6013
+ message ListProjectDataProfilesResponse {
6014
+ // List of data profiles.
6015
+ repeated ProjectDataProfile project_data_profiles = 1;
6016
+
6017
+ // The next page token.
6018
+ string next_page_token = 2;
6019
+ }
6020
+
6021
+ // Request to list the profiles generated for a given organization or project.
6022
+ message ListTableDataProfilesRequest {
6023
+ // Required. Resource name of the organization or project, for
6024
+ // example `organizations/433245324/locations/europe` or
6025
+ // `projects/project-id/locations/asia`.
6026
+ string parent = 1 [
6027
+ (google.api.field_behavior) = REQUIRED,
6028
+ (google.api.resource_reference) = {
6029
+ child_type: "dlp.googleapis.com/TableDataProfile"
6030
+ }
6031
+ ];
6032
+
6033
+ // Page token to continue retrieval.
6034
+ string page_token = 2;
6035
+
6036
+ // Size of the page. This value can be limited by the server. If zero, server
6037
+ // returns a page of max size 100.
6038
+ int32 page_size = 3;
6039
+
6040
+ // Comma separated list of fields to order by, followed by `asc` or `desc`
6041
+ // postfix. This list is case insensitive. The default sorting order is
6042
+ // ascending. Redundant space characters are insignificant. Only one order
6043
+ // field at a time is allowed.
6044
+ //
6045
+ // Examples:
6046
+ // * `project_id asc`
6047
+ // * `table_id`
6048
+ // * `sensitivity_level desc`
6049
+ //
6050
+ // Supported fields are:
6051
+ //
6052
+ // - `project_id`: The GCP project ID.
6053
+ // - `dataset_id`: The ID of a BigQuery dataset.
6054
+ // - `table_id`: The ID of a BigQuery table.
6055
+ // - `sensitivity_level`: How sensitive the data in a table is, at most.
6056
+ // - `data_risk_level`: How much risk is associated with this data.
6057
+ // - `profile_last_generated`: When the profile was last updated in epoch
6058
+ // seconds.
6059
+ // - `last_modified`: The last time the resource was modified.
6060
+ // - `resource_visibility`: Visibility restriction for this resource.
6061
+ // - `row_count`: Number of rows in this resource.
6062
+ string order_by = 4;
6063
+
6064
+ // Allows filtering.
6065
+ //
6066
+ // Supported syntax:
6067
+ //
6068
+ // * Filter expressions are made up of one or more restrictions.
6069
+ // * Restrictions can be combined by `AND` or `OR` logical operators. A
6070
+ // sequence of restrictions implicitly uses `AND`.
6071
+ // * A restriction has the form of `{field} {operator} {value}`.
6072
+ // * Supported fields/values:
6073
+ // - `project_id` - The GCP project ID.
6074
+ // - `dataset_id` - The BigQuery dataset ID.
6075
+ // - `table_id` - The ID of the BigQuery table.
6076
+ // - `sensitivity_level` - HIGH|MODERATE|LOW
6077
+ // - `data_risk_level` - HIGH|MODERATE|LOW
6078
+ // - `resource_visibility`: PUBLIC|RESTRICTED
6079
+ // - `status_code` - an RPC status code as defined in
6080
+ // https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto
6081
+ // * The operator must be `=` or `!=`.
6082
+ //
6083
+ // Examples:
6084
+ //
6085
+ // * `project_id = 12345 AND status_code = 1`
6086
+ // * `project_id = 12345 AND sensitivity_level = HIGH`
6087
+ // * `project_id = 12345 AND resource_visibility = PUBLIC`
6088
+ //
6089
+ // The length of this field should be no more than 500 characters.
6090
+ string filter = 5;
6091
+ }
6092
+
6093
+ // List of profiles generated for a given organization or project.
6094
+ message ListTableDataProfilesResponse {
6095
+ // List of data profiles.
6096
+ repeated TableDataProfile table_data_profiles = 1;
6097
+
6098
+ // The next page token.
6099
+ string next_page_token = 2;
6100
+ }
6101
+
6102
+ // Request to list the profiles generated for a given organization or project.
6103
+ message ListColumnDataProfilesRequest {
6104
+ // Required. Resource name of the organization or project, for
6105
+ // example `organizations/433245324/locations/europe` or
6106
+ // `projects/project-id/locations/asia`.
6107
+ string parent = 1 [
6108
+ (google.api.field_behavior) = REQUIRED,
6109
+ (google.api.resource_reference) = {
6110
+ child_type: "dlp.googleapis.com/ColumnDataProfile"
6111
+ }
6112
+ ];
6113
+
6114
+ // Page token to continue retrieval.
6115
+ string page_token = 2;
6116
+
6117
+ // Size of the page. This value can be limited by the server. If zero, server
6118
+ // returns a page of max size 100.
6119
+ int32 page_size = 3;
6120
+
6121
+ // Comma separated list of fields to order by, followed by `asc` or `desc`
6122
+ // postfix. This list is case insensitive. The default sorting order is
6123
+ // ascending. Redundant space characters are insignificant. Only one order
6124
+ // field at a time is allowed.
6125
+ //
6126
+ // Examples:
6127
+ // * `project_id asc`
6128
+ // * `table_id`
6129
+ // * `sensitivity_level desc`
6130
+ //
6131
+ // Supported fields are:
6132
+ //
6133
+ // - `project_id`: The Google Cloud project ID.
6134
+ // - `dataset_id`: The ID of a BigQuery dataset.
6135
+ // - `table_id`: The ID of a BigQuery table.
6136
+ // - `sensitivity_level`: How sensitive the data in a column is, at most.
6137
+ // - `data_risk_level`: How much risk is associated with this data.
6138
+ // - `profile_last_generated`: When the profile was last updated in epoch
6139
+ // seconds.
6140
+ string order_by = 4;
6141
+
6142
+ // Allows filtering.
6143
+ //
6144
+ // Supported syntax:
6145
+ //
6146
+ // * Filter expressions are made up of one or more restrictions.
6147
+ // * Restrictions can be combined by `AND` or `OR` logical operators. A
6148
+ // sequence of restrictions implicitly uses `AND`.
6149
+ // * A restriction has the form of `{field} {operator} {value}`.
6150
+ // * Supported fields/values:
6151
+ // - `table_data_profile_name` - The name of the related table data
6152
+ // profile.
6153
+ // - `project_id` - The Google Cloud project ID. (REQUIRED)
6154
+ // - `dataset_id` - The BigQuery dataset ID. (REQUIRED)
6155
+ // - `table_id` - The BigQuery table ID. (REQUIRED)
6156
+ // - `field_id` - The ID of the BigQuery field.
6157
+ // - `info_type` - The infotype detected in the resource.
6158
+ // - `sensitivity_level` - HIGH|MEDIUM|LOW
6159
+ // - `data_risk_level`: How much risk is associated with this data.
6160
+ // - `status_code` - an RPC status code as defined in
6161
+ // https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto
6162
+ // * The operator must be `=` for project_id, dataset_id, and table_id. Other
6163
+ // filters also support `!=`.
6164
+ //
6165
+ // Examples:
6166
+ //
6167
+ // * project_id = 12345 AND status_code = 1
6168
+ // * project_id = 12345 AND sensitivity_level = HIGH
6169
+ // * project_id = 12345 AND info_type = STREET_ADDRESS
6170
+ //
6171
+ // The length of this field should be no more than 500 characters.
6172
+ string filter = 5;
6173
+ }
6174
+
6175
+ // List of profiles generated for a given organization or project.
6176
+ message ListColumnDataProfilesResponse {
6177
+ // List of data profiles.
6178
+ repeated ColumnDataProfile column_data_profiles = 1;
6179
+
6180
+ // The next page token.
6181
+ string next_page_token = 2;
6182
+ }
6183
+
5790
6184
  // Score is a summary of all elements in the data profile.
5791
6185
  // A higher number means more risk.
5792
6186
  message DataRiskLevel {
@@ -5815,8 +6209,35 @@ message DataRiskLevel {
5815
6209
  DataRiskLevelScore score = 1;
5816
6210
  }
5817
6211
 
5818
- // How broadly a resource has been shared. New items may be added over time.
5819
- // A higher number means more restricted.
6212
+ // An aggregated profile for this project, based on the resources profiled
6213
+ // within it.
6214
+ message ProjectDataProfile {
6215
+ option (google.api.resource) = {
6216
+ type: "dlp.googleapis.com/ProjectDataProfile"
6217
+ pattern: "organizations/{organization}/locations/{location}/projectDataProfiles/{project_data_profile}"
6218
+ pattern: "projects/{project}/locations/{location}/projectDataProfiles/{project_data_profile}"
6219
+ };
6220
+ // The resource name of the profile.
6221
+ string name = 1;
6222
+
6223
+ // Project ID that was profiled.
6224
+ string project_id = 2;
6225
+
6226
+ // The last time the profile was generated.
6227
+ google.protobuf.Timestamp profile_last_generated = 3;
6228
+
6229
+ // The sensitivity score of this project.
6230
+ SensitivityScore sensitivity_score = 4;
6231
+
6232
+ // The data risk level of this project.
6233
+ DataRiskLevel data_risk_level = 5;
6234
+
6235
+ // Success or error status of the last attempt to profile the project.
6236
+ ProfileStatus profile_status = 7;
6237
+ }
6238
+
6239
+ // How broadly the data in the resource has been shared. New items may be added
6240
+ // over time. A higher number means more restricted.
5820
6241
  enum ResourceVisibility {
5821
6242
  // Unused.
5822
6243
  RESOURCE_VISIBILITY_UNSPECIFIED = 0;
@@ -5834,12 +6255,30 @@ message DataProfileConfigSnapshot {
5834
6255
  // is a copy of the inspect_template specified in `DataProfileJobConfig`.
5835
6256
  InspectConfig inspect_config = 2;
5836
6257
 
6258
+ // A copy of the configuration used to generate this profile. This is
6259
+ // deprecated, and the DiscoveryConfig field is preferred moving forward.
6260
+ // DataProfileJobConfig will still be written here for Discovery in BigQuery
6261
+ // for backwards compatibility, but will not be updated with new fields, while
6262
+ // DiscoveryConfig will.
6263
+ DataProfileJobConfig data_profile_job = 3 [deprecated = true];
6264
+
5837
6265
  // A copy of the configuration used to generate this profile.
5838
- DataProfileJobConfig data_profile_job = 3;
6266
+ DiscoveryConfig discovery_config = 4;
6267
+
6268
+ // Name of the inspection template used to generate this profile
6269
+ string inspect_template_name = 5;
6270
+
6271
+ // Timestamp when the template was modified
6272
+ google.protobuf.Timestamp inspect_template_modified_time = 6;
5839
6273
  }
5840
6274
 
5841
6275
  // The profile for a scanned table.
5842
6276
  message TableDataProfile {
6277
+ option (google.api.resource) = {
6278
+ type: "dlp.googleapis.com/TableDataProfile"
6279
+ pattern: "organizations/{organization}/locations/{location}/tableDataProfiles/{table_data_profile}"
6280
+ pattern: "projects/{project}/locations/{location}/tableDataProfiles/{table_data_profile}"
6281
+ };
5843
6282
  // Possible states of a profile. New items may be added.
5844
6283
  enum State {
5845
6284
  // Unused.
@@ -5858,24 +6297,27 @@ message TableDataProfile {
5858
6297
  // The name of the profile.
5859
6298
  string name = 1;
5860
6299
 
6300
+ // The resource type that was profiled.
6301
+ DataSourceType data_source_type = 36;
6302
+
5861
6303
  // The resource name to the project data profile for this table.
5862
6304
  string project_data_profile = 2;
5863
6305
 
5864
- // The Google Cloud project ID that owns the BigQuery dataset.
6306
+ // The Google Cloud project ID that owns the resource.
5865
6307
  string dataset_project_id = 24;
5866
6308
 
5867
- // The BigQuery location where the dataset's data is stored.
6309
+ // If supported, the location where the dataset's data is stored.
5868
6310
  // See https://cloud.google.com/bigquery/docs/locations for supported
5869
6311
  // locations.
5870
6312
  string dataset_location = 29;
5871
6313
 
5872
- // The BigQuery dataset ID.
6314
+ // If the resource is BigQuery, the dataset ID.
5873
6315
  string dataset_id = 25;
5874
6316
 
5875
- // The BigQuery table ID.
6317
+ // If the resource is BigQuery, the BigQuery table ID.
5876
6318
  string table_id = 26;
5877
6319
 
5878
- // The resource name of the table.
6320
+ // The resource name of the resource profiled.
5879
6321
  // https://cloud.google.com/apis/design/resource_names#full_resource_name
5880
6322
  string full_resource = 3;
5881
6323
 
@@ -5936,6 +6378,7 @@ message TableDataProfile {
5936
6378
  google.protobuf.Timestamp create_time = 23;
5937
6379
  }
5938
6380
 
6381
+ // Success or errors for the profile generation.
5939
6382
  message ProfileStatus {
5940
6383
  // Profiling status code and optional message. The `status.code` value is 0
5941
6384
  // (default value) for OK.
@@ -5992,6 +6435,7 @@ enum NullPercentageLevel {
5992
6435
  // Some null entries.
5993
6436
  NULL_PERCENTAGE_LOW = 2;
5994
6437
 
6438
+ // A few null entries.
5995
6439
  NULL_PERCENTAGE_MEDIUM = 3;
5996
6440
 
5997
6441
  // A lot of null entries.
@@ -6019,6 +6463,11 @@ enum UniquenessScoreLevel {
6019
6463
 
6020
6464
  // The profile for a scanned column within a table.
6021
6465
  message ColumnDataProfile {
6466
+ option (google.api.resource) = {
6467
+ type: "dlp.googleapis.com/ColumnDataProfile"
6468
+ pattern: "organizations/{organization}/locations/{location}/columnDataProfiles/{column_data_profile}"
6469
+ pattern: "projects/{project}/locations/{location}/columnDataProfiles/{column_data_profile}"
6470
+ };
6022
6471
  // Possible states of a profile. New items may be added.
6023
6472
  enum State {
6024
6473
  // Unused.
@@ -6108,10 +6557,10 @@ message ColumnDataProfile {
6108
6557
  // The resource name of the table data profile.
6109
6558
  string table_data_profile = 4;
6110
6559
 
6111
- // The resource name of the table this column is within.
6560
+ // The resource name of the resource this column is within.
6112
6561
  string table_full_resource = 5;
6113
6562
 
6114
- // The Google Cloud project ID that owns the BigQuery dataset.
6563
+ // The Google Cloud project ID that owns the profiled resource.
6115
6564
  string dataset_project_id = 19;
6116
6565
 
6117
6566
  // The BigQuery location where the dataset's data is stored.
@@ -6161,6 +6610,42 @@ message ColumnDataProfile {
6161
6610
  ColumnPolicyState policy_state = 15;
6162
6611
  }
6163
6612
 
6613
+ // Request to get a project data profile.
6614
+ message GetProjectDataProfileRequest {
6615
+ // Required. Resource name, for example
6616
+ // `organizations/12345/locations/us/projectDataProfiles/53234423`.
6617
+ string name = 1 [
6618
+ (google.api.field_behavior) = REQUIRED,
6619
+ (google.api.resource_reference) = {
6620
+ type: "dlp.googleapis.com/ProjectDataProfile"
6621
+ }
6622
+ ];
6623
+ }
6624
+
6625
+ // Request to get a table data profile.
6626
+ message GetTableDataProfileRequest {
6627
+ // Required. Resource name, for example
6628
+ // `organizations/12345/locations/us/tableDataProfiles/53234423`.
6629
+ string name = 1 [
6630
+ (google.api.field_behavior) = REQUIRED,
6631
+ (google.api.resource_reference) = {
6632
+ type: "dlp.googleapis.com/TableDataProfile"
6633
+ }
6634
+ ];
6635
+ }
6636
+
6637
+ // Request to get a column data profile.
6638
+ message GetColumnDataProfileRequest {
6639
+ // Required. Resource name, for example
6640
+ // `organizations/12345/locations/us/columnDataProfiles/53234423`.
6641
+ string name = 1 [
6642
+ (google.api.field_behavior) = REQUIRED,
6643
+ (google.api.resource_reference) = {
6644
+ type: "dlp.googleapis.com/ColumnDataProfile"
6645
+ }
6646
+ ];
6647
+ }
6648
+
6164
6649
  // A condition for determining whether a Pub/Sub should be triggered.
6165
6650
  message DataProfilePubSubCondition {
6166
6651
  // Various score levels for resources.
@@ -6224,3 +6709,10 @@ message DataProfilePubSubMessage {
6224
6709
  // The event that caused the Pub/Sub message to be sent.
6225
6710
  DataProfileAction.EventType event = 2;
6226
6711
  }
6712
+
6713
+ // Message used to identify the type of resource being profiled.
6714
+ message DataSourceType {
6715
+ // Output only. An identifying string to the type of resource being profiled.
6716
+ // Current values: google/bigquery/table, google/project
6717
+ string data_source = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
6718
+ }