chore: regens API reference docs (#889)
diff --git a/docs/dyn/websecurityscanner_v1alpha.projects.scanConfigs.html b/docs/dyn/websecurityscanner_v1alpha.projects.scanConfigs.html
index e021531..023997d 100644
--- a/docs/dyn/websecurityscanner_v1alpha.projects.scanConfigs.html
+++ b/docs/dyn/websecurityscanner_v1alpha.projects.scanConfigs.html
@@ -80,7 +80,7 @@
<p class="firstline">Returns the scanRuns Resource.</p>
<p class="toc_element">
- <code><a href="#create">create(parent, body, x__xgafv=None)</a></code></p>
+ <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new ScanConfig.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
@@ -95,31 +95,29 @@
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
- <code><a href="#patch">patch(name, body, updateMask=None, x__xgafv=None)</a></code></p>
+ <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates a ScanConfig. This method support partial update of a ScanConfig.</p>
<p class="toc_element">
<code><a href="#start">start(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Start a ScanRun according to the given ScanConfig.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="create">create(parent, body, x__xgafv=None)</code>
+ <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
<pre>Creates a new ScanConfig.
Args:
- parent: string, Required.
-The parent resource name where the scan is created, which should be a
+ parent: string, Required. The parent resource name where the scan is created, which should be a
project resource name in the format 'projects/{projectId}'. (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # A ScanConfig resource contains the configurations to launch a scan.
# next id: 12
- "targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
- # used as a default.
- "A String",
- ],
- "displayName": "A String", # Required.
- # The user provided display name of the ScanConfig.
+ "maxQps": 42, # 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.
+ "displayName": "A String", # Required. The user provided display name of the ScanConfig.
"name": "A 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.
@@ -128,13 +126,12 @@
# refreshed by the server after each run. If unspecified, it will default
# to current server time, which means the scan will be scheduled to start
# immediately.
- "intervalDurationDays": 42, # Required.
- # The duration of time between executions in days.
+ "intervalDurationDays": 42, # Required. The duration of time between executions in days.
},
- "maxQps": 42, # 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.
+ "targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
+ # used as a default.
+ "A String",
+ ],
"blacklistPatterns": [ # The blacklist URL patterns as described in
# https://cloud.google.com/security-scanner/docs/excluded-urls
"A String",
@@ -142,59 +139,42 @@
"authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the
# authentication configuration during scanning.
"googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
- "username": "A String", # Required.
- # The user name of the Google account.
- "password": "A String", # Input only.
- # Required.
- # The password of the Google account. The credential is stored encrypted
+ "username": "A String", # Required. The user name of the Google account.
+ "password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted
# and not returned in any response nor included in audit logs.
},
"customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
- "username": "A String", # Required.
- # The user name of the custom account.
- "loginUrl": "A String", # Required.
- # The login form URL of the website.
- "password": "A String", # Input only.
- # Required.
- # The password of the custom account. The credential is stored encrypted
+ "username": "A String", # Required. The user name of the custom account.
+ "loginUrl": "A String", # Required. The login form URL of the website.
+ "password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted
# and not returned in any response nor included in audit logs.
},
},
"userAgent": "A String", # The user agent used during scanning.
- "startingUrls": [ # Required.
- # The starting URLs from which the scanner finds site pages.
+ "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
"A String",
],
"latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
- "name": "A String", # Output only.
- # The resource name of the ScanRun. The name follows the format of
+ "name": "A String", # The resource name of the ScanRun. The name follows the format of
# 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
# The ScanRun IDs are generated by the system.
- "executionState": "A String", # Output only.
- # The execution state of the ScanRun.
- "urlsTestedCount": "A String", # Output only.
- # The number of URLs tested during this ScanRun. If the scan is in progress,
+ "executionState": "A String", # The execution state of the ScanRun.
+ "urlsTestedCount": "A String", # The number of URLs tested during this ScanRun. If the scan is in progress,
# the value represents the number of URLs tested up to now. The number of
# URLs tested is usually larger than the number URLS crawled because
# typically a crawled URL is tested with multiple test payloads.
- "progressPercent": 42, # Output only.
- # The percentage of total completion ranging from 0 to 100.
+ "progressPercent": 42, # The percentage of total completion ranging from 0 to 100.
# If the scan is in queue, the value is 0.
# If the scan is running, the value ranges from 0 to 100.
# If the scan is finished, the value is 100.
- "resultState": "A String", # Output only.
- # The result state of the ScanRun. This field is only available after the
- # execution state reaches "FINISHED".
- "startTime": "A String", # Output only.
- # The time at which the ScanRun started.
- "endTime": "A String", # Output only.
- # The time at which the ScanRun reached termination state - that the ScanRun
- # is either finished or stopped by user.
- "hasVulnerabilities": True or False, # Output only.
- # Whether the scan run has found any vulnerabilities.
- "urlsCrawledCount": "A String", # Output only.
- # The number of URLs crawled during this ScanRun. If the scan is in progress,
+ "urlsCrawledCount": "A String", # The number of URLs crawled during this ScanRun. If the scan is in progress,
# the value represents the number of URLs crawled up to now.
+ "startTime": "A String", # The time at which the ScanRun started.
+ "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
+ # is either finished or stopped by user.
+ "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
+ "resultState": "A String", # The result state of the ScanRun. This field is only available after the
+ # execution state reaches "FINISHED".
},
}
@@ -208,12 +188,11 @@
{ # A ScanConfig resource contains the configurations to launch a scan.
# next id: 12
- "targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
- # used as a default.
- "A String",
- ],
- "displayName": "A String", # Required.
- # The user provided display name of the ScanConfig.
+ "maxQps": 42, # 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.
+ "displayName": "A String", # Required. The user provided display name of the ScanConfig.
"name": "A 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.
@@ -222,13 +201,12 @@
# refreshed by the server after each run. If unspecified, it will default
# to current server time, which means the scan will be scheduled to start
# immediately.
- "intervalDurationDays": 42, # Required.
- # The duration of time between executions in days.
+ "intervalDurationDays": 42, # Required. The duration of time between executions in days.
},
- "maxQps": 42, # 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.
+ "targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
+ # used as a default.
+ "A String",
+ ],
"blacklistPatterns": [ # The blacklist URL patterns as described in
# https://cloud.google.com/security-scanner/docs/excluded-urls
"A String",
@@ -236,59 +214,42 @@
"authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the
# authentication configuration during scanning.
"googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
- "username": "A String", # Required.
- # The user name of the Google account.
- "password": "A String", # Input only.
- # Required.
- # The password of the Google account. The credential is stored encrypted
+ "username": "A String", # Required. The user name of the Google account.
+ "password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted
# and not returned in any response nor included in audit logs.
},
"customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
- "username": "A String", # Required.
- # The user name of the custom account.
- "loginUrl": "A String", # Required.
- # The login form URL of the website.
- "password": "A String", # Input only.
- # Required.
- # The password of the custom account. The credential is stored encrypted
+ "username": "A String", # Required. The user name of the custom account.
+ "loginUrl": "A String", # Required. The login form URL of the website.
+ "password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted
# and not returned in any response nor included in audit logs.
},
},
"userAgent": "A String", # The user agent used during scanning.
- "startingUrls": [ # Required.
- # The starting URLs from which the scanner finds site pages.
+ "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
"A String",
],
"latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
- "name": "A String", # Output only.
- # The resource name of the ScanRun. The name follows the format of
+ "name": "A String", # The resource name of the ScanRun. The name follows the format of
# 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
# The ScanRun IDs are generated by the system.
- "executionState": "A String", # Output only.
- # The execution state of the ScanRun.
- "urlsTestedCount": "A String", # Output only.
- # The number of URLs tested during this ScanRun. If the scan is in progress,
+ "executionState": "A String", # The execution state of the ScanRun.
+ "urlsTestedCount": "A String", # The number of URLs tested during this ScanRun. If the scan is in progress,
# the value represents the number of URLs tested up to now. The number of
# URLs tested is usually larger than the number URLS crawled because
# typically a crawled URL is tested with multiple test payloads.
- "progressPercent": 42, # Output only.
- # The percentage of total completion ranging from 0 to 100.
+ "progressPercent": 42, # The percentage of total completion ranging from 0 to 100.
# If the scan is in queue, the value is 0.
# If the scan is running, the value ranges from 0 to 100.
# If the scan is finished, the value is 100.
- "resultState": "A String", # Output only.
- # The result state of the ScanRun. This field is only available after the
- # execution state reaches "FINISHED".
- "startTime": "A String", # Output only.
- # The time at which the ScanRun started.
- "endTime": "A String", # Output only.
- # The time at which the ScanRun reached termination state - that the ScanRun
- # is either finished or stopped by user.
- "hasVulnerabilities": True or False, # Output only.
- # Whether the scan run has found any vulnerabilities.
- "urlsCrawledCount": "A String", # Output only.
- # The number of URLs crawled during this ScanRun. If the scan is in progress,
+ "urlsCrawledCount": "A String", # The number of URLs crawled during this ScanRun. If the scan is in progress,
# the value represents the number of URLs crawled up to now.
+ "startTime": "A String", # The time at which the ScanRun started.
+ "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
+ # is either finished or stopped by user.
+ "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
+ "resultState": "A String", # The result state of the ScanRun. This field is only available after the
+ # execution state reaches "FINISHED".
},
}</pre>
</div>
@@ -298,8 +259,7 @@
<pre>Deletes an existing ScanConfig and its child resources.
Args:
- name: string, Required.
-The resource name of the ScanConfig to be deleted. The name follows the
+ name: string, Required. The resource name of the ScanConfig to be deleted. The name follows the
format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. (required)
x__xgafv: string, V1 error format.
Allowed values
@@ -326,8 +286,7 @@
<pre>Gets a ScanConfig.
Args:
- name: string, Required.
-The resource name of the ScanConfig to be returned. The name follows the
+ name: string, Required. The resource name of the ScanConfig to be returned. The name follows the
format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. (required)
x__xgafv: string, V1 error format.
Allowed values
@@ -339,12 +298,11 @@
{ # A ScanConfig resource contains the configurations to launch a scan.
# next id: 12
- "targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
- # used as a default.
- "A String",
- ],
- "displayName": "A String", # Required.
- # The user provided display name of the ScanConfig.
+ "maxQps": 42, # 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.
+ "displayName": "A String", # Required. The user provided display name of the ScanConfig.
"name": "A 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.
@@ -353,13 +311,12 @@
# refreshed by the server after each run. If unspecified, it will default
# to current server time, which means the scan will be scheduled to start
# immediately.
- "intervalDurationDays": 42, # Required.
- # The duration of time between executions in days.
+ "intervalDurationDays": 42, # Required. The duration of time between executions in days.
},
- "maxQps": 42, # 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.
+ "targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
+ # used as a default.
+ "A String",
+ ],
"blacklistPatterns": [ # The blacklist URL patterns as described in
# https://cloud.google.com/security-scanner/docs/excluded-urls
"A String",
@@ -367,59 +324,42 @@
"authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the
# authentication configuration during scanning.
"googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
- "username": "A String", # Required.
- # The user name of the Google account.
- "password": "A String", # Input only.
- # Required.
- # The password of the Google account. The credential is stored encrypted
+ "username": "A String", # Required. The user name of the Google account.
+ "password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted
# and not returned in any response nor included in audit logs.
},
"customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
- "username": "A String", # Required.
- # The user name of the custom account.
- "loginUrl": "A String", # Required.
- # The login form URL of the website.
- "password": "A String", # Input only.
- # Required.
- # The password of the custom account. The credential is stored encrypted
+ "username": "A String", # Required. The user name of the custom account.
+ "loginUrl": "A String", # Required. The login form URL of the website.
+ "password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted
# and not returned in any response nor included in audit logs.
},
},
"userAgent": "A String", # The user agent used during scanning.
- "startingUrls": [ # Required.
- # The starting URLs from which the scanner finds site pages.
+ "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
"A String",
],
"latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
- "name": "A String", # Output only.
- # The resource name of the ScanRun. The name follows the format of
+ "name": "A String", # The resource name of the ScanRun. The name follows the format of
# 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
# The ScanRun IDs are generated by the system.
- "executionState": "A String", # Output only.
- # The execution state of the ScanRun.
- "urlsTestedCount": "A String", # Output only.
- # The number of URLs tested during this ScanRun. If the scan is in progress,
+ "executionState": "A String", # The execution state of the ScanRun.
+ "urlsTestedCount": "A String", # The number of URLs tested during this ScanRun. If the scan is in progress,
# the value represents the number of URLs tested up to now. The number of
# URLs tested is usually larger than the number URLS crawled because
# typically a crawled URL is tested with multiple test payloads.
- "progressPercent": 42, # Output only.
- # The percentage of total completion ranging from 0 to 100.
+ "progressPercent": 42, # The percentage of total completion ranging from 0 to 100.
# If the scan is in queue, the value is 0.
# If the scan is running, the value ranges from 0 to 100.
# If the scan is finished, the value is 100.
- "resultState": "A String", # Output only.
- # The result state of the ScanRun. This field is only available after the
- # execution state reaches "FINISHED".
- "startTime": "A String", # Output only.
- # The time at which the ScanRun started.
- "endTime": "A String", # Output only.
- # The time at which the ScanRun reached termination state - that the ScanRun
- # is either finished or stopped by user.
- "hasVulnerabilities": True or False, # Output only.
- # Whether the scan run has found any vulnerabilities.
- "urlsCrawledCount": "A String", # Output only.
- # The number of URLs crawled during this ScanRun. If the scan is in progress,
+ "urlsCrawledCount": "A String", # The number of URLs crawled during this ScanRun. If the scan is in progress,
# the value represents the number of URLs crawled up to now.
+ "startTime": "A String", # The time at which the ScanRun started.
+ "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
+ # is either finished or stopped by user.
+ "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
+ "resultState": "A String", # The result state of the ScanRun. This field is only available after the
+ # execution state reaches "FINISHED".
},
}</pre>
</div>
@@ -429,8 +369,7 @@
<pre>Lists ScanConfigs under a given project.
Args:
- parent: string, Required.
-The parent resource name, which should be a project resource name in the
+ parent: string, Required. The parent resource name, which should be a project resource name in the
format 'projects/{projectId}'. (required)
pageToken: string, A token identifying a page of results to be returned. This should be a
`next_page_token` value returned from a previous List request.
@@ -452,12 +391,11 @@
"scanConfigs": [ # The list of ScanConfigs returned.
{ # A ScanConfig resource contains the configurations to launch a scan.
# next id: 12
- "targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
- # used as a default.
- "A String",
- ],
- "displayName": "A String", # Required.
- # The user provided display name of the ScanConfig.
+ "maxQps": 42, # 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.
+ "displayName": "A String", # Required. The user provided display name of the ScanConfig.
"name": "A 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.
@@ -466,13 +404,12 @@
# refreshed by the server after each run. If unspecified, it will default
# to current server time, which means the scan will be scheduled to start
# immediately.
- "intervalDurationDays": 42, # Required.
- # The duration of time between executions in days.
+ "intervalDurationDays": 42, # Required. The duration of time between executions in days.
},
- "maxQps": 42, # 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.
+ "targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
+ # used as a default.
+ "A String",
+ ],
"blacklistPatterns": [ # The blacklist URL patterns as described in
# https://cloud.google.com/security-scanner/docs/excluded-urls
"A String",
@@ -480,59 +417,42 @@
"authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the
# authentication configuration during scanning.
"googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
- "username": "A String", # Required.
- # The user name of the Google account.
- "password": "A String", # Input only.
- # Required.
- # The password of the Google account. The credential is stored encrypted
+ "username": "A String", # Required. The user name of the Google account.
+ "password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted
# and not returned in any response nor included in audit logs.
},
"customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
- "username": "A String", # Required.
- # The user name of the custom account.
- "loginUrl": "A String", # Required.
- # The login form URL of the website.
- "password": "A String", # Input only.
- # Required.
- # The password of the custom account. The credential is stored encrypted
+ "username": "A String", # Required. The user name of the custom account.
+ "loginUrl": "A String", # Required. The login form URL of the website.
+ "password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted
# and not returned in any response nor included in audit logs.
},
},
"userAgent": "A String", # The user agent used during scanning.
- "startingUrls": [ # Required.
- # The starting URLs from which the scanner finds site pages.
+ "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
"A String",
],
"latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
- "name": "A String", # Output only.
- # The resource name of the ScanRun. The name follows the format of
+ "name": "A String", # The resource name of the ScanRun. The name follows the format of
# 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
# The ScanRun IDs are generated by the system.
- "executionState": "A String", # Output only.
- # The execution state of the ScanRun.
- "urlsTestedCount": "A String", # Output only.
- # The number of URLs tested during this ScanRun. If the scan is in progress,
+ "executionState": "A String", # The execution state of the ScanRun.
+ "urlsTestedCount": "A String", # The number of URLs tested during this ScanRun. If the scan is in progress,
# the value represents the number of URLs tested up to now. The number of
# URLs tested is usually larger than the number URLS crawled because
# typically a crawled URL is tested with multiple test payloads.
- "progressPercent": 42, # Output only.
- # The percentage of total completion ranging from 0 to 100.
+ "progressPercent": 42, # The percentage of total completion ranging from 0 to 100.
# If the scan is in queue, the value is 0.
# If the scan is running, the value ranges from 0 to 100.
# If the scan is finished, the value is 100.
- "resultState": "A String", # Output only.
- # The result state of the ScanRun. This field is only available after the
- # execution state reaches "FINISHED".
- "startTime": "A String", # Output only.
- # The time at which the ScanRun started.
- "endTime": "A String", # Output only.
- # The time at which the ScanRun reached termination state - that the ScanRun
- # is either finished or stopped by user.
- "hasVulnerabilities": True or False, # Output only.
- # Whether the scan run has found any vulnerabilities.
- "urlsCrawledCount": "A String", # Output only.
- # The number of URLs crawled during this ScanRun. If the scan is in progress,
+ "urlsCrawledCount": "A String", # The number of URLs crawled during this ScanRun. If the scan is in progress,
# the value represents the number of URLs crawled up to now.
+ "startTime": "A String", # The time at which the ScanRun started.
+ "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
+ # is either finished or stopped by user.
+ "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
+ "resultState": "A String", # The result state of the ScanRun. This field is only available after the
+ # execution state reaches "FINISHED".
},
},
],
@@ -554,24 +474,23 @@
</div>
<div class="method">
- <code class="details" id="patch">patch(name, body, updateMask=None, x__xgafv=None)</code>
+ <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates a ScanConfig. This method support partial update of a ScanConfig.
Args:
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. (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # A ScanConfig resource contains the configurations to launch a scan.
# next id: 12
- "targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
- # used as a default.
- "A String",
- ],
- "displayName": "A String", # Required.
- # The user provided display name of the ScanConfig.
+ "maxQps": 42, # 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.
+ "displayName": "A String", # Required. The user provided display name of the ScanConfig.
"name": "A 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.
@@ -580,13 +499,12 @@
# refreshed by the server after each run. If unspecified, it will default
# to current server time, which means the scan will be scheduled to start
# immediately.
- "intervalDurationDays": 42, # Required.
- # The duration of time between executions in days.
+ "intervalDurationDays": 42, # Required. The duration of time between executions in days.
},
- "maxQps": 42, # 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.
+ "targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
+ # used as a default.
+ "A String",
+ ],
"blacklistPatterns": [ # The blacklist URL patterns as described in
# https://cloud.google.com/security-scanner/docs/excluded-urls
"A String",
@@ -594,64 +512,46 @@
"authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the
# authentication configuration during scanning.
"googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
- "username": "A String", # Required.
- # The user name of the Google account.
- "password": "A String", # Input only.
- # Required.
- # The password of the Google account. The credential is stored encrypted
+ "username": "A String", # Required. The user name of the Google account.
+ "password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted
# and not returned in any response nor included in audit logs.
},
"customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
- "username": "A String", # Required.
- # The user name of the custom account.
- "loginUrl": "A String", # Required.
- # The login form URL of the website.
- "password": "A String", # Input only.
- # Required.
- # The password of the custom account. The credential is stored encrypted
+ "username": "A String", # Required. The user name of the custom account.
+ "loginUrl": "A String", # Required. The login form URL of the website.
+ "password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted
# and not returned in any response nor included in audit logs.
},
},
"userAgent": "A String", # The user agent used during scanning.
- "startingUrls": [ # Required.
- # The starting URLs from which the scanner finds site pages.
+ "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
"A String",
],
"latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
- "name": "A String", # Output only.
- # The resource name of the ScanRun. The name follows the format of
+ "name": "A String", # The resource name of the ScanRun. The name follows the format of
# 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
# The ScanRun IDs are generated by the system.
- "executionState": "A String", # Output only.
- # The execution state of the ScanRun.
- "urlsTestedCount": "A String", # Output only.
- # The number of URLs tested during this ScanRun. If the scan is in progress,
+ "executionState": "A String", # The execution state of the ScanRun.
+ "urlsTestedCount": "A String", # The number of URLs tested during this ScanRun. If the scan is in progress,
# the value represents the number of URLs tested up to now. The number of
# URLs tested is usually larger than the number URLS crawled because
# typically a crawled URL is tested with multiple test payloads.
- "progressPercent": 42, # Output only.
- # The percentage of total completion ranging from 0 to 100.
+ "progressPercent": 42, # The percentage of total completion ranging from 0 to 100.
# If the scan is in queue, the value is 0.
# If the scan is running, the value ranges from 0 to 100.
# If the scan is finished, the value is 100.
- "resultState": "A String", # Output only.
- # The result state of the ScanRun. This field is only available after the
- # execution state reaches "FINISHED".
- "startTime": "A String", # Output only.
- # The time at which the ScanRun started.
- "endTime": "A String", # Output only.
- # The time at which the ScanRun reached termination state - that the ScanRun
- # is either finished or stopped by user.
- "hasVulnerabilities": True or False, # Output only.
- # Whether the scan run has found any vulnerabilities.
- "urlsCrawledCount": "A String", # Output only.
- # The number of URLs crawled during this ScanRun. If the scan is in progress,
+ "urlsCrawledCount": "A String", # The number of URLs crawled during this ScanRun. If the scan is in progress,
# the value represents the number of URLs crawled up to now.
+ "startTime": "A String", # The time at which the ScanRun started.
+ "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
+ # is either finished or stopped by user.
+ "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
+ "resultState": "A String", # The result state of the ScanRun. This field is only available after the
+ # execution state reaches "FINISHED".
},
}
- updateMask: string, Required.
-The update mask applies to the resource. For the `FieldMask` definition,
+ updateMask: string, Required. The update mask applies to the resource. For the `FieldMask` definition,
see
https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
x__xgafv: string, V1 error format.
@@ -664,12 +564,11 @@
{ # A ScanConfig resource contains the configurations to launch a scan.
# next id: 12
- "targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
- # used as a default.
- "A String",
- ],
- "displayName": "A String", # Required.
- # The user provided display name of the ScanConfig.
+ "maxQps": 42, # 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.
+ "displayName": "A String", # Required. The user provided display name of the ScanConfig.
"name": "A 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.
@@ -678,13 +577,12 @@
# refreshed by the server after each run. If unspecified, it will default
# to current server time, which means the scan will be scheduled to start
# immediately.
- "intervalDurationDays": 42, # Required.
- # The duration of time between executions in days.
+ "intervalDurationDays": 42, # Required. The duration of time between executions in days.
},
- "maxQps": 42, # 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.
+ "targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
+ # used as a default.
+ "A String",
+ ],
"blacklistPatterns": [ # The blacklist URL patterns as described in
# https://cloud.google.com/security-scanner/docs/excluded-urls
"A String",
@@ -692,59 +590,42 @@
"authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the
# authentication configuration during scanning.
"googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
- "username": "A String", # Required.
- # The user name of the Google account.
- "password": "A String", # Input only.
- # Required.
- # The password of the Google account. The credential is stored encrypted
+ "username": "A String", # Required. The user name of the Google account.
+ "password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted
# and not returned in any response nor included in audit logs.
},
"customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
- "username": "A String", # Required.
- # The user name of the custom account.
- "loginUrl": "A String", # Required.
- # The login form URL of the website.
- "password": "A String", # Input only.
- # Required.
- # The password of the custom account. The credential is stored encrypted
+ "username": "A String", # Required. The user name of the custom account.
+ "loginUrl": "A String", # Required. The login form URL of the website.
+ "password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted
# and not returned in any response nor included in audit logs.
},
},
"userAgent": "A String", # The user agent used during scanning.
- "startingUrls": [ # Required.
- # The starting URLs from which the scanner finds site pages.
+ "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
"A String",
],
"latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
- "name": "A String", # Output only.
- # The resource name of the ScanRun. The name follows the format of
+ "name": "A String", # The resource name of the ScanRun. The name follows the format of
# 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
# The ScanRun IDs are generated by the system.
- "executionState": "A String", # Output only.
- # The execution state of the ScanRun.
- "urlsTestedCount": "A String", # Output only.
- # The number of URLs tested during this ScanRun. If the scan is in progress,
+ "executionState": "A String", # The execution state of the ScanRun.
+ "urlsTestedCount": "A String", # The number of URLs tested during this ScanRun. If the scan is in progress,
# the value represents the number of URLs tested up to now. The number of
# URLs tested is usually larger than the number URLS crawled because
# typically a crawled URL is tested with multiple test payloads.
- "progressPercent": 42, # Output only.
- # The percentage of total completion ranging from 0 to 100.
+ "progressPercent": 42, # The percentage of total completion ranging from 0 to 100.
# If the scan is in queue, the value is 0.
# If the scan is running, the value ranges from 0 to 100.
# If the scan is finished, the value is 100.
- "resultState": "A String", # Output only.
- # The result state of the ScanRun. This field is only available after the
- # execution state reaches "FINISHED".
- "startTime": "A String", # Output only.
- # The time at which the ScanRun started.
- "endTime": "A String", # Output only.
- # The time at which the ScanRun reached termination state - that the ScanRun
- # is either finished or stopped by user.
- "hasVulnerabilities": True or False, # Output only.
- # Whether the scan run has found any vulnerabilities.
- "urlsCrawledCount": "A String", # Output only.
- # The number of URLs crawled during this ScanRun. If the scan is in progress,
+ "urlsCrawledCount": "A String", # The number of URLs crawled during this ScanRun. If the scan is in progress,
# the value represents the number of URLs crawled up to now.
+ "startTime": "A String", # The time at which the ScanRun started.
+ "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
+ # is either finished or stopped by user.
+ "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
+ "resultState": "A String", # The result state of the ScanRun. This field is only available after the
+ # execution state reaches "FINISHED".
},
}</pre>
</div>
@@ -754,8 +635,7 @@
<pre>Start a ScanRun according to the given ScanConfig.
Args:
- name: string, Required.
-The resource name of the ScanConfig to be used. The name follows the
+ name: string, Required. The resource name of the ScanConfig to be used. The name follows the
format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. (required)
body: object, The request body.
The object takes the form of:
@@ -772,35 +652,26 @@
An object of the form:
{ # A ScanRun is a output-only resource representing an actual run of the scan.
- "name": "A String", # Output only.
- # The resource name of the ScanRun. The name follows the format of
+ "name": "A String", # The resource name of the ScanRun. The name follows the format of
# 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
# The ScanRun IDs are generated by the system.
- "executionState": "A String", # Output only.
- # The execution state of the ScanRun.
- "urlsTestedCount": "A String", # Output only.
- # The number of URLs tested during this ScanRun. If the scan is in progress,
+ "executionState": "A String", # The execution state of the ScanRun.
+ "urlsTestedCount": "A String", # The number of URLs tested during this ScanRun. If the scan is in progress,
# the value represents the number of URLs tested up to now. The number of
# URLs tested is usually larger than the number URLS crawled because
# typically a crawled URL is tested with multiple test payloads.
- "progressPercent": 42, # Output only.
- # The percentage of total completion ranging from 0 to 100.
+ "progressPercent": 42, # The percentage of total completion ranging from 0 to 100.
# If the scan is in queue, the value is 0.
# If the scan is running, the value ranges from 0 to 100.
# If the scan is finished, the value is 100.
- "resultState": "A String", # Output only.
- # The result state of the ScanRun. This field is only available after the
- # execution state reaches "FINISHED".
- "startTime": "A String", # Output only.
- # The time at which the ScanRun started.
- "endTime": "A String", # Output only.
- # The time at which the ScanRun reached termination state - that the ScanRun
- # is either finished or stopped by user.
- "hasVulnerabilities": True or False, # Output only.
- # Whether the scan run has found any vulnerabilities.
- "urlsCrawledCount": "A String", # Output only.
- # The number of URLs crawled during this ScanRun. If the scan is in progress,
+ "urlsCrawledCount": "A String", # The number of URLs crawled during this ScanRun. If the scan is in progress,
# the value represents the number of URLs crawled up to now.
+ "startTime": "A String", # The time at which the ScanRun started.
+ "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
+ # is either finished or stopped by user.
+ "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
+ "resultState": "A String", # The result state of the ScanRun. This field is only available after the
+ # execution state reaches "FINISHED".
}</pre>
</div>