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

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

Overview

The rule that adjusts the likelihood of findings within a certain proximity of hotwords.

Instance Attribute Summary collapse

Instance Attribute Details

#hotword_regex ⇒ ::Google::Cloud::Dlp::V2::CustomInfoType::Regex

Returns Regular expression pattern defining what qualifies as a hotword.

Returns:



285
286
287
288
 
# File 'proto_docs/google/privacy/dlp/v2/storage.rb', line 285

class HotwordRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#likelihood_adjustment ⇒ ::Google::Cloud::Dlp::V2::CustomInfoType::DetectionRule::LikelihoodAdjustment

Returns Likelihood adjustment to apply to all matching findings.

Returns:



285
286
287
288
 
# File 'proto_docs/google/privacy/dlp/v2/storage.rb', line 285

class HotwordRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#proximity ⇒ ::Google::Cloud::Dlp::V2::CustomInfoType::DetectionRule::Proximity

Returns 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.

Returns:

  • (::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.



285
286
287
288
 
# File 'proto_docs/google/privacy/dlp/v2/storage.rb', line 285

class HotwordRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end