Class: Google::Cloud::Dlp::V2::CustomInfoType::DetectionRule

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/privacy/dlp/v2/storage.rb

Overview

Deprecated; use InspectionRuleSet instead. Rule for modifying a CustomInfoType to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the surrogate_type custom infoType.

Defined Under Namespace

Classes: HotwordRule, LikelihoodAdjustment, Proximity

Instance Attribute Summary collapse

Instance Attribute Details

#hotword_rule ⇒ ::Google::Cloud::Dlp::V2::CustomInfoType::DetectionRule::HotwordRule

Returns Hotword-based detection rule.

Returns:



207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'proto_docs/google/privacy/dlp/v2/storage.rb', line 207

class DetectionRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Message for specifying a window around a finding to apply a detection
  # rule.
  # @!attribute [rw] window_before
  #   @return [::Integer]
  #     Number of characters before the finding to consider. For tabular data,
  #     if you want to modify the likelihood of an entire column of findngs,
  #     set this to 1. For more information, see
  #     [Hotword example: Set the match likelihood of a table column]
  #     (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values).
  # @!attribute [rw] window_after
  #   @return [::Integer]
  #     Number of characters after the finding to consider.
  class Proximity
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Message for specifying an adjustment to the likelihood of a finding as
  # part of a detection rule.
  # @!attribute [rw] fixed_likelihood
  #   @return [::Google::Cloud::Dlp::V2::Likelihood]
  #     Set the likelihood of a finding to a fixed value.
  # @!attribute [rw] relative_likelihood
  #   @return [::Integer]
  #     Increase or decrease the likelihood by the specified number of
  #     levels. For example, if a finding would be `POSSIBLE` without the
  #     detection rule and `relative_likelihood` is 1, then it is upgraded to
  #     `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`.
  #     Likelihood may never drop below `VERY_UNLIKELY` or exceed
  #     `VERY_LIKELY`, so applying an adjustment of 1 followed by an
  #     adjustment of -1 when base likelihood is `VERY_LIKELY` will result in
  #     a final likelihood of `LIKELY`.
  class LikelihoodAdjustment
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The rule that adjusts the likelihood of findings within a certain
  # proximity of hotwords.
  # @!attribute [rw] hotword_regex
  #   @return [::Google::Cloud::Dlp::V2::CustomInfoType::Regex]
  #     Regular expression pattern defining what qualifies as a hotword.
  # @!attribute [rw] proximity
  #   @return [::Google::Cloud::Dlp::V2::CustomInfoType::DetectionRule::Proximity]
  #     Range of characters within which the entire hotword must reside.
  #     The total length of the window cannot exceed 1000 characters.
  #     The finding itself will be included in the window, so that hotwords can
  #     be used to match substrings of the finding itself. Suppose you
  #     want Cloud DLP to promote the likelihood of the phone number
  #     regex "\(\d\\{3}\) \d\\{3}-\d\\{4}" if the area code is known to be the
  #     area code of a company's office. In this case, use the hotword regex
  #     "\(xxx\)", where "xxx" is the area code in question.
  #
  #     For tabular data, if you want to modify the likelihood of an entire
  #     column of findngs, see
  #     [Hotword example: Set the match likelihood of a table column]
  #     (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values).
  # @!attribute [rw] likelihood_adjustment
  #   @return [::Google::Cloud::Dlp::V2::CustomInfoType::DetectionRule::LikelihoodAdjustment]
  #     Likelihood adjustment to apply to all matching findings.
  class HotwordRule
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end