Web Security Scanner V1beta API - Class Google::Cloud::WebSecurityScanner::V1beta::ScanRun (v0.4.0)

Reference documentation and code samples for the Web Security Scanner V1beta API class Google::Cloud::WebSecurityScanner::V1beta::ScanRun.

A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#end_time

def end_time() -> ::Google::Protobuf::Timestamp
Returns
  • (::Google::Protobuf::Timestamp) — The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.

#end_time=

def end_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
  • value (::Google::Protobuf::Timestamp) — The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
Returns
  • (::Google::Protobuf::Timestamp) — The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.

#error_trace

def error_trace() -> ::Google::Cloud::WebSecurityScanner::V1beta::ScanRunErrorTrace
Returns

#error_trace=

def error_trace=(value) -> ::Google::Cloud::WebSecurityScanner::V1beta::ScanRunErrorTrace
Parameter
Returns

#execution_state

def execution_state() -> ::Google::Cloud::WebSecurityScanner::V1beta::ScanRun::ExecutionState
Returns

#execution_state=

def execution_state=(value) -> ::Google::Cloud::WebSecurityScanner::V1beta::ScanRun::ExecutionState
Parameter
Returns

#has_vulnerabilities

def has_vulnerabilities() -> ::Boolean
Returns
  • (::Boolean) — Whether the scan run has found any vulnerabilities.

#has_vulnerabilities=

def has_vulnerabilities=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Whether the scan run has found any vulnerabilities.
Returns
  • (::Boolean) — Whether the scan run has found any vulnerabilities.

#name

def name() -> ::String
Returns
  • (::String) — The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system.
Returns
  • (::String) — The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system.

#progress_percent

def progress_percent() -> ::Integer
Returns
  • (::Integer) — The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100.

#progress_percent=

def progress_percent=(value) -> ::Integer
Parameter
  • value (::Integer) — The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100.
Returns
  • (::Integer) — The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100.

#result_state

def result_state() -> ::Google::Cloud::WebSecurityScanner::V1beta::ScanRun::ResultState
Returns

#result_state=

def result_state=(value) -> ::Google::Cloud::WebSecurityScanner::V1beta::ScanRun::ResultState
Parameter
Returns

#start_time

def start_time() -> ::Google::Protobuf::Timestamp
Returns

#start_time=

def start_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
Returns

#urls_crawled_count

def urls_crawled_count() -> ::Integer
Returns
  • (::Integer) — The number of URLs crawled during this ScanRun. If the scan is in progress, the value represents the number of URLs crawled up to now.

#urls_crawled_count=

def urls_crawled_count=(value) -> ::Integer
Parameter
  • value (::Integer) — The number of URLs crawled during this ScanRun. If the scan is in progress, the value represents the number of URLs crawled up to now.
Returns
  • (::Integer) — The number of URLs crawled during this ScanRun. If the scan is in progress, the value represents the number of URLs crawled up to now.

#urls_tested_count

def urls_tested_count() -> ::Integer
Returns
  • (::Integer) — The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than the number URLS crawled because typically a crawled URL is tested with multiple test payloads.

#urls_tested_count=

def urls_tested_count=(value) -> ::Integer
Parameter
  • value (::Integer) — The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than the number URLS crawled because typically a crawled URL is tested with multiple test payloads.
Returns
  • (::Integer) — The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than the number URLS crawled because typically a crawled URL is tested with multiple test payloads.

#warning_traces

def warning_traces() -> ::Array<::Google::Cloud::WebSecurityScanner::V1beta::ScanRunWarningTrace>
Returns

#warning_traces=

def warning_traces=(value) -> ::Array<::Google::Cloud::WebSecurityScanner::V1beta::ScanRunWarningTrace>
Parameter
Returns