Data Loss Prevention V2 Client - Class TransformationSummary (1.8.6)

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

Summary of a single transformation.

Only one of 'transformation', 'field_transformation', or 'record_suppress' will be set.

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

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ info_type Google\Cloud\Dlp\V2\InfoType

Set if the transformation was limited to a specific InfoType.

↳ field Google\Cloud\Dlp\V2\FieldId

Set if the transformation was limited to a specific FieldId.

↳ transformation Google\Cloud\Dlp\V2\PrimitiveTransformation

The specific transformation these stats apply to.

↳ field_transformations array<Google\Cloud\Dlp\V2\FieldTransformation>

The field transformation that was applied. If multiple field transformations are requested for a single field, this list will contain all of them; otherwise, only one is supplied.

↳ record_suppress Google\Cloud\Dlp\V2\RecordSuppression

The specific suppression option these stats apply to.

↳ results array<Google\Cloud\Dlp\V2\TransformationSummary\SummaryResult>

Collection of all transformations that took place or had an error.

↳ transformed_bytes int|string

Total size in bytes that were transformed in some way.

getInfoType

Set if the transformation was limited to a specific InfoType.

Returns
TypeDescription
Google\Cloud\Dlp\V2\InfoType|null

hasInfoType

clearInfoType

setInfoType

Set if the transformation was limited to a specific InfoType.

Parameter
NameDescription
var Google\Cloud\Dlp\V2\InfoType
Returns
TypeDescription
$this

getField

Set if the transformation was limited to a specific FieldId.

Returns
TypeDescription
Google\Cloud\Dlp\V2\FieldId|null

hasField

clearField

setField

Set if the transformation was limited to a specific FieldId.

Parameter
NameDescription
var Google\Cloud\Dlp\V2\FieldId
Returns
TypeDescription
$this

getTransformation

The specific transformation these stats apply to.

Returns
TypeDescription
Google\Cloud\Dlp\V2\PrimitiveTransformation|null

hasTransformation

clearTransformation

setTransformation

The specific transformation these stats apply to.

Parameter
NameDescription
var Google\Cloud\Dlp\V2\PrimitiveTransformation
Returns
TypeDescription
$this

getFieldTransformations

The field transformation that was applied.

If multiple field transformations are requested for a single field, this list will contain all of them; otherwise, only one is supplied.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setFieldTransformations

The field transformation that was applied.

If multiple field transformations are requested for a single field, this list will contain all of them; otherwise, only one is supplied.

Parameter
NameDescription
var array<Google\Cloud\Dlp\V2\FieldTransformation>
Returns
TypeDescription
$this

getRecordSuppress

The specific suppression option these stats apply to.

Returns
TypeDescription
Google\Cloud\Dlp\V2\RecordSuppression|null

hasRecordSuppress

clearRecordSuppress

setRecordSuppress

The specific suppression option these stats apply to.

Parameter
NameDescription
var Google\Cloud\Dlp\V2\RecordSuppression
Returns
TypeDescription
$this

getResults

Collection of all transformations that took place or had an error.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setResults

Collection of all transformations that took place or had an error.

Parameter
NameDescription
var array<Google\Cloud\Dlp\V2\TransformationSummary\SummaryResult>
Returns
TypeDescription
$this

getTransformedBytes

Total size in bytes that were transformed in some way.

Returns
TypeDescription
int|string

setTransformedBytes

Total size in bytes that were transformed in some way.

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this