Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 715bd7f9ca9a324a05ee05a6476af383e54930f9 / . / docs / dyn / websecurityscanner_v1beta.projects.scanConfigs.scanRuns.html
blob: 572cf93dbf3f37dd3b51edfc68bdd5e3506b8fcb [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -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_v1beta.html">Web Security Scanner API</a> . <a href="websecurityscanner_v1beta.projects.html">projects</a> . <a href="websecurityscanner_v1beta.projects.scanConfigs.html">scanConfigs</a> . <a href="websecurityscanner_v1beta.projects.scanConfigs.scanRuns.html">scanRuns</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="websecurityscanner_v1beta.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_v1beta.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_v1beta.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">
96 <code><a href="#list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
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.
111The resource name of the ScanRun to be returned. The name follows the
112format of
113'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. (required)
114 x__xgafv: string, V1 error format.
115 Allowed values
116 1 - v1 error format
117 2 - v2 error format
118
119Returns:
120 An object of the form:
121
122 { # A ScanRun is a output-only resource representing an actual run of the scan.
123 # Next id: 12
124 "warningTraces": [ # Output only.
125 # A list of warnings, if such are encountered during this scan run.
126 { # Output only.
127 # Defines a warning trace message for ScanRun. Warning traces provide customers
128 # with useful information that helps make the scanning process more effective.
129 "code": "A String", # Output only.
130 # Indicates the warning code.
131 },
132 ],
133 "name": "A String", # Output only.
134 # The resource name of the ScanRun. The name follows the format of
135 # 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
136 # The ScanRun IDs are generated by the system.
137 "executionState": "A String", # Output only.
138 # The execution state of the ScanRun.
139 "urlsTestedCount": "A String", # Output only.
140 # The number of URLs tested during this ScanRun. If the scan is in progress,
141 # the value represents the number of URLs tested up to now. The number of
142 # URLs tested is usually larger than the number URLS crawled because
143 # typically a crawled URL is tested with multiple test payloads.
144 "progressPercent": 42, # Output only.
145 # The percentage of total completion ranging from 0 to 100.
146 # If the scan is in queue, the value is 0.
147 # If the scan is running, the value ranges from 0 to 100.
148 # If the scan is finished, the value is 100.
149 "errorTrace": { # Output only. # Output only.
150 # If result_state is an ERROR, this field provides the primary reason for
151 # scan's termination and more details, if such are available.
152 # Defines an error trace message for a ScanRun.
153 "mostCommonHttpErrorCode": 42, # Output only.
154 # If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most
155 # common HTTP error code, if such is available. For example, if this code is
156 # 404, the scan has encountered too many NOT_FOUND responses.
157 "code": "A String", # Output only.
158 # Indicates the error reason code.
159 "scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig # Output only.
160 # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error
161 # message encountered during scan configuration validation that is performed
162 # before each scan run.
163 # APIs when scan configuration validation fails. It is also reported as part of
164 # a ScanRunErrorTrace message if scan validation fails due to a scan
165 # configuration error.
166 "code": "A String", # Output only.
167 # Indicates the reason code for a configuration failure.
168 "fieldName": "A String", # Output only.
169 # Indicates the full name of the ScanConfig field that triggers this error,
170 # for example "scan_config.max_qps". This field is provided for
171 # troubleshooting purposes only and its actual value can change in the
172 # future.
173 },
174 },
175 "resultState": "A String", # Output only.
176 # The result state of the ScanRun. This field is only available after the
177 # execution state reaches "FINISHED".
178 "startTime": "A String", # Output only.
179 # The time at which the ScanRun started.
180 "endTime": "A String", # Output only.
181 # The time at which the ScanRun reached termination state - that the ScanRun
182 # is either finished or stopped by user.
183 "hasVulnerabilities": True or False, # Output only.
184 # Whether the scan run has found any vulnerabilities.
185 "urlsCrawledCount": "A String", # Output only.
186 # The number of URLs crawled during this ScanRun. If the scan is in progress,
187 # the value represents the number of URLs crawled up to now.
188 }</pre>
189</div>
190
191<div class="method">
192 <code class="details" id="list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</code>
193 <pre>Lists ScanRuns under a given ScanConfig, in descending order of ScanRun
194stop time.
195
196Args:
197 parent: string, Required.
198The parent resource name, which should be a scan resource name in the
199format 'projects/{projectId}/scanConfigs/{scanConfigId}'. (required)
200 pageToken: string, A token identifying a page of results to be returned. This should be a
201`next_page_token` value returned from a previous List request.
202If unspecified, the first page of results is returned.
203 x__xgafv: string, V1 error format.
204 Allowed values
205 1 - v1 error format
206 2 - v2 error format
207 pageSize: integer, The maximum number of ScanRuns to return, can be limited by server.
208If not specified or not positive, the implementation will select a
209reasonable value.
210
211Returns:
212 An object of the form:
213
214 { # Response for the `ListScanRuns` method.
215 "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no
216 # more results in the list.
217 "scanRuns": [ # The list of ScanRuns returned.
218 { # A ScanRun is a output-only resource representing an actual run of the scan.
219 # Next id: 12
220 "warningTraces": [ # Output only.
221 # A list of warnings, if such are encountered during this scan run.
222 { # Output only.
223 # Defines a warning trace message for ScanRun. Warning traces provide customers
224 # with useful information that helps make the scanning process more effective.
225 "code": "A String", # Output only.
226 # Indicates the warning code.
227 },
228 ],
229 "name": "A String", # Output only.
230 # The resource name of the ScanRun. The name follows the format of
231 # 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
232 # The ScanRun IDs are generated by the system.
233 "executionState": "A String", # Output only.
234 # The execution state of the ScanRun.
235 "urlsTestedCount": "A String", # Output only.
236 # The number of URLs tested during this ScanRun. If the scan is in progress,
237 # the value represents the number of URLs tested up to now. The number of
238 # URLs tested is usually larger than the number URLS crawled because
239 # typically a crawled URL is tested with multiple test payloads.
240 "progressPercent": 42, # Output only.
241 # The percentage of total completion ranging from 0 to 100.
242 # If the scan is in queue, the value is 0.
243 # If the scan is running, the value ranges from 0 to 100.
244 # If the scan is finished, the value is 100.
245 "errorTrace": { # Output only. # Output only.
246 # If result_state is an ERROR, this field provides the primary reason for
247 # scan's termination and more details, if such are available.
248 # Defines an error trace message for a ScanRun.
249 "mostCommonHttpErrorCode": 42, # Output only.
250 # If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most
251 # common HTTP error code, if such is available. For example, if this code is
252 # 404, the scan has encountered too many NOT_FOUND responses.
253 "code": "A String", # Output only.
254 # Indicates the error reason code.
255 "scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig # Output only.
256 # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error
257 # message encountered during scan configuration validation that is performed
258 # before each scan run.
259 # APIs when scan configuration validation fails. It is also reported as part of
260 # a ScanRunErrorTrace message if scan validation fails due to a scan
261 # configuration error.
262 "code": "A String", # Output only.
263 # Indicates the reason code for a configuration failure.
264 "fieldName": "A String", # Output only.
265 # Indicates the full name of the ScanConfig field that triggers this error,
266 # for example "scan_config.max_qps". This field is provided for
267 # troubleshooting purposes only and its actual value can change in the
268 # future.
269 },
270 },
271 "resultState": "A String", # Output only.
272 # The result state of the ScanRun. This field is only available after the
273 # execution state reaches "FINISHED".
274 "startTime": "A String", # Output only.
275 # The time at which the ScanRun started.
276 "endTime": "A String", # Output only.
277 # The time at which the ScanRun reached termination state - that the ScanRun
278 # is either finished or stopped by user.
279 "hasVulnerabilities": True or False, # Output only.
280 # Whether the scan run has found any vulnerabilities.
281 "urlsCrawledCount": "A String", # Output only.
282 # The number of URLs crawled during this ScanRun. If the scan is in progress,
283 # the value represents the number of URLs crawled up to now.
284 },
285 ],
286 }</pre>
287</div>
288
289<div class="method">
290 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
291 <pre>Retrieves the next page of results.
292
293Args:
294 previous_request: The request for the previous page. (required)
295 previous_response: The response from the request for the previous page. (required)
296
297Returns:
298 A request object that you can call 'execute()' on to request the next
299 page. Returns None if there are no more items in the collection.
300 </pre>
301</div>
302
303<div class="method">
304 <code class="details" id="stop">stop(name, body=None, x__xgafv=None)</code>
305 <pre>Stops a ScanRun. The stopped ScanRun is returned.
306
307Args:
308 name: string, Required.
309The resource name of the ScanRun to be stopped. The name follows the
310format of
311'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. (required)
312 body: object, The request body.
313 The object takes the form of:
314
315{ # Request for the `StopScanRun` method.
316 }
317
318 x__xgafv: string, V1 error format.
319 Allowed values
320 1 - v1 error format
321 2 - v2 error format
322
323Returns:
324 An object of the form:
325
326 { # A ScanRun is a output-only resource representing an actual run of the scan.
327 # Next id: 12
328 "warningTraces": [ # Output only.
329 # A list of warnings, if such are encountered during this scan run.
330 { # Output only.
331 # Defines a warning trace message for ScanRun. Warning traces provide customers
332 # with useful information that helps make the scanning process more effective.
333 "code": "A String", # Output only.
334 # Indicates the warning code.
335 },
336 ],
337 "name": "A String", # Output only.
338 # The resource name of the ScanRun. The name follows the format of
339 # 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
340 # The ScanRun IDs are generated by the system.
341 "executionState": "A String", # Output only.
342 # The execution state of the ScanRun.
343 "urlsTestedCount": "A String", # Output only.
344 # The number of URLs tested during this ScanRun. If the scan is in progress,
345 # the value represents the number of URLs tested up to now. The number of
346 # URLs tested is usually larger than the number URLS crawled because
347 # typically a crawled URL is tested with multiple test payloads.
348 "progressPercent": 42, # Output only.
349 # The percentage of total completion ranging from 0 to 100.
350 # If the scan is in queue, the value is 0.
351 # If the scan is running, the value ranges from 0 to 100.
352 # If the scan is finished, the value is 100.
353 "errorTrace": { # Output only. # Output only.
354 # If result_state is an ERROR, this field provides the primary reason for
355 # scan's termination and more details, if such are available.
356 # Defines an error trace message for a ScanRun.
357 "mostCommonHttpErrorCode": 42, # Output only.
358 # If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most
359 # common HTTP error code, if such is available. For example, if this code is
360 # 404, the scan has encountered too many NOT_FOUND responses.
361 "code": "A String", # Output only.
362 # Indicates the error reason code.
363 "scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig # Output only.
364 # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error
365 # message encountered during scan configuration validation that is performed
366 # before each scan run.
367 # APIs when scan configuration validation fails. It is also reported as part of
368 # a ScanRunErrorTrace message if scan validation fails due to a scan
369 # configuration error.
370 "code": "A String", # Output only.
371 # Indicates the reason code for a configuration failure.
372 "fieldName": "A String", # Output only.
373 # Indicates the full name of the ScanConfig field that triggers this error,
374 # for example "scan_config.max_qps". This field is provided for
375 # troubleshooting purposes only and its actual value can change in the
376 # future.
377 },
378 },
379 "resultState": "A String", # Output only.
380 # The result state of the ScanRun. This field is only available after the
381 # execution state reaches "FINISHED".
382 "startTime": "A String", # Output only.
383 # The time at which the ScanRun started.
384 "endTime": "A String", # Output only.
385 # The time at which the ScanRun reached termination state - that the ScanRun
386 # is either finished or stopped by user.
387 "hasVulnerabilities": True or False, # Output only.
388 # Whether the scan run has found any vulnerabilities.
389 "urlsCrawledCount": "A String", # Output only.
390 # The number of URLs crawled during this ScanRun. If the scan is in progress,
391 # the value represents the number of URLs crawled up to now.
392 }</pre>
393</div>
394
395</body></html>