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

<h1><a href="containeranalysis_v1beta1.html">Container Analysis API</a> . <a href="containeranalysis_v1beta1.projects.html">projects</a> . <a href="containeranalysis_v1beta1.projects.notes.html">notes</a> . <a href="containeranalysis_v1beta1.projects.notes.occurrences.html">occurrences</a></h1>

76

<h2>Instance Methods</h2>

77

Bu Sun Kim

6502091

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

[diff] [blame]

78

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

Bu Sun Kim

715bd7f

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

[diff] [blame]

79

<p class="firstline">Lists occurrences referencing the specified note. Provider projects can use</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

6502091

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

[diff] [blame]

85

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

Bu Sun Kim

715bd7f

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

[diff] [blame]

86

<pre>Lists occurrences referencing the specified note. Provider projects can use

87

this method to get all occurrences across consumer projects referencing the

88

specified note.

89

90

Args:

Dan O'Meara

dd49464

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

[diff] [blame]

91

name: string, Required. The name of the note to list occurrences for in the form of

Bu Sun Kim

715bd7f

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

[diff] [blame]

92

`projects/[PROVIDER_ID]/notes/[NOTE_ID]`. (required)

93

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

Bu Sun Kim

6502091

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

[diff] [blame]

94

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

95

filter: string, The filter expression.

Bu Sun Kim

715bd7f

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

715bd7f

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

[diff] [blame]

100

101

Returns:

102

An object of the form:

103

104

{ # Response for listing occurrences for a note.

Bu Sun Kim

6502091

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

[diff] [blame]

105

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

Bu Sun Kim

715bd7f

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

[diff] [blame]

106

{ # An instance of an analysis type that has been found on a resource.

Bu Sun Kim

4ed7d3f

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

[diff] [blame^]

107

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

108

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

109

"resource": { # An entity that can have metadata. For example, a Docker image. # Required. Immutable. The resource for which the occurrence applies.

110

"name": "A String", # Deprecated, do not use. Use uri instead.

111

#

112

# The name of the resource. For example, the name of a Docker image -

113

# "Debian".

114

"contentHash": { # Container message for hash values. # Deprecated, do not use. Use uri instead.

115

#

116

# The hash of the resource content. For example, the Docker digest.

117

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

118

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

119

},

120

"uri": "A String", # Required. The unique URI of the resource. For example,

121

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

122

},

123

"attestation": { # Details of an attestation occurrence. # Describes an attestation of an artifact.

124

"attestation": { # Occurrence that represents a single "attestation". The authenticity of an # Required. Attestation for the resource.

125

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

126

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

127

# sufficient to establish trust. In this circumstance, the authority to which

128

# this attestation is attached is primarily useful for look-up (how to find

129

# this attestation if you already know the authority and artifact to be

130

# verified) and intent (which authority was this attestation intended to sign

131

# for).

132

"pgpSignedAttestation": { # An attestation wrapper with a PGP-compatible signature. This message only # A PGP signed attestation.

133

# supports `ATTACHED` signatures, where the payload that is signed is included

134

# alongside the signature itself in the same file.

135

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

136

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

137

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

138

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

139

"signature": "A String", # Required. The raw content of the signature, as output by GNU Privacy Guard

140

# (GPG) or equivalent. Since this message only supports attached signatures,

141

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

142

# supported is dependent on the verification implementation, currently only

143

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

144

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

145

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

146

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

147

# attestation payload.

148

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

149

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

150

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

151

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

152

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

153

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

154

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

155

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

156

# ```

157

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

158

# --list-keys attester@example.com

159

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

160

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

161

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

162

# ```

163

# Above, the fingerprint is `24FF6481B76AC91E66A00AC657A93A81EF3AE6FB`.

164

},

165

"genericSignedAttestation": { # An attestation wrapper that uses the Grafeas `Signature` message.

166

# This attestation must define the `serialized_payload` that the `signatures`

167

# verify and any metadata necessary to interpret that plaintext. The

168

# signatures should always be over the `serialized_payload` bytestring.

169

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

170

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

171

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

172

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

173

"signatures": [ # One or more signatures over `serialized_payload`. Verifier implementations

174

# should consider this attestation message verified if at least one

175

# `signature` verifies `serialized_payload`. See `Signature` in common.proto

176

# for more details on signature structure and verification.

177

{ # Verifiers (e.g. Kritis implementations) MUST verify signatures

178

# with respect to the trust anchors defined in policy (e.g. a Kritis policy).

179

# Typically this means that the verifier has been configured with a map from

180

# `public_key_id` to public key material (and any required parameters, e.g.

181

# signing algorithm).

182

#

183

# In particular, verification implementations MUST NOT treat the signature

184

# `public_key_id` as anything more than a key lookup hint. The `public_key_id`

185

# DOES NOT validate or authenticate a public key; it only provides a mechanism

186

# for quickly selecting a public key ALREADY CONFIGURED on the verifier through

187

# a trusted channel. Verification implementations MUST reject signatures in any

188

# of the following circumstances:

189

# * The `public_key_id` is not recognized by the verifier.

190

# * The public key that `public_key_id` refers to does not verify the

191

# signature with respect to the payload.

192

#

193

# The `signature` contents SHOULD NOT be "attached" (where the payload is

194

# included with the serialized `signature` bytes). Verifiers MUST ignore any

195

# "attached" payload and only verify signatures with respect to explicitly

196

# provided payload (e.g. a `payload` field on the proto message that holds

197

# this Signature, or the canonical serialization of the proto message that

198

# holds this signature).

199

"publicKeyId": "A String", # The identifier for the public key that verifies this signature.

200

# * The `public_key_id` is required.

201

# * The `public_key_id` MUST be an RFC3986 conformant URI.

202

# * When possible, the `public_key_id` SHOULD be an immutable reference,

203

# such as a cryptographic digest.

204

#

205

# Examples of valid `public_key_id`s:

206

#

207

# OpenPGP V4 public key fingerprint:

208

# * "openpgp4fpr:74FAF3B861BDA0870C7B6DEF607E48D2A663AEEA"

209

# See https://www.iana.org/assignments/uri-schemes/prov/openpgp4fpr for more

210

# details on this scheme.

211

#

212

# RFC6920 digest-named SubjectPublicKeyInfo (digest of the DER

213

# serialization):

214

# * "ni:///sha-256;cD9o9Cq6LG3jD0iKXqEi_vdjJGecm_iXkbqVoScViaU"

215

# * "nih:///sha-256;703f68f42aba2c6de30f488a5ea122fef76324679c9bf89791ba95a1271589a5"

216

"signature": "A String", # The content of the signature, an opaque bytestring.

217

# The payload that this signature verifies MUST be unambiguously provided

218

# with the Signature during verification. A wrapper message might provide

219

# the payload explicitly. Alternatively, a message might have a canonical

220

# serialization that can always be unambiguously computed to derive the

# payload.

},

],

"serializedPayload": "A String", # The serialized payload that is verified by one or more `signatures`.

225

# The encoding and semantic meaning of this payload must match what is set in

# `content_type`.

},

},

},

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

231

# `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.

232

"vulnerability": { # Details of a vulnerability Occurrence. # Describes a security vulnerability.

233

"longDescription": "A String", # Output only. A detailed description of this vulnerability.

234

"shortDescription": "A String", # Output only. A one sentence description of this vulnerability.

235

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

236

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

237

# assigned a severity for this vulnerability.

238

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

239

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

240

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

241

# severity.

242

"relatedUrls": [ # Output only. URLs related to this vulnerability.

243

{ # Metadata for any related URL information.

244

"url": "A String", # Specific URL associated with the resource.

245

"label": "A String", # Label to describe usage of the URL.

246

},

247

],

248

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

249

# packages etc)

250

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

251

# within the associated resource.

252

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

253

# associated fix (if one is available).

254

"severityName": "A String", # Deprecated, use Details.effective_severity instead

255

# The severity (e.g., distro assigned severity) for this vulnerability.

256

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

257

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

258

"version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.

259

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

260

"name": "A String", # Required only when version kind is NORMAL. The main part of the version

261

# name.

262

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

263

# versions.

264

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

265

},

266

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

267

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

268

},

269

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

270

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

271

"version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.

272

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

273

"name": "A String", # Required only when version kind is NORMAL. The main part of the version

274

# name.

275

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

276

# versions.

277

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

278

},

279

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

280

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

},

},

],

},

"installation": { # Details of a package occurrence. # Describes the installation of a package on the linked resource.

286

"installation": { # This represents how a particular software package may be installed on a # Required. Where the package was installed.

287

# system.

288

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

289

# have been found.

290

{ # An occurrence of a particular package installation found within a system's

291

# filesystem. E.g., glibc was found in `/var/lib/dpkg/status`.

292

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

293

# denoting the package manager version distributing a package.

294

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

295

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

296

"name": "A String", # Required only when version kind is NORMAL. The main part of the version

297

# name.

298

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

299

# versions.

300

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

301

},

302

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

303

},

304

],

305

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

306

},

307

},

308

"build": { # Details of a build occurrence. # Describes a verifiable build.

309

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

310

# build signature in the corresponding build note. After verifying the

311

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

312

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

313

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

314

# to interoperate with openssl which expects this format for signature

315

# verification.

316

#

317

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

318

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

319

# future changes.

320

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

321

# details about the build from source to completion.

322

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

323

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

324

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

325

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

326

"artifactStorageSourceUri": "A String", # If provided, the input binary artifacts for the build came from this

327

# location.

328

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

329

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

330

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

331

# the context field.

332

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

333

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

334

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

335

"a_key": "A String",

336

},

337

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

338

# repository (e.g., GitHub).

339

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

340

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

341

},

342

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

343

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

344

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

345

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

346

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

347

# hostURI/project.

348

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

349

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

350

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

351

},

352

},

353

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

354

# Source Repo.

355

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

356

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

357

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

358

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

359

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

360

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

361

},

362

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

363

},

364

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

365

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

366

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

},

},

},

],

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

372

# source integrity was maintained in the build.

373

#

374

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

375

# contain the hash values for those files.

376

#

377

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

378

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

379

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

380

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

381

"fileHash": [ # Required. Collection of file hashes.

382

{ # Container message for hash values.

383

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

384

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

},

],

},

},

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

390

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

391

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

392

"a_key": "A String",

393

},

394

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

395

# repository (e.g., GitHub).

396

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

397

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

398

},

399

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

400

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

401

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

402

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

403

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

404

# hostURI/project.

405

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

406

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

407

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

408

},

409

},

410

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

411

# Source Repo.

412

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

413

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

414

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

415

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

416

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

417

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

418

},

419

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

420

},

421

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

422

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

423

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

},

},

},

},

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

429

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

430

"logsUri": "A String", # URI where any logs for this provenance were written.

431

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

432

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

433

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

434

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

435

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

436

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

437

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

438

# command.

439

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

440

"A String",

441

],

442

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

443

"A String",

444

],

445

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

446

"A String",

447

],

448

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

449

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

450

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

451

# this command as a dependency.

452

},

453

],

454

"builtArtifacts": [ # Output of the build.

455

{ # Artifact describes a build product.

456

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

457

# container.

458

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

459

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

460

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

461

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

462

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

463

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

464

# applied to one image.

"A String",

],

},

],

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

470

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

471

# build providers can enter any desired additional details.

"a_key": "A String",

},

},

},

"discovered": { # Details of a discovery occurrence. # Describes when a resource was discovered.

477

"discovered": { # Provides information about the analysis status of a discovered resource. # Required. Analysis status for the discovered resource.

478

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

479

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

480

# populated by the API.

481

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

482

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

483

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

484

#

485

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

486

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

487

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

488

# message types for APIs to use.

489

{

490

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

491

},

492

],

493

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

494

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

495

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

496

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

497

},

498

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

499

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

500

"lastAnalysisTime": "A String", # The last time continuous analysis was done for this resource.

501

# Deprecated, do not use.

502

},

503

},

504

"noteName": "A String", # Required. Immutable. The analysis note associated with this occurrence, in

505

# the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. This field can be

506

# used as a filter in list requests.

507

"deployment": { # Details of a deployment occurrence. # Describes the deployment of an artifact on a runtime.

508

"deployment": { # The period during which some deployable was active in a runtime. # Required. Deployment history for the resource.

509

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

510

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

511

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

512

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

513

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

514

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

515

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

516

# the deployable field with the same name.

"A String",

],

},

},

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

Bu Sun Kim

6502091

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

[diff] [blame]

522

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

523

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

524

"intoto": { # This corresponds to a signed in-toto link - it is made up of one or more # Describes a specific in-toto link.

525

# signatures and the in-toto link itself. This is used for occurrences of a

526

# Grafeas in-toto note.

527

"signed": { # This corresponds to an in-toto link.

528

"command": [ # This field contains the full command executed for the step. This can also

529

# be empty if links are generated for operations that aren't directly mapped

530

# to a specific command. Each term in the command is an independent string

531

# in the list. An example of a command in the in-toto metadata field is:

532

# "command": ["git", "clone", "https://github.com/in-toto/demo-project.git"]

533

"A String",

534

],

535

"byproducts": { # Defines an object for the byproducts field in in-toto links. The suggested # ByProducts are data generated as part of a software supply chain step, but

536

# are not the actual result of the step.

537

# fields are "stderr", "stdout", and "return-value".

"customValues": {

"a_key": "A String",

},

},

"environment": { # Defines an object for the environment field in in-toto links. The suggested # This is a field that can be used to capture information about the

543

# environment. It is suggested for this field to contain information that

544

# details environment variables, filesystem information, and the present

545

# working directory. The recommended structure of this field is:

546

# "environment": {

547

# "custom_values": {

548

# "variables": "<ENV>",

549

# "filesystem": "<FS>",

550

# "workdir": "<CWD>",

551

# "<ANY OTHER RELEVANT FIELDS>": "..."

552

# }

553

# }

554

# fields are "variables", "filesystem", and "workdir".

"customValues": {

"a_key": "A String",

},

},

"materials": [ # Materials are the supply chain artifacts that go into the step and are used

560

# for the operation performed. The key of the map is the path of the artifact

561

# and the structure contains the recorded hash information. An example is:

562

# "materials": [

563

# {

564

# "resource_uri": "foo/bar",

565

# "hashes": {

566

# "sha256": "ebebf...",

567

# <OTHER HASH ALGORITHMS>: <HASH VALUE>

# }

# }

# ]

{

"hashes": { # Defines a hash object for use in Materials and Products.

573

"sha256": "A String",

574

},

575

"resourceUri": "A String",

576

},

577

],

578

"products": [ # Products are the supply chain artifacts generated as a result of the step.

579

# The structure is identical to that of materials.

580

{

581

"hashes": { # Defines a hash object for use in Materials and Products.

582

"sha256": "A String",

583

},

584

"resourceUri": "A String",

585

},

586

],

Bu Sun Kim

715bd7f

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

[diff] [blame]

587

},

Bu Sun Kim

6502091

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

[diff] [blame]

588

"signatures": [

589

{ # A signature object consists of the KeyID used and the signature itself.

590

"sig": "A String",

591

"keyid": "A String",

Bu Sun Kim

715bd7f

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

[diff] [blame]

592

},

593

],

Bu Sun Kim

715bd7f

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

[diff] [blame]

594

},

Bu Sun Kim

6502091

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

[diff] [blame]

595

"derivedImage": { # Details of an image occurrence. # Describes how this resource derives from the basis in the associated

596

# note.

597

"derivedImage": { # Derived describes the derived image portion (Occurrence) of the DockerImage # Required. Immutable. The child image derived from the base image.

598

# relationship. This image would be produced from a Dockerfile with FROM

599

# <DockerImage.Basis in attached Note>.

600

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

Bu Sun Kim

4ed7d3f

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

[diff] [blame^]

601

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

602

"A String",

603

],

Bu Sun Kim

6502091

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

[diff] [blame]

604

"v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1

605

# representation.

606

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

607

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

608

# Only the name of the final blob is kept.

Bu Sun Kim

715bd7f

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

[diff] [blame]

609

},

Bu Sun Kim

6502091

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

[diff] [blame]

610

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

611

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

612

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

613

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

614

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

615

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

616

},

617

],

618

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

619

# associated image basis.

620

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

621

# occurrence.

Bu Sun Kim

715bd7f

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

[diff] [blame]

622

},

623

},

Bu Sun Kim

715bd7f

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

[diff] [blame]

624

},

625

],

Bu Sun Kim

6502091

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

[diff] [blame]

626

"nextPageToken": "A String", # Token to provide to skip to a particular spot in the list.

Bu Sun Kim

715bd7f

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

[diff] [blame]

}</pre>

</div>

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

632

<pre>Retrieves the next page of results.

633

634

Args:

635

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

636

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

637

638

Returns:

Bu Sun Kim

6502091

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

[diff] [blame]

639

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

Bu Sun Kim

715bd7f

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

[diff] [blame]

640

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

</pre>

</div>

</body></html>