Class protos.google.privacy.dlp.v2.FileClusterSummary (5.10.0)

Represents a FileClusterSummary.

Package

@google-cloud/dlp

Constructors

(constructor)(properties)

constructor(properties?: google.privacy.dlp.v2.IFileClusterSummary);

Constructs a new FileClusterSummary.

Parameter
Name Description
properties IFileClusterSummary

Properties to set

Properties

dataRiskLevel

public dataRiskLevel?: (google.privacy.dlp.v2.IDataRiskLevel|null);

FileClusterSummary dataRiskLevel.

errors

public errors: google.privacy.dlp.v2.IError[];

FileClusterSummary errors.

fileClusterType

public fileClusterType?: (google.privacy.dlp.v2.IFileClusterType|null);

FileClusterSummary fileClusterType.

fileExtensionsScanned

public fileExtensionsScanned: google.privacy.dlp.v2.IFileExtensionInfo[];

FileClusterSummary fileExtensionsScanned.

fileExtensionsSeen

public fileExtensionsSeen: google.privacy.dlp.v2.IFileExtensionInfo[];

FileClusterSummary fileExtensionsSeen.

fileStoreInfoTypeSummaries

public fileStoreInfoTypeSummaries: google.privacy.dlp.v2.IFileStoreInfoTypeSummary[];

FileClusterSummary fileStoreInfoTypeSummaries.

noFilesExist

public noFilesExist: boolean;

FileClusterSummary noFilesExist.

sensitivityScore

public sensitivityScore?: (google.privacy.dlp.v2.ISensitivityScore|null);

FileClusterSummary sensitivityScore.

Methods

create(properties)

public static create(properties?: google.privacy.dlp.v2.IFileClusterSummary): google.privacy.dlp.v2.FileClusterSummary;

Creates a new FileClusterSummary instance using the specified properties.

Parameter
Name Description
properties IFileClusterSummary

Properties to set

Returns
Type Description
FileClusterSummary

FileClusterSummary instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.privacy.dlp.v2.FileClusterSummary;

Decodes a FileClusterSummary message from the specified reader or buffer.

Parameters
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
Type Description
FileClusterSummary

FileClusterSummary

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.privacy.dlp.v2.FileClusterSummary;

Decodes a FileClusterSummary message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
FileClusterSummary

FileClusterSummary

encode(message, writer)

public static encode(message: google.privacy.dlp.v2.IFileClusterSummary, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified FileClusterSummary message. Does not implicitly messages.

Parameters
Name Description
message IFileClusterSummary

FileClusterSummary message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
Type Description
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.privacy.dlp.v2.IFileClusterSummary, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified FileClusterSummary message, length delimited. Does not implicitly messages.

Parameters
Name Description
message IFileClusterSummary

FileClusterSummary message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
Type Description
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.privacy.dlp.v2.FileClusterSummary;

Creates a FileClusterSummary message from a plain object. Also converts values to their respective internal types.

Parameter
Name Description
object { [k: string]: any }

Plain object

Returns
Type Description
FileClusterSummary

FileClusterSummary

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for FileClusterSummary

Parameter
Name Description
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
Type Description
string

The default type url

toJSON()

public toJSON(): { [k: string]: any };

Converts this FileClusterSummary to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.privacy.dlp.v2.FileClusterSummary, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a FileClusterSummary message. Also converts values to other types if specified.

Parameters
Name Description
message FileClusterSummary

FileClusterSummary

options $protobuf.IConversionOptions

Conversion options

Returns
Type Description
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a FileClusterSummary message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify

Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not