Blame - docs/dyn/containeranalysis_v1alpha1.projects.notes.occurrences.html - platform/external/python/google-api-python-client

2020-05-27 12:20:54 -0700

[diff] [blame]

78

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

Bu Sun Kim

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

[diff] [blame]

79

<p class="firstline">Lists `Occurrences` referencing the specified `Note`. Use this method to</p>

80

81

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

82

<p class="firstline">Retrieves the next page of results.</p>

83

<h3>Method Details</h3>

84

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

85

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

Bu Sun Kim

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

[diff] [blame]

86

<pre>Lists `Occurrences` referencing the specified `Note`. Use this method to

87

get all occurrences referencing your `Note` across all your customer

projects.

Args:

name: string, The name field will contain the note name for example:

Bu Sun Kim

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

[diff] [blame]

92

"provider/{provider_id}/notes/{note_id}" (required)

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

93

filter: string, The filter expression.

Bu Sun Kim

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

[diff] [blame]

94

pageToken: string, Token to provide to skip to a particular spot in the list.

Bu Sun Kim

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

[diff] [blame]

95

pageSize: integer, Number of notes to return in the list.

Bu Sun Kim

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

[diff] [blame]

96

x__xgafv: string, V1 error format.

97

Allowed values

98

1 - v1 error format

99

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

100

101

Returns:

102

An object of the form:

103

104

{ # Response including listed occurrences for a note.

Bu Sun Kim

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

[diff] [blame]

105

"occurrences": [ # The occurrences attached to the specified note.

Bu Sun Kim

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

[diff] [blame]

106

{ # `Occurrence` includes information about analysis occurrences for an image.

Bu Sun Kim

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

[diff] [blame]

107

"buildDetails": { # Message encapsulating build provenance details. # Build details for a verifiable build.

Bu Sun Kim

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

[diff] [blame]

108

"provenance": { # Provenance of a build. Contains all information needed to verify the full # The actual provenance

109

# details about the build from source to completion.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

110

"id": "A String", # Unique identifier of the build.

111

"buildOptions": { # Special options applied to this build. This is a catch-all field where

112

# build providers can enter any desired additional details.

113

"a_key": "A String",

114

},

Bu Sun Kim

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

[diff] [blame]

115

"startTime": "A String", # Time at which execution of the build was started.

116

"triggerId": "A String", # Trigger identifier if the build was triggered automatically; empty if not.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

117

"createTime": "A String", # Time at which the build was created.

Bu Sun Kim

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

[diff] [blame]

118

"sourceProvenance": { # Source describes the location of the source used for the build. # Details of the Source input to the build.

119

"repoSource": { # RepoSource describes the location of the source in a Google Cloud Source # If provided, get source from this location in a Cloud Repo.

120

# Repository.

121

"projectId": "A String", # ID of the project that owns the repo.

122

"repoName": "A String", # Name of the repo.

123

"branchName": "A String", # Name of the branch to build.

124

"tagName": "A String", # Name of the tag to build.

125

"commitSha": "A String", # Explicit commit SHA to build.

126

},

127

"storageSource": { # StorageSource describes the location of the source in an archive file in # If provided, get the source from this location in in Google Cloud

128

# Storage.

129

# Google Cloud Storage.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

130

"generation": "A String", # Google Cloud Storage generation for the object.

Bu Sun Kim

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

[diff] [blame]

131

"bucket": "A String", # Google Cloud Storage bucket containing source (see [Bucket Name

132

# Requirements]

133

# (https://cloud.google.com/storage/docs/bucket-naming#requirements)).

134

"object": "A String", # Google Cloud Storage object containing source.

Bu Sun Kim

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

[diff] [blame]

135

},

136

"fileHashes": { # Hash(es) of the build source, which can be used to verify that the original

137

# source integrity was maintained in the build.

138

#

139

# The keys to this map are file paths used as build source and the values

140

# contain the hash values for those files.

141

#

142

# If the build source came in a single package such as a gzipped tarfile

143

# (.tar.gz), the FileHash will be for the single path to that file.

144

"a_key": { # Container message for hashes of byte content of files, used in Source

145

# messages to verify integrity of source input to the build.

146

"fileHash": [ # Collection of file hashes.

147

{ # Container message for hash values.

148

"type": "A String", # The type of hash that was performed.

149

"value": "A String", # The hash value.

},

],

},

},

"artifactStorageSource": { # StorageSource describes the location of the source in an archive file in # If provided, the input binary artifacts for the build came from this

155

# location.

156

# Google Cloud Storage.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

157

"generation": "A String", # Google Cloud Storage generation for the object.

Bu Sun Kim

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

[diff] [blame]

158

"bucket": "A String", # Google Cloud Storage bucket containing source (see [Bucket Name

159

# Requirements]

160

# (https://cloud.google.com/storage/docs/bucket-naming#requirements)).

161

"object": "A String", # Google Cloud Storage object containing source.

Bu Sun Kim

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

[diff] [blame]

162

},

163

"additionalContexts": [ # If provided, some of the source code used for the build may be found in

164

# these locations, in the case where the source repository had multiple

165

# remotes or submodules. This list will not include the context specified in

166

# the context field.

167

{ # A SourceContext is a reference to a tree of files. A SourceContext together

168

# with a path point to a unique revision of a single file or directory.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

169

"labels": { # Labels with user defined metadata.

170

"a_key": "A String",

171

},

172

"git": { # A GitSourceContext denotes a particular revision in a third party Git # A SourceContext referring to any third party Git repo (e.g., GitHub).

173

# repository (e.g., GitHub).

174

"revisionId": "A String", # Required. Git commit hash.

175

"url": "A String", # Git repository URL.

176

},

177

"gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.

178

"gerritProject": "A String", # The full project name within the host. Projects may be nested, so

179

# "project/subproject" is a valid project name. The "repo name" is

180

# the hostURI/project.

181

"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.

182

"name": "A String", # The alias name.

183

"kind": "A String", # The alias kind.

184

},

185

"hostUri": "A String", # The URI of a running Gerrit instance.

186

"revisionId": "A String", # A revision (commit) ID.

187

},

Bu Sun Kim

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

[diff] [blame]

188

"cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud # A SourceContext referring to a revision in a Google Cloud Source Repo.

189

# Source Repo.

Bu Sun Kim

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

[diff] [blame]

190

"repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.

191

"uid": "A String", # A server-assigned, globally unique identifier.

192

"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., # A combination of a project ID and a repo name.

193

# winged-cargo-31) and a repo name within that project.

194

"projectId": "A String", # The ID of the project.

195

"repoName": "A String", # The name of the repo. Leave empty for the default repo.

196

},

197

},

198

"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.

199

"name": "A String", # The alias name.

200

"kind": "A String", # The alias kind.

201

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

202

"revisionId": "A String", # A revision ID.

Bu Sun Kim

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

[diff] [blame]

203

},

Bu Sun Kim

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

[diff] [blame]

204

},

205

],

Bu Sun Kim

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

[diff] [blame]

206

"context": { # A SourceContext is a reference to a tree of files. A SourceContext together # If provided, the source code used for the build came from this location.

207

# with a path point to a unique revision of a single file or directory.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

208

"labels": { # Labels with user defined metadata.

209

"a_key": "A String",

210

},

211

"git": { # A GitSourceContext denotes a particular revision in a third party Git # A SourceContext referring to any third party Git repo (e.g., GitHub).

212

# repository (e.g., GitHub).

213

"revisionId": "A String", # Required. Git commit hash.

214

"url": "A String", # Git repository URL.

215

},

216

"gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.

217

"gerritProject": "A String", # The full project name within the host. Projects may be nested, so

218

# "project/subproject" is a valid project name. The "repo name" is

219

# the hostURI/project.

220

"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.

221

"name": "A String", # The alias name.

222

"kind": "A String", # The alias kind.

223

},

224

"hostUri": "A String", # The URI of a running Gerrit instance.

225

"revisionId": "A String", # A revision (commit) ID.

226

},

Bu Sun Kim

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

[diff] [blame]

227

"cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud # A SourceContext referring to a revision in a Google Cloud Source Repo.

228

# Source Repo.

Bu Sun Kim

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

[diff] [blame]

229

"repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.

230

"uid": "A String", # A server-assigned, globally unique identifier.

231

"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., # A combination of a project ID and a repo name.

232

# winged-cargo-31) and a repo name within that project.

233

"projectId": "A String", # The ID of the project.

234

"repoName": "A String", # The name of the repo. Leave empty for the default repo.

235

},

236

},

237

"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.

238

"name": "A String", # The alias name.

239

"kind": "A String", # The alias kind.

240

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

241

"revisionId": "A String", # A revision ID.

Bu Sun Kim

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

[diff] [blame]

242

},

243

},

Bu Sun Kim

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

[diff] [blame]

244

},

Bu Sun Kim

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

[diff] [blame]

245

"projectId": "A String", # ID of the project.

246

"finishTime": "A String", # Time at which execution of the build was finished.

247

"creator": "A String", # E-mail address of the user who initiated this build. Note that this was the

248

# user's e-mail address at the time the build was initiated; this address may

249

# not represent the same end-user for all time.

250

"logsBucket": "A String", # Google Cloud Storage bucket where logs were written.

251

"builderVersion": "A String", # Version string of the builder at the time this build was executed.

252

"commands": [ # Commands requested by the build.

253

{ # Command describes a step performed as part of the build pipeline.

254

"name": "A String", # Name of the command, as presented on the command line, or if the command is

255

# packaged as a Docker container, as presented to `docker pull`.

256

"id": "A String", # Optional unique identifier for this Command, used in wait_for to reference

257

# this Command as a dependency.

258

"dir": "A String", # Working directory (relative to project source root) used when running

259

# this Command.

260

"waitFor": [ # The ID(s) of the Command(s) that this Command depends on.

261

"A String",

262

],

263

"env": [ # Environment variables set before running this Command.

264

"A String",

265

],

266

"args": [ # Command-line arguments used when executing this Command.

267

"A String",

268

],

Bu Sun Kim

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

[diff] [blame]

269

},

270

],

Bu Sun Kim

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

[diff] [blame]

271

"builtArtifacts": [ # Output of the build.

272

{ # Artifact describes a build product.

273

"id": "A String", # Artifact ID, if any; for container images, this will be a URL by digest

274

# like gcr.io/projectID/imagename@sha256:123456

275

"names": [ # Related artifact names. This may be the path to a binary or jar file, or in

276

# the case of a container build, the name used to push the container image to

277

# Google Container Registry, as presented to `docker push`. Note that a

278

# single Artifact ID can have multiple names, for example if two tags are

279

# applied to one image.

280

"A String",

281

],

282

"name": "A String", # Name of the artifact. This may be the path to a binary or jar file, or in

283

# the case of a container build, the name used to push the container image to

284

# Google Container Registry, as presented to `docker push`.

285

#

286

# This field is deprecated in favor of the plural `names` field; it continues

287

# to exist here to allow existing BuildProvenance serialized to json in

288

# google.devtools.containeranalysis.v1alpha1.BuildDetails.provenance_bytes to

289

# deserialize back into proto.

290

"checksum": "A String", # Hash or checksum value of a binary, or Docker Registry 2.0 digest of a

291

# container.

292

},

293

],

Bu Sun Kim

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

[diff] [blame]

294

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

295

"provenanceBytes": "A String", # Serialized JSON representation of the provenance, used in generating the

296

# `BuildSignature` in the corresponding Result. After verifying the

297

# signature, `provenance_bytes` can be unmarshalled and compared to the

298

# provenance to confirm that it is unchanged. A base64-encoded string

299

# representation of the provenance bytes is used for the signature in order

300

# to interoperate with openssl which expects this format for signature

301

# verification.

302

#

303

# The serialized form is captured both to avoid ambiguity in how the

304

# provenance is marshalled to json as well to prevent incompatibilities with

305

# future changes.

Bu Sun Kim

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

[diff] [blame]

306

},

Bu Sun Kim

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

[diff] [blame]

307

"kind": "A String", # Output only. This explicitly denotes which of the `Occurrence` details are

308

# specified. This field can be used as a filter in list requests.

309

"resource": { # #

310

# The resource for which the `Occurrence` applies.

311

# Resource is an entity that can have metadata. E.g., a Docker image.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

312

"uri": "A String", # The unique URI of the resource. E.g.,

313

# "https://gcr.io/project/image@sha256:foo" for a Docker image.

Bu Sun Kim

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

[diff] [blame]

314

"name": "A String", # The name of the resource. E.g., the name of a Docker image - "Debian".

315

"contentHash": { # Container message for hash values. # The hash of the resource content. E.g., the Docker digest.

316

"type": "A String", # The type of hash that was performed.

317

"value": "A String", # The hash value.

318

},

Bu Sun Kim

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

[diff] [blame]

319

},

320

"resourceUrl": "A String", # The unique URL of the image or the container for which the `Occurrence`

321

# applies. For example, https://gcr.io/project/image@sha256:foo This field

322

# can be used as a filter in list requests.

323

"name": "A String", # Output only. The name of the `Occurrence` in the form

324

# "projects/{project_id}/occurrences/{OCCURRENCE_ID}"

325

"attestation": { # Occurrence that represents a single "attestation". The authenticity of an # Describes an attestation of an artifact.

Bu Sun Kim

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

[diff] [blame]

326

# Attestation can be verified using the attached signature. If the verifier

327

# trusts the public key of the signer, then verifying the signature is

328

# sufficient to establish trust. In this circumstance, the

329

# AttestationAuthority to which this Attestation is attached is primarily

330

# useful for look-up (how to find this Attestation if you already know the

331

# Authority and artifact to be verified) and intent (which authority was this

332

# attestation intended to sign for).

Bu Sun Kim

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

[diff] [blame]

333

"pgpSignedAttestation": { # An attestation wrapper with a PGP-compatible signature.

Bu Sun Kim

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

[diff] [blame]

334

# This message only supports `ATTACHED` signatures, where the payload that is

335

# signed is included alongside the signature itself in the same file.

Bu Sun Kim

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

[diff] [blame]

336

"signature": "A String", # The raw content of the signature, as output by GNU Privacy Guard (GPG) or

337

# equivalent. Since this message only supports attached signatures, the

338

# payload that was signed must be attached. While the signature format

339

# supported is dependent on the verification implementation, currently only

340

# ASCII-armored (`--armor` to gpg), non-clearsigned (`--sign` rather than

341

# `--clearsign` to gpg) are supported. Concretely, `gpg --sign --armor

342

# --output=signature.gpg payload.json` will create the signature content

343

# expected in this field in `signature.gpg` for the `payload.json`

344

# attestation payload.

345

"pgpKeyId": "A String", # The cryptographic fingerprint of the key used to generate the signature,

Bu Sun Kim

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

[diff] [blame]

346

# as output by, e.g. `gpg --list-keys`. This should be the version 4, full

347

# 160-bit fingerprint, expressed as a 40 character hexadecimal string. See

348

# https://tools.ietf.org/html/rfc4880#section-12.2 for details.

Bu Sun Kim

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

[diff] [blame]

349

# Implementations may choose to acknowledge "LONG", "SHORT", or other

Bu Sun Kim

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

[diff] [blame]

350

# abbreviated key IDs, but only the full fingerprint is guaranteed to work.

351

# In gpg, the full fingerprint can be retrieved from the `fpr` field

352

# returned when calling --list-keys with --with-colons. For example:

353

# ```

354

# gpg --with-colons --with-fingerprint --force-v4-certs \

355

# --list-keys attester@example.com

356

# tru::1:1513631572:0:3:1:5

Dan O'Meara

dd49464

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

[diff] [blame]

357

# pub:...<SNIP>...

Bu Sun Kim

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

[diff] [blame]

358

# fpr:::::::::24FF6481B76AC91E66A00AC657A93A81EF3AE6FB:

359

# ```

360

# Above, the fingerprint is `24FF6481B76AC91E66A00AC657A93A81EF3AE6FB`.

Bu Sun Kim

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

[diff] [blame]

361

"contentType": "A String", # Type (for example schema) of the attestation payload that was signed.

Bu Sun Kim

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

[diff] [blame]

362

# The verifier must ensure that the provided type is one that the verifier

363

# supports, and that the attestation payload is a valid instantiation of that

364

# type (for example by validating a JSON schema).

Bu Sun Kim

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

[diff] [blame]

365

},

366

},

Bu Sun Kim

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

[diff] [blame]

367

"installation": { # This represents how a particular software package may be installed on # Describes the installation of a package on the linked resource.

368

# a system.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

369

"name": "A String", # Output only. The name of the installed package.

Bu Sun Kim

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

[diff] [blame]

370

"location": [ # All of the places within the filesystem versions of this package

371

# have been found.

372

{ # An occurrence of a particular package installation found within a

373

# system's filesystem.

374

# e.g. glibc was found in /var/lib/dpkg/status

375

"cpeUri": "A String", # The cpe_uri in [cpe format](https://cpe.mitre.org/specification/)

376

# denoting the package manager version distributing a package.

377

"version": { # Version contains structured information about the version of the package. # The version installed at this location.

378

# For a discussion of this in Debian/Ubuntu:

379

# http://serverfault.com/questions/604541/debian-packages-version-convention

380

# For a discussion of this in Redhat/Fedora/Centos:

381

# http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/

382

"name": "A String", # The main part of the version name.

383

"kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.

384

# If kind is not NORMAL, then the other fields are ignored.

385

"epoch": 42, # Used to correct mistakes in the version numbering scheme.

386

"revision": "A String", # The iteration of the package build from the above version.

387

},

388

"path": "A String", # The path from which we gathered that this package/version is installed.

Bu Sun Kim

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

[diff] [blame]

389

},

390

],

Bu Sun Kim

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

[diff] [blame]

391

},

392

"upgrade": { # An Upgrade Occurrence represents that a specific resource_url could install a # Describes an upgrade.

393

# specific upgrade. This presence is supplied via local sources (i.e. it is

394

# present in the mirror and the running system has noticed its availability).

Bu Sun Kim

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

[diff] [blame]

395

"package": "A String", # Required - The package this Upgrade is for.

396

"parsedVersion": { # Version contains structured information about the version of the package. # Required - The version of the package in a machine + human readable form.

397

# For a discussion of this in Debian/Ubuntu:

398

# http://serverfault.com/questions/604541/debian-packages-version-convention

399

# For a discussion of this in Redhat/Fedora/Centos:

400

# http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/

401

"name": "A String", # The main part of the version name.

402

"kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.

403

# If kind is not NORMAL, then the other fields are ignored.

404

"epoch": 42, # Used to correct mistakes in the version numbering scheme.

405

"revision": "A String", # The iteration of the package build from the above version.

Bu Sun Kim

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

[diff] [blame]

406

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

407

"distribution": { # The Upgrade Distribution represents metadata about the Upgrade for each # Metadata about the upgrade for available for the specific operating system

408

# for the resource_url. This allows efficient filtering, as well as

409

# making it easier to use the occurrence.

410

# operating system (CPE). Some distributions have additional metadata around

411

# updates, classifying them into various categories and severities.

412

"classification": "A String", # The operating system classification of this Upgrade, as specified by the

413

# upstream operating system upgrade feed.

414

"severity": "A String", # The severity as specified by the upstream operating system.

415

"cpeUri": "A String", # Required - The specific operating system this metadata applies to. See

416

# https://cpe.mitre.org/specification/.

417

"cve": [ # The cve that would be resolved by this upgrade.

418

"A String",

419

],

420

},

Bu Sun Kim

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

[diff] [blame]

421

},

Bu Sun Kim

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

[diff] [blame]

422

"discovered": { # Provides information about the scan status of a discovered resource. # Describes the initial scan status for this resource.

423

"operation": { # This resource represents a long-running operation that is the result of a # Output only. An operation that indicates the status of the current scan.

424

# This field is deprecated, do not use.

425

# network API call.

Bu Sun Kim

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

[diff] [blame]

426

"response": { # The normal response of the operation in case of success. If the original

427

# method returns no data on success, such as `Delete`, the response is

428

# `google.protobuf.Empty`. If the original method is standard

429

# `Get`/`Create`/`Update`, the response should be the resource. For other

430

# methods, the response should have the type `XxxResponse`, where `Xxx`

431

# is the original method name. For example, if the original method name

432

# is `TakeSnapshot()`, the inferred response type is

433

# `TakeSnapshotResponse`.

434

"a_key": "", # Properties of the object. Contains field @type with type URL.

435

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

436

"name": "A String", # The server-assigned name, which is only unique within the same service that

437

# originally returns it. If you use the default HTTP mapping, the

438

# `name` should be a resource name ending with `operations/{unique_id}`.

439

"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.

440

# different programming environments, including REST APIs and RPC APIs. It is

441

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

442

# three pieces of data: error code, error message, and error details.

443

#

444

# You can find out more about this error model and how to work with it in the

445

# [API Design Guide](https://cloud.google.com/apis/design/errors).

446

"details": [ # A list of messages that carry the error details. There is a common set of

447

# message types for APIs to use.

448

{

449

"a_key": "", # Properties of the object. Contains field @type with type URL.

450

},

451

],

452

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

453

"message": "A String", # A developer-facing error message, which should be in English. Any

454

# user-facing error message should be localized and sent in the

455

# google.rpc.Status.details field, or localized by the client.

456

},

457

"metadata": { # Service-specific metadata associated with the operation. It typically

458

# contains progress information and common metadata such as create time.

459

# Some services might not provide such metadata. Any method that returns a

460

# long-running operation should document the metadata type, if any.

461

"a_key": "", # Properties of the object. Contains field @type with type URL.

462

},

463

"done": True or False, # If the value is `false`, it means the operation is still in progress.

464

# If `true`, the operation is completed, and either `error` or `response` is

465

# available.

Bu Sun Kim

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

[diff] [blame]

466

},

467

"analysisStatus": "A String", # The status of discovery for the resource.

468

"continuousAnalysis": "A String", # Whether the resource is continuously analyzed.

469

"cpe": "A String", # The CPE of the resource being scanned.

470

"analysisStatusError": { # The `Status` type defines a logical error model that is suitable for # When an error is encountered this will contain a LocalizedMessage under

471

# details to show to the user. The LocalizedMessage output only and

472

# populated by the API.

473

# different programming environments, including REST APIs and RPC APIs. It is

474

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

475

# three pieces of data: error code, error message, and error details.

476

#

477

# You can find out more about this error model and how to work with it in the

478

# [API Design Guide](https://cloud.google.com/apis/design/errors).

Bu Sun Kim

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

[diff] [blame]

479

"details": [ # A list of messages that carry the error details. There is a common set of

480

# message types for APIs to use.

481

{

482

"a_key": "", # Properties of the object. Contains field @type with type URL.

483

},

484

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

485

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

486

"message": "A String", # A developer-facing error message, which should be in English. Any

487

# user-facing error message should be localized and sent in the

488

# google.rpc.Status.details field, or localized by the client.

Bu Sun Kim

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

[diff] [blame]

489

},

490

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

491

"noteName": "A String", # An analysis note associated with this image, in the form

492

# "providers/{provider_id}/notes/{NOTE_ID}"

493

# This field can be used as a filter in list requests.

Bu Sun Kim

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

[diff] [blame]

494

"deployment": { # The period during which some deployable was active in a runtime. # Describes the deployment of an artifact on a runtime.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

495

"deployTime": "A String", # Beginning of the lifetime of this deployment.

Bu Sun Kim

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

[diff] [blame]

496

"address": "A String", # Address of the runtime element hosting this deployment.

497

"resourceUri": [ # Output only. Resource URI for the artifact being deployed taken from the

498

# deployable field with the same name.

499

"A String",

500

],

Bu Sun Kim

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

[diff] [blame]

501

"config": "A String", # Configuration used to create this deployment.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

502

"userEmail": "A String", # Identity of the user that triggered this deployment.

Bu Sun Kim

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

[diff] [blame]

503

"undeployTime": "A String", # End of the lifetime of this deployment.

504

"platform": "A String", # Platform hosting this deployment.

Bu Sun Kim

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

[diff] [blame]

505

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

506

"createTime": "A String", # Output only. The time this `Occurrence` was created.

Bu Sun Kim

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

[diff] [blame]

507

"vulnerabilityDetails": { # Used by Occurrence to point to where the vulnerability exists and how # Details of a security vulnerability note.

508

# to fix it.

Bu Sun Kim

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

[diff] [blame]

509

"effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when that is

510

# available and note provider assigned severity when distro has not yet

511

# assigned a severity for this vulnerability.

512

"packageIssue": [ # The set of affected locations and their fixes (if available) within

513

# the associated resource.

514

{ # This message wraps a location affected by a vulnerability and its

515

# associated fix (if one is available).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

516

"severityName": "A String",

Bu Sun Kim

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

[diff] [blame]

517

"affectedLocation": { # The location of the vulnerability # The location of the vulnerability.

Bu Sun Kim

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

[diff] [blame]

518

"version": { # Version contains structured information about the version of the package. # The version of the package being described. This field can be used as a

519

# filter in list requests.

520

# For a discussion of this in Debian/Ubuntu:

521

# http://serverfault.com/questions/604541/debian-packages-version-convention

522

# For a discussion of this in Redhat/Fedora/Centos:

523

# http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/

524

"name": "A String", # The main part of the version name.

525

"kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.

526

# If kind is not NORMAL, then the other fields are ignored.

527

"epoch": 42, # Used to correct mistakes in the version numbering scheme.

528

"revision": "A String", # The iteration of the package build from the above version.

529

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

530

"cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/)

531

# format. Examples include distro or storage location for vulnerable jar.

532

# This field can be used as a filter in list requests.

533

"package": "A String", # The package being described.

Bu Sun Kim

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

[diff] [blame]

534

},

535

"fixedLocation": { # The location of the vulnerability # The location of the available fix for vulnerability.

Bu Sun Kim

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

[diff] [blame]

536

"version": { # Version contains structured information about the version of the package. # The version of the package being described. This field can be used as a

537

# filter in list requests.

538

# For a discussion of this in Debian/Ubuntu:

539

# http://serverfault.com/questions/604541/debian-packages-version-convention

540

# For a discussion of this in Redhat/Fedora/Centos:

541

# http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/

542

"name": "A String", # The main part of the version name.

543

"kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.

544

# If kind is not NORMAL, then the other fields are ignored.

545

"epoch": 42, # Used to correct mistakes in the version numbering scheme.

546

"revision": "A String", # The iteration of the package build from the above version.

547

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

548

"cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/)

549

# format. Examples include distro or storage location for vulnerable jar.

550

# This field can be used as a filter in list requests.

551

"package": "A String", # The package being described.

Bu Sun Kim

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

[diff] [blame]

552

},

Bu Sun Kim

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

[diff] [blame]

553

},

554

],

555

"severity": "A String", # Output only. The note provider assigned Severity of the vulnerability.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

556

"cvssScore": 3.14, # Output only. The CVSS score of this vulnerability. CVSS score is on a

557

# scale of 0-10 where 0 indicates low severity and 10 indicates high

558

# severity.

559

"type": "A String", # The type of package; whether native or non native(ruby gems,

560

# node.js packages etc)

Bu Sun Kim

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

[diff] [blame]

561

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

562

"updateTime": "A String", # Output only. The time this `Occurrence` was last updated.

563

"remediation": "A String", # A description of actions that can be taken to remedy the `Note`

564

"derivedImage": { # Derived describes the derived image portion (Occurrence) of the # Describes how this resource derives from the basis

565

# in the associated note.

566

# DockerImage relationship. This image would be produced from a Dockerfile

567

# with FROM <DockerImage.Basis in attached Note>.

568

"distance": 42, # Output only. The number of layers by which this image differs from the

569

# associated image basis.

570

"baseResourceUrl": "A String", # Output only. This contains the base image URL for the derived image

571

# occurrence.

572

"fingerprint": { # A set of properties that uniquely identify a given Docker image. # The fingerprint of the derived image.

573

"v2Blob": [ # The ordered list of v2 blobs that represent a given image.

574

"A String",

575

],

576

"v1Name": "A String", # The layer-id of the final layer in the Docker image's v1

577

# representation.

578

# This field can be used as a filter in list requests.

579

"v2Name": "A String", # Output only. The name of the image's v2 blobs computed via:

580

# [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1])

581

# Only the name of the final blob is kept.

582

# This field can be used as a filter in list requests.

583

},

584

"layerInfo": [ # This contains layer-specific metadata, if populated it has length

585

# "distance" and is ordered with [distance] being the layer immediately

586

# following the base image and [1] being the final layer.

587

{ # Layer holds metadata specific to a layer of a Docker image.

588

"directive": "A String", # The recovered Dockerfile directive used to construct this layer.

589

"arguments": "A String", # The recovered arguments to the Dockerfile directive.

590

},

591

],

592

},

Bu Sun Kim

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

[diff] [blame]

593

},

594

],

Bu Sun Kim

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

[diff] [blame]

595

"nextPageToken": "A String", # Token to receive the next page of notes.

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>

601

<pre>Retrieves the next page of results.

602

603

Args:

604

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

605

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

606

607

Returns:

Bu Sun Kim

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

[diff] [blame]

608

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

Bu Sun Kim