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

2020-05-01 07:42:23 -0700

[diff] [blame]

83

<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

84

<p class="firstline">Creates a new ScanConfig.</p>

85

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

89

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

90

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

91

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

92

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

93

<p class="firstline">Lists ScanConfigs under a given project.</p>

94

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

98

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

99

<p class="firstline">Updates a ScanConfig. This method support partial update of a ScanConfig.</p>

100

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

105

<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

106

<pre>Creates a new ScanConfig.

107

108

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

109

parent: string, Required. The parent resource name where the scan is created, which should be a

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

110

project resource name in the format 'projects/{projectId}'. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

111

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

112

The object takes the form of:

113

114

{ # A ScanConfig resource contains the configurations to launch a scan.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

115

# next id: 12

116

"blacklistPatterns": [ # The blacklist URL patterns as described in

117

# https://cloud.google.com/security-scanner/docs/excluded-urls

118

"A String",

119

],

120

"latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.

121

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

122

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

123

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

124

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

125

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

126

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

127

# is either finished or stopped by user.

128

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

129

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

130

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

131

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

132

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

133

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

134

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

135

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

136

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

137

# execution state reaches "FINISHED".

138

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

139

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

140

# The ScanRun IDs are generated by the system.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

141

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

142

"displayName": "A String", # Required. The user provided display name of the ScanConfig.

143

"startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.

144

"A String",

145

],

146

"userAgent": "A String", # The user agent used during scanning.

147

"targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be

# used as a default.

"A String",

],

"schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.

152

"scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is

153

# refreshed by the server after each run. If unspecified, it will default

154

# to current server time, which means the scan will be scheduled to start

155

# immediately.

156

"intervalDurationDays": 42, # Required. The duration of time between executions in days.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

157

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

158

"name": "A String", # The resource name of the ScanConfig. The name follows the format of

159

# 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are

160

# generated by the system.

161

"maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20

162

# inclusively. If the field is unspecified or its value is set 0, server will

163

# default to 15. Other values outside of [5, 20] range will be rejected with

164

# INVALID_ARGUMENT error.

165

"authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the

166

# authentication configuration during scanning.

167

"googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.

168

"password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted

169

# and not returned in any response nor included in audit logs.

170

"username": "A String", # Required. The user name of the Google account.

171

},

172

"customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.

173

"password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted

174

# and not returned in any response nor included in audit logs.

175

"username": "A String", # Required. The user name of the custom account.

176

"loginUrl": "A String", # Required. The login form URL of the website.

177

},

178

},

179

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

180

181

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

188

189

{ # A ScanConfig resource contains the configurations to launch a scan.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

190

# next id: 12

191

"blacklistPatterns": [ # The blacklist URL patterns as described in

192

# https://cloud.google.com/security-scanner/docs/excluded-urls

193

"A String",

194

],

195

"latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.

196

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

197

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

198

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

199

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

200

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

201

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

202

# is either finished or stopped by user.

203

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

204

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

205

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

206

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

207

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

208

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

209

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

210

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

211

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

212

# execution state reaches "FINISHED".

213

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

214

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

215

# The ScanRun IDs are generated by the system.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

216

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

217

"displayName": "A String", # Required. The user provided display name of the ScanConfig.

218

"startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.

219

"A String",

220

],

221

"userAgent": "A String", # The user agent used during scanning.

222

"targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be

# used as a default.

"A String",

],

"schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.

227

"scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is

228

# refreshed by the server after each run. If unspecified, it will default

229

# to current server time, which means the scan will be scheduled to start

230

# immediately.

231

"intervalDurationDays": 42, # Required. The duration of time between executions in days.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

232

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

233

"name": "A String", # The resource name of the ScanConfig. The name follows the format of

234

# 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are

235

# generated by the system.

236

"maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20

237

# inclusively. If the field is unspecified or its value is set 0, server will

238

# default to 15. Other values outside of [5, 20] range will be rejected with

239

# INVALID_ARGUMENT error.

240

"authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the

241

# authentication configuration during scanning.

242

"googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.

243

"password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted

244

# and not returned in any response nor included in audit logs.

245

"username": "A String", # Required. The user name of the Google account.

246

},

247

"customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.

248

"password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted

249

# and not returned in any response nor included in audit logs.

250

"username": "A String", # Required. The user name of the custom account.

251

"loginUrl": "A String", # Required. The login form URL of the website.

252

},

253

},

254

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

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

259

<pre>Deletes an existing ScanConfig and its child resources.

260

261

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

262

name: string, Required. The resource name of the ScanConfig to be deleted. The name follows the

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

263

format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

264

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

271

272

{ # A generic empty message that you can re-use to avoid defining duplicated

273

# empty messages in your APIs. A typical example is to use it as the request

274

# or the response type of an API method. For instance:

275

#

276

# service Foo {

277

# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);

278

# }

279

#

280

# The JSON representation for `Empty` is empty JSON object `{}`.

}</pre>

</div>

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

286

<pre>Gets a ScanConfig.

287

288

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

289

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

290

format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

291

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

298

299

{ # A ScanConfig resource contains the configurations to launch a scan.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

300

# next id: 12

301

"blacklistPatterns": [ # The blacklist URL patterns as described in

302

# https://cloud.google.com/security-scanner/docs/excluded-urls

303

"A String",

304

],

305

"latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.

306

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

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.

310

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

311

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

312

# is either finished or stopped by user.

313

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

314

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

315

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

316

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

317

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

318

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

319

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

320

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

321

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

322

# execution state reaches "FINISHED".

323

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

324

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

325

# The ScanRun IDs are generated by the system.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

326

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

327

"displayName": "A String", # Required. The user provided display name of the ScanConfig.

328

"startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.

329

"A String",

330

],

331

"userAgent": "A String", # The user agent used during scanning.

332

"targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be

# used as a default.

"A String",

],

"schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.

337

"scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is

338

# refreshed by the server after each run. If unspecified, it will default

339

# to current server time, which means the scan will be scheduled to start

340

# immediately.

341

"intervalDurationDays": 42, # Required. The duration of time between executions in days.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

342

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

343

"name": "A String", # The resource name of the ScanConfig. The name follows the format of

344

# 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are

345

# generated by the system.

346

"maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20

347

# inclusively. If the field is unspecified or its value is set 0, server will

348

# default to 15. Other values outside of [5, 20] range will be rejected with

349

# INVALID_ARGUMENT error.

350

"authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the

351

# authentication configuration during scanning.

352

"googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.

353

"password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted

354

# and not returned in any response nor included in audit logs.

355

"username": "A String", # Required. The user name of the Google account.

356

},

357

"customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.

358

"password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted

359

# and not returned in any response nor included in audit logs.

360

"username": "A String", # Required. The user name of the custom account.

361

"loginUrl": "A String", # Required. The login form URL of the website.

362

},

363

},

364

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

368

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

369

<pre>Lists ScanConfigs under a given project.

370

371

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

372

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

373

format 'projects/{projectId}'. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

374

pageToken: string, A token identifying a page of results to be returned. This should be a

375

`next_page_token` value returned from a previous List request.

376

If unspecified, the first page of results is returned.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

377

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

378

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

379

reasonable value.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

380

x__xgafv: string, V1 error format.

381

Allowed values

382

1 - v1 error format

383

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

384

385

Returns:

386

An object of the form:

387

388

{ # Response for the `ListScanConfigs` method.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

389

"scanConfigs": [ # The list of ScanConfigs returned.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

390

{ # A ScanConfig resource contains the configurations to launch a scan.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

391

# next id: 12

392

"blacklistPatterns": [ # The blacklist URL patterns as described in

393

# https://cloud.google.com/security-scanner/docs/excluded-urls

394

"A String",

395

],

396

"latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.

397

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

398

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

399

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

400

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

401

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

402

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

403

# is either finished or stopped by user.

404

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

405

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

406

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

407

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

408

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

409

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

410

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

411

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

412

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

413

# execution state reaches "FINISHED".

414

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

415

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

416

# The ScanRun IDs are generated by the system.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

417

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

418

"displayName": "A String", # Required. The user provided display name of the ScanConfig.

419

"startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.

420

"A String",

421

],

422

"userAgent": "A String", # The user agent used during scanning.

423

"targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be

# used as a default.

"A String",

],

"schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.

428

"scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is

429

# refreshed by the server after each run. If unspecified, it will default

430

# to current server time, which means the scan will be scheduled to start

431

# immediately.

432

"intervalDurationDays": 42, # Required. The duration of time between executions in days.

433

},

434

"name": "A String", # The resource name of the ScanConfig. The name follows the format of

435

# 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are

436

# generated by the system.

437

"maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20

438

# inclusively. If the field is unspecified or its value is set 0, server will

439

# default to 15. Other values outside of [5, 20] range will be rejected with

440

# INVALID_ARGUMENT error.

441

"authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the

442

# authentication configuration during scanning.

443

"googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.

444

"password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted

445

# and not returned in any response nor included in audit logs.

446

"username": "A String", # Required. The user name of the Google account.

447

},

448

"customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.

449

"password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted

450

# and not returned in any response nor included in audit logs.

451

"username": "A String", # Required. The user name of the custom account.

452

"loginUrl": "A String", # Required. The login form URL of the website.

453

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

454

},

455

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

456

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

457

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

458

# more results in the list.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

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

464

<pre>Retrieves the next page of results.

465

466

Args:

467

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

468

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

469

470

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

471

A request object that you can call 'execute()' on to request the next

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

472

page. Returns None if there are no more items in the collection.

</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

477

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

478

<pre>Updates a ScanConfig. This method support partial update of a ScanConfig.

479

480

Args:

481

name: string, The resource name of the ScanConfig. The name follows the format of

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

482

'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

483

generated by the system. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

484

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

485

The object takes the form of:

486

487

{ # A ScanConfig resource contains the configurations to launch a scan.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

488

# next id: 12

489

"blacklistPatterns": [ # The blacklist URL patterns as described in

490

# https://cloud.google.com/security-scanner/docs/excluded-urls

491

"A String",

492

],

493

"latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.

494

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

495

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

496

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

497

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

498

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

499

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

500

# is either finished or stopped by user.

501

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

502

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

503

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

504

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

505

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

506

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

507

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

508

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

509

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

510

# execution state reaches "FINISHED".

511

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

512

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

513

# The ScanRun IDs are generated by the system.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

514

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

515

"displayName": "A String", # Required. The user provided display name of the ScanConfig.

516

"startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.

517

"A String",

518

],

519

"userAgent": "A String", # The user agent used during scanning.

520

"targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be

# used as a default.

"A String",

],

"schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.

525

"scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is

526

# refreshed by the server after each run. If unspecified, it will default

527

# to current server time, which means the scan will be scheduled to start

528

# immediately.

529

"intervalDurationDays": 42, # Required. The duration of time between executions in days.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

530

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

531

"name": "A String", # The resource name of the ScanConfig. The name follows the format of

532

# 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are

533

# generated by the system.

534

"maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20

535

# inclusively. If the field is unspecified or its value is set 0, server will

536

# default to 15. Other values outside of [5, 20] range will be rejected with

537

# INVALID_ARGUMENT error.

538

"authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the

539

# authentication configuration during scanning.

540

"googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.

541

"password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted

542

# and not returned in any response nor included in audit logs.

543

"username": "A String", # Required. The user name of the Google account.

544

},

545

"customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.

546

"password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted

547

# and not returned in any response nor included in audit logs.

548

"username": "A String", # Required. The user name of the custom account.

549

"loginUrl": "A String", # Required. The login form URL of the website.

550

},

551

},

552

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

553

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

554

updateMask: string, Required. The update mask applies to the resource. For the `FieldMask` definition,

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

555

see

556

https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask

557

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

564

565

{ # A ScanConfig resource contains the configurations to launch a scan.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

566

# next id: 12

567

"blacklistPatterns": [ # The blacklist URL patterns as described in

568

# https://cloud.google.com/security-scanner/docs/excluded-urls

569

"A String",

570

],

571

"latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.

572

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

573

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

574

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

575

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

576

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

577

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

578

# is either finished or stopped by user.

579

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

580

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

581

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

582

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

583

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

584

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

585

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

586

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

587

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

588

# execution state reaches "FINISHED".

589

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

590

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

591

# The ScanRun IDs are generated by the system.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

592

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

593

"displayName": "A String", # Required. The user provided display name of the ScanConfig.

594

"startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.

595

"A String",

596

],

597

"userAgent": "A String", # The user agent used during scanning.

598

"targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be

# used as a default.

"A String",

],

"schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.

603

"scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is

604

# refreshed by the server after each run. If unspecified, it will default

605

# to current server time, which means the scan will be scheduled to start

606

# immediately.

607

"intervalDurationDays": 42, # Required. The duration of time between executions in days.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

608

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

609

"name": "A String", # The resource name of the ScanConfig. The name follows the format of

610

# 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are

611

# generated by the system.

612

"maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20

613

# inclusively. If the field is unspecified or its value is set 0, server will

614

# default to 15. Other values outside of [5, 20] range will be rejected with

615

# INVALID_ARGUMENT error.

616

"authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the

617

# authentication configuration during scanning.

618

"googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.

619

"password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted

620

# and not returned in any response nor included in audit logs.

621

"username": "A String", # Required. The user name of the Google account.

622

},

623

"customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.

624

"password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted

625

# and not returned in any response nor included in audit logs.

626

"username": "A String", # Required. The user name of the custom account.

627

"loginUrl": "A String", # Required. The login form URL of the website.

628

},

629

},

630

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

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

635

<pre>Start a ScanRun according to the given ScanConfig.

636

637

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

638

name: string, Required. The resource name of the ScanConfig to be used. The name follows the

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

639

format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

640

body: object, The request body.

641

The object takes the form of:

642

643

{ # Request for the `StartScanRun` method.

644

}

645

646

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

653

654

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

655

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

656

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

657

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

658

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

659

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

660

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

661

# is either finished or stopped by user.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

662

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

663

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

664

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

665

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

666

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

667

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

668

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

669

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

670

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

671

# execution state reaches "FINISHED".

672

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

673

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

674

# The ScanRun IDs are generated by the system.

Bu Sun Kim