google-cloud-dlp-v2 0.7.4 → 0.9.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 6510ec23fca41980b6dc811b377e3df7dcf55cf8eaf72f2ccc1c6f1fb1b2bbbf
4
- data.tar.gz: 8d088ae6958de87947996999f8d2b999f9f2c7c516b87b879fcfb66dafd416c5
3
+ metadata.gz: e37b5c2a20db558a06589da232dda1197ed292328cd9eb86ca9b5651a8ba94ad
4
+ data.tar.gz: ad66a533c643f66a009a3fbe61c941c4600fb25570abdac27f047cf5810783bc
5
5
  SHA512:
6
- metadata.gz: b39a024246c7cec2aaac822efd5eb5d90dfdb585d54ffaaf2aab8fb92c2425985d68cc0343e27133770580edf272ad36e30ea0710a1d74ff198e55b2c54c5854
7
- data.tar.gz: 5c13a401e90af32a24df54290703b8f0625224fb78a359b47403d2bdf12e3caadcc17f2f1e5acba3d9ab3a656823fd9d651a4a9fa0070a5005f99518e78b1afa
6
+ metadata.gz: b382823c5263cd5abccbcc691b6a9d7a15692ec841e0919b6359bda4df3fb7513ce2418d08ec656287def8d9c42a2c3176322927531203ab2cef2adce55003a8
7
+ data.tar.gz: 82c3ae0255f92910e306d40d78cc0dc292c374b6499524895980bef9ff8a1d39d0341d22c52799d6c4136612abc66b11d092e1d702d26757ffe9d97de7adb485
data/.yardopts CHANGED
@@ -1,5 +1,5 @@
1
1
  --no-private
2
- --title=Cloud Data Loss Prevention (DLP) V2 API
2
+ --title="Cloud Data Loss Prevention (DLP) V2 API"
3
3
  --exclude _pb\.rb$
4
4
  --markup markdown
5
5
  --markup-provider redcarpet
data/AUTHENTICATION.md CHANGED
@@ -120,15 +120,6 @@ To configure your system for this, simply:
120
120
  **NOTE:** This is _not_ recommended for running in production. The Cloud SDK
121
121
  *should* only be used during development.
122
122
 
123
- [gce-how-to]: https://cloud.google.com/compute/docs/authentication#using
124
- [dev-console]: https://console.cloud.google.com/project
125
-
126
- [enable-apis]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/enable-apis.png
127
-
128
- [create-new-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account.png
129
- [create-new-service-account-existing-keys]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account-existing-keys.png
130
- [reuse-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/reuse-service-account.png
131
-
132
123
  ## Creating a Service Account
133
124
 
134
125
  Google Cloud requires **Service Account Credentials** to
@@ -139,31 +130,22 @@ If you are not running this client within
139
130
  [Google Cloud Platform environments](#google-cloud-platform-environments), you
140
131
  need a Google Developers service account.
141
132
 
142
- 1. Visit the [Google Developers Console][dev-console].
133
+ 1. Visit the [Google Cloud Console](https://console.cloud.google.com/project).
143
134
  2. Create a new project or click on an existing project.
144
- 3. Activate the slide-out navigation tray and select **API Manager**. From
135
+ 3. Activate the menu in the upper left and select **APIs & Services**. From
145
136
  here, you will enable the APIs that your application requires.
146
137
 
147
- ![Enable the APIs that your application requires][enable-apis]
148
-
149
138
  *Note: You may need to enable billing in order to use these services.*
150
139
 
151
140
  4. Select **Credentials** from the side navigation.
152
141
 
153
- You should see a screen like one of the following.
154
-
155
- ![Create a new service account][create-new-service-account]
156
-
157
- ![Create a new service account With Existing Keys][create-new-service-account-existing-keys]
158
-
159
- Find the "Add credentials" drop down and select "Service account" to be
160
- guided through downloading a new JSON key file.
142
+ Find the "Create credentials" drop down near the top of the page, and select
143
+ "Service account" to be guided through downloading a new JSON key file.
161
144
 
162
145
  If you want to re-use an existing service account, you can easily generate a
163
- new key file. Just select the account you wish to re-use, and click "Generate
164
- new JSON key":
165
-
166
- ![Re-use an existing service account][reuse-service-account]
146
+ new key file. Just select the account you wish to re-use, click the pencil
147
+ tool on the right side to edit the service account, select the **Keys** tab,
148
+ and then select **Add Key**.
167
149
 
168
150
  The key file you download will be used by this library to authenticate API
169
151
  requests and should be stored in a secure location.
data/README.md CHANGED
@@ -37,7 +37,7 @@ request = ::Google::Cloud::Dlp::V2::InspectContentRequest.new # (request fields
37
37
  response = client.inspect_content request
38
38
  ```
39
39
 
40
- View the [Client Library Documentation](https://googleapis.dev/ruby/google-cloud-dlp-v2/latest)
40
+ View the [Client Library Documentation](https://cloud.google.com/ruby/docs/reference/google-cloud-dlp-v2/latest)
41
41
  for class and method documentation.
42
42
 
43
43
  See also the [Product Documentation](https://cloud.google.com/dlp)
@@ -2121,9 +2121,6 @@ module Google
2121
2121
  # Inspect hybrid content and store findings to a trigger. The inspection
2122
2122
  # will be processed asynchronously. To review the findings monitor the
2123
2123
  # jobs within the trigger.
2124
- # Early access feature is in a pre-release state and might change or have
2125
- # limited support. For more information, see
2126
- # https://cloud.google.com/products#product-launch-stages.
2127
2124
  #
2128
2125
  # @overload hybrid_inspect_job_trigger(request, options = nil)
2129
2126
  # Pass arguments to `hybrid_inspect_job_trigger` via a request object, either of type
@@ -2311,7 +2308,7 @@ module Google
2311
2308
  # @param options [::Gapic::CallOptions, ::Hash]
2312
2309
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
2313
2310
  #
2314
- # @overload list_job_triggers(parent: nil, page_token: nil, page_size: nil, order_by: nil, filter: nil, location_id: nil)
2311
+ # @overload list_job_triggers(parent: nil, page_token: nil, page_size: nil, order_by: nil, filter: nil, type: nil, location_id: nil)
2315
2312
  # Pass arguments to `list_job_triggers` via keyword arguments. Note that at
2316
2313
  # least one keyword argument is required. To specify no parameters, or to keep all
2317
2314
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -2364,7 +2361,7 @@ module Google
2364
2361
  # * Restrictions can be combined by `AND` or `OR` logical operators. A
2365
2362
  # sequence of restrictions implicitly uses `AND`.
2366
2363
  # * A restriction has the form of `{field} {operator} {value}`.
2367
- # * Supported fields/values for inspect jobs:
2364
+ # * Supported fields/values for inspect triggers:
2368
2365
  # - `status` - HEALTHY|PAUSED|CANCELLED
2369
2366
  # - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY
2370
2367
  # - 'last_run_time` - RFC 3339 formatted timestamp, surrounded by
@@ -2380,6 +2377,8 @@ module Google
2380
2377
  # * last_run_time > \"2017-12-12T00:00:00+00:00\"
2381
2378
  #
2382
2379
  # The length of this field should be no more than 500 characters.
2380
+ # @param type [::Google::Cloud::Dlp::V2::DlpJobType]
2381
+ # The type of jobs. Will use `DlpJobType.INSPECT` if not set.
2383
2382
  # @param location_id [::String]
2384
2383
  # Deprecated. This field has no effect.
2385
2384
  #
@@ -2670,9 +2669,10 @@ module Google
2670
2669
  #
2671
2670
  # parent=projects/example-project/locations/europe-west3
2672
2671
  # @param inspect_job [::Google::Cloud::Dlp::V2::InspectJobConfig, ::Hash]
2673
- # Set to control what and how to inspect.
2672
+ # An inspection job scans a storage repository for InfoTypes.
2674
2673
  # @param risk_job [::Google::Cloud::Dlp::V2::RiskAnalysisJobConfig, ::Hash]
2675
- # Set to choose what metric to calculate.
2674
+ # A risk analysis job calculates re-identification risk metrics for a
2675
+ # BigQuery table.
2676
2676
  # @param job_id [::String]
2677
2677
  # The job id can contain uppercase and lowercase letters,
2678
2678
  # numbers, and hyphens; that is, it must match the regular
@@ -3697,11 +3697,8 @@ module Google
3697
3697
 
3698
3698
  ##
3699
3699
  # Inspect hybrid content and store findings to a job.
3700
- # To review the findings inspect the job. Inspection will occur
3700
+ # To review the findings, inspect the job. Inspection will occur
3701
3701
  # asynchronously.
3702
- # Early access feature is in a pre-release state and might change or have
3703
- # limited support. For more information, see
3704
- # https://cloud.google.com/products#product-launch-stages.
3705
3702
  #
3706
3703
  # @overload hybrid_inspect_dlp_job(request, options = nil)
3707
3704
  # Pass arguments to `hybrid_inspect_dlp_job` via a request object, either of type
@@ -3791,9 +3788,6 @@ module Google
3791
3788
  ##
3792
3789
  # Finish a running hybrid DlpJob. Triggers the finalization steps and running
3793
3790
  # of any enabled actions that have not yet run.
3794
- # Early access feature is in a pre-release state and might change or have
3795
- # limited support. For more information, see
3796
- # https://cloud.google.com/products#product-launch-stages.
3797
3791
  #
3798
3792
  # @overload finish_dlp_job(request, options = nil)
3799
3793
  # Pass arguments to `finish_dlp_job` via a request object, either of type
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module Dlp
23
23
  module V2
24
- VERSION = "0.7.4"
24
+ VERSION = "0.9.0"
25
25
  end
26
26
  end
27
27
  end
@@ -25,6 +25,8 @@ module Google
25
25
  ##
26
26
  # To load this package, including all its services, and instantiate a client:
27
27
  #
28
+ # @example
29
+ #
28
30
  # require "google/cloud/dlp/v2"
29
31
  # client = ::Google::Cloud::Dlp::V2::DlpService::Client.new
30
32
  #
@@ -1,6 +1,7 @@
1
1
  # Generated by the protocol buffer compiler. DO NOT EDIT!
2
2
  # source: google/privacy/dlp/v2/dlp.proto
3
3
 
4
+ require 'google/api/annotations_pb'
4
5
  require 'google/api/client_pb'
5
6
  require 'google/api/field_behavior_pb'
6
7
  require 'google/api/resource_pb'
@@ -13,7 +14,6 @@ require 'google/rpc/status_pb'
13
14
  require 'google/type/date_pb'
14
15
  require 'google/type/dayofweek_pb'
15
16
  require 'google/type/timeofday_pb'
16
- require 'google/api/annotations_pb'
17
17
  require 'google/protobuf'
18
18
 
19
19
  Google::Protobuf::DescriptorPool.generated_pool.build do
@@ -72,6 +72,8 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
72
72
  value :TEXT_UTF8, 5
73
73
  value :WORD_DOCUMENT, 7
74
74
  value :PDF, 8
75
+ value :POWERPOINT_DOCUMENT, 9
76
+ value :EXCEL_DOCUMENT, 10
75
77
  value :AVRO, 11
76
78
  value :CSV, 12
77
79
  value :TSV, 13
@@ -107,6 +109,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
107
109
  map :labels, :string, :string, 10
108
110
  optional :job_create_time, :message, 11, "google.protobuf.Timestamp"
109
111
  optional :job_name, :string, 13
112
+ optional :finding_id, :string, 15
110
113
  end
111
114
  add_message "google.privacy.dlp.v2.Location" do
112
115
  optional :byte_range, :message, 1, "google.privacy.dlp.v2.Range"
@@ -502,6 +505,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
502
505
  optional :crypto_hash_config, :message, 9, "google.privacy.dlp.v2.CryptoHashConfig"
503
506
  optional :date_shift_config, :message, 11, "google.privacy.dlp.v2.DateShiftConfig"
504
507
  optional :crypto_deterministic_config, :message, 12, "google.privacy.dlp.v2.CryptoDeterministicConfig"
508
+ optional :replace_dictionary_config, :message, 13, "google.privacy.dlp.v2.ReplaceDictionaryConfig"
505
509
  end
506
510
  end
507
511
  add_message "google.privacy.dlp.v2.TimePartConfig" do
@@ -527,6 +531,11 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
527
531
  add_message "google.privacy.dlp.v2.ReplaceValueConfig" do
528
532
  optional :new_value, :message, 1, "google.privacy.dlp.v2.Value"
529
533
  end
534
+ add_message "google.privacy.dlp.v2.ReplaceDictionaryConfig" do
535
+ oneof :type do
536
+ optional :word_list, :message, 1, "google.privacy.dlp.v2.CustomInfoType.Dictionary.WordList"
537
+ end
538
+ end
530
539
  add_message "google.privacy.dlp.v2.ReplaceWithInfoTypeConfig" do
531
540
  end
532
541
  add_message "google.privacy.dlp.v2.RedactConfig" do
@@ -809,6 +818,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
809
818
  optional :page_size, :int32, 3
810
819
  optional :order_by, :string, 4
811
820
  optional :filter, :string, 5
821
+ optional :type, :enum, 6, "google.privacy.dlp.v2.DlpJobType"
812
822
  optional :location_id, :string, 7
813
823
  end
814
824
  add_message "google.privacy.dlp.v2.ListJobTriggersResponse" do
@@ -1125,6 +1135,7 @@ module Google
1125
1135
  CryptoHashConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.privacy.dlp.v2.CryptoHashConfig").msgclass
1126
1136
  CryptoDeterministicConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.privacy.dlp.v2.CryptoDeterministicConfig").msgclass
1127
1137
  ReplaceValueConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.privacy.dlp.v2.ReplaceValueConfig").msgclass
1138
+ ReplaceDictionaryConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.privacy.dlp.v2.ReplaceDictionaryConfig").msgclass
1128
1139
  ReplaceWithInfoTypeConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.privacy.dlp.v2.ReplaceWithInfoTypeConfig").msgclass
1129
1140
  RedactConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.privacy.dlp.v2.RedactConfig").msgclass
1130
1141
  CharsToIgnore = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.privacy.dlp.v2.CharsToIgnore").msgclass
@@ -125,9 +125,6 @@ module Google
125
125
  # Inspect hybrid content and store findings to a trigger. The inspection
126
126
  # will be processed asynchronously. To review the findings monitor the
127
127
  # jobs within the trigger.
128
- # Early access feature is in a pre-release state and might change or have
129
- # limited support. For more information, see
130
- # https://cloud.google.com/products#product-launch-stages.
131
128
  rpc :HybridInspectJobTrigger, ::Google::Cloud::Dlp::V2::HybridInspectJobTriggerRequest, ::Google::Cloud::Dlp::V2::HybridInspectResponse
132
129
  # Gets a job trigger.
133
130
  # See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.
@@ -191,17 +188,11 @@ module Google
191
188
  # learn more.
192
189
  rpc :DeleteStoredInfoType, ::Google::Cloud::Dlp::V2::DeleteStoredInfoTypeRequest, ::Google::Protobuf::Empty
193
190
  # Inspect hybrid content and store findings to a job.
194
- # To review the findings inspect the job. Inspection will occur
191
+ # To review the findings, inspect the job. Inspection will occur
195
192
  # asynchronously.
196
- # Early access feature is in a pre-release state and might change or have
197
- # limited support. For more information, see
198
- # https://cloud.google.com/products#product-launch-stages.
199
193
  rpc :HybridInspectDlpJob, ::Google::Cloud::Dlp::V2::HybridInspectDlpJobRequest, ::Google::Cloud::Dlp::V2::HybridInspectResponse
200
194
  # Finish a running hybrid DlpJob. Triggers the finalization steps and running
201
195
  # of any enabled actions that have not yet run.
202
- # Early access feature is in a pre-release state and might change or have
203
- # limited support. For more information, see
204
- # https://cloud.google.com/products#product-launch-stages.
205
196
  rpc :FinishDlpJob, ::Google::Cloud::Dlp::V2::FinishDlpJobRequest, ::Google::Protobuf::Empty
206
197
  end
207
198
 
@@ -3,13 +3,13 @@
3
3
 
4
4
  require 'google/api/resource_pb'
5
5
  require 'google/protobuf/timestamp_pb'
6
- require 'google/api/annotations_pb'
7
6
  require 'google/protobuf'
8
7
 
9
8
  Google::Protobuf::DescriptorPool.generated_pool.build do
10
9
  add_file("google/privacy/dlp/v2/storage.proto", :syntax => :proto3) do
11
10
  add_message "google.privacy.dlp.v2.InfoType" do
12
11
  optional :name, :string, 1
12
+ optional :version, :string, 2
13
13
  end
14
14
  add_message "google.privacy.dlp.v2.StoredType" do
15
15
  optional :name, :string, 1
@@ -115,6 +115,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
115
115
  optional :rows_limit_percent, :int32, 6
116
116
  optional :sample_method, :enum, 4, "google.privacy.dlp.v2.BigQueryOptions.SampleMethod"
117
117
  repeated :excluded_fields, :message, 5, "google.privacy.dlp.v2.FieldId"
118
+ repeated :included_fields, :message, 7, "google.privacy.dlp.v2.FieldId"
118
119
  end
119
120
  add_enum "google.privacy.dlp.v2.BigQueryOptions.SampleMethod" do
120
121
  value :SAMPLE_METHOD_UNSPECIFIED, 0
@@ -200,6 +201,8 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
200
201
  value :AVRO, 7
201
202
  value :CSV, 8
202
203
  value :TSV, 9
204
+ value :POWERPOINT, 11
205
+ value :EXCEL, 12
203
206
  end
204
207
  end
205
208
  end
@@ -33,11 +33,7 @@ module Google
33
33
  # // For Kubernetes resources, the format is {api group}/{kind}.
34
34
  # option (google.api.resource) = {
35
35
  # type: "pubsub.googleapis.com/Topic"
36
- # name_descriptor: {
37
- # pattern: "projects/{project}/topics/{topic}"
38
- # parent_type: "cloudresourcemanager.googleapis.com/Project"
39
- # parent_name_extractor: "projects/{project}"
40
- # }
36
+ # pattern: "projects/{project}/topics/{topic}"
41
37
  # };
42
38
  # }
43
39
  #
@@ -45,10 +41,7 @@ module Google
45
41
  #
46
42
  # resources:
47
43
  # - type: "pubsub.googleapis.com/Topic"
48
- # name_descriptor:
49
- # - pattern: "projects/{project}/topics/{topic}"
50
- # parent_type: "cloudresourcemanager.googleapis.com/Project"
51
- # parent_name_extractor: "projects/{project}"
44
+ # pattern: "projects/{project}/topics/{topic}"
52
45
  #
53
46
  # Sometimes, resources have multiple patterns, typically because they can
54
47
  # live under multiple parents.
@@ -58,26 +51,10 @@ module Google
58
51
  # message LogEntry {
59
52
  # option (google.api.resource) = {
60
53
  # type: "logging.googleapis.com/LogEntry"
61
- # name_descriptor: {
62
- # pattern: "projects/{project}/logs/{log}"
63
- # parent_type: "cloudresourcemanager.googleapis.com/Project"
64
- # parent_name_extractor: "projects/{project}"
65
- # }
66
- # name_descriptor: {
67
- # pattern: "folders/{folder}/logs/{log}"
68
- # parent_type: "cloudresourcemanager.googleapis.com/Folder"
69
- # parent_name_extractor: "folders/{folder}"
70
- # }
71
- # name_descriptor: {
72
- # pattern: "organizations/{organization}/logs/{log}"
73
- # parent_type: "cloudresourcemanager.googleapis.com/Organization"
74
- # parent_name_extractor: "organizations/{organization}"
75
- # }
76
- # name_descriptor: {
77
- # pattern: "billingAccounts/{billing_account}/logs/{log}"
78
- # parent_type: "billing.googleapis.com/BillingAccount"
79
- # parent_name_extractor: "billingAccounts/{billing_account}"
80
- # }
54
+ # pattern: "projects/{project}/logs/{log}"
55
+ # pattern: "folders/{folder}/logs/{log}"
56
+ # pattern: "organizations/{organization}/logs/{log}"
57
+ # pattern: "billingAccounts/{billing_account}/logs/{log}"
81
58
  # };
82
59
  # }
83
60
  #
@@ -85,48 +62,10 @@ module Google
85
62
  #
86
63
  # resources:
87
64
  # - type: 'logging.googleapis.com/LogEntry'
88
- # name_descriptor:
89
- # - pattern: "projects/{project}/logs/{log}"
90
- # parent_type: "cloudresourcemanager.googleapis.com/Project"
91
- # parent_name_extractor: "projects/{project}"
92
- # - pattern: "folders/{folder}/logs/{log}"
93
- # parent_type: "cloudresourcemanager.googleapis.com/Folder"
94
- # parent_name_extractor: "folders/{folder}"
95
- # - pattern: "organizations/{organization}/logs/{log}"
96
- # parent_type: "cloudresourcemanager.googleapis.com/Organization"
97
- # parent_name_extractor: "organizations/{organization}"
98
- # - pattern: "billingAccounts/{billing_account}/logs/{log}"
99
- # parent_type: "billing.googleapis.com/BillingAccount"
100
- # parent_name_extractor: "billingAccounts/{billing_account}"
101
- #
102
- # For flexible resources, the resource name doesn't contain parent names, but
103
- # the resource itself has parents for policy evaluation.
104
- #
105
- # Example:
106
- #
107
- # message Shelf {
108
- # option (google.api.resource) = {
109
- # type: "library.googleapis.com/Shelf"
110
- # name_descriptor: {
111
- # pattern: "shelves/{shelf}"
112
- # parent_type: "cloudresourcemanager.googleapis.com/Project"
113
- # }
114
- # name_descriptor: {
115
- # pattern: "shelves/{shelf}"
116
- # parent_type: "cloudresourcemanager.googleapis.com/Folder"
117
- # }
118
- # };
119
- # }
120
- #
121
- # The ResourceDescriptor Yaml config will look like:
122
- #
123
- # resources:
124
- # - type: 'library.googleapis.com/Shelf'
125
- # name_descriptor:
126
- # - pattern: "shelves/{shelf}"
127
- # parent_type: "cloudresourcemanager.googleapis.com/Project"
128
- # - pattern: "shelves/{shelf}"
129
- # parent_type: "cloudresourcemanager.googleapis.com/Folder"
65
+ # pattern: "projects/{project}/logs/{log}"
66
+ # pattern: "folders/{folder}/logs/{log}"
67
+ # pattern: "organizations/{organization}/logs/{log}"
68
+ # pattern: "billingAccounts/{billing_account}/logs/{log}"
130
69
  # @!attribute [rw] type
131
70
  # @return [::String]
132
71
  # The resource type. It must be in the format of
@@ -106,21 +106,23 @@ module Google
106
106
  # @!attribute [rw] limits
107
107
  # @return [::Google::Cloud::Dlp::V2::InspectConfig::FindingLimits]
108
108
  # Configuration to control the number of findings returned.
109
+ # This is not used for data profiling.
109
110
  # @!attribute [rw] include_quote
110
111
  # @return [::Boolean]
111
112
  # When true, a contextual quote from the data that triggered a finding is
112
113
  # included in the response; see Finding.quote.
114
+ # This is not used for data profiling.
113
115
  # @!attribute [rw] exclude_info_types
114
116
  # @return [::Boolean]
115
117
  # When true, excludes type information of the findings.
118
+ # This is not used for data profiling.
116
119
  # @!attribute [rw] custom_info_types
117
120
  # @return [::Array<::Google::Cloud::Dlp::V2::CustomInfoType>]
118
121
  # CustomInfoTypes provided by the user. See
119
122
  # https://cloud.google.com/dlp/docs/creating-custom-infotypes to learn more.
120
123
  # @!attribute [rw] content_options
121
124
  # @return [::Array<::Google::Cloud::Dlp::V2::ContentOption>]
122
- # List of options defining data content to scan.
123
- # If empty, text, images, and other content will be included.
125
+ # Deprecated and unused.
124
126
  # @!attribute [rw] rule_set
125
127
  # @return [::Array<::Google::Cloud::Dlp::V2::InspectionRuleSet>]
126
128
  # Set of rules to apply to the findings for this InspectConfig.
@@ -130,7 +132,8 @@ module Google
130
132
  include ::Google::Protobuf::MessageExts
131
133
  extend ::Google::Protobuf::MessageExts::ClassMethods
132
134
 
133
- # Configuration to control the number of findings returned.
135
+ # Configuration to control the number of findings returned for inspection.
136
+ # This is not used for de-identification or data profiling.
134
137
  # @!attribute [rw] max_findings_per_item
135
138
  # @return [::Integer]
136
139
  # Max number of findings that will be returned for each item scanned.
@@ -178,7 +181,9 @@ module Google
178
181
  include ::Google::Protobuf::MessageExts
179
182
  extend ::Google::Protobuf::MessageExts::ClassMethods
180
183
 
181
- # The type of data being sent for inspection.
184
+ # The type of data being sent for inspection. To learn more, see
185
+ # [Supported file
186
+ # types](https://cloud.google.com/dlp/docs/supported-file-types).
182
187
  module BytesType
183
188
  # Unused
184
189
  BYTES_TYPE_UNSPECIFIED = 0
@@ -207,6 +212,12 @@ module Google
207
212
  # pdf
208
213
  PDF = 8
209
214
 
215
+ # pptx, pptm, potx, potm, pot
216
+ POWERPOINT_DOCUMENT = 9
217
+
218
+ # xlsx, xlsm, xltx, xltm
219
+ EXCEL_DOCUMENT = 10
220
+
210
221
  # avro
211
222
  AVRO = 11
212
223
 
@@ -235,9 +246,9 @@ module Google
235
246
  extend ::Google::Protobuf::MessageExts::ClassMethods
236
247
  end
237
248
 
238
- # Structured content to inspect. Up to 50,000 `Value`s per request allowed.
239
- # See https://cloud.google.com/dlp/docs/inspecting-text#inspecting_a_table to
240
- # learn more.
249
+ # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See
250
+ # https://cloud.google.com/dlp/docs/inspecting-structured-text#inspecting_a_table
251
+ # to learn more.
241
252
  # @!attribute [rw] headers
242
253
  # @return [::Array<::Google::Cloud::Dlp::V2::FieldId>]
243
254
  # Headers of the table.
@@ -333,6 +344,9 @@ module Google
333
344
  # @!attribute [rw] job_name
334
345
  # @return [::String]
335
346
  # The job that stored the finding.
347
+ # @!attribute [rw] finding_id
348
+ # @return [::String]
349
+ # The unique finding id.
336
350
  class Finding
337
351
  include ::Google::Protobuf::MessageExts
338
352
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -914,7 +928,7 @@ module Google
914
928
  # The configuration used for this job.
915
929
  # @!attribute [rw] result
916
930
  # @return [::Google::Cloud::Dlp::V2::InspectDataSourceDetails::Result]
917
- # A summary of the outcome of this inspect job.
931
+ # A summary of the outcome of this inspection job.
918
932
  class InspectDataSourceDetails
919
933
  include ::Google::Protobuf::MessageExts
920
934
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -946,9 +960,6 @@ module Google
946
960
  # @!attribute [rw] hybrid_stats
947
961
  # @return [::Google::Cloud::Dlp::V2::HybridInspectStatistics]
948
962
  # Statistics related to the processing of hybrid inspect.
949
- # Early access feature is in a pre-release state and might change or have
950
- # limited support. For more information, see
951
- # https://cloud.google.com/products#product-launch-stages.
952
963
  class Result
953
964
  include ::Google::Protobuf::MessageExts
954
965
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1755,7 +1766,7 @@ module Google
1755
1766
  # A rule for transforming a value.
1756
1767
  # @!attribute [rw] replace_config
1757
1768
  # @return [::Google::Cloud::Dlp::V2::ReplaceValueConfig]
1758
- # Replace
1769
+ # Replace with a specified value.
1759
1770
  # @!attribute [rw] redact_config
1760
1771
  # @return [::Google::Cloud::Dlp::V2::RedactConfig]
1761
1772
  # Redact
@@ -1786,6 +1797,9 @@ module Google
1786
1797
  # @!attribute [rw] crypto_deterministic_config
1787
1798
  # @return [::Google::Cloud::Dlp::V2::CryptoDeterministicConfig]
1788
1799
  # Deterministic Crypto
1800
+ # @!attribute [rw] replace_dictionary_config
1801
+ # @return [::Google::Cloud::Dlp::V2::ReplaceDictionaryConfig]
1802
+ # Replace with a value randomly drawn (with replacement) from a dictionary.
1789
1803
  class PrimitiveTransformation
1790
1804
  include ::Google::Protobuf::MessageExts
1791
1805
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1845,7 +1859,9 @@ module Google
1845
1859
  # Uses AES-SIV based on the RFC https://tools.ietf.org/html/rfc5297.
1846
1860
  # @!attribute [rw] crypto_key
1847
1861
  # @return [::Google::Cloud::Dlp::V2::CryptoKey]
1848
- # The key used by the encryption function.
1862
+ # The key used by the encryption function. For deterministic encryption
1863
+ # using AES-SIV, the provided key is internally expanded to 64 bytes prior to
1864
+ # use.
1849
1865
  # @!attribute [rw] surrogate_info_type
1850
1866
  # @return [::Google::Cloud::Dlp::V2::InfoType]
1851
1867
  # The custom info type to annotate the surrogate with.
@@ -1914,6 +1930,17 @@ module Google
1914
1930
  extend ::Google::Protobuf::MessageExts::ClassMethods
1915
1931
  end
1916
1932
 
1933
+ # Replace each input value with a value randomly selected from the dictionary.
1934
+ # @!attribute [rw] word_list
1935
+ # @return [::Google::Cloud::Dlp::V2::CustomInfoType::Dictionary::WordList]
1936
+ # A list of words to select from for random replacement. The
1937
+ # [limits](https://cloud.google.com/dlp/limits) page contains details about
1938
+ # the size limits of dictionaries.
1939
+ class ReplaceDictionaryConfig
1940
+ include ::Google::Protobuf::MessageExts
1941
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1942
+ end
1943
+
1917
1944
  # Replace each matching finding with the name of the info_type.
1918
1945
  class ReplaceWithInfoTypeConfig
1919
1946
  include ::Google::Protobuf::MessageExts
@@ -2003,8 +2030,8 @@ module Google
2003
2030
  # the user for simple bucketing strategies.
2004
2031
  #
2005
2032
  # The transformed value will be a hyphenated string of
2006
- # \\{lower_bound}-\\{upper_bound}, i.e if lower_bound = 10 and upper_bound = 20
2007
- # all values that are within this bucket will be replaced with "10-20".
2033
+ # \\{lower_bound}-\\{upper_bound}. For example, if lower_bound = 10 and upper_bound
2034
+ # = 20, all values that are within this bucket will be replaced with "10-20".
2008
2035
  #
2009
2036
  # This can be used on data of type: double, long.
2010
2037
  #
@@ -2176,10 +2203,11 @@ module Google
2176
2203
  end
2177
2204
 
2178
2205
  # This is a data encryption key (DEK) (as opposed to
2179
- # a key encryption key (KEK) stored by KMS).
2180
- # When using KMS to wrap/unwrap DEKs, be sure to set an appropriate
2181
- # IAM policy on the KMS CryptoKey (KEK) to ensure an attacker cannot
2182
- # unwrap the data crypto key.
2206
+ # a key encryption key (KEK) stored by Cloud Key Management Service
2207
+ # (Cloud KMS).
2208
+ # When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate
2209
+ # IAM policy on the KEK to ensure an attacker cannot
2210
+ # unwrap the DEK.
2183
2211
  # @!attribute [rw] transient
2184
2212
  # @return [::Google::Cloud::Dlp::V2::TransientCryptoKey]
2185
2213
  # Transient crypto key
@@ -2188,7 +2216,7 @@ module Google
2188
2216
  # Unwrapped crypto key
2189
2217
  # @!attribute [rw] kms_wrapped
2190
2218
  # @return [::Google::Cloud::Dlp::V2::KmsWrappedCryptoKey]
2191
- # Kms wrapped key
2219
+ # Key wrapped using Cloud KMS
2192
2220
  class CryptoKey
2193
2221
  include ::Google::Protobuf::MessageExts
2194
2222
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -2220,10 +2248,16 @@ module Google
2220
2248
  end
2221
2249
 
2222
2250
  # Include to use an existing data crypto key wrapped by KMS.
2223
- # The wrapped key must be a 128/192/256 bit key.
2251
+ # The wrapped key must be a 128-, 192-, or 256-bit key.
2224
2252
  # Authorization requires the following IAM permissions when sending a request
2225
- # to perform a crypto transformation using a kms-wrapped crypto key:
2253
+ # to perform a crypto transformation using a KMS-wrapped crypto key:
2226
2254
  # dlp.kms.encrypt
2255
+ #
2256
+ # For more information, see [Creating a wrapped key]
2257
+ # (https://cloud.google.com/dlp/docs/create-wrapped-key).
2258
+ #
2259
+ # Note: When you use Cloud KMS for cryptographic operations,
2260
+ # [charges apply](https://cloud.google.com/kms/pricing).
2227
2261
  # @!attribute [rw] wrapped_key
2228
2262
  # @return [::String]
2229
2263
  # Required. The wrapped data crypto key.
@@ -2295,6 +2329,9 @@ module Google
2295
2329
  # @!attribute [rw] fields
2296
2330
  # @return [::Array<::Google::Cloud::Dlp::V2::FieldId>]
2297
2331
  # Required. Input field(s) to apply the transformation to.
2332
+ # When you have columns that reference their position within a list,
2333
+ # omit the index from the FieldId. FieldId name matching ignores the index.
2334
+ # For example, instead of "contact.nums[0].type", use "contact.nums.type".
2298
2335
  # @!attribute [rw] condition
2299
2336
  # @return [::Google::Cloud::Dlp::V2::RecordCondition]
2300
2337
  # Only apply the transformation if the condition evaluates to true for the
@@ -2489,7 +2526,7 @@ module Google
2489
2526
  end
2490
2527
  end
2491
2528
 
2492
- # Schedule for triggeredJobs.
2529
+ # Schedule for inspect job triggers.
2493
2530
  # @!attribute [rw] recurrence_period_duration
2494
2531
  # @return [::Google::Protobuf::Duration]
2495
2532
  # With this option a job is started a regular periodic basis. For
@@ -2566,7 +2603,7 @@ module Google
2566
2603
  # Output only. The last update timestamp of an inspectTemplate.
2567
2604
  # @!attribute [rw] deidentify_config
2568
2605
  # @return [::Google::Cloud::Dlp::V2::DeidentifyConfig]
2569
- # ///////////// // The core content of the template // ///////////////
2606
+ # The core content of the template.
2570
2607
  class DeidentifyTemplate
2571
2608
  include ::Google::Protobuf::MessageExts
2572
2609
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -2635,9 +2672,6 @@ module Google
2635
2672
  # @!attribute [rw] manual
2636
2673
  # @return [::Google::Cloud::Dlp::V2::Manual]
2637
2674
  # For use with hybrid jobs. Jobs must be manually created and finished.
2638
- # Early access feature is in a pre-release state and might change or have
2639
- # limited support. For more information, see
2640
- # https://cloud.google.com/products#product-launch-stages.
2641
2675
  class Trigger
2642
2676
  include ::Google::Protobuf::MessageExts
2643
2677
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -2730,11 +2764,11 @@ module Google
2730
2764
  extend ::Google::Protobuf::MessageExts::ClassMethods
2731
2765
  end
2732
2766
 
2733
- # Publish findings of a DlpJob to Cloud Data Catalog. Labels summarizing the
2767
+ # Publish findings of a DlpJob to Data Catalog. Labels summarizing the
2734
2768
  # results of the DlpJob will be applied to the entry for the resource scanned
2735
- # in Cloud Data Catalog. Any labels previously written by another DlpJob will
2769
+ # in Data Catalog. Any labels previously written by another DlpJob will
2736
2770
  # be deleted. InfoType naming patterns are strictly enforced when using this
2737
- # feature. Note that the findings will be persisted in Cloud Data Catalog
2771
+ # feature. Note that the findings will be persisted in Data Catalog
2738
2772
  # storage and are governed by Data Catalog service-specific policy, see
2739
2773
  # https://cloud.google.com/terms/service-terms
2740
2774
  # Only a single instance of this action can be specified and only allowed if
@@ -3003,10 +3037,11 @@ module Google
3003
3037
  # parent=projects/example-project/locations/europe-west3
3004
3038
  # @!attribute [rw] inspect_job
3005
3039
  # @return [::Google::Cloud::Dlp::V2::InspectJobConfig]
3006
- # Set to control what and how to inspect.
3040
+ # An inspection job scans a storage repository for InfoTypes.
3007
3041
  # @!attribute [rw] risk_job
3008
3042
  # @return [::Google::Cloud::Dlp::V2::RiskAnalysisJobConfig]
3009
- # Set to choose what metric to calculate.
3043
+ # A risk analysis job calculates re-identification risk metrics for a
3044
+ # BigQuery table.
3010
3045
  # @!attribute [rw] job_id
3011
3046
  # @return [::String]
3012
3047
  # The job id can contain uppercase and lowercase letters,
@@ -3075,7 +3110,7 @@ module Google
3075
3110
  # * Restrictions can be combined by `AND` or `OR` logical operators. A
3076
3111
  # sequence of restrictions implicitly uses `AND`.
3077
3112
  # * A restriction has the form of `{field} {operator} {value}`.
3078
- # * Supported fields/values for inspect jobs:
3113
+ # * Supported fields/values for inspect triggers:
3079
3114
  # - `status` - HEALTHY|PAUSED|CANCELLED
3080
3115
  # - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY
3081
3116
  # - 'last_run_time` - RFC 3339 formatted timestamp, surrounded by
@@ -3091,6 +3126,9 @@ module Google
3091
3126
  # * last_run_time > \"2017-12-12T00:00:00+00:00\"
3092
3127
  #
3093
3128
  # The length of this field should be no more than 500 characters.
3129
+ # @!attribute [rw] type
3130
+ # @return [::Google::Cloud::Dlp::V2::DlpJobType]
3131
+ # The type of jobs. Will use `DlpJobType.INSPECT` if not set.
3094
3132
  # @!attribute [rw] location_id
3095
3133
  # @return [::String]
3096
3134
  # Deprecated. This field has no effect.
@@ -3904,7 +3942,7 @@ module Google
3904
3942
  MATCHING_TYPE_INVERSE_MATCH = 3
3905
3943
  end
3906
3944
 
3907
- # Options describing which parts of the provided content should be scanned.
3945
+ # Deprecated and unused.
3908
3946
  module ContentOption
3909
3947
  # Includes entire content of a file or a data stream.
3910
3948
  CONTENT_UNSPECIFIED = 0
@@ -3939,7 +3977,7 @@ module Google
3939
3977
 
3940
3978
  # An enum to represent the various types of DLP jobs.
3941
3979
  module DlpJobType
3942
- # Unused
3980
+ # Defaults to INSPECT_JOB.
3943
3981
  DLP_JOB_TYPE_UNSPECIFIED = 0
3944
3982
 
3945
3983
  # The job inspected Google Cloud for sensitive data.
@@ -29,6 +29,9 @@ module Google
29
29
  # at https://cloud.google.com/dlp/docs/infotypes-reference when specifying
30
30
  # a built-in type. When sending Cloud DLP results to Data Catalog, infoType
31
31
  # names should conform to the pattern `[A-Za-z0-9$-_]{1,64}`.
32
+ # @!attribute [rw] version
33
+ # @return [::String]
34
+ # Optional version name for this InfoType.
32
35
  class InfoType
33
36
  include ::Google::Protobuf::MessageExts
34
37
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -361,12 +364,14 @@ module Google
361
364
  # Max number of bytes to scan from a file. If a scanned file's size is bigger
362
365
  # than this value then the rest of the bytes are omitted. Only one
363
366
  # of bytes_limit_per_file and bytes_limit_per_file_percent can be specified.
367
+ # Cannot be set if de-identification is requested.
364
368
  # @!attribute [rw] bytes_limit_per_file_percent
365
369
  # @return [::Integer]
366
370
  # Max percentage of bytes to scan from a file. The rest are omitted. The
367
371
  # number of bytes scanned is rounded down. Must be between 0 and 100,
368
372
  # inclusively. Both 0 and 100 means no limit. Defaults to 0. Only one
369
373
  # of bytes_limit_per_file and bytes_limit_per_file_percent can be specified.
374
+ # Cannot be set if de-identification is requested.
370
375
  # @!attribute [rw] file_types
371
376
  # @return [::Array<::Google::Cloud::Dlp::V2::FileType>]
372
377
  # List of file type groups to include in the scan.
@@ -474,6 +479,9 @@ module Google
474
479
  # @return [::Array<::Google::Cloud::Dlp::V2::FieldId>]
475
480
  # References to fields excluded from scanning. This allows you to skip
476
481
  # inspection of entire columns which you know have no findings.
482
+ # @!attribute [rw] included_fields
483
+ # @return [::Array<::Google::Cloud::Dlp::V2::FieldId>]
484
+ # Limit scanning only to these fields.
477
485
  class BigQueryOptions
478
486
  include ::Google::Protobuf::MessageExts
479
487
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -507,9 +515,6 @@ module Google
507
515
  # @!attribute [rw] hybrid_options
508
516
  # @return [::Google::Cloud::Dlp::V2::HybridOptions]
509
517
  # Hybrid inspection options.
510
- # Early access feature is in a pre-release state and might change or have
511
- # limited support. For more information, see
512
- # https://cloud.google.com/products#product-launch-stages.
513
518
  # @!attribute [rw] timespan_config
514
519
  # @return [::Google::Cloud::Dlp::V2::StorageConfig::TimespanConfig]
515
520
  class StorageConfig
@@ -787,11 +792,12 @@ module Google
787
792
  BINARY_FILE = 1
788
793
 
789
794
  # Included file extensions:
790
- # asc, brf, c, cc, cpp, csv, cxx, c++, cs, css, dart, eml, go, h, hh, hpp,
791
- # hxx, h++, hs, html, htm, shtml, shtm, xhtml, lhs, ini, java, js, json,
792
- # ocaml, md, mkd, markdown, m, ml, mli, pl, pm, php, phtml, pht, py, pyw,
793
- # rb, rbw, rs, rc, scala, sh, sql, tex, txt, text, tsv, vcard, vcs, wml,
794
- # xml, xsl, xsd, yml, yaml.
795
+ # asc,asp, aspx, brf, c, cc,cfm, cgi, cpp, csv, cxx, c++, cs, css, dart,
796
+ # dat, dot, eml,, epbub, ged, go, h, hh, hpp, hxx, h++, hs, html, htm,
797
+ # mkd, markdown, m, ml, mli, perl, pl, plist, pm, php, phtml, pht,
798
+ # properties, py, pyw, rb, rbw, rs, rss, rc, scala, sh, sql, swift, tex,
799
+ # shtml, shtm, xhtml, lhs, ics, ini, java, js, json, kix, kml, ocaml, md,
800
+ # txt, text, tsv, vb, vcard, vcs, wml, xcodeproj, xml, xsl, xsd, yml, yaml.
795
801
  TEXT_FILE = 2
796
802
 
797
803
  # Included file extensions:
@@ -821,6 +827,16 @@ module Google
821
827
  # Included file extensions:
822
828
  # tsv
823
829
  TSV = 9
830
+
831
+ # Powerpoint files >30 MB will be scanned as binary files.
832
+ # Included file extensions:
833
+ # pptx, pptm, potx, potm, pot
834
+ POWERPOINT = 11
835
+
836
+ # Excel files >30 MB will be scanned as binary files.
837
+ # Included file extensions:
838
+ # xlsx, xlsm, xltx, xltm
839
+ EXCEL = 12
824
840
  end
825
841
  end
826
842
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-dlp-v2
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.7.4
4
+ version: 0.9.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-11-08 00:00:00.000000000 Z
11
+ date: 2022-03-30 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common
@@ -212,7 +212,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
212
212
  - !ruby/object:Gem::Version
213
213
  version: '0'
214
214
  requirements: []
215
- rubygems_version: 3.2.17
215
+ rubygems_version: 3.3.5
216
216
  signing_key:
217
217
  specification_version: 4
218
218
  summary: API Client library for the Cloud Data Loss Prevention (DLP) V2 API