google_api_web_security_scanner v0.6.0 GoogleApi.WebSecurityScanner.V1alpha.Model.ScanConfig 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 blacklist URL patterns as described in https://cloud.google.com/security-scanner/docs/excluded-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 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.

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Link to this type

t()

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

Link to this section Functions

Link to this function

decode(value, options)

View Source
decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.