Class protos.google.privacy.dlp.v2.DataProfileFinding (6.2.0)

Represents a DataProfileFinding.

Package

@google-cloud/dlp

Constructors

(constructor)(properties)

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

Constructs a new DataProfileFinding.

Parameter
Name Description
properties IDataProfileFinding

Properties to set

Properties

dataProfileResourceName

public dataProfileResourceName: string;

DataProfileFinding dataProfileResourceName.

dataSourceType

public dataSourceType?: (google.privacy.dlp.v2.IDataSourceType|null);

DataProfileFinding dataSourceType.

findingId

public findingId: string;

DataProfileFinding findingId.

fullResourceName

public fullResourceName: string;

DataProfileFinding fullResourceName.

infotype

public infotype?: (google.privacy.dlp.v2.IInfoType|null);

DataProfileFinding infotype.

location

public location?: (google.privacy.dlp.v2.IDataProfileFindingLocation|null);

DataProfileFinding location.

quote

public quote: string;

DataProfileFinding quote.

quoteInfo

public quoteInfo?: (google.privacy.dlp.v2.IQuoteInfo|null);

DataProfileFinding quoteInfo.

resourceVisibility

public resourceVisibility: (google.privacy.dlp.v2.ResourceVisibility|keyof typeof google.privacy.dlp.v2.ResourceVisibility);

DataProfileFinding resourceVisibility.

timestamp

public timestamp?: (google.protobuf.ITimestamp|null);

DataProfileFinding timestamp.

Methods

create(properties)

public static create(properties?: google.privacy.dlp.v2.IDataProfileFinding): google.privacy.dlp.v2.DataProfileFinding;

Creates a new DataProfileFinding instance using the specified properties.

Parameter
Name Description
properties IDataProfileFinding

Properties to set

Returns
Type Description
DataProfileFinding

DataProfileFinding instance

decode(reader, length)

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

Decodes a DataProfileFinding 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
DataProfileFinding

DataProfileFinding

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
DataProfileFinding

DataProfileFinding

encode(message, writer)

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

Encodes the specified DataProfileFinding message. Does not implicitly messages.

Parameters
Name Description
message IDataProfileFinding

DataProfileFinding 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.IDataProfileFinding, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IDataProfileFinding

DataProfileFinding 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.DataProfileFinding;

Creates a DataProfileFinding 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
DataProfileFinding

DataProfileFinding

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for DataProfileFinding

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 DataProfileFinding to JSON.

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message DataProfileFinding

DataProfileFinding

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 DataProfileFinding 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