Cloud Data Loss Prevention (DLP) V2 API - Class Google::Cloud::Dlp::V2::CustomInfoType::DetectionRule::HotwordRule (v1.3.0)

Version 1.3.0

• 1.5.0 (latest)
• 1.4.0
• 1.3.1
• 1.2.0
• 1.1.0
• 1.0.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.2
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.1
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.1

Reference documentation and code samples for the Cloud Data Loss Prevention (DLP) V2 API class Google::Cloud::Dlp::V2::CustomInfoType::DetectionRule::HotwordRule.

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

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#hotword_regex

def hotword_regex() -> ::Google::Cloud::Dlp::V2::CustomInfoType::Regex

Returns

• (::Google::Cloud::Dlp::V2::CustomInfoType::Regex) — Regular expression pattern defining what qualifies as a hotword.

#hotword_regex=

def hotword_regex=(value) -> ::Google::Cloud::Dlp::V2::CustomInfoType::Regex

Parameter

• value (::Google::Cloud::Dlp::V2::CustomInfoType::Regex) — Regular expression pattern defining what qualifies as a hotword.

Returns

• (::Google::Cloud::Dlp::V2::CustomInfoType::Regex) — Regular expression pattern defining what qualifies as a hotword.

#likelihood_adjustment

def likelihood_adjustment() -> ::Google::Cloud::Dlp::V2::CustomInfoType::DetectionRule::LikelihoodAdjustment

Returns

• (::Google::Cloud::Dlp::V2::CustomInfoType::DetectionRule::LikelihoodAdjustment) — Likelihood adjustment to apply to all matching findings.

#likelihood_adjustment=

def likelihood_adjustment=(value) -> ::Google::Cloud::Dlp::V2::CustomInfoType::DetectionRule::LikelihoodAdjustment

Parameter

• value (::Google::Cloud::Dlp::V2::CustomInfoType::DetectionRule::LikelihoodAdjustment) — Likelihood adjustment to apply to all matching findings.

Returns

• (::Google::Cloud::Dlp::V2::CustomInfoType::DetectionRule::LikelihoodAdjustment) — Likelihood adjustment to apply to all matching findings.

#proximity

def proximity() -> ::Google::Cloud::Dlp::V2::CustomInfoType::DetectionRule::Proximity

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.

#proximity=

def proximity=(value) -> ::Google::Cloud::Dlp::V2::CustomInfoType::DetectionRule::Proximity

Parameter

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

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.