Web Security Scanner V1 API - Class Google::Cloud::WebSecurityScanner::V1::ScanConfig (v0.7.1)

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

A ScanConfig resource contains the configurations to launch a scan.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#authentication

def authentication() -> ::Google::Cloud::WebSecurityScanner::V1::ScanConfig::Authentication
Returns

#authentication=

def authentication=(value) -> ::Google::Cloud::WebSecurityScanner::V1::ScanConfig::Authentication
Parameter
Returns

#blacklist_patterns

def blacklist_patterns() -> ::Array<::String>
Returns
  • (::Array<::String>) — The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls

#blacklist_patterns=

def blacklist_patterns=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
Returns
  • (::Array<::String>) — The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls

#display_name

def display_name() -> ::String
Returns
  • (::String) — Required. The user provided display name of the ScanConfig.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — Required. The user provided display name of the ScanConfig.
Returns
  • (::String) — Required. The user provided display name of the ScanConfig.

#export_to_security_command_center

def export_to_security_command_center() -> ::Google::Cloud::WebSecurityScanner::V1::ScanConfig::ExportToSecurityCommandCenter
Returns

#export_to_security_command_center=

def export_to_security_command_center=(value) -> ::Google::Cloud::WebSecurityScanner::V1::ScanConfig::ExportToSecurityCommandCenter
Parameter
Returns

#ignore_http_status_errors

def ignore_http_status_errors() -> ::Boolean
Returns
  • (::Boolean) — Whether to keep scanning even if most requests return HTTP error codes.

#ignore_http_status_errors=

def ignore_http_status_errors=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Whether to keep scanning even if most requests return HTTP error codes.
Returns
  • (::Boolean) — Whether to keep scanning even if most requests return HTTP error codes.

#managed_scan

def managed_scan() -> ::Boolean
Returns
  • (::Boolean) — Whether the scan config is managed by Web Security Scanner, output only.

#managed_scan=

def managed_scan=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Whether the scan config is managed by Web Security Scanner, output only.
Returns
  • (::Boolean) — Whether the scan config is managed by Web Security Scanner, output only.

#max_qps

def max_qps() -> ::Integer
Returns
  • (::Integer) — The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error.

#max_qps=

def max_qps=(value) -> ::Integer
Parameter
  • value (::Integer) — The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error.
Returns
  • (::Integer) — The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error.

#name

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

#name=

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

#risk_level

def risk_level() -> ::Google::Cloud::WebSecurityScanner::V1::ScanConfig::RiskLevel
Returns

#risk_level=

def risk_level=(value) -> ::Google::Cloud::WebSecurityScanner::V1::ScanConfig::RiskLevel
Parameter
Returns

#schedule

def schedule() -> ::Google::Cloud::WebSecurityScanner::V1::ScanConfig::Schedule
Returns

#schedule=

def schedule=(value) -> ::Google::Cloud::WebSecurityScanner::V1::ScanConfig::Schedule
Parameter
Returns

#starting_urls

def starting_urls() -> ::Array<::String>
Returns
  • (::Array<::String>) — Required. The starting URLs from which the scanner finds site pages.

#starting_urls=

def starting_urls=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — Required. The starting URLs from which the scanner finds site pages.
Returns
  • (::Array<::String>) — Required. The starting URLs from which the scanner finds site pages.

#static_ip_scan

def static_ip_scan() -> ::Boolean
Returns
  • (::Boolean) — Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses.

#static_ip_scan=

def static_ip_scan=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses.
Returns
  • (::Boolean) — Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses.

#user_agent

def user_agent() -> ::Google::Cloud::WebSecurityScanner::V1::ScanConfig::UserAgent
Returns

#user_agent=

def user_agent=(value) -> ::Google::Cloud::WebSecurityScanner::V1::ScanConfig::UserAgent
Parameter
Returns