Class protos.google.privacy.dlp.v2.DlpJob

Represents a DlpJob.

Package

@google-cloud/dlp

Constructors

(constructor)(properties)

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

Constructs a new DlpJob.

Parameter
NameDescription
properties IDlpJob

Properties to set

Properties

createTime

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

DlpJob createTime.

details

public details?: ("riskDetails"|"inspectDetails");

DlpJob details.

endTime

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

DlpJob endTime.

errors

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

DlpJob errors.

inspectDetails

public inspectDetails?: (google.privacy.dlp.v2.IInspectDataSourceDetails|null);

DlpJob inspectDetails.

jobTriggerName

public jobTriggerName: string;

DlpJob jobTriggerName.

name

public name: string;

DlpJob name.

riskDetails

public riskDetails?: (google.privacy.dlp.v2.IAnalyzeDataSourceRiskDetails|null);

DlpJob riskDetails.

startTime

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

DlpJob startTime.

state

public state: (google.privacy.dlp.v2.DlpJob.JobState|keyof typeof google.privacy.dlp.v2.DlpJob.JobState);

DlpJob state.

type

public type: (google.privacy.dlp.v2.DlpJobType|keyof typeof google.privacy.dlp.v2.DlpJobType);

DlpJob type.

Methods

create(properties)

public static create(properties?: google.privacy.dlp.v2.IDlpJob): google.privacy.dlp.v2.DlpJob;

Creates a new DlpJob instance using the specified properties.

Parameter
NameDescription
properties IDlpJob

Properties to set

Returns
TypeDescription
google.privacy.dlp.v2.DlpJob

DlpJob instance

decode(reader, length)

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

Decodes a DlpJob message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.privacy.dlp.v2.DlpJob

DlpJob

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.privacy.dlp.v2.DlpJob

DlpJob

encode(message, writer)

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

Encodes the specified DlpJob message. Does not implicitly messages.

Parameters
NameDescription
message IDlpJob

DlpJob message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

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

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

Parameters
NameDescription
message IDlpJob

DlpJob message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

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

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

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
google.privacy.dlp.v2.DlpJob

DlpJob

toJSON()

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

Converts this DlpJob to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.privacy.dlp.v2.DlpJob

DlpJob

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies a DlpJob message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not