Class protos.google.privacy.dlp.v2.Finding (4.1.1)

Represents a Finding.

Package

@google-cloud/dlp

Constructors

(constructor)(properties)

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

Constructs a new Finding.

Parameter
Name Description
properties IFinding

Properties to set

Properties

createTime

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

Finding createTime.

findingId

public findingId: string;

Finding findingId.

infoType

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

Finding infoType.

jobCreateTime

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

Finding jobCreateTime.

jobName

public jobName: string;

Finding jobName.

labels

public labels: { [k: string]: string };

Finding labels.

likelihood

public likelihood: (google.privacy.dlp.v2.Likelihood|keyof typeof google.privacy.dlp.v2.Likelihood);

Finding likelihood.

location

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

Finding location.

name

public name: string;

Finding name.

quote

public quote: string;

Finding quote.

quoteInfo

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

Finding quoteInfo.

resourceName

public resourceName: string;

Finding resourceName.

triggerName

public triggerName: string;

Finding triggerName.

Methods

create(properties)

public static create(properties?: google.privacy.dlp.v2.IFinding): google.privacy.dlp.v2.Finding;

Creates a new Finding instance using the specified properties.

Parameter
Name Description
properties IFinding

Properties to set
Returns
Type Description
google.privacy.dlp.v2.Finding

Finding instance

decode(reader, length)

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

Decodes a Finding message from the specified reader or buffer.

Parameters
Name Description
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from
length number

Message length if known beforehand
Returns
Type Description
google.privacy.dlp.v2.Finding

Finding

decodeDelimited(reader)

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

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

Parameter
Name Description
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from
Returns
Type Description
google.privacy.dlp.v2.Finding

Finding

encode(message, writer)

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

Encodes the specified Finding message. Does not implicitly messages.

Parameters
Name Description
message IFinding

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

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

Parameters
Name Description
message IFinding

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

Creates a Finding 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
google.privacy.dlp.v2.Finding

Finding

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for Finding

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message google.privacy.dlp.v2.Finding

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