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="#close">close()</a></code></p> 94<p class="firstline">Close httplib2 connections.</p> 95<p class="toc_element"> 96 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 97<p class="firstline">Gets a ScanRun.</p> 98<p class="toc_element"> 99 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 100<p class="firstline">Lists ScanRuns under a given ScanConfig, in descending order of ScanRun stop time.</p> 101<p class="toc_element"> 102 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 103<p class="firstline">Retrieves the next page of results.</p> 104<p class="toc_element"> 105 <code><a href="#stop">stop(name, body=None, x__xgafv=None)</a></code></p> 106<p class="firstline">Stops a ScanRun. The stopped ScanRun is returned.</p> 107<h3>Method Details</h3> 108<div class="method"> 109 <code class="details" id="close">close()</code> 110 <pre>Close httplib2 connections.</pre> 111</div> 112 113<div class="method"> 114 <code class="details" id="get">get(name, x__xgafv=None)</code> 115 <pre>Gets a ScanRun. 116 117Args: 118 name: string, Required. The resource name of the ScanRun to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. (required) 119 x__xgafv: string, V1 error format. 120 Allowed values 121 1 - v1 error format 122 2 - v2 error format 123 124Returns: 125 An object of the form: 126 127 { # A ScanRun is a output-only resource representing an actual run of the scan. 128 "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user. 129 "executionState": "A String", # The execution state of the ScanRun. 130 "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities. 131 "name": "A String", # The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system. 132 "progressPercent": 42, # The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100. 133 "resultState": "A String", # The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED". 134 "startTime": "A String", # The time at which the ScanRun started. 135 "urlsCrawledCount": "A String", # The number of URLs crawled during this ScanRun. If the scan is in progress, the value represents the number of URLs crawled up to now. 136 "urlsTestedCount": "A String", # The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than the number URLS crawled because typically a crawled URL is tested with multiple test payloads. 137}</pre> 138</div> 139 140<div class="method"> 141 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> 142 <pre>Lists ScanRuns under a given ScanConfig, in descending order of ScanRun stop time. 143 144Args: 145 parent: string, Required. The parent resource name, which should be a scan resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}'. (required) 146 pageSize: integer, The maximum number of ScanRuns to return, can be limited by server. If not specified or not positive, the implementation will select a reasonable value. 147 pageToken: string, A token identifying a page of results to be returned. This should be a `next_page_token` value returned from a previous List request. If unspecified, the first page of results is returned. 148 x__xgafv: string, V1 error format. 149 Allowed values 150 1 - v1 error format 151 2 - v2 error format 152 153Returns: 154 An object of the form: 155 156 { # Response for the `ListScanRuns` method. 157 "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list. 158 "scanRuns": [ # The list of ScanRuns returned. 159 { # A ScanRun is a output-only resource representing an actual run of the scan. 160 "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user. 161 "executionState": "A String", # The execution state of the ScanRun. 162 "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities. 163 "name": "A String", # The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system. 164 "progressPercent": 42, # The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100. 165 "resultState": "A String", # The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED". 166 "startTime": "A String", # The time at which the ScanRun started. 167 "urlsCrawledCount": "A String", # The number of URLs crawled during this ScanRun. If the scan is in progress, the value represents the number of URLs crawled up to now. 168 "urlsTestedCount": "A String", # The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than the number URLS crawled because typically a crawled URL is tested with multiple test payloads. 169 }, 170 ], 171}</pre> 172</div> 173 174<div class="method"> 175 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 176 <pre>Retrieves the next page of results. 177 178Args: 179 previous_request: The request for the previous page. (required) 180 previous_response: The response from the request for the previous page. (required) 181 182Returns: 183 A request object that you can call 'execute()' on to request the next 184 page. Returns None if there are no more items in the collection. 185 </pre> 186</div> 187 188<div class="method"> 189 <code class="details" id="stop">stop(name, body=None, x__xgafv=None)</code> 190 <pre>Stops a ScanRun. The stopped ScanRun is returned. 191 192Args: 193 name: string, Required. The resource name of the ScanRun to be stopped. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. (required) 194 body: object, The request body. 195 The object takes the form of: 196 197{ # Request for the `StopScanRun` method. 198} 199 200 x__xgafv: string, V1 error format. 201 Allowed values 202 1 - v1 error format 203 2 - v2 error format 204 205Returns: 206 An object of the form: 207 208 { # A ScanRun is a output-only resource representing an actual run of the scan. 209 "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user. 210 "executionState": "A String", # The execution state of the ScanRun. 211 "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities. 212 "name": "A String", # The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system. 213 "progressPercent": 42, # The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100. 214 "resultState": "A String", # The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED". 215 "startTime": "A String", # The time at which the ScanRun started. 216 "urlsCrawledCount": "A String", # The number of URLs crawled during this ScanRun. If the scan is in progress, the value represents the number of URLs crawled up to now. 217 "urlsTestedCount": "A String", # The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than the number URLS crawled because typically a crawled URL is tested with multiple test payloads. 218}</pre> 219</div> 220 221</body></html>