Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 715bd7f9ca9a324a05ee05a6476af383e54930f9 / . / docs / dyn / websecurityscanner_v1alpha.projects.scanConfigs.html
blob: e0215319aaf9fa80c9df232e6d2f5af2f6871320 [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></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="websecurityscanner_v1alpha.projects.scanConfigs.scanRuns.html">scanRuns()</a></code>
79</p>
80<p class="firstline">Returns the scanRuns Resource.</p>
81
82<p class="toc_element">
83 <code><a href="#create">create(parent, body, x__xgafv=None)</a></code></p>
84<p class="firstline">Creates a new ScanConfig.</p>
85<p class="toc_element">
86 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
87<p class="firstline">Deletes an existing ScanConfig and its child resources.</p>
88<p class="toc_element">
89 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
90<p class="firstline">Gets a ScanConfig.</p>
91<p class="toc_element">
92 <code><a href="#list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
93<p class="firstline">Lists ScanConfigs under a given project.</p>
94<p class="toc_element">
95 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
96<p class="firstline">Retrieves the next page of results.</p>
97<p class="toc_element">
98 <code><a href="#patch">patch(name, body, updateMask=None, x__xgafv=None)</a></code></p>
99<p class="firstline">Updates a ScanConfig. This method support partial update of a ScanConfig.</p>
100<p class="toc_element">
101 <code><a href="#start">start(name, body=None, x__xgafv=None)</a></code></p>
102<p class="firstline">Start a ScanRun according to the given ScanConfig.</p>
103<h3>Method Details</h3>
104<div class="method">
105 <code class="details" id="create">create(parent, body, x__xgafv=None)</code>
106 <pre>Creates a new ScanConfig.
107
108Args:
109 parent: string, Required.
110The parent resource name where the scan is created, which should be a
111project resource name in the format 'projects/{projectId}'. (required)
112 body: object, The request body. (required)
113 The object takes the form of:
114
115{ # A ScanConfig resource contains the configurations to launch a scan.
116 # next id: 12
117 "targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
118 # used as a default.
119 "A String",
120 ],
121 "displayName": "A String", # Required.
122 # The user provided display name of the ScanConfig.
123 "name": "A String", # The resource name of the ScanConfig. The name follows the format of
124 # 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are
125 # generated by the system.
126 "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
127 "scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is
128 # refreshed by the server after each run. If unspecified, it will default
129 # to current server time, which means the scan will be scheduled to start
130 # immediately.
131 "intervalDurationDays": 42, # Required.
132 # The duration of time between executions in days.
133 },
134 "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20
135 # inclusively. If the field is unspecified or its value is set 0, server will
136 # default to 15. Other values outside of [5, 20] range will be rejected with
137 # INVALID_ARGUMENT error.
138 "blacklistPatterns": [ # The blacklist URL patterns as described in
139 # https://cloud.google.com/security-scanner/docs/excluded-urls
140 "A String",
141 ],
142 "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the
143 # authentication configuration during scanning.
144 "googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
145 "username": "A String", # Required.
146 # The user name of the Google account.
147 "password": "A String", # Input only.
148 # Required.
149 # The password of the Google account. The credential is stored encrypted
150 # and not returned in any response nor included in audit logs.
151 },
152 "customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
153 "username": "A String", # Required.
154 # The user name of the custom account.
155 "loginUrl": "A String", # Required.
156 # The login form URL of the website.
157 "password": "A String", # Input only.
158 # Required.
159 # The password of the custom account. The credential is stored encrypted
160 # and not returned in any response nor included in audit logs.
161 },
162 },
163 "userAgent": "A String", # The user agent used during scanning.
164 "startingUrls": [ # Required.
165 # The starting URLs from which the scanner finds site pages.
166 "A String",
167 ],
168 "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
169 "name": "A String", # Output only.
170 # The resource name of the ScanRun. The name follows the format of
171 # 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
172 # The ScanRun IDs are generated by the system.
173 "executionState": "A String", # Output only.
174 # The execution state of the ScanRun.
175 "urlsTestedCount": "A String", # Output only.
176 # The number of URLs tested during this ScanRun. If the scan is in progress,
177 # the value represents the number of URLs tested up to now. The number of
178 # URLs tested is usually larger than the number URLS crawled because
179 # typically a crawled URL is tested with multiple test payloads.
180 "progressPercent": 42, # Output only.
181 # The percentage of total completion ranging from 0 to 100.
182 # If the scan is in queue, the value is 0.
183 # If the scan is running, the value ranges from 0 to 100.
184 # If the scan is finished, the value is 100.
185 "resultState": "A String", # Output only.
186 # The result state of the ScanRun. This field is only available after the
187 # execution state reaches "FINISHED".
188 "startTime": "A String", # Output only.
189 # The time at which the ScanRun started.
190 "endTime": "A String", # Output only.
191 # The time at which the ScanRun reached termination state - that the ScanRun
192 # is either finished or stopped by user.
193 "hasVulnerabilities": True or False, # Output only.
194 # Whether the scan run has found any vulnerabilities.
195 "urlsCrawledCount": "A String", # Output only.
196 # The number of URLs crawled during this ScanRun. If the scan is in progress,
197 # the value represents the number of URLs crawled up to now.
198 },
199}
200
201 x__xgafv: string, V1 error format.
202 Allowed values
203 1 - v1 error format
204 2 - v2 error format
205
206Returns:
207 An object of the form:
208
209 { # A ScanConfig resource contains the configurations to launch a scan.
210 # next id: 12
211 "targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
212 # used as a default.
213 "A String",
214 ],
215 "displayName": "A String", # Required.
216 # The user provided display name of the ScanConfig.
217 "name": "A String", # The resource name of the ScanConfig. The name follows the format of
218 # 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are
219 # generated by the system.
220 "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
221 "scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is
222 # refreshed by the server after each run. If unspecified, it will default
223 # to current server time, which means the scan will be scheduled to start
224 # immediately.
225 "intervalDurationDays": 42, # Required.
226 # The duration of time between executions in days.
227 },
228 "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20
229 # inclusively. If the field is unspecified or its value is set 0, server will
230 # default to 15. Other values outside of [5, 20] range will be rejected with
231 # INVALID_ARGUMENT error.
232 "blacklistPatterns": [ # The blacklist URL patterns as described in
233 # https://cloud.google.com/security-scanner/docs/excluded-urls
234 "A String",
235 ],
236 "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the
237 # authentication configuration during scanning.
238 "googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
239 "username": "A String", # Required.
240 # The user name of the Google account.
241 "password": "A String", # Input only.
242 # Required.
243 # The password of the Google account. The credential is stored encrypted
244 # and not returned in any response nor included in audit logs.
245 },
246 "customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
247 "username": "A String", # Required.
248 # The user name of the custom account.
249 "loginUrl": "A String", # Required.
250 # The login form URL of the website.
251 "password": "A String", # Input only.
252 # Required.
253 # The password of the custom account. The credential is stored encrypted
254 # and not returned in any response nor included in audit logs.
255 },
256 },
257 "userAgent": "A String", # The user agent used during scanning.
258 "startingUrls": [ # Required.
259 # The starting URLs from which the scanner finds site pages.
260 "A String",
261 ],
262 "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
263 "name": "A String", # Output only.
264 # The resource name of the ScanRun. The name follows the format of
265 # 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
266 # The ScanRun IDs are generated by the system.
267 "executionState": "A String", # Output only.
268 # The execution state of the ScanRun.
269 "urlsTestedCount": "A String", # Output only.
270 # The number of URLs tested during this ScanRun. If the scan is in progress,
271 # the value represents the number of URLs tested up to now. The number of
272 # URLs tested is usually larger than the number URLS crawled because
273 # typically a crawled URL is tested with multiple test payloads.
274 "progressPercent": 42, # Output only.
275 # The percentage of total completion ranging from 0 to 100.
276 # If the scan is in queue, the value is 0.
277 # If the scan is running, the value ranges from 0 to 100.
278 # If the scan is finished, the value is 100.
279 "resultState": "A String", # Output only.
280 # The result state of the ScanRun. This field is only available after the
281 # execution state reaches "FINISHED".
282 "startTime": "A String", # Output only.
283 # The time at which the ScanRun started.
284 "endTime": "A String", # Output only.
285 # The time at which the ScanRun reached termination state - that the ScanRun
286 # is either finished or stopped by user.
287 "hasVulnerabilities": True or False, # Output only.
288 # Whether the scan run has found any vulnerabilities.
289 "urlsCrawledCount": "A String", # Output only.
290 # The number of URLs crawled during this ScanRun. If the scan is in progress,
291 # the value represents the number of URLs crawled up to now.
292 },
293 }</pre>
294</div>
295
296<div class="method">
297 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
298 <pre>Deletes an existing ScanConfig and its child resources.
299
300Args:
301 name: string, Required.
302The resource name of the ScanConfig to be deleted. The name follows the
303format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. (required)
304 x__xgafv: string, V1 error format.
305 Allowed values
306 1 - v1 error format
307 2 - v2 error format
308
309Returns:
310 An object of the form:
311
312 { # A generic empty message that you can re-use to avoid defining duplicated
313 # empty messages in your APIs. A typical example is to use it as the request
314 # or the response type of an API method. For instance:
315 #
316 # service Foo {
317 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
318 # }
319 #
320 # The JSON representation for `Empty` is empty JSON object `{}`.
321 }</pre>
322</div>
323
324<div class="method">
325 <code class="details" id="get">get(name, x__xgafv=None)</code>
326 <pre>Gets a ScanConfig.
327
328Args:
329 name: string, Required.
330The resource name of the ScanConfig to be returned. The name follows the
331format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. (required)
332 x__xgafv: string, V1 error format.
333 Allowed values
334 1 - v1 error format
335 2 - v2 error format
336
337Returns:
338 An object of the form:
339
340 { # A ScanConfig resource contains the configurations to launch a scan.
341 # next id: 12
342 "targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
343 # used as a default.
344 "A String",
345 ],
346 "displayName": "A String", # Required.
347 # The user provided display name of the ScanConfig.
348 "name": "A String", # The resource name of the ScanConfig. The name follows the format of
349 # 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are
350 # generated by the system.
351 "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
352 "scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is
353 # refreshed by the server after each run. If unspecified, it will default
354 # to current server time, which means the scan will be scheduled to start
355 # immediately.
356 "intervalDurationDays": 42, # Required.
357 # The duration of time between executions in days.
358 },
359 "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20
360 # inclusively. If the field is unspecified or its value is set 0, server will
361 # default to 15. Other values outside of [5, 20] range will be rejected with
362 # INVALID_ARGUMENT error.
363 "blacklistPatterns": [ # The blacklist URL patterns as described in
364 # https://cloud.google.com/security-scanner/docs/excluded-urls
365 "A String",
366 ],
367 "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the
368 # authentication configuration during scanning.
369 "googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
370 "username": "A String", # Required.
371 # The user name of the Google account.
372 "password": "A String", # Input only.
373 # Required.
374 # The password of the Google account. The credential is stored encrypted
375 # and not returned in any response nor included in audit logs.
376 },
377 "customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
378 "username": "A String", # Required.
379 # The user name of the custom account.
380 "loginUrl": "A String", # Required.
381 # The login form URL of the website.
382 "password": "A String", # Input only.
383 # Required.
384 # The password of the custom account. The credential is stored encrypted
385 # and not returned in any response nor included in audit logs.
386 },
387 },
388 "userAgent": "A String", # The user agent used during scanning.
389 "startingUrls": [ # Required.
390 # The starting URLs from which the scanner finds site pages.
391 "A String",
392 ],
393 "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
394 "name": "A String", # Output only.
395 # The resource name of the ScanRun. The name follows the format of
396 # 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
397 # The ScanRun IDs are generated by the system.
398 "executionState": "A String", # Output only.
399 # The execution state of the ScanRun.
400 "urlsTestedCount": "A String", # Output only.
401 # The number of URLs tested during this ScanRun. If the scan is in progress,
402 # the value represents the number of URLs tested up to now. The number of
403 # URLs tested is usually larger than the number URLS crawled because
404 # typically a crawled URL is tested with multiple test payloads.
405 "progressPercent": 42, # Output only.
406 # The percentage of total completion ranging from 0 to 100.
407 # If the scan is in queue, the value is 0.
408 # If the scan is running, the value ranges from 0 to 100.
409 # If the scan is finished, the value is 100.
410 "resultState": "A String", # Output only.
411 # The result state of the ScanRun. This field is only available after the
412 # execution state reaches "FINISHED".
413 "startTime": "A String", # Output only.
414 # The time at which the ScanRun started.
415 "endTime": "A String", # Output only.
416 # The time at which the ScanRun reached termination state - that the ScanRun
417 # is either finished or stopped by user.
418 "hasVulnerabilities": True or False, # Output only.
419 # Whether the scan run has found any vulnerabilities.
420 "urlsCrawledCount": "A String", # Output only.
421 # The number of URLs crawled during this ScanRun. If the scan is in progress,
422 # the value represents the number of URLs crawled up to now.
423 },
424 }</pre>
425</div>
426
427<div class="method">
428 <code class="details" id="list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</code>
429 <pre>Lists ScanConfigs under a given project.
430
431Args:
432 parent: string, Required.
433The parent resource name, which should be a project resource name in the
434format 'projects/{projectId}'. (required)
435 pageToken: string, A token identifying a page of results to be returned. This should be a
436`next_page_token` value returned from a previous List request.
437If unspecified, the first page of results is returned.
438 x__xgafv: string, V1 error format.
439 Allowed values
440 1 - v1 error format
441 2 - v2 error format
442 pageSize: integer, The maximum number of ScanConfigs to return, can be limited by server.
443If not specified or not positive, the implementation will select a
444reasonable value.
445
446Returns:
447 An object of the form:
448
449 { # Response for the `ListScanConfigs` method.
450 "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no
451 # more results in the list.
452 "scanConfigs": [ # The list of ScanConfigs returned.
453 { # A ScanConfig resource contains the configurations to launch a scan.
454 # next id: 12
455 "targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
456 # used as a default.
457 "A String",
458 ],
459 "displayName": "A String", # Required.
460 # The user provided display name of the ScanConfig.
461 "name": "A String", # The resource name of the ScanConfig. The name follows the format of
462 # 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are
463 # generated by the system.
464 "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
465 "scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is
466 # refreshed by the server after each run. If unspecified, it will default
467 # to current server time, which means the scan will be scheduled to start
468 # immediately.
469 "intervalDurationDays": 42, # Required.
470 # The duration of time between executions in days.
471 },
472 "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20
473 # inclusively. If the field is unspecified or its value is set 0, server will
474 # default to 15. Other values outside of [5, 20] range will be rejected with
475 # INVALID_ARGUMENT error.
476 "blacklistPatterns": [ # The blacklist URL patterns as described in
477 # https://cloud.google.com/security-scanner/docs/excluded-urls
478 "A String",
479 ],
480 "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the
481 # authentication configuration during scanning.
482 "googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
483 "username": "A String", # Required.
484 # The user name of the Google account.
485 "password": "A String", # Input only.
486 # Required.
487 # The password of the Google account. The credential is stored encrypted
488 # and not returned in any response nor included in audit logs.
489 },
490 "customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
491 "username": "A String", # Required.
492 # The user name of the custom account.
493 "loginUrl": "A String", # Required.
494 # The login form URL of the website.
495 "password": "A String", # Input only.
496 # Required.
497 # The password of the custom account. The credential is stored encrypted
498 # and not returned in any response nor included in audit logs.
499 },
500 },
501 "userAgent": "A String", # The user agent used during scanning.
502 "startingUrls": [ # Required.
503 # The starting URLs from which the scanner finds site pages.
504 "A String",
505 ],
506 "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
507 "name": "A String", # Output only.
508 # The resource name of the ScanRun. The name follows the format of
509 # 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
510 # The ScanRun IDs are generated by the system.
511 "executionState": "A String", # Output only.
512 # The execution state of the ScanRun.
513 "urlsTestedCount": "A String", # Output only.
514 # The number of URLs tested during this ScanRun. If the scan is in progress,
515 # the value represents the number of URLs tested up to now. The number of
516 # URLs tested is usually larger than the number URLS crawled because
517 # typically a crawled URL is tested with multiple test payloads.
518 "progressPercent": 42, # Output only.
519 # The percentage of total completion ranging from 0 to 100.
520 # If the scan is in queue, the value is 0.
521 # If the scan is running, the value ranges from 0 to 100.
522 # If the scan is finished, the value is 100.
523 "resultState": "A String", # Output only.
524 # The result state of the ScanRun. This field is only available after the
525 # execution state reaches "FINISHED".
526 "startTime": "A String", # Output only.
527 # The time at which the ScanRun started.
528 "endTime": "A String", # Output only.
529 # The time at which the ScanRun reached termination state - that the ScanRun
530 # is either finished or stopped by user.
531 "hasVulnerabilities": True or False, # Output only.
532 # Whether the scan run has found any vulnerabilities.
533 "urlsCrawledCount": "A String", # Output only.
534 # The number of URLs crawled during this ScanRun. If the scan is in progress,
535 # the value represents the number of URLs crawled up to now.
536 },
537 },
538 ],
539 }</pre>
540</div>
541
542<div class="method">
543 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
544 <pre>Retrieves the next page of results.
545
546Args:
547 previous_request: The request for the previous page. (required)
548 previous_response: The response from the request for the previous page. (required)
549
550Returns:
551 A request object that you can call 'execute()' on to request the next
552 page. Returns None if there are no more items in the collection.
553 </pre>
554</div>
555
556<div class="method">
557 <code class="details" id="patch">patch(name, body, updateMask=None, x__xgafv=None)</code>
558 <pre>Updates a ScanConfig. This method support partial update of a ScanConfig.
559
560Args:
561 name: string, The resource name of the ScanConfig. The name follows the format of
562'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are
563generated by the system. (required)
564 body: object, The request body. (required)
565 The object takes the form of:
566
567{ # A ScanConfig resource contains the configurations to launch a scan.
568 # next id: 12
569 "targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
570 # used as a default.
571 "A String",
572 ],
573 "displayName": "A String", # Required.
574 # The user provided display name of the ScanConfig.
575 "name": "A String", # The resource name of the ScanConfig. The name follows the format of
576 # 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are
577 # generated by the system.
578 "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
579 "scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is
580 # refreshed by the server after each run. If unspecified, it will default
581 # to current server time, which means the scan will be scheduled to start
582 # immediately.
583 "intervalDurationDays": 42, # Required.
584 # The duration of time between executions in days.
585 },
586 "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20
587 # inclusively. If the field is unspecified or its value is set 0, server will
588 # default to 15. Other values outside of [5, 20] range will be rejected with
589 # INVALID_ARGUMENT error.
590 "blacklistPatterns": [ # The blacklist URL patterns as described in
591 # https://cloud.google.com/security-scanner/docs/excluded-urls
592 "A String",
593 ],
594 "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the
595 # authentication configuration during scanning.
596 "googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
597 "username": "A String", # Required.
598 # The user name of the Google account.
599 "password": "A String", # Input only.
600 # Required.
601 # The password of the Google account. The credential is stored encrypted
602 # and not returned in any response nor included in audit logs.
603 },
604 "customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
605 "username": "A String", # Required.
606 # The user name of the custom account.
607 "loginUrl": "A String", # Required.
608 # The login form URL of the website.
609 "password": "A String", # Input only.
610 # Required.
611 # The password of the custom account. The credential is stored encrypted
612 # and not returned in any response nor included in audit logs.
613 },
614 },
615 "userAgent": "A String", # The user agent used during scanning.
616 "startingUrls": [ # Required.
617 # The starting URLs from which the scanner finds site pages.
618 "A String",
619 ],
620 "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
621 "name": "A String", # Output only.
622 # The resource name of the ScanRun. The name follows the format of
623 # 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
624 # The ScanRun IDs are generated by the system.
625 "executionState": "A String", # Output only.
626 # The execution state of the ScanRun.
627 "urlsTestedCount": "A String", # Output only.
628 # The number of URLs tested during this ScanRun. If the scan is in progress,
629 # the value represents the number of URLs tested up to now. The number of
630 # URLs tested is usually larger than the number URLS crawled because
631 # typically a crawled URL is tested with multiple test payloads.
632 "progressPercent": 42, # Output only.
633 # The percentage of total completion ranging from 0 to 100.
634 # If the scan is in queue, the value is 0.
635 # If the scan is running, the value ranges from 0 to 100.
636 # If the scan is finished, the value is 100.
637 "resultState": "A String", # Output only.
638 # The result state of the ScanRun. This field is only available after the
639 # execution state reaches "FINISHED".
640 "startTime": "A String", # Output only.
641 # The time at which the ScanRun started.
642 "endTime": "A String", # Output only.
643 # The time at which the ScanRun reached termination state - that the ScanRun
644 # is either finished or stopped by user.
645 "hasVulnerabilities": True or False, # Output only.
646 # Whether the scan run has found any vulnerabilities.
647 "urlsCrawledCount": "A String", # Output only.
648 # The number of URLs crawled during this ScanRun. If the scan is in progress,
649 # the value represents the number of URLs crawled up to now.
650 },
651}
652
653 updateMask: string, Required.
654The update mask applies to the resource. For the `FieldMask` definition,
655see
656https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
657 x__xgafv: string, V1 error format.
658 Allowed values
659 1 - v1 error format
660 2 - v2 error format
661
662Returns:
663 An object of the form:
664
665 { # A ScanConfig resource contains the configurations to launch a scan.
666 # next id: 12
667 "targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
668 # used as a default.
669 "A String",
670 ],
671 "displayName": "A String", # Required.
672 # The user provided display name of the ScanConfig.
673 "name": "A String", # The resource name of the ScanConfig. The name follows the format of
674 # 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are
675 # generated by the system.
676 "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
677 "scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is
678 # refreshed by the server after each run. If unspecified, it will default
679 # to current server time, which means the scan will be scheduled to start
680 # immediately.
681 "intervalDurationDays": 42, # Required.
682 # The duration of time between executions in days.
683 },
684 "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20
685 # inclusively. If the field is unspecified or its value is set 0, server will
686 # default to 15. Other values outside of [5, 20] range will be rejected with
687 # INVALID_ARGUMENT error.
688 "blacklistPatterns": [ # The blacklist URL patterns as described in
689 # https://cloud.google.com/security-scanner/docs/excluded-urls
690 "A String",
691 ],
692 "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the
693 # authentication configuration during scanning.
694 "googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
695 "username": "A String", # Required.
696 # The user name of the Google account.
697 "password": "A String", # Input only.
698 # Required.
699 # The password of the Google account. The credential is stored encrypted
700 # and not returned in any response nor included in audit logs.
701 },
702 "customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
703 "username": "A String", # Required.
704 # The user name of the custom account.
705 "loginUrl": "A String", # Required.
706 # The login form URL of the website.
707 "password": "A String", # Input only.
708 # Required.
709 # The password of the custom account. The credential is stored encrypted
710 # and not returned in any response nor included in audit logs.
711 },
712 },
713 "userAgent": "A String", # The user agent used during scanning.
714 "startingUrls": [ # Required.
715 # The starting URLs from which the scanner finds site pages.
716 "A String",
717 ],
718 "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
719 "name": "A String", # Output only.
720 # The resource name of the ScanRun. The name follows the format of
721 # 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
722 # The ScanRun IDs are generated by the system.
723 "executionState": "A String", # Output only.
724 # The execution state of the ScanRun.
725 "urlsTestedCount": "A String", # Output only.
726 # The number of URLs tested during this ScanRun. If the scan is in progress,
727 # the value represents the number of URLs tested up to now. The number of
728 # URLs tested is usually larger than the number URLS crawled because
729 # typically a crawled URL is tested with multiple test payloads.
730 "progressPercent": 42, # Output only.
731 # The percentage of total completion ranging from 0 to 100.
732 # If the scan is in queue, the value is 0.
733 # If the scan is running, the value ranges from 0 to 100.
734 # If the scan is finished, the value is 100.
735 "resultState": "A String", # Output only.
736 # The result state of the ScanRun. This field is only available after the
737 # execution state reaches "FINISHED".
738 "startTime": "A String", # Output only.
739 # The time at which the ScanRun started.
740 "endTime": "A String", # Output only.
741 # The time at which the ScanRun reached termination state - that the ScanRun
742 # is either finished or stopped by user.
743 "hasVulnerabilities": True or False, # Output only.
744 # Whether the scan run has found any vulnerabilities.
745 "urlsCrawledCount": "A String", # Output only.
746 # The number of URLs crawled during this ScanRun. If the scan is in progress,
747 # the value represents the number of URLs crawled up to now.
748 },
749 }</pre>
750</div>
751
752<div class="method">
753 <code class="details" id="start">start(name, body=None, x__xgafv=None)</code>
754 <pre>Start a ScanRun according to the given ScanConfig.
755
756Args:
757 name: string, Required.
758The resource name of the ScanConfig to be used. The name follows the
759format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. (required)
760 body: object, The request body.
761 The object takes the form of:
762
763{ # Request for the `StartScanRun` method.
764 }
765
766 x__xgafv: string, V1 error format.
767 Allowed values
768 1 - v1 error format
769 2 - v2 error format
770
771Returns:
772 An object of the form:
773
774 { # A ScanRun is a output-only resource representing an actual run of the scan.
775 "name": "A String", # Output only.
776 # The resource name of the ScanRun. The name follows the format of
777 # 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
778 # The ScanRun IDs are generated by the system.
779 "executionState": "A String", # Output only.
780 # The execution state of the ScanRun.
781 "urlsTestedCount": "A String", # Output only.
782 # The number of URLs tested during this ScanRun. If the scan is in progress,
783 # the value represents the number of URLs tested up to now. The number of
784 # URLs tested is usually larger than the number URLS crawled because
785 # typically a crawled URL is tested with multiple test payloads.
786 "progressPercent": 42, # Output only.
787 # The percentage of total completion ranging from 0 to 100.
788 # If the scan is in queue, the value is 0.
789 # If the scan is running, the value ranges from 0 to 100.
790 # If the scan is finished, the value is 100.
791 "resultState": "A String", # Output only.
792 # The result state of the ScanRun. This field is only available after the
793 # execution state reaches "FINISHED".
794 "startTime": "A String", # Output only.
795 # The time at which the ScanRun started.
796 "endTime": "A String", # Output only.
797 # The time at which the ScanRun reached termination state - that the ScanRun
798 # is either finished or stopped by user.
799 "hasVulnerabilities": True or False, # Output only.
800 # Whether the scan run has found any vulnerabilities.
801 "urlsCrawledCount": "A String", # Output only.
802 # The number of URLs crawled during this ScanRun. If the scan is in progress,
803 # the value represents the number of URLs crawled up to now.
804 }</pre>
805</div>
806
807</body></html>