Class: Google::Apis::DlpV2::GooglePrivacyDlpV2CustomInfoType
- Inherits:
-
Object
- Object
- Google::Apis::DlpV2::GooglePrivacyDlpV2CustomInfoType
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/dlp_v2/classes.rb,
generated/google/apis/dlp_v2/representations.rb,
generated/google/apis/dlp_v2/representations.rb
Overview
Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question.
Instance Attribute Summary collapse
-
#detection_rules ⇒ Array<Google::Apis::DlpV2::GooglePrivacyDlpV2DetectionRule>
Set of detection rules to apply to all findings of this CustomInfoType.
-
#dictionary ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2Dictionary
Custom information type based on a dictionary of words or phrases.
-
#exclusion_type ⇒ String
If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned.
-
#info_type ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2InfoType
Type of information detected by the API.
-
#likelihood ⇒ String
Likelihood to return for this CustomInfoType.
-
#regex ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2Regex
Message defining a custom regular expression.
-
#stored_type ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2StoredType
A reference to a StoredInfoType to use with scanning.
-
#surrogate_type ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2SurrogateType
Message for detecting output from deidentification transformations such as
CryptoReplaceFfxFpeConfig
.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GooglePrivacyDlpV2CustomInfoType
constructor
A new instance of GooglePrivacyDlpV2CustomInfoType.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ GooglePrivacyDlpV2CustomInfoType
Returns a new instance of GooglePrivacyDlpV2CustomInfoType
1457 1458 1459 |
# File 'generated/google/apis/dlp_v2/classes.rb', line 1457 def initialize(**args) update!(**args) end |
Instance Attribute Details
#detection_rules ⇒ Array<Google::Apis::DlpV2::GooglePrivacyDlpV2DetectionRule>
Set of detection rules to apply to all findings of this CustomInfoType.
Rules are applied in order that they are specified. Not supported for the
surrogate_type
CustomInfoType.
Corresponds to the JSON property detectionRules
1388 1389 1390 |
# File 'generated/google/apis/dlp_v2/classes.rb', line 1388 def detection_rules @detection_rules end |
#dictionary ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2Dictionary
Custom information type based on a dictionary of words or phrases. This can
be used to match sensitive information specific to the data, such as a list
of employee IDs or job titles.
Dictionary words are case-insensitive and all characters other than letters
and digits in the unicode Basic Multilingual
Plane
will be replaced with whitespace when scanning for matches, so the
dictionary phrase "Sam Johnson" will match all three phrases "sam johnson",
"Sam, Johnson", and "Sam (Johnson)". Additionally, the characters
surrounding any match must be of a different type than the adjacent
characters within the word, so letters must be next to non-letters and
digits next to non-digits. For example, the dictionary word "jen" will
match the first three letters of the text "jen123" but will return no
matches for "jennifer".
Dictionary words containing a large number of characters that are not
letters or digits may result in unexpected findings because such characters
are treated as whitespace. The
limits page contains details about
the size limits of dictionaries. For dictionaries that do not fit within
these constraints, consider using LargeCustomDictionaryConfig
in the
StoredInfoType
API.
Corresponds to the JSON property dictionary
1414 1415 1416 |
# File 'generated/google/apis/dlp_v2/classes.rb', line 1414 def dictionary @dictionary end |
#exclusion_type ⇒ String
If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding
to be returned. It still can be used for rules matching.
Corresponds to the JSON property exclusionType
1420 1421 1422 |
# File 'generated/google/apis/dlp_v2/classes.rb', line 1420 def exclusion_type @exclusion_type end |
#info_type ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2InfoType
Type of information detected by the API.
Corresponds to the JSON property infoType
1425 1426 1427 |
# File 'generated/google/apis/dlp_v2/classes.rb', line 1425 def info_type @info_type end |
#likelihood ⇒ String
Likelihood to return for this CustomInfoType. This base value can be
altered by a detection rule if the finding meets the criteria specified by
the rule. Defaults to VERY_LIKELY
if not specified.
Corresponds to the JSON property likelihood
1432 1433 1434 |
# File 'generated/google/apis/dlp_v2/classes.rb', line 1432 def likelihood @likelihood end |
#regex ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2Regex
Message defining a custom regular expression.
Corresponds to the JSON property regex
1437 1438 1439 |
# File 'generated/google/apis/dlp_v2/classes.rb', line 1437 def regex @regex end |
#stored_type ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2StoredType
A reference to a StoredInfoType to use with scanning.
Corresponds to the JSON property storedType
1442 1443 1444 |
# File 'generated/google/apis/dlp_v2/classes.rb', line 1442 def stored_type @stored_type end |
#surrogate_type ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2SurrogateType
Message for detecting output from deidentification transformations
such as
CryptoReplaceFfxFpeConfig
.
These types of transformations are
those that perform pseudonymization, thereby producing a "surrogate" as
output. This should be used in conjunction with a field on the
transformation such as surrogate_info_type
. This CustomInfoType does
not support the use of detection_rules
.
Corresponds to the JSON property surrogateType
1455 1456 1457 |
# File 'generated/google/apis/dlp_v2/classes.rb', line 1455 def surrogate_type @surrogate_type end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 |
# File 'generated/google/apis/dlp_v2/classes.rb', line 1462 def update!(**args) @detection_rules = args[:detection_rules] if args.key?(:detection_rules) @dictionary = args[:dictionary] if args.key?(:dictionary) @exclusion_type = args[:exclusion_type] if args.key?(:exclusion_type) @info_type = args[:info_type] if args.key?(:info_type) @likelihood = args[:likelihood] if args.key?(:likelihood) @regex = args[:regex] if args.key?(:regex) @stored_type = args[:stored_type] if args.key?(:stored_type) @surrogate_type = args[:surrogate_type] if args.key?(:surrogate_type) end |