GoogleApi.WebSecurityScanner.V1alpha.Model.ScanConfig (google_api_web_security_scanner v0.19.0)

View Source

A ScanConfig resource contains the configurations to launch a scan. next id: 12

Attributes

  • authentication (type: GoogleApi.WebSecurityScanner.V1alpha.Model.Authentication.t, default: nil) - The authentication configuration. If specified, service will use the authentication configuration during scanning.
  • blacklistPatterns (type: list(String.t), default: nil) - The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
  • displayName (type: String.t, default: nil) - Required. The user provided display name of the ScanConfig.
  • latestRun (type: GoogleApi.WebSecurityScanner.V1alpha.Model.ScanRun.t, default: nil) - Latest ScanRun if available.
  • maxQps (type: integer(), default: nil) - 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 (type: String.t, default: nil) - The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.
  • schedule (type: GoogleApi.WebSecurityScanner.V1alpha.Model.Schedule.t, default: nil) - The schedule of the ScanConfig.
  • startingUrls (type: list(String.t), default: nil) - Required. The starting URLs from which the scanner finds site pages.
  • targetPlatforms (type: list(String.t), default: nil) - Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.
  • userAgent (type: String.t, default: nil) - The user agent used during scanning.

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.WebSecurityScanner.V1alpha.Model.ScanConfig{
  authentication:
    GoogleApi.WebSecurityScanner.V1alpha.Model.Authentication.t() | nil,
  blacklistPatterns: [String.t()] | nil,
  displayName: String.t() | nil,
  latestRun: GoogleApi.WebSecurityScanner.V1alpha.Model.ScanRun.t() | nil,
  maxQps: integer() | nil,
  name: String.t() | nil,
  schedule: GoogleApi.WebSecurityScanner.V1alpha.Model.Schedule.t() | nil,
  startingUrls: [String.t()] | nil,
  targetPlatforms: [String.t()] | nil,
  userAgent: String.t() | nil
}

Functions

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.