Data Loss Prevention V2 Client - Class TransformationDetails (1.8.6)

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

Details about a single transformation. This object contains a description of the transformation, information about whether the transformation was successfully applied, and the precise location where the transformation occurred. These details are stored in a user-specified BigQuery table.

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

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ resource_name string

The name of the job that completed the transformation.

↳ container_name string

The top level name of the container where the transformation is located (this will be the source file name or table name).

↳ transformation array<Google\Cloud\Dlp\V2\TransformationDescription>

Description of transformation. This would only contain more than one element if there were multiple matching transformations and which one to apply was ambiguous. Not set for states that contain no transformation, currently only state that contains no transformation is TransformationResultStateType.METADATA_UNRETRIEVABLE.

↳ status_details Google\Cloud\Dlp\V2\TransformationResultStatus

Status of the transformation, if transformation was not successful, this will specify what caused it to fail, otherwise it will show that the transformation was successful.

↳ transformed_bytes int|string

The number of bytes that were transformed. If transformation was unsuccessful or did not take place because there was no content to transform, this will be zero.

↳ transformation_location Google\Cloud\Dlp\V2\TransformationLocation

The precise location of the transformed content in the original container.

getResourceName

The name of the job that completed the transformation.

Returns
TypeDescription
string

setResourceName

The name of the job that completed the transformation.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getContainerName

The top level name of the container where the transformation is located (this will be the source file name or table name).

Returns
TypeDescription
string

setContainerName

The top level name of the container where the transformation is located (this will be the source file name or table name).

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getTransformation

Description of transformation. This would only contain more than one element if there were multiple matching transformations and which one to apply was ambiguous. Not set for states that contain no transformation, currently only state that contains no transformation is TransformationResultStateType.METADATA_UNRETRIEVABLE.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setTransformation

Description of transformation. This would only contain more than one element if there were multiple matching transformations and which one to apply was ambiguous. Not set for states that contain no transformation, currently only state that contains no transformation is TransformationResultStateType.METADATA_UNRETRIEVABLE.

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

getStatusDetails

Status of the transformation, if transformation was not successful, this will specify what caused it to fail, otherwise it will show that the transformation was successful.

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

hasStatusDetails

clearStatusDetails

setStatusDetails

Status of the transformation, if transformation was not successful, this will specify what caused it to fail, otherwise it will show that the transformation was successful.

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

getTransformedBytes

The number of bytes that were transformed. If transformation was unsuccessful or did not take place because there was no content to transform, this will be zero.

Returns
TypeDescription
int|string

setTransformedBytes

The number of bytes that were transformed. If transformation was unsuccessful or did not take place because there was no content to transform, this will be zero.

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this

getTransformationLocation

The precise location of the transformed content in the original container.

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

hasTransformationLocation

clearTransformationLocation

setTransformationLocation

The precise location of the transformed content in the original container.

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