Data Loss Prevention V2 Client - Class TransformationDescription (1.11.0)

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

A flattened description of a PrimitiveTransformation or RecordSuppression.

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

Namespace

Google \ Cloud \ Dlp \ V2

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ type`	`int` The transformation type.
`↳ description`	`string` A description of the transformation. This is empty for a RECORD_SUPPRESSION, or is the output of calling toString() on the `PrimitiveTransformation` protocol buffer message for any other type of transformation.
`↳ condition`	`string` A human-readable string representation of the `RecordCondition` corresponding to this transformation. Set if a `RecordCondition` was used to determine whether or not to apply this transformation. Examples: * (age_field > 85) * (age_field <= 18) * (zip_field exists) * (zip_field == 01234) && (city_field != "Springville") * (zip_field == 01234) && (age_field <= 18) && (city_field exists)
`↳ info_type`	`Google\Cloud\Dlp\V2\InfoType` Set if the transformation was limited to a specific `InfoType`.

getType

The transformation type.

Returns
Type	Description
`int`

setType

The transformation type.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getDescription

A description of the transformation. This is empty for a RECORD_SUPPRESSION, or is the output of calling toString() on the PrimitiveTransformation protocol buffer message for any other type of transformation.

Returns
Type	Description
`string`

setDescription

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCondition

A human-readable string representation of the RecordCondition corresponding to this transformation. Set if a RecordCondition was used to determine whether or not to apply this transformation.

Examples:

(age_field > 85)
(age_field <= 18)
(zip_field exists)
(zip_field == 01234) && (city_field != "Springville")
(zip_field == 01234) && (age_field <= 18) && (city_field exists)

Returns
Type	Description
`string`

setCondition

A human-readable string representation of the RecordCondition corresponding to this transformation. Set if a RecordCondition was used to determine whether or not to apply this transformation.

Examples:

(age_field > 85)
(age_field <= 18)
(zip_field exists)
(zip_field == 01234) && (city_field != "Springville")
(zip_field == 01234) && (age_field <= 18) && (city_field exists)

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getInfoType

Set if the transformation was limited to a specific InfoType.

Returns
Type	Description
`Google\Cloud\Dlp\V2\InfoType\|null`

hasInfoType

clearInfoType

setInfoType

Set if the transformation was limited to a specific InfoType.

Parameter
Name	Description
`var`	`Google\Cloud\Dlp\V2\InfoType`

Returns
Type	Description
`$this`