Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 715bd7f9ca9a324a05ee05a6476af383e54930f9 / . / docs / dyn / websecurityscanner_v1alpha.projects.scanConfigs.scanRuns.html
blob: 80cfcd42060af83b2612f5cba83d8e1042a1b6ac [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_v1alpha.html">Web Security Scanner API</a> . <a href="websecurityscanner_v1alpha.projects.html">projects</a> . <a href="websecurityscanner_v1alpha.projects.scanConfigs.html">scanConfigs</a> . <a href="websecurityscanner_v1alpha.projects.scanConfigs.scanRuns.html">scanRuns</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="websecurityscanner_v1alpha.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_v1alpha.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_v1alpha.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, pageSize=None, pageToken=None, x__xgafv=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 "name": "A String", # Output only.
124 # The resource name of the ScanRun. The name follows the format of
125 # 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
126 # The ScanRun IDs are generated by the system.
127 "executionState": "A String", # Output only.
128 # The execution state of the ScanRun.
129 "urlsTestedCount": "A String", # Output only.
130 # The number of URLs tested during this ScanRun. If the scan is in progress,
131 # the value represents the number of URLs tested up to now. The number of
132 # URLs tested is usually larger than the number URLS crawled because
133 # typically a crawled URL is tested with multiple test payloads.
134 "progressPercent": 42, # Output only.
135 # The percentage of total completion ranging from 0 to 100.
136 # If the scan is in queue, the value is 0.
137 # If the scan is running, the value ranges from 0 to 100.
138 # If the scan is finished, the value is 100.
139 "resultState": "A String", # Output only.
140 # The result state of the ScanRun. This field is only available after the
141 # execution state reaches "FINISHED".
142 "startTime": "A String", # Output only.
143 # The time at which the ScanRun started.
144 "endTime": "A String", # Output only.
145 # The time at which the ScanRun reached termination state - that the ScanRun
146 # is either finished or stopped by user.
147 "hasVulnerabilities": True or False, # Output only.
148 # Whether the scan run has found any vulnerabilities.
149 "urlsCrawledCount": "A String", # Output only.
150 # The number of URLs crawled during this ScanRun. If the scan is in progress,
151 # the value represents the number of URLs crawled up to now.
152 }</pre>
153</div>
154
155<div class="method">
156 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
157 <pre>Lists ScanRuns under a given ScanConfig, in descending order of ScanRun
158stop time.
159
160Args:
161 parent: string, Required.
162The parent resource name, which should be a scan resource name in the
163format 'projects/{projectId}/scanConfigs/{scanConfigId}'. (required)
164 pageSize: integer, The maximum number of ScanRuns to return, can be limited by server.
165If not specified or not positive, the implementation will select a
166reasonable value.
167 pageToken: string, A token identifying a page of results to be returned. This should be a
168`next_page_token` value returned from a previous List request.
169If unspecified, the first page of results is returned.
170 x__xgafv: string, V1 error format.
171 Allowed values
172 1 - v1 error format
173 2 - v2 error format
174
175Returns:
176 An object of the form:
177
178 { # Response for the `ListScanRuns` method.
179 "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no
180 # more results in the list.
181 "scanRuns": [ # The list of ScanRuns returned.
182 { # A ScanRun is a output-only resource representing an actual run of the scan.
183 "name": "A String", # Output only.
184 # The resource name of the ScanRun. The name follows the format of
185 # 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
186 # The ScanRun IDs are generated by the system.
187 "executionState": "A String", # Output only.
188 # The execution state of the ScanRun.
189 "urlsTestedCount": "A String", # Output only.
190 # The number of URLs tested during this ScanRun. If the scan is in progress,
191 # the value represents the number of URLs tested up to now. The number of
192 # URLs tested is usually larger than the number URLS crawled because
193 # typically a crawled URL is tested with multiple test payloads.
194 "progressPercent": 42, # Output only.
195 # The percentage of total completion ranging from 0 to 100.
196 # If the scan is in queue, the value is 0.
197 # If the scan is running, the value ranges from 0 to 100.
198 # If the scan is finished, the value is 100.
199 "resultState": "A String", # Output only.
200 # The result state of the ScanRun. This field is only available after the
201 # execution state reaches "FINISHED".
202 "startTime": "A String", # Output only.
203 # The time at which the ScanRun started.
204 "endTime": "A String", # Output only.
205 # The time at which the ScanRun reached termination state - that the ScanRun
206 # is either finished or stopped by user.
207 "hasVulnerabilities": True or False, # Output only.
208 # Whether the scan run has found any vulnerabilities.
209 "urlsCrawledCount": "A String", # Output only.
210 # The number of URLs crawled during this ScanRun. If the scan is in progress,
211 # the value represents the number of URLs crawled up to now.
212 },
213 ],
214 }</pre>
215</div>
216
217<div class="method">
218 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
219 <pre>Retrieves the next page of results.
220
221Args:
222 previous_request: The request for the previous page. (required)
223 previous_response: The response from the request for the previous page. (required)
224
225Returns:
226 A request object that you can call 'execute()' on to request the next
227 page. Returns None if there are no more items in the collection.
228 </pre>
229</div>
230
231<div class="method">
232 <code class="details" id="stop">stop(name, body=None, x__xgafv=None)</code>
233 <pre>Stops a ScanRun. The stopped ScanRun is returned.
234
235Args:
236 name: string, Required.
237The resource name of the ScanRun to be stopped. The name follows the
238format of
239'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. (required)
240 body: object, The request body.
241 The object takes the form of:
242
243{ # Request for the `StopScanRun` method.
244 }
245
246 x__xgafv: string, V1 error format.
247 Allowed values
248 1 - v1 error format
249 2 - v2 error format
250
251Returns:
252 An object of the form:
253
254 { # A ScanRun is a output-only resource representing an actual run of the scan.
255 "name": "A String", # Output only.
256 # The resource name of the ScanRun. The name follows the format of
257 # 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
258 # The ScanRun IDs are generated by the system.
259 "executionState": "A String", # Output only.
260 # The execution state of the ScanRun.
261 "urlsTestedCount": "A String", # Output only.
262 # The number of URLs tested during this ScanRun. If the scan is in progress,
263 # the value represents the number of URLs tested up to now. The number of
264 # URLs tested is usually larger than the number URLS crawled because
265 # typically a crawled URL is tested with multiple test payloads.
266 "progressPercent": 42, # Output only.
267 # The percentage of total completion ranging from 0 to 100.
268 # If the scan is in queue, the value is 0.
269 # If the scan is running, the value ranges from 0 to 100.
270 # If the scan is finished, the value is 100.
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 }</pre>
285</div>
286
287</body></html>