Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / websecurityscanner_v1beta.projects.scanConfigs.scanRuns.html
blob: de594ba80bfbe2339c9954963a611bd3077db734 [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:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]110 name: string, Required. The resource name of the ScanRun to be returned. The name follows the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]111format of
112'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. (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
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]123 "warningTraces": [ # A list of warnings, if such are encountered during this scan run.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]124 { # Output only.
125 # Defines a warning trace message for ScanRun. Warning traces provide customers
126 # with useful information that helps make the scanning process more effective.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]127 "code": "A String", # Indicates the warning code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]128 },
129 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]130 "name": "A String", # The resource name of the ScanRun. The name follows the format of
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]131 # 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
132 # The ScanRun IDs are generated by the system.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]133 "executionState": "A String", # The execution state of the ScanRun.
134 "urlsTestedCount": "A String", # The number of URLs tested during this ScanRun. If the scan is in progress,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]135 # the value represents the number of URLs tested up to now. The number of
136 # URLs tested is usually larger than the number URLS crawled because
137 # typically a crawled URL is tested with multiple test payloads.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]138 "progressPercent": 42, # The percentage of total completion ranging from 0 to 100.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]139 # If the scan is in queue, the value is 0.
140 # If the scan is running, the value ranges from 0 to 100.
141 # If the scan is finished, the value is 100.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]142 "errorTrace": { # Output only. # If result_state is an ERROR, this field provides the primary reason for
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]143 # scan's termination and more details, if such are available.
144 # Defines an error trace message for a ScanRun.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]145 "mostCommonHttpErrorCode": 42, # If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]146 # common HTTP error code, if such is available. For example, if this code is
147 # 404, the scan has encountered too many NOT_FOUND responses.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]148 "code": "A String", # Indicates the error reason code.
149 "scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]150 # message encountered during scan configuration validation that is performed
151 # before each scan run.
152 # APIs when scan configuration validation fails. It is also reported as part of
153 # a ScanRunErrorTrace message if scan validation fails due to a scan
154 # configuration error.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]155 "code": "A String", # Indicates the reason code for a configuration failure.
156 "fieldName": "A String", # Indicates the full name of the ScanConfig field that triggers this error,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]157 # for example "scan_config.max_qps". This field is provided for
158 # troubleshooting purposes only and its actual value can change in the
159 # future.
160 },
161 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]162 "urlsCrawledCount": "A String", # The number of URLs crawled during this ScanRun. If the scan is in progress,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]163 # the value represents the number of URLs crawled up to now.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]164 "startTime": "A String", # The time at which the ScanRun started.
165 "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
166 # is either finished or stopped by user.
167 "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
168 "resultState": "A String", # The result state of the ScanRun. This field is only available after the
169 # execution state reaches "FINISHED".
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]170 }</pre>
171</div>
172
173<div class="method">
174 <code class="details" id="list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</code>
175 <pre>Lists ScanRuns under a given ScanConfig, in descending order of ScanRun
176stop time.
177
178Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]179 parent: string, Required. The parent resource name, which should be a scan resource name in the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]180format 'projects/{projectId}/scanConfigs/{scanConfigId}'. (required)
181 pageToken: string, A token identifying a page of results to be returned. This should be a
182`next_page_token` value returned from a previous List request.
183If unspecified, the first page of results is returned.
184 x__xgafv: string, V1 error format.
185 Allowed values
186 1 - v1 error format
187 2 - v2 error format
188 pageSize: integer, The maximum number of ScanRuns to return, can be limited by server.
189If not specified or not positive, the implementation will select a
190reasonable value.
191
192Returns:
193 An object of the form:
194
195 { # Response for the `ListScanRuns` method.
196 "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no
197 # more results in the list.
198 "scanRuns": [ # The list of ScanRuns returned.
199 { # A ScanRun is a output-only resource representing an actual run of the scan.
200 # Next id: 12
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]201 "warningTraces": [ # A list of warnings, if such are encountered during this scan run.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]202 { # Output only.
203 # Defines a warning trace message for ScanRun. Warning traces provide customers
204 # with useful information that helps make the scanning process more effective.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]205 "code": "A String", # Indicates the warning code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]206 },
207 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]208 "name": "A String", # The resource name of the ScanRun. The name follows the format of
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]209 # 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
210 # The ScanRun IDs are generated by the system.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]211 "executionState": "A String", # The execution state of the ScanRun.
212 "urlsTestedCount": "A String", # The number of URLs tested during this ScanRun. If the scan is in progress,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]213 # the value represents the number of URLs tested up to now. The number of
214 # URLs tested is usually larger than the number URLS crawled because
215 # typically a crawled URL is tested with multiple test payloads.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]216 "progressPercent": 42, # The percentage of total completion ranging from 0 to 100.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]217 # If the scan is in queue, the value is 0.
218 # If the scan is running, the value ranges from 0 to 100.
219 # If the scan is finished, the value is 100.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]220 "errorTrace": { # Output only. # If result_state is an ERROR, this field provides the primary reason for
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]221 # scan's termination and more details, if such are available.
222 # Defines an error trace message for a ScanRun.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]223 "mostCommonHttpErrorCode": 42, # If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]224 # common HTTP error code, if such is available. For example, if this code is
225 # 404, the scan has encountered too many NOT_FOUND responses.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]226 "code": "A String", # Indicates the error reason code.
227 "scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]228 # message encountered during scan configuration validation that is performed
229 # before each scan run.
230 # APIs when scan configuration validation fails. It is also reported as part of
231 # a ScanRunErrorTrace message if scan validation fails due to a scan
232 # configuration error.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]233 "code": "A String", # Indicates the reason code for a configuration failure.
234 "fieldName": "A String", # Indicates the full name of the ScanConfig field that triggers this error,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]235 # for example "scan_config.max_qps". This field is provided for
236 # troubleshooting purposes only and its actual value can change in the
237 # future.
238 },
239 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]240 "urlsCrawledCount": "A String", # The number of URLs crawled during this ScanRun. If the scan is in progress,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]241 # the value represents the number of URLs crawled up to now.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]242 "startTime": "A String", # The time at which the ScanRun started.
243 "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
244 # is either finished or stopped by user.
245 "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
246 "resultState": "A String", # The result state of the ScanRun. This field is only available after the
247 # execution state reaches "FINISHED".
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]248 },
249 ],
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 'execute()' 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:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]272 name: string, Required. The resource name of the ScanRun to be stopped. The name follows the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]273format of
274'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. (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
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]291 "warningTraces": [ # A list of warnings, if such are encountered during this scan run.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]292 { # Output only.
293 # Defines a warning trace message for ScanRun. Warning traces provide customers
294 # with useful information that helps make the scanning process more effective.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]295 "code": "A String", # Indicates the warning code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]296 },
297 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]298 "name": "A String", # The resource name of the ScanRun. The name follows the format of
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]299 # 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
300 # The ScanRun IDs are generated by the system.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]301 "executionState": "A String", # The execution state of the ScanRun.
302 "urlsTestedCount": "A String", # The number of URLs tested during this ScanRun. If the scan is in progress,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]303 # the value represents the number of URLs tested up to now. The number of
304 # URLs tested is usually larger than the number URLS crawled because
305 # typically a crawled URL is tested with multiple test payloads.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]306 "progressPercent": 42, # The percentage of total completion ranging from 0 to 100.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]307 # If the scan is in queue, the value is 0.
308 # If the scan is running, the value ranges from 0 to 100.
309 # If the scan is finished, the value is 100.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]310 "errorTrace": { # Output only. # If result_state is an ERROR, this field provides the primary reason for
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]311 # scan's termination and more details, if such are available.
312 # Defines an error trace message for a ScanRun.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]313 "mostCommonHttpErrorCode": 42, # If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]314 # common HTTP error code, if such is available. For example, if this code is
315 # 404, the scan has encountered too many NOT_FOUND responses.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]316 "code": "A String", # Indicates the error reason code.
317 "scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]318 # message encountered during scan configuration validation that is performed
319 # before each scan run.
320 # APIs when scan configuration validation fails. It is also reported as part of
321 # a ScanRunErrorTrace message if scan validation fails due to a scan
322 # configuration error.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]323 "code": "A String", # Indicates the reason code for a configuration failure.
324 "fieldName": "A String", # Indicates the full name of the ScanConfig field that triggers this error,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]325 # for example "scan_config.max_qps". This field is provided for
326 # troubleshooting purposes only and its actual value can change in the
327 # future.
328 },
329 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]330 "urlsCrawledCount": "A String", # The number of URLs crawled during this ScanRun. If the scan is in progress,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]331 # the value represents the number of URLs crawled up to now.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]332 "startTime": "A String", # The time at which the ScanRun started.
333 "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
334 # is either finished or stopped by user.
335 "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
336 "resultState": "A String", # The result state of the ScanRun. This field is only available after the
337 # execution state reaches "FINISHED".
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]338 }</pre>
339</div>
340
341</body></html>