Struct ScanConfig

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: i32,
    pub blacklist_patterns: Vec<String>,
    pub schedule: Option<Schedule>,
    pub export_to_security_command_center: i32,
    pub risk_level: i32,
    pub managed_scan: bool,
    pub static_ip_scan: bool,
}

A ScanConfig resource contains the configurations to launch a scan.

Fields

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: i32

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: i32

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

risk_level: i32

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.

Implementations

impl ScanConfig

pub fn user_agent(&self) -> UserAgent

Returns the enum value of user_agent, or the default if the field is set to an invalid enum value.

pub fn set_user_agent(&mut self, value: UserAgent)

Sets user_agent to the provided enum value.

pub fn export_to_security_command_center(&self) -> ExportToSecurityCommandCenter

Returns the enum value of export_to_security_command_center, or the default if the field is set to an invalid enum value.

pub fn set_export_to_security_command_center( &mut self, value: ExportToSecurityCommandCenter, )

Sets export_to_security_command_center to the provided enum value.

pub fn risk_level(&self) -> RiskLevel

Returns the enum value of risk_level, or the default if the field is set to an invalid enum value.

pub fn set_risk_level(&mut self, value: RiskLevel)

Sets risk_level to the provided enum value.

Trait Implementations

impl Clone for ScanConfig

fn clone(&self) -> ScanConfig

Returns a copy 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 encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message to a buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

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