DlpJob

google.privacy.dlp.v2. DlpJob

Represents a DlpJob.

Constructor

new DlpJob(propertiesopt)

Constructs a new DlpJob.

Parameters:
Name Type Attributes Description
properties google.privacy.dlp.v2.IDlpJob <optional>

Properties to set

Implements:
  • IDlpJob

Members

(static) JobState :number

JobState enum.

Properties:
Name Type Description
JOB_STATE_UNSPECIFIED number

JOB_STATE_UNSPECIFIED value

PENDING number

PENDING value

RUNNING number

RUNNING value

DONE number

DONE value

CANCELED number

CANCELED value

FAILED number

FAILED value

ACTIVE number

ACTIVE value

createTime :google.protobuf.ITimestamp|null|undefined

DlpJob createTime.

details :"riskDetails"|"inspectDetails"|undefined

DlpJob details.

endTime :google.protobuf.ITimestamp|null|undefined

DlpJob endTime.

errors :Array.<google.privacy.dlp.v2.IError>

DlpJob errors.

inspectDetails :google.privacy.dlp.v2.IInspectDataSourceDetails|null|undefined

DlpJob inspectDetails.

jobTriggerName :string

DlpJob jobTriggerName.

name :string

DlpJob name.

riskDetails :google.privacy.dlp.v2.IAnalyzeDataSourceRiskDetails|null|undefined

DlpJob riskDetails.

startTime :google.protobuf.ITimestamp|null|undefined

DlpJob startTime.

state :google.privacy.dlp.v2.DlpJob.JobState

DlpJob state.

type :google.privacy.dlp.v2.DlpJobType

DlpJob type.

Methods

(static) create(propertiesopt) → {google.privacy.dlp.v2.DlpJob}

Creates a new DlpJob instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.privacy.dlp.v2.IDlpJob <optional>

Properties to set

(static) decode(reader, lengthopt) → {google.privacy.dlp.v2.DlpJob}

Decodes a DlpJob message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

length number <optional>

Message length if known beforehand

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.privacy.dlp.v2.DlpJob}

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

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified DlpJob message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.privacy.dlp.v2.IDlpJob

DlpJob message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

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

Parameters:
Name Type Attributes Description
message google.privacy.dlp.v2.IDlpJob

DlpJob message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

(static) fromObject(object) → {google.privacy.dlp.v2.DlpJob}

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

Parameters:
Name Type Description
object Object.<string, *>

Plain object

(static) toObject(message, optionsopt) → {Object.<string, *>}

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

Parameters:
Name Type Attributes Description
message google.privacy.dlp.v2.DlpJob

DlpJob

options $protobuf.IConversionOptions <optional>

Conversion options

(static) verify(message) → {string|null}

Verifies a DlpJob message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

toJSON() → {Object.<string, *>}

Converts this DlpJob to JSON.