Blame - docs/dyn/websecurityscanner_v1.projects.scanConfigs.scanRuns.html - platform/external/python/google-api-python-client

<h1><a href="websecurityscanner_v1.html">Web Security Scanner API</a> . <a href="websecurityscanner_v1.projects.html">projects</a> . <a href="websecurityscanner_v1.projects.scanConfigs.html">scanConfigs</a> . <a href="websecurityscanner_v1.projects.scanConfigs.scanRuns.html">scanRuns</a></h1>

76

<h2>Instance Methods</h2>

77

78

<code><a href="websecurityscanner_v1.projects.scanConfigs.scanRuns.crawledUrls.html">crawledUrls()</a></code>

79

</p>

80

<p class="firstline">Returns the crawledUrls Resource.</p>

81

82

83

<code><a href="websecurityscanner_v1.projects.scanConfigs.scanRuns.findingTypeStats.html">findingTypeStats()</a></code>

84

</p>

85

<p class="firstline">Returns the findingTypeStats Resource.</p>

86

87

88

<code><a href="websecurityscanner_v1.projects.scanConfigs.scanRuns.findings.html">findings()</a></code>

89

</p>

90

<p class="firstline">Returns the findings Resource.</p>

91

92

93

<code><a href="#get">get(name, x__xgafv=None)</a></code></p>

94

<p class="firstline">Gets a ScanRun.</p>

95

96

<code><a href="#list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>

97

<p class="firstline">Lists ScanRuns under a given ScanConfig, in descending order of ScanRun</p>

98

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

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

106

<code class="details" id="get">get(name, x__xgafv=None)</code>

<pre>Gets a ScanRun.

Args:

name: string, Required. The resource name of the ScanRun to be returned. The name follows the

111

format of

112

'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. (required)

113

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

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

123

"progressPercent": 42, # Output only. The percentage of total completion ranging from 0 to 100.

124

# If the scan is in queue, the value is 0.

125

# If the scan is running, the value ranges from 0 to 100.

126

# If the scan is finished, the value is 100.

127

"executionState": "A String", # Output only. The execution state of the ScanRun.

128

"endTime": "A String", # Output only. The time at which the ScanRun reached termination state - that the ScanRun

129

# is either finished or stopped by user.

130

"startTime": "A String", # Output only. The time at which the ScanRun started.

131

"urlsCrawledCount": "A String", # Output only. The number of URLs crawled during this ScanRun. If the scan is in progress,

132

# the value represents the number of URLs crawled up to now.

133

"hasVulnerabilities": True or False, # Output only. Whether the scan run has found any vulnerabilities.

134

"urlsTestedCount": "A String", # Output only. The number of URLs tested during this ScanRun. If the scan is in progress,

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.

138

"warningTraces": [ # Output only. A list of warnings, if such are encountered during this scan run.

139

{ # Output only.

140

# Defines a warning trace message for ScanRun. Warning traces provide customers

141

# with useful information that helps make the scanning process more effective.

142

"code": "A String", # Output only. Indicates the warning code.

143

},

144

],

145

"resultState": "A String", # Output only. The result state of the ScanRun. This field is only available after the

146

# execution state reaches "FINISHED".

147

"name": "A String", # Output only. The resource name of the ScanRun. The name follows the format of

148

# 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.

149

# The ScanRun IDs are generated by the system.

150

"errorTrace": { # Output only. # Output only. 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

"scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig # Output only. If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error

154

# message encountered during scan configuration validation that is performed

155

# before each scan run.

156

# APIs when scan configuration validation fails. It is also reported as part of

157

# a ScanRunErrorTrace message if scan validation fails due to a scan

158

# configuration error.

159

"fieldName": "A String", # Output only. Indicates the full name of the ScanConfig field that triggers this error,

160

# for example "scan_config.max_qps". This field is provided for

161

# troubleshooting purposes only and its actual value can change in the

162

# future.

163

"code": "A String", # Output only. Indicates the reason code for a configuration failure.

164

},

165

"mostCommonHttpErrorCode": 42, # Output only. If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most

166

# common HTTP error code, if such is available. For example, if this code is

167

# 404, the scan has encountered too many NOT_FOUND responses.

168

"code": "A String", # Output only. Indicates the error reason code.

},

}</pre>

</div>

<code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code>

175

<pre>Lists ScanRuns under a given ScanConfig, in descending order of ScanRun

stop time.

Args:

parent: string, Required. The parent resource name, which should be a scan resource name in the

180

format '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.

183

If unspecified, the first page of results is returned.

184

pageSize: integer, The maximum number of ScanRuns to return, can be limited by server.

185

If not specified or not positive, the implementation will select a

186

reasonable value.

187

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

194

195

{ # Response for the `ListScanRuns` method.

196

"scanRuns": [ # The list of ScanRuns returned.

197

{ # A ScanRun is a output-only resource representing an actual run of the scan.

198

# Next id: 12

199

"progressPercent": 42, # Output only. The percentage of total completion ranging from 0 to 100.

200

# If the scan is in queue, the value is 0.

201

# If the scan is running, the value ranges from 0 to 100.

202

# If the scan is finished, the value is 100.

203

"executionState": "A String", # Output only. The execution state of the ScanRun.

204

"endTime": "A String", # Output only. The time at which the ScanRun reached termination state - that the ScanRun

205

# is either finished or stopped by user.

206

"startTime": "A String", # Output only. The time at which the ScanRun started.

207

"urlsCrawledCount": "A String", # Output only. The number of URLs crawled during this ScanRun. If the scan is in progress,

208

# the value represents the number of URLs crawled up to now.

209

"hasVulnerabilities": True or False, # Output only. Whether the scan run has found any vulnerabilities.

210

"urlsTestedCount": "A String", # Output only. The number of URLs tested during this ScanRun. If the scan is in progress,

211

# the value represents the number of URLs tested up to now. The number of

212

# URLs tested is usually larger than the number URLS crawled because

213

# typically a crawled URL is tested with multiple test payloads.

214

"warningTraces": [ # Output only. A list of warnings, if such are encountered during this scan run.

215

{ # Output only.

216

# Defines a warning trace message for ScanRun. Warning traces provide customers

217

# with useful information that helps make the scanning process more effective.

218

"code": "A String", # Output only. Indicates the warning code.

219

},

220

],

221

"resultState": "A String", # Output only. The result state of the ScanRun. This field is only available after the

222

# execution state reaches "FINISHED".

223

"name": "A String", # Output only. The resource name of the ScanRun. The name follows the format of

224

# 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.

225

# The ScanRun IDs are generated by the system.

226

"errorTrace": { # Output only. # Output only. If result_state is an ERROR, this field provides the primary reason for

227

# scan's termination and more details, if such are available.

228

# Defines an error trace message for a ScanRun.

229

"scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig # Output only. If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error

230

# message encountered during scan configuration validation that is performed

231

# before each scan run.

232

# APIs when scan configuration validation fails. It is also reported as part of

233

# a ScanRunErrorTrace message if scan validation fails due to a scan

234

# configuration error.

235

"fieldName": "A String", # Output only. Indicates the full name of the ScanConfig field that triggers this error,

236

# for example "scan_config.max_qps". This field is provided for

237

# troubleshooting purposes only and its actual value can change in the

238

# future.

239

"code": "A String", # Output only. Indicates the reason code for a configuration failure.

240

},

241

"mostCommonHttpErrorCode": 42, # Output only. If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most

242

# common HTTP error code, if such is available. For example, if this code is

243

# 404, the scan has encountered too many NOT_FOUND responses.

244

"code": "A String", # Output only. Indicates the error reason code.

},

},

],

"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no

249

# more results in the list.

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

255

<pre>Retrieves the next page of results.

256

257

Args:

258

previous_request: The request for the previous page. (required)

259

previous_response: The response from the request for the previous page. (required)

260

261

Returns:

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.

</pre>

</div>

<code class="details" id="stop">stop(name, body=None, x__xgafv=None)</code>

269

<pre>Stops a ScanRun. The stopped ScanRun is returned.

270

271

Args:

272

name: string, Required. The resource name of the ScanRun to be stopped. The name follows the

273

format 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.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

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

291

"progressPercent": 42, # Output only. The percentage of total completion ranging from 0 to 100.

292

# If the scan is in queue, the value is 0.

293

# If the scan is running, the value ranges from 0 to 100.

294

# If the scan is finished, the value is 100.

295

"executionState": "A String", # Output only. The execution state of the ScanRun.

296

"endTime": "A String", # Output only. The time at which the ScanRun reached termination state - that the ScanRun

297

# is either finished or stopped by user.

298

"startTime": "A String", # Output only. The time at which the ScanRun started.

299

"urlsCrawledCount": "A String", # Output only. The number of URLs crawled during this ScanRun. If the scan is in progress,

300

# the value represents the number of URLs crawled up to now.

301

"hasVulnerabilities": True or False, # Output only. Whether the scan run has found any vulnerabilities.

302

"urlsTestedCount": "A String", # Output only. The number of URLs tested during this ScanRun. If the scan is in progress,

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.

306

"warningTraces": [ # Output only. A list of warnings, if such are encountered during this scan run.

307

{ # Output only.

308

# Defines a warning trace message for ScanRun. Warning traces provide customers

309

# with useful information that helps make the scanning process more effective.

310

"code": "A String", # Output only. Indicates the warning code.

311

},

312

],

313

"resultState": "A String", # Output only. The result state of the ScanRun. This field is only available after the

314

# execution state reaches "FINISHED".

315

"name": "A String", # Output only. The resource name of the ScanRun. The name follows the format of

316

# 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.

317

# The ScanRun IDs are generated by the system.

318

"errorTrace": { # Output only. # Output only. If result_state is an ERROR, this field provides the primary reason for

319

# scan's termination and more details, if such are available.

320

# Defines an error trace message for a ScanRun.

321

"scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig # Output only. If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error

322

# message encountered during scan configuration validation that is performed

323

# before each scan run.

324

# APIs when scan configuration validation fails. It is also reported as part of

325

# a ScanRunErrorTrace message if scan validation fails due to a scan

326

# configuration error.

327

"fieldName": "A String", # Output only. Indicates the full name of the ScanConfig field that triggers this error,