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

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

Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#detection_rules

def detection_rules() -> ::Array<::Google::Cloud::Dlp::V2::CustomInfoType::DetectionRule>
Returns

#detection_rules=

def detection_rules=(value) -> ::Array<::Google::Cloud::Dlp::V2::CustomInfoType::DetectionRule>
Parameter
Returns

#dictionary

def dictionary() -> ::Google::Cloud::Dlp::V2::CustomInfoType::Dictionary
Returns
  • (::Google::Cloud::Dlp::V2::CustomInfoType::Dictionary) — A list of phrases to detect as a CustomInfoType.

    Note: The following fields are mutually exclusive: dictionary, regex, surrogate_type, stored_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

#dictionary=

def dictionary=(value) -> ::Google::Cloud::Dlp::V2::CustomInfoType::Dictionary
Parameter
  • value (::Google::Cloud::Dlp::V2::CustomInfoType::Dictionary) — A list of phrases to detect as a CustomInfoType.

    Note: The following fields are mutually exclusive: dictionary, regex, surrogate_type, stored_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Dlp::V2::CustomInfoType::Dictionary) — A list of phrases to detect as a CustomInfoType.

    Note: The following fields are mutually exclusive: dictionary, regex, surrogate_type, stored_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

#exclusion_type

def exclusion_type() -> ::Google::Cloud::Dlp::V2::CustomInfoType::ExclusionType
Returns

#exclusion_type=

def exclusion_type=(value) -> ::Google::Cloud::Dlp::V2::CustomInfoType::ExclusionType
Parameter
Returns

#info_type

def info_type() -> ::Google::Cloud::Dlp::V2::InfoType
Returns
  • (::Google::Cloud::Dlp::V2::InfoType) — CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in InspectContent.info_types field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in InspectContent.info_types list then the name is treated as a custom info type.

#info_type=

def info_type=(value) -> ::Google::Cloud::Dlp::V2::InfoType
Parameter
  • value (::Google::Cloud::Dlp::V2::InfoType) — CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in InspectContent.info_types field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in InspectContent.info_types list then the name is treated as a custom info type.
Returns
  • (::Google::Cloud::Dlp::V2::InfoType) — CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in InspectContent.info_types field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in InspectContent.info_types list then the name is treated as a custom info type.

#likelihood

def likelihood() -> ::Google::Cloud::Dlp::V2::Likelihood
Returns
  • (::Google::Cloud::Dlp::V2::Likelihood) — 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.

#likelihood=

def likelihood=(value) -> ::Google::Cloud::Dlp::V2::Likelihood
Parameter
  • value (::Google::Cloud::Dlp::V2::Likelihood) — 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.
Returns
  • (::Google::Cloud::Dlp::V2::Likelihood) — 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.

#regex

def regex() -> ::Google::Cloud::Dlp::V2::CustomInfoType::Regex
Returns
  • (::Google::Cloud::Dlp::V2::CustomInfoType::Regex) — Regular expression based CustomInfoType.

    Note: The following fields are mutually exclusive: regex, dictionary, surrogate_type, stored_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

#regex=

def regex=(value) -> ::Google::Cloud::Dlp::V2::CustomInfoType::Regex
Parameter
  • value (::Google::Cloud::Dlp::V2::CustomInfoType::Regex) — Regular expression based CustomInfoType.

    Note: The following fields are mutually exclusive: regex, dictionary, surrogate_type, stored_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Dlp::V2::CustomInfoType::Regex) — Regular expression based CustomInfoType.

    Note: The following fields are mutually exclusive: regex, dictionary, surrogate_type, stored_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

#sensitivity_score

def sensitivity_score() -> ::Google::Cloud::Dlp::V2::SensitivityScore
Returns
  • (::Google::Cloud::Dlp::V2::SensitivityScore) — Sensitivity for this CustomInfoType. If this CustomInfoType extends an existing InfoType, the sensitivity here will take precedence over that of the original InfoType. If unset for a CustomInfoType, it will default to HIGH. This only applies to data profiling.

#sensitivity_score=

def sensitivity_score=(value) -> ::Google::Cloud::Dlp::V2::SensitivityScore
Parameter
  • value (::Google::Cloud::Dlp::V2::SensitivityScore) — Sensitivity for this CustomInfoType. If this CustomInfoType extends an existing InfoType, the sensitivity here will take precedence over that of the original InfoType. If unset for a CustomInfoType, it will default to HIGH. This only applies to data profiling.
Returns
  • (::Google::Cloud::Dlp::V2::SensitivityScore) — Sensitivity for this CustomInfoType. If this CustomInfoType extends an existing InfoType, the sensitivity here will take precedence over that of the original InfoType. If unset for a CustomInfoType, it will default to HIGH. This only applies to data profiling.

#stored_type

def stored_type() -> ::Google::Cloud::Dlp::V2::StoredType
Returns
  • (::Google::Cloud::Dlp::V2::StoredType) — Load an existing StoredInfoType resource for use in InspectDataSource. Not currently supported in InspectContent.

    Note: The following fields are mutually exclusive: stored_type, dictionary, regex, surrogate_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

#stored_type=

def stored_type=(value) -> ::Google::Cloud::Dlp::V2::StoredType
Parameter
  • value (::Google::Cloud::Dlp::V2::StoredType) — Load an existing StoredInfoType resource for use in InspectDataSource. Not currently supported in InspectContent.

    Note: The following fields are mutually exclusive: stored_type, dictionary, regex, surrogate_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Dlp::V2::StoredType) — Load an existing StoredInfoType resource for use in InspectDataSource. Not currently supported in InspectContent.

    Note: The following fields are mutually exclusive: stored_type, dictionary, regex, surrogate_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

#surrogate_type

def surrogate_type() -> ::Google::Cloud::Dlp::V2::CustomInfoType::SurrogateType
Returns
  • (::Google::Cloud::Dlp::V2::CustomInfoType::SurrogateType) — Message for detecting output from deidentification transformations that support reversing.

    Note: The following fields are mutually exclusive: surrogate_type, dictionary, regex, stored_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

#surrogate_type=

def surrogate_type=(value) -> ::Google::Cloud::Dlp::V2::CustomInfoType::SurrogateType
Parameter
  • value (::Google::Cloud::Dlp::V2::CustomInfoType::SurrogateType) — Message for detecting output from deidentification transformations that support reversing.

    Note: The following fields are mutually exclusive: surrogate_type, dictionary, regex, stored_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Dlp::V2::CustomInfoType::SurrogateType) — Message for detecting output from deidentification transformations that support reversing.

    Note: The following fields are mutually exclusive: surrogate_type, dictionary, regex, stored_type. If a field in that set is populated, all other fields in the set will automatically be cleared.