Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Data Loss Prevention V2 Client - Class CustomInfoType (2.8.1)

Reference documentation and code samples for the Data Loss Prevention V2 Client class CustomInfoType.

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

Generated from protobuf message google.privacy.dlp.v2.CustomInfoType

Namespace

Google \ Cloud \ Dlp \ V2

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ info_type`	`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`	`int` 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.
`↳ dictionary`	`CustomInfoType\Dictionary` A list of phrases to detect as a CustomInfoType.
`↳ regex`	`CustomInfoType\Regex` Regular expression based CustomInfoType.
`↳ surrogate_type`	`CustomInfoType\SurrogateType` Message for detecting output from deidentification transformations that support reversing.
`↳ stored_type`	`StoredType` Load an existing `StoredInfoType` resource for use in `InspectDataSource`. Not currently supported in `InspectContent`.
`↳ detection_rules`	`array<CustomInfoType\DetectionRule>` 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.
`↳ exclusion_type`	`int` If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching.
`↳ sensitivity_score`	`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.

getInfoType

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
Type	Description
`InfoType\|null`

hasInfoType

clearInfoType

setInfoType

Parameter
Name	Description
`var`	`InfoType`

Returns
Type	Description
`$this`

getLikelihood

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
Type	Description
`int`	Enum of type Likelihood.

setLikelihood

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.

Parameter
Name	Description
`var`	`int` Enum of type Likelihood.

Returns
Type	Description
`$this`

getDictionary

A list of phrases to detect as a CustomInfoType.

Returns
Type	Description
`CustomInfoType\Dictionary\|null`

hasDictionary

setDictionary

A list of phrases to detect as a CustomInfoType.

Parameter
Name	Description
`var`	`CustomInfoType\Dictionary`

Returns
Type	Description
`$this`

getRegex

Regular expression based CustomInfoType.

Returns
Type	Description
`CustomInfoType\Regex\|null`

hasRegex

setRegex

Regular expression based CustomInfoType.

Parameter
Name	Description
`var`	`CustomInfoType\Regex`

Returns
Type	Description
`$this`

getSurrogateType

Message for detecting output from deidentification transformations that support reversing.

Returns
Type	Description
`CustomInfoType\SurrogateType\|null`

hasSurrogateType

setSurrogateType

Message for detecting output from deidentification transformations that support reversing.

Parameter
Name	Description
`var`	`CustomInfoType\SurrogateType`

Returns
Type	Description
`$this`

getStoredType

Load an existing StoredInfoType resource for use in InspectDataSource. Not currently supported in InspectContent.

Returns
Type	Description
`StoredType\|null`

hasStoredType

setStoredType

Load an existing StoredInfoType resource for use in InspectDataSource. Not currently supported in InspectContent.

Parameter
Name	Description
`var`	`StoredType`

Returns
Type	Description
`$this`

getDetectionRules

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.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setDetectionRules

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.

Parameter
Name	Description
`var`	`array<CustomInfoType\DetectionRule>`

Returns
Type	Description
`$this`

getExclusionType

If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching.

Returns
Type	Description
`int`	Enum of type ExclusionType.

setExclusionType

If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching.

Parameter
Name	Description
`var`	`int` Enum of type ExclusionType.

Returns
Type	Description
`$this`

getSensitivityScore

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
Type	Description
`SensitivityScore\|null`

hasSensitivityScore

clearSensitivityScore

setSensitivityScore

This only applies to data profiling.

Parameter
Name	Description
`var`	`SensitivityScore`

Returns
Type	Description
`$this`

getType

Returns
Type	Description
`string`