Data Loss Prevention V2 Client - Class FileClusterSummary (2.2.0)

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

The file cluster summary.

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

Namespace

Google \ Cloud \ Dlp \ V2

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ file_cluster_type Google\Cloud\Dlp\V2\FileClusterType

The file cluster type.

↳ file_store_info_type_summaries array<Google\Cloud\Dlp\V2\FileStoreInfoTypeSummary>

InfoTypes detected in this cluster.

↳ sensitivity_score Google\Cloud\Dlp\V2\SensitivityScore

The sensitivity score of this cluster. The score will be SENSITIVITY_LOW if nothing has been scanned.

↳ data_risk_level Google\Cloud\Dlp\V2\DataRiskLevel

The data risk level of this cluster. RISK_LOW if nothing has been scanned.

↳ errors array<Google\Cloud\Dlp\V2\Error>

A list of errors detected while scanning this cluster. The list is truncated to 10 per cluster.

↳ file_extensions_scanned array<Google\Cloud\Dlp\V2\FileExtensionInfo>

A sample of file types scanned in this cluster. Empty if no files were scanned. File extensions can be derived from the file name or the file content.

↳ file_extensions_seen array<Google\Cloud\Dlp\V2\FileExtensionInfo>

A sample of file types seen in this cluster. Empty if no files were seen. File extensions can be derived from the file name or the file content.

↳ no_files_exist bool

True if no files exist in this cluster. If the bucket had more files than could be listed, this will be false even if no files for this cluster were seen and file_extensions_seen is empty.

getFileClusterType

The file cluster type.

Returns
Type Description
Google\Cloud\Dlp\V2\FileClusterType|null

hasFileClusterType

clearFileClusterType

setFileClusterType

The file cluster type.

Parameter
Name Description
var Google\Cloud\Dlp\V2\FileClusterType
Returns
Type Description
$this

getFileStoreInfoTypeSummaries

InfoTypes detected in this cluster.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setFileStoreInfoTypeSummaries

InfoTypes detected in this cluster.

Parameter
Name Description
var array<Google\Cloud\Dlp\V2\FileStoreInfoTypeSummary>
Returns
Type Description
$this

getSensitivityScore

The sensitivity score of this cluster. The score will be SENSITIVITY_LOW if nothing has been scanned.

Returns
Type Description
Google\Cloud\Dlp\V2\SensitivityScore|null

hasSensitivityScore

clearSensitivityScore

setSensitivityScore

The sensitivity score of this cluster. The score will be SENSITIVITY_LOW if nothing has been scanned.

Parameter
Name Description
var Google\Cloud\Dlp\V2\SensitivityScore
Returns
Type Description
$this

getDataRiskLevel

The data risk level of this cluster. RISK_LOW if nothing has been scanned.

Returns
Type Description
Google\Cloud\Dlp\V2\DataRiskLevel|null

hasDataRiskLevel

clearDataRiskLevel

setDataRiskLevel

The data risk level of this cluster. RISK_LOW if nothing has been scanned.

Parameter
Name Description
var Google\Cloud\Dlp\V2\DataRiskLevel
Returns
Type Description
$this

getErrors

A list of errors detected while scanning this cluster. The list is truncated to 10 per cluster.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setErrors

A list of errors detected while scanning this cluster. The list is truncated to 10 per cluster.

Parameter
Name Description
var array<Google\Cloud\Dlp\V2\Error>
Returns
Type Description
$this

getFileExtensionsScanned

A sample of file types scanned in this cluster. Empty if no files were scanned. File extensions can be derived from the file name or the file content.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setFileExtensionsScanned

A sample of file types scanned in this cluster. Empty if no files were scanned. File extensions can be derived from the file name or the file content.

Parameter
Name Description
var array<Google\Cloud\Dlp\V2\FileExtensionInfo>
Returns
Type Description
$this

getFileExtensionsSeen

A sample of file types seen in this cluster. Empty if no files were seen.

File extensions can be derived from the file name or the file content.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setFileExtensionsSeen

A sample of file types seen in this cluster. Empty if no files were seen.

File extensions can be derived from the file name or the file content.

Parameter
Name Description
var array<Google\Cloud\Dlp\V2\FileExtensionInfo>
Returns
Type Description
$this

getNoFilesExist

True if no files exist in this cluster. If the bucket had more files than could be listed, this will be false even if no files for this cluster were seen and file_extensions_seen is empty.

Returns
Type Description
bool

setNoFilesExist

True if no files exist in this cluster. If the bucket had more files than could be listed, this will be false even if no files for this cluster were seen and file_extensions_seen is empty.

Parameter
Name Description
var bool
Returns
Type Description
$this