Data Loss Prevention V2 Client - Class LikelihoodAdjustment (2.0.0)

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

Message for specifying an adjustment to the likelihood of a finding as part of a detection rule.

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

Namespace

Google \ Cloud \ Dlp \ V2 \ CustomInfoType \ DetectionRule

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ fixed_likelihood int

Set the likelihood of a finding to a fixed value.
↳ relative_likelihood int

Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be POSSIBLE without the detection rule and relative_likelihood is 1, then it is upgraded to LIKELY, while a value of -1 would downgrade it to UNLIKELY. Likelihood may never drop below VERY_UNLIKELY or exceed VERY_LIKELY, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is VERY_LIKELY will result in a final likelihood of LIKELY.

getFixedLikelihood

Set the likelihood of a finding to a fixed value.

Returns
Type Description
int

hasFixedLikelihood

setFixedLikelihood

Set the likelihood of a finding to a fixed value.

Parameter
Name Description
var int
Returns
Type Description
$this

getRelativeLikelihood

Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be POSSIBLE without the detection rule and relative_likelihood is 1, then it is upgraded to LIKELY, while a value of -1 would downgrade it to UNLIKELY.

Likelihood may never drop below VERY_UNLIKELY or exceed VERY_LIKELY, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is VERY_LIKELY will result in a final likelihood of LIKELY.

Returns
Type Description
int

hasRelativeLikelihood

setRelativeLikelihood

Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be POSSIBLE without the detection rule and relative_likelihood is 1, then it is upgraded to LIKELY, while a value of -1 would downgrade it to UNLIKELY.

Likelihood may never drop below VERY_UNLIKELY or exceed VERY_LIKELY, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is VERY_LIKELY will result in a final likelihood of LIKELY.

Parameter
Name Description
var int
Returns
Type Description
$this

getAdjustment

Returns
Type Description
string