Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / a527de24cda7c7d62a371203158fd5f617a1c08c / . / docs / dyn / websecurityscanner_v1.projects.scanConfigs.scanRuns.html
blob: 533a81e2ce2e450073f6835cab5755050793856b [file] [log] [blame]
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="websecurityscanner_v1.html">Web Security Scanner API</a> . <a href="websecurityscanner_v1.projects.html">projects</a> . <a href="websecurityscanner_v1.projects.scanConfigs.html">scanConfigs</a> . <a href="websecurityscanner_v1.projects.scanConfigs.scanRuns.html">scanRuns</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="websecurityscanner_v1.projects.scanConfigs.scanRuns.crawledUrls.html">crawledUrls()</a></code>
79</p>
80<p class="firstline">Returns the crawledUrls Resource.</p>
81
82<p class="toc_element">
83 <code><a href="websecurityscanner_v1.projects.scanConfigs.scanRuns.findingTypeStats.html">findingTypeStats()</a></code>
84</p>
85<p class="firstline">Returns the findingTypeStats Resource.</p>
86
87<p class="toc_element">
88 <code><a href="websecurityscanner_v1.projects.scanConfigs.scanRuns.findings.html">findings()</a></code>
89</p>
90<p class="firstline">Returns the findings Resource.</p>
91
92<p class="toc_element">
93 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
94<p class="firstline">Gets a ScanRun.</p>
95<p class="toc_element">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]96 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]97<p class="firstline">Lists ScanRuns under a given ScanConfig, in descending order of ScanRun</p>
98<p class="toc_element">
99 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
100<p class="firstline">Retrieves the next page of results.</p>
101<p class="toc_element">
102 <code><a href="#stop">stop(name, body=None, x__xgafv=None)</a></code></p>
103<p class="firstline">Stops a ScanRun. The stopped ScanRun is returned.</p>
104<h3>Method Details</h3>
105<div class="method">
106 <code class="details" id="get">get(name, x__xgafv=None)</code>
107 <pre>Gets a ScanRun.
108
109Args:
110 name: string, Required. The resource name of the ScanRun to be returned. The name follows the
111format of
112&#x27;projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}&#x27;. (required)
113 x__xgafv: string, V1 error format.
114 Allowed values
115 1 - v1 error format
116 2 - v2 error format
117
118Returns:
119 An object of the form:
120
121 { # A ScanRun is a output-only resource representing an actual run of the scan.
122 # Next id: 12
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]123 &quot;errorTrace&quot;: { # Output only. # Output only. If result_state is an ERROR, this field provides the primary reason for
124 # scan&#x27;s termination and more details, if such are available.
125 # Defines an error trace message for a ScanRun.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]126 &quot;mostCommonHttpErrorCode&quot;: 42, # Output only. If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most
127 # common HTTP error code, if such is available. For example, if this code is
128 # 404, the scan has encountered too many NOT_FOUND responses.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]129 &quot;scanConfigError&quot;: { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig # Output only. If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error
130 # message encountered during scan configuration validation that is performed
131 # before each scan run.
132 # APIs when scan configuration validation fails. It is also reported as part of
133 # a ScanRunErrorTrace message if scan validation fails due to a scan
134 # configuration error.
135 &quot;fieldName&quot;: &quot;A String&quot;, # Output only. Indicates the full name of the ScanConfig field that triggers this error,
136 # for example &quot;scan_config.max_qps&quot;. This field is provided for
137 # troubleshooting purposes only and its actual value can change in the
138 # future.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]139 &quot;code&quot;: &quot;A String&quot;, # Output only. Indicates the reason code for a configuration failure.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]140 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]141 &quot;code&quot;: &quot;A String&quot;, # Output only. Indicates the error reason code.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]142 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]143 &quot;urlsCrawledCount&quot;: &quot;A String&quot;, # Output only. The number of URLs crawled during this ScanRun. If the scan is in progress,
144 # the value represents the number of URLs crawled up to now.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]145 &quot;warningTraces&quot;: [ # Output only. A list of warnings, if such are encountered during this scan run.
146 { # Output only.
147 # Defines a warning trace message for ScanRun. Warning traces provide customers
148 # with useful information that helps make the scanning process more effective.
149 &quot;code&quot;: &quot;A String&quot;, # Output only. Indicates the warning code.
150 },
151 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]152 &quot;resultState&quot;: &quot;A String&quot;, # Output only. The result state of the ScanRun. This field is only available after the
153 # execution state reaches &quot;FINISHED&quot;.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]154 &quot;executionState&quot;: &quot;A String&quot;, # Output only. The execution state of the ScanRun.
155 &quot;urlsTestedCount&quot;: &quot;A String&quot;, # Output only. The number of URLs tested during this ScanRun. If the scan is in progress,
156 # the value represents the number of URLs tested up to now. The number of
157 # URLs tested is usually larger than the number URLS crawled because
158 # typically a crawled URL is tested with multiple test payloads.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]159 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the ScanRun. The name follows the format of
160 # &#x27;projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}&#x27;.
161 # The ScanRun IDs are generated by the system.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]162 &quot;hasVulnerabilities&quot;: True or False, # Output only. Whether the scan run has found any vulnerabilities.
163 &quot;endTime&quot;: &quot;A String&quot;, # Output only. The time at which the ScanRun reached termination state - that the ScanRun
164 # is either finished or stopped by user.
165 &quot;progressPercent&quot;: 42, # Output only. The percentage of total completion ranging from 0 to 100.
166 # If the scan is in queue, the value is 0.
167 # If the scan is running, the value ranges from 0 to 100.
168 # If the scan is finished, the value is 100.
169 &quot;startTime&quot;: &quot;A String&quot;, # Output only. The time at which the ScanRun started.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]170 }</pre>
171</div>
172
173<div class="method">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]174 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]175 <pre>Lists ScanRuns under a given ScanConfig, in descending order of ScanRun
176stop time.
177
178Args:
179 parent: string, Required. The parent resource name, which should be a scan resource name in the
180format &#x27;projects/{projectId}/scanConfigs/{scanConfigId}&#x27;. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]181 pageSize: integer, The maximum number of ScanRuns to return, can be limited by server.
182If not specified or not positive, the implementation will select a
183reasonable value.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]184 pageToken: string, A token identifying a page of results to be returned. This should be a
185`next_page_token` value returned from a previous List request.
186If unspecified, the first page of results is returned.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]187 x__xgafv: string, V1 error format.
188 Allowed values
189 1 - v1 error format
190 2 - v2 error format
191
192Returns:
193 An object of the form:
194
195 { # Response for the `ListScanRuns` method.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]196 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results, or empty if there are no
197 # more results in the list.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]198 &quot;scanRuns&quot;: [ # The list of ScanRuns returned.
199 { # A ScanRun is a output-only resource representing an actual run of the scan.
200 # Next id: 12
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]201 &quot;errorTrace&quot;: { # Output only. # Output only. If result_state is an ERROR, this field provides the primary reason for
202 # scan&#x27;s termination and more details, if such are available.
203 # Defines an error trace message for a ScanRun.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]204 &quot;mostCommonHttpErrorCode&quot;: 42, # Output only. If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most
205 # common HTTP error code, if such is available. For example, if this code is
206 # 404, the scan has encountered too many NOT_FOUND responses.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]207 &quot;scanConfigError&quot;: { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig # Output only. If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error
208 # message encountered during scan configuration validation that is performed
209 # before each scan run.
210 # APIs when scan configuration validation fails. It is also reported as part of
211 # a ScanRunErrorTrace message if scan validation fails due to a scan
212 # configuration error.
213 &quot;fieldName&quot;: &quot;A String&quot;, # Output only. Indicates the full name of the ScanConfig field that triggers this error,
214 # for example &quot;scan_config.max_qps&quot;. This field is provided for
215 # troubleshooting purposes only and its actual value can change in the
216 # future.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]217 &quot;code&quot;: &quot;A String&quot;, # Output only. Indicates the reason code for a configuration failure.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]218 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]219 &quot;code&quot;: &quot;A String&quot;, # Output only. Indicates the error reason code.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]220 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]221 &quot;urlsCrawledCount&quot;: &quot;A String&quot;, # Output only. The number of URLs crawled during this ScanRun. If the scan is in progress,
222 # the value represents the number of URLs crawled up to now.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]223 &quot;warningTraces&quot;: [ # Output only. A list of warnings, if such are encountered during this scan run.
224 { # Output only.
225 # Defines a warning trace message for ScanRun. Warning traces provide customers
226 # with useful information that helps make the scanning process more effective.
227 &quot;code&quot;: &quot;A String&quot;, # Output only. Indicates the warning code.
228 },
229 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]230 &quot;resultState&quot;: &quot;A String&quot;, # Output only. The result state of the ScanRun. This field is only available after the
231 # execution state reaches &quot;FINISHED&quot;.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]232 &quot;executionState&quot;: &quot;A String&quot;, # Output only. The execution state of the ScanRun.
233 &quot;urlsTestedCount&quot;: &quot;A String&quot;, # Output only. The number of URLs tested during this ScanRun. If the scan is in progress,
234 # the value represents the number of URLs tested up to now. The number of
235 # URLs tested is usually larger than the number URLS crawled because
236 # typically a crawled URL is tested with multiple test payloads.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]237 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the ScanRun. The name follows the format of
238 # &#x27;projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}&#x27;.
239 # The ScanRun IDs are generated by the system.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]240 &quot;hasVulnerabilities&quot;: True or False, # Output only. Whether the scan run has found any vulnerabilities.
241 &quot;endTime&quot;: &quot;A String&quot;, # Output only. The time at which the ScanRun reached termination state - that the ScanRun
242 # is either finished or stopped by user.
243 &quot;progressPercent&quot;: 42, # Output only. The percentage of total completion ranging from 0 to 100.
244 # If the scan is in queue, the value is 0.
245 # If the scan is running, the value ranges from 0 to 100.
246 # If the scan is finished, the value is 100.
247 &quot;startTime&quot;: &quot;A String&quot;, # Output only. The time at which the ScanRun started.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]248 },
249 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]250 }</pre>
251</div>
252
253<div class="method">
254 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
255 <pre>Retrieves the next page of results.
256
257Args:
258 previous_request: The request for the previous page. (required)
259 previous_response: The response from the request for the previous page. (required)
260
261Returns:
262 A request object that you can call &#x27;execute()&#x27; on to request the next
263 page. Returns None if there are no more items in the collection.
264 </pre>
265</div>
266
267<div class="method">
268 <code class="details" id="stop">stop(name, body=None, x__xgafv=None)</code>
269 <pre>Stops a ScanRun. The stopped ScanRun is returned.
270
271Args:
272 name: string, Required. The resource name of the ScanRun to be stopped. The name follows the
273format of
274&#x27;projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}&#x27;. (required)
275 body: object, The request body.
276 The object takes the form of:
277
278{ # Request for the `StopScanRun` method.
279 }
280
281 x__xgafv: string, V1 error format.
282 Allowed values
283 1 - v1 error format
284 2 - v2 error format
285
286Returns:
287 An object of the form:
288
289 { # A ScanRun is a output-only resource representing an actual run of the scan.
290 # Next id: 12
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]291 &quot;errorTrace&quot;: { # Output only. # Output only. If result_state is an ERROR, this field provides the primary reason for
292 # scan&#x27;s termination and more details, if such are available.
293 # Defines an error trace message for a ScanRun.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]294 &quot;mostCommonHttpErrorCode&quot;: 42, # Output only. If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most
295 # common HTTP error code, if such is available. For example, if this code is
296 # 404, the scan has encountered too many NOT_FOUND responses.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]297 &quot;scanConfigError&quot;: { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig # Output only. If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error
298 # message encountered during scan configuration validation that is performed
299 # before each scan run.
300 # APIs when scan configuration validation fails. It is also reported as part of
301 # a ScanRunErrorTrace message if scan validation fails due to a scan
302 # configuration error.
303 &quot;fieldName&quot;: &quot;A String&quot;, # Output only. Indicates the full name of the ScanConfig field that triggers this error,
304 # for example &quot;scan_config.max_qps&quot;. This field is provided for
305 # troubleshooting purposes only and its actual value can change in the
306 # future.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]307 &quot;code&quot;: &quot;A String&quot;, # Output only. Indicates the reason code for a configuration failure.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]308 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]309 &quot;code&quot;: &quot;A String&quot;, # Output only. Indicates the error reason code.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]310 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]311 &quot;urlsCrawledCount&quot;: &quot;A String&quot;, # Output only. The number of URLs crawled during this ScanRun. If the scan is in progress,
312 # the value represents the number of URLs crawled up to now.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]313 &quot;warningTraces&quot;: [ # Output only. A list of warnings, if such are encountered during this scan run.
314 { # Output only.
315 # Defines a warning trace message for ScanRun. Warning traces provide customers
316 # with useful information that helps make the scanning process more effective.
317 &quot;code&quot;: &quot;A String&quot;, # Output only. Indicates the warning code.
318 },
319 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]320 &quot;resultState&quot;: &quot;A String&quot;, # Output only. The result state of the ScanRun. This field is only available after the
321 # execution state reaches &quot;FINISHED&quot;.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]322 &quot;executionState&quot;: &quot;A String&quot;, # Output only. The execution state of the ScanRun.
323 &quot;urlsTestedCount&quot;: &quot;A String&quot;, # Output only. The number of URLs tested during this ScanRun. If the scan is in progress,
324 # the value represents the number of URLs tested up to now. The number of
325 # URLs tested is usually larger than the number URLS crawled because
326 # typically a crawled URL is tested with multiple test payloads.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]327 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the ScanRun. The name follows the format of
328 # &#x27;projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}&#x27;.
329 # The ScanRun IDs are generated by the system.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]330 &quot;hasVulnerabilities&quot;: True or False, # Output only. Whether the scan run has found any vulnerabilities.
331 &quot;endTime&quot;: &quot;A String&quot;, # Output only. The time at which the ScanRun reached termination state - that the ScanRun
332 # is either finished or stopped by user.
333 &quot;progressPercent&quot;: 42, # Output only. The percentage of total completion ranging from 0 to 100.
334 # If the scan is in queue, the value is 0.
335 # If the scan is running, the value ranges from 0 to 100.
336 # If the scan is finished, the value is 100.
337 &quot;startTime&quot;: &quot;A String&quot;, # Output only. The time at which the ScanRun started.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]338 }</pre>
339</div>
340
341</body></html>