Struct ScanConfig 

#[non_exhaustive]
pub struct ScanConfig {

    pub name: String,
    pub display_name: String,
    pub max_qps: i32,
    pub starting_urls: Vec<String>,
    pub authentication: Option<Authentication>,
    pub user_agent: UserAgent,
    pub blacklist_patterns: Vec<String>,
    pub schedule: Option<Schedule>,
    pub export_to_security_command_center: ExportToSecurityCommandCenter,
    pub risk_level: RiskLevel,
    pub managed_scan: bool,
    pub static_ip_scan: bool,
    pub ignore_http_status_errors: bool,
    /* private fields */
}

A ScanConfig resource contains the configurations to launch a scan.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: 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.

display_name: String

Required. The user provided display name of the ScanConfig.

max_qps: i32

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.

starting_urls: Vec<String>

Required. The starting URLs from which the scanner finds site pages.

authentication: Option<Authentication>

The authentication configuration. If specified, service will use the authentication configuration during scanning.

user_agent: UserAgent

The user agent used during scanning.

blacklist_patterns: Vec<String>

The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls

schedule: Option<Schedule>

The schedule of the ScanConfig.

export_to_security_command_center: ExportToSecurityCommandCenter

Controls export of scan configurations and results to Security Command Center.

risk_level: RiskLevel

The risk level selected for the scan

managed_scan: bool

Whether the scan config is managed by Web Security Scanner, output only.

static_ip_scan: bool

Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses.

ignore_http_status_errors: bool

Whether to keep scanning even if most requests return HTTP error codes.

Implementations

impl ScanConfig

pub fn new() -> Self

pub fn set_name<T: Into<String>>(self, v: T) -> Self

Sets the value of name.

Example

let x = ScanConfig::new().set_name("example");

pub fn set_display_name<T: Into<String>>(self, v: T) -> Self

Sets the value of display_name.

Example

let x = ScanConfig::new().set_display_name("example");

pub fn set_max_qps<T: Into<i32>>(self, v: T) -> Self

Sets the value of max_qps.

Example

let x = ScanConfig::new().set_max_qps(42);

pub fn set_starting_urls<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of starting_urls.

Example

let x = ScanConfig::new().set_starting_urls(["a", "b", "c"]);

pub fn set_authentication<T>(self, v: T) -> Self

where T: Into<Authentication>,

Sets the value of authentication.

Example

use google_cloud_websecurityscanner_v1::model::scan_config::Authentication;
let x = ScanConfig::new().set_authentication(Authentication::default()/* use setters */);

pub fn set_or_clear_authentication<T>(self, v: Option<T>) -> Self

where T: Into<Authentication>,

Sets or clears the value of authentication.

Example

use google_cloud_websecurityscanner_v1::model::scan_config::Authentication;
let x = ScanConfig::new().set_or_clear_authentication(Some(Authentication::default()/* use setters */));
let x = ScanConfig::new().set_or_clear_authentication(None::<Authentication>);

pub fn set_user_agent<T: Into<UserAgent>>(self, v: T) -> Self

Sets the value of user_agent.

Example

use google_cloud_websecurityscanner_v1::model::scan_config::UserAgent;
let x0 = ScanConfig::new().set_user_agent(UserAgent::ChromeLinux);
let x1 = ScanConfig::new().set_user_agent(UserAgent::ChromeAndroid);
let x2 = ScanConfig::new().set_user_agent(UserAgent::SafariIphone);

pub fn set_blacklist_patterns<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of blacklist_patterns.

Example

let x = ScanConfig::new().set_blacklist_patterns(["a", "b", "c"]);

pub fn set_schedule<T>(self, v: T) -> Self

where T: Into<Schedule>,

Sets the value of schedule.

Example

use google_cloud_websecurityscanner_v1::model::scan_config::Schedule;
let x = ScanConfig::new().set_schedule(Schedule::default()/* use setters */);

pub fn set_or_clear_schedule<T>(self, v: Option<T>) -> Self

where T: Into<Schedule>,

Sets or clears the value of schedule.

Example

use google_cloud_websecurityscanner_v1::model::scan_config::Schedule;
let x = ScanConfig::new().set_or_clear_schedule(Some(Schedule::default()/* use setters */));
let x = ScanConfig::new().set_or_clear_schedule(None::<Schedule>);

pub fn set_export_to_security_command_center<T: Into<ExportToSecurityCommandCenter>>( self, v: T, ) -> Self

Sets the value of export_to_security_command_center.

Example

use google_cloud_websecurityscanner_v1::model::scan_config::ExportToSecurityCommandCenter;
let x0 = ScanConfig::new().set_export_to_security_command_center(ExportToSecurityCommandCenter::Enabled);
let x1 = ScanConfig::new().set_export_to_security_command_center(ExportToSecurityCommandCenter::Disabled);

pub fn set_risk_level<T: Into<RiskLevel>>(self, v: T) -> Self

Sets the value of risk_level.

Example

use google_cloud_websecurityscanner_v1::model::scan_config::RiskLevel;
let x0 = ScanConfig::new().set_risk_level(RiskLevel::Normal);
let x1 = ScanConfig::new().set_risk_level(RiskLevel::Low);

pub fn set_managed_scan<T: Into<bool>>(self, v: T) -> Self

Sets the value of managed_scan.

Example

let x = ScanConfig::new().set_managed_scan(true);

pub fn set_static_ip_scan<T: Into<bool>>(self, v: T) -> Self

Sets the value of static_ip_scan.

Example

let x = ScanConfig::new().set_static_ip_scan(true);

pub fn set_ignore_http_status_errors<T: Into<bool>>(self, v: T) -> Self

Sets the value of ignore_http_status_errors.

Example

let x = ScanConfig::new().set_ignore_http_status_errors(true);

Trait Implementations

impl Clone for ScanConfig

fn clone(&self) -> ScanConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ScanConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ScanConfig

fn default() -> ScanConfig

Returns the “default value” for a type.

impl Message for ScanConfig

fn typename() -> &'static str

The typename of this message.

impl PartialEq for ScanConfig

fn eq(&self, other: &ScanConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ScanConfig