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
actionDetails
DlpJob actionDetails.
createTime
DlpJob createTime.
details
DlpJob details.
endTime
DlpJob endTime.
errors
DlpJob errors.
inspectDetails
DlpJob inspectDetails.
jobTriggerName
DlpJob jobTriggerName.
lastModified
DlpJob lastModified.
name
DlpJob name.
riskDetails
DlpJob riskDetails.
startTime
DlpJob startTime.
state
DlpJob state.
type
DlpJob type.
JobState
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 |
Methods
toJSON() → {Object.<string, *>}
Converts this DlpJob to JSON.
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
JSON object |
(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 |
Returns:
| Type | Description |
|---|---|
| google.privacy.dlp.v2.DlpJob |
DlpJob instance |
(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 |
Returns:
| Type | Description |
|---|---|
| google.privacy.dlp.v2.DlpJob |
DlpJob |
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 |
Returns:
| Type | Description |
|---|---|
| google.privacy.dlp.v2.DlpJob |
DlpJob |
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 |
Returns:
| Type | Description |
|---|---|
| $protobuf.Writer |
Writer |
(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 |
Returns:
| Type | Description |
|---|---|
| $protobuf.Writer |
Writer |
(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 |
Returns:
| Type | Description |
|---|---|
| google.privacy.dlp.v2.DlpJob |
DlpJob |
(static) getTypeUrl(typeUrlPrefixopt) → {string}
Gets the default type url for DlpJob
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
typeUrlPrefix |
string |
<optional> |
your custom typeUrlPrefix(default "type.googleapis.com") |
Returns:
| Type | Description |
|---|---|
| string |
The default type url |
(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 |
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
Plain object |
(static) verify(message) → {string|null}
Verifies a DlpJob message.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Object.<string, *> |
Plain object to verify |
Returns:
| Type | Description |
|---|---|
| string | null |
|