ScanRun

google.cloud.websecurityscanner.v1beta. ScanRun

Represents a ScanRun.

Constructor

new ScanRun(propertiesopt)

Constructs a new ScanRun.

Parameters:
Name Type Attributes Description
properties google.cloud.websecurityscanner.v1beta.IScanRun <optional>

Properties to set

Implements:
  • IScanRun

Members

endTime

ScanRun endTime.

errorTrace

ScanRun errorTrace.

executionState

ScanRun executionState.

hasVulnerabilities

ScanRun hasVulnerabilities.

name

ScanRun name.

progressPercent

ScanRun progressPercent.

resultState

ScanRun resultState.

startTime

ScanRun startTime.

urlsCrawledCount

ScanRun urlsCrawledCount.

urlsTestedCount

ScanRun urlsTestedCount.

warningTraces

ScanRun warningTraces.

ExecutionState

ExecutionState enum.

Properties:
Name Type Description
EXECUTION_STATE_UNSPECIFIED number

EXECUTION_STATE_UNSPECIFIED value

QUEUED number

QUEUED value

SCANNING number

SCANNING value

FINISHED number

FINISHED value

ResultState

ResultState enum.

Properties:
Name Type Description
RESULT_STATE_UNSPECIFIED number

RESULT_STATE_UNSPECIFIED value

SUCCESS number

SUCCESS value

ERROR number

ERROR value

KILLED number

KILLED value

Methods

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

Converts this ScanRun to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.cloud.websecurityscanner.v1beta.ScanRun}

Creates a new ScanRun instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.websecurityscanner.v1beta.IScanRun <optional>

Properties to set

Returns:
Type Description
google.cloud.websecurityscanner.v1beta.ScanRun

ScanRun instance

(static) decode(reader, lengthopt) → {google.cloud.websecurityscanner.v1beta.ScanRun}

Decodes a ScanRun 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.cloud.websecurityscanner.v1beta.ScanRun

ScanRun

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.cloud.websecurityscanner.v1beta.ScanRun}

Decodes a ScanRun 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.cloud.websecurityscanner.v1beta.ScanRun

ScanRun

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 ScanRun message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.websecurityscanner.v1beta.IScanRun

ScanRun 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 ScanRun message, length delimited. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.websecurityscanner.v1beta.IScanRun

ScanRun message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.cloud.websecurityscanner.v1beta.ScanRun}

Creates a ScanRun 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.cloud.websecurityscanner.v1beta.ScanRun

ScanRun

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for ScanRun

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 ScanRun message. Also converts values to other types if specified.

Parameters:
Name Type Attributes Description
message google.cloud.websecurityscanner.v1beta.ScanRun

ScanRun

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

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

Verifies a ScanRun message.

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

Plain object to verify

Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not