Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / f80be181200f4aae910badec3f4bddea08ae5044 / . / docs / dyn / containeranalysis_v1beta1.projects.notes.occurrences.html
blob: 9285ee9920c556bf0bfa21afd590efc08f1cadb6 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="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<p class="toc_element">
78 <code><a href="#list">list(name, pageToken=None, x__xgafv=None, pageSize=None, filter=None)</a></code></p>
79<p class="firstline">Lists occurrences referencing the specified note. Provider projects can use</p>
80<p class="toc_element">
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<div class="method">
85 <code class="details" id="list">list(name, pageToken=None, x__xgafv=None, pageSize=None, filter=None)</code>
86 <pre>Lists occurrences referencing the specified note. Provider projects can use
87this method to get all occurrences across consumer projects referencing the
88specified note.
89
90Args:
Dan O'Mearadd494642020-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 Kim715bd7f2019-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.
94 x__xgafv: string, V1 error format.
95 Allowed values
96 1 - v1 error format
97 2 - v2 error format
98 pageSize: integer, Number of occurrences to return in the list.
99 filter: string, The filter expression.
100
101Returns:
102 An object of the form:
103
104 { # Response for listing occurrences for a note.
105 "nextPageToken": "A String", # Token to provide to skip to a particular spot in the list.
106 "occurrences": [ # The occurrences attached to the specified note.
107 { # An instance of an analysis type that has been found on a resource.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]108 "updateTime": "A String", # Output only. The time this occurrence was last updated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]109 "resource": { # An entity that can have metadata. For example, a Docker image. # Required. Immutable. The resource for which the occurrence applies.
110 "contentHash": { # Container message for hash values. # Deprecated, do not use. Use uri instead.
111 #
112 # The hash of the resource content. For example, the Docker digest.
113 "type": "A String", # Required. The type of hash that was performed.
114 "value": "A String", # Required. The hash value.
115 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]116 "name": "A String", # Deprecated, do not use. Use uri instead.
117 #
118 # The name of the resource. For example, the name of a Docker image -
119 # "Debian".
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]122 },
123 "name": "A String", # Output only. The name of the occurrence in the form of
124 # `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.
125 "vulnerability": { # Details of a vulnerability Occurrence. # Describes a security vulnerability.
126 "cvssScore": 3.14, # Output only. The CVSS score of this vulnerability. CVSS score is on a
127 # scale of 0-10 where 0 indicates low severity and 10 indicates high
128 # severity.
129 "severity": "A String", # Output only. The note provider assigned Severity of the vulnerability.
130 "type": "A String", # The type of package; whether native or non native(ruby gems, node.js
131 # packages etc)
132 "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when it is
133 # available, and note provider assigned severity when distro has not yet
134 # assigned a severity for this vulnerability.
135 "relatedUrls": [ # Output only. URLs related to this vulnerability.
136 { # Metadata for any related URL information.
137 "url": "A String", # Specific URL associated with the resource.
138 "label": "A String", # Label to describe usage of the URL.
139 },
140 ],
141 "packageIssue": [ # Required. The set of affected locations and their fixes (if available)
142 # within the associated resource.
143 { # This message wraps a location affected by a vulnerability and its
144 # associated fix (if one is available).
145 "severityName": "A String", # Deprecated, use Details.effective_severity instead
146 # The severity (e.g., distro assigned severity) for this vulnerability.
147 "affectedLocation": { # The location of the vulnerability. # Required. The location of the vulnerability.
148 "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/)
149 # format. Examples include distro or storage location for vulnerable jar.
150 "version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.
151 "epoch": 42, # Used to correct mistakes in the version numbering scheme.
152 "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
153 # versions.
154 "name": "A String", # Required only when version kind is NORMAL. The main part of the version
155 # name.
156 "revision": "A String", # The iteration of the package build from the above version.
157 },
158 "package": "A String", # Required. The package being described.
159 },
160 "fixedLocation": { # The location of the vulnerability. # The location of the available fix for vulnerability.
161 "cpeUri": "A String", # Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/)
162 # format. Examples include distro or storage location for vulnerable jar.
163 "version": { # Version contains structured information about the version of a package. # Required. The version of the package being described.
164 "epoch": 42, # Used to correct mistakes in the version numbering scheme.
165 "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
166 # versions.
167 "name": "A String", # Required only when version kind is NORMAL. The main part of the version
168 # name.
169 "revision": "A String", # The iteration of the package build from the above version.
170 },
171 "package": "A String", # Required. The package being described.
172 },
173 },
174 ],
175 "longDescription": "A String", # Output only. A detailed description of this vulnerability.
176 "shortDescription": "A String", # Output only. A one sentence description of this vulnerability.
177 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]178 "kind": "A String", # Output only. This explicitly denotes which of the occurrence details are
179 # specified. This field can be used as a filter in list requests.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]180 "discovered": { # Details of a discovery occurrence. # Describes when a resource was discovered.
181 "discovered": { # Provides information about the analysis status of a discovered resource. # Required. Analysis status for the discovered resource.
182 "lastAnalysisTime": "A String", # The last time continuous analysis was done for this resource.
183 # Deprecated, do not use.
184 "analysisStatus": "A String", # The status of discovery for the resource.
185 "continuousAnalysis": "A String", # Whether the resource is continuously analyzed.
186 "analysisStatusError": { # The `Status` type defines a logical error model that is suitable for # When an error is encountered this will contain a LocalizedMessage under
187 # details to show to the user. The LocalizedMessage is output only and
188 # populated by the API.
189 # different programming environments, including REST APIs and RPC APIs. It is
190 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
191 # three pieces of data: error code, error message, and error details.
192 #
193 # You can find out more about this error model and how to work with it in the
194 # [API Design Guide](https://cloud.google.com/apis/design/errors).
195 "message": "A String", # A developer-facing error message, which should be in English. Any
196 # user-facing error message should be localized and sent in the
197 # google.rpc.Status.details field, or localized by the client.
198 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
199 "details": [ # A list of messages that carry the error details. There is a common set of
200 # message types for APIs to use.
201 {
202 "a_key": "", # Properties of the object. Contains field @type with type URL.
203 },
204 ],
205 },
206 },
207 },
208 "attestation": { # Details of an attestation occurrence. # Describes an attestation of an artifact.
209 "attestation": { # Occurrence that represents a single "attestation". The authenticity of an # Required. Attestation for the resource.
210 # attestation can be verified using the attached signature. If the verifier
211 # trusts the public key of the signer, then verifying the signature is
212 # sufficient to establish trust. In this circumstance, the authority to which
213 # this attestation is attached is primarily useful for look-up (how to find
214 # this attestation if you already know the authority and artifact to be
215 # verified) and intent (which authority was this attestation intended to sign
216 # for).
217 "pgpSignedAttestation": { # An attestation wrapper with a PGP-compatible signature. This message only # A PGP signed attestation.
218 # supports `ATTACHED` signatures, where the payload that is signed is included
219 # alongside the signature itself in the same file.
220 "pgpKeyId": "A String", # The cryptographic fingerprint of the key used to generate the signature,
221 # as output by, e.g. `gpg --list-keys`. This should be the version 4, full
222 # 160-bit fingerprint, expressed as a 40 character hexidecimal string. See
223 # https://tools.ietf.org/html/rfc4880#section-12.2 for details.
224 # Implementations may choose to acknowledge "LONG", "SHORT", or other
225 # abbreviated key IDs, but only the full fingerprint is guaranteed to work.
226 # In gpg, the full fingerprint can be retrieved from the `fpr` field
227 # returned when calling --list-keys with --with-colons. For example:
228 # ```
229 # gpg --with-colons --with-fingerprint --force-v4-certs \
230 # --list-keys attester@example.com
231 # tru::1:1513631572:0:3:1:5
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]232 # pub:...&lt;SNIP&gt;...
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]233 # fpr:::::::::24FF6481B76AC91E66A00AC657A93A81EF3AE6FB:
234 # ```
235 # Above, the fingerprint is `24FF6481B76AC91E66A00AC657A93A81EF3AE6FB`.
236 "contentType": "A String", # Type (for example schema) of the attestation payload that was signed.
237 # The verifier must ensure that the provided type is one that the verifier
238 # supports, and that the attestation payload is a valid instantiation of that
239 # type (for example by validating a JSON schema).
240 "signature": "A String", # Required. The raw content of the signature, as output by GNU Privacy Guard
241 # (GPG) or equivalent. Since this message only supports attached signatures,
242 # the payload that was signed must be attached. While the signature format
243 # supported is dependent on the verification implementation, currently only
244 # ASCII-armored (`--armor` to gpg), non-clearsigned (`--sign` rather than
245 # `--clearsign` to gpg) are supported. Concretely, `gpg --sign --armor
246 # --output=signature.gpg payload.json` will create the signature content
247 # expected in this field in `signature.gpg` for the `payload.json`
248 # attestation payload.
249 },
250 "genericSignedAttestation": { # An attestation wrapper that uses the Grafeas `Signature` message.
251 # This attestation must define the `serialized_payload` that the `signatures`
252 # verify and any metadata necessary to interpret that plaintext. The
253 # signatures should always be over the `serialized_payload` bytestring.
254 "signatures": [ # One or more signatures over `serialized_payload`. Verifier implementations
255 # should consider this attestation message verified if at least one
256 # `signature` verifies `serialized_payload`. See `Signature` in common.proto
257 # for more details on signature structure and verification.
258 { # Verifiers (e.g. Kritis implementations) MUST verify signatures
259 # with respect to the trust anchors defined in policy (e.g. a Kritis policy).
260 # Typically this means that the verifier has been configured with a map from
261 # `public_key_id` to public key material (and any required parameters, e.g.
262 # signing algorithm).
263 #
264 # In particular, verification implementations MUST NOT treat the signature
265 # `public_key_id` as anything more than a key lookup hint. The `public_key_id`
266 # DOES NOT validate or authenticate a public key; it only provides a mechanism
267 # for quickly selecting a public key ALREADY CONFIGURED on the verifier through
268 # a trusted channel. Verification implementations MUST reject signatures in any
269 # of the following circumstances:
270 # * The `public_key_id` is not recognized by the verifier.
271 # * The public key that `public_key_id` refers to does not verify the
272 # signature with respect to the payload.
273 #
274 # The `signature` contents SHOULD NOT be "attached" (where the payload is
275 # included with the serialized `signature` bytes). Verifiers MUST ignore any
276 # "attached" payload and only verify signatures with respect to explicitly
277 # provided payload (e.g. a `payload` field on the proto message that holds
278 # this Signature, or the canonical serialization of the proto message that
279 # holds this signature).
280 "publicKeyId": "A String", # The identifier for the public key that verifies this signature.
281 # * The `public_key_id` is required.
282 # * The `public_key_id` MUST be an RFC3986 conformant URI.
283 # * When possible, the `public_key_id` SHOULD be an immutable reference,
284 # such as a cryptographic digest.
285 #
286 # Examples of valid `public_key_id`s:
287 #
288 # OpenPGP V4 public key fingerprint:
289 # * "openpgp4fpr:74FAF3B861BDA0870C7B6DEF607E48D2A663AEEA"
290 # See https://www.iana.org/assignments/uri-schemes/prov/openpgp4fpr for more
291 # details on this scheme.
292 #
293 # RFC6920 digest-named SubjectPublicKeyInfo (digest of the DER
294 # serialization):
295 # * "ni:///sha-256;cD9o9Cq6LG3jD0iKXqEi_vdjJGecm_iXkbqVoScViaU"
296 # * "nih:///sha-256;703f68f42aba2c6de30f488a5ea122fef76324679c9bf89791ba95a1271589a5"
297 "signature": "A String", # The content of the signature, an opaque bytestring.
298 # The payload that this signature verifies MUST be unambiguously provided
299 # with the Signature during verification. A wrapper message might provide
300 # the payload explicitly. Alternatively, a message might have a canonical
301 # serialization that can always be unambiguously computed to derive the
302 # payload.
303 },
304 ],
305 "contentType": "A String", # Type (for example schema) of the attestation payload that was signed.
306 # The verifier must ensure that the provided type is one that the verifier
307 # supports, and that the attestation payload is a valid instantiation of that
308 # type (for example by validating a JSON schema).
309 "serializedPayload": "A String", # The serialized payload that is verified by one or more `signatures`.
310 # The encoding and semantic meaning of this payload must match what is set in
311 # `content_type`.
312 },
313 },
314 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]315 "intoto": { # This corresponds to a signed in-toto link - it is made up of one or more # Describes a specific in-toto link.
316 # signatures and the in-toto link itself. This is used for occurrences of a
317 # Grafeas in-toto note.
318 "signatures": [
319 { # A signature object consists of the KeyID used and the signature itself.
320 "keyid": "A String",
321 "sig": "A String",
322 },
323 ],
324 "signed": { # This corresponds to an in-toto link.
325 "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
326 # environment. It is suggested for this field to contain information that
327 # details environment variables, filesystem information, and the present
328 # working directory. The recommended structure of this field is:
329 # "environment": {
330 # "custom_values": {
331 # "variables": "&lt;ENV&gt;",
332 # "filesystem": "&lt;FS&gt;",
333 # "workdir": "&lt;CWD&gt;",
334 # "&lt;ANY OTHER RELEVANT FIELDS&gt;": "..."
335 # }
336 # }
337 # fields are "variables", "filesystem", and "workdir".
338 "customValues": {
339 "a_key": "A String",
340 },
341 },
342 "command": [ # This field contains the full command executed for the step. This can also
343 # be empty if links are generated for operations that aren't directly mapped
344 # to a specific command. Each term in the command is an independent string
345 # in the list. An example of a command in the in-toto metadata field is:
346 # "command": ["git", "clone", "https://github.com/in-toto/demo-project.git"]
347 "A String",
348 ],
349 "materials": [ # Materials are the supply chain artifacts that go into the step and are used
350 # for the operation performed. The key of the map is the path of the artifact
351 # and the structure contains the recorded hash information. An example is:
352 # "materials": [
353 # {
354 # "resource_uri": "foo/bar",
355 # "hashes": {
356 # "sha256": "ebebf...",
357 # &lt;OTHER HASH ALGORITHMS&gt;: &lt;HASH VALUE&gt;
358 # }
359 # }
360 # ]
361 {
362 "resourceUri": "A String",
363 "hashes": { # Defines a hash object for use in Materials and Products.
364 "sha256": "A String",
365 },
366 },
367 ],
368 "products": [ # Products are the supply chain artifacts generated as a result of the step.
369 # The structure is identical to that of materials.
370 {
371 "resourceUri": "A String",
372 "hashes": { # Defines a hash object for use in Materials and Products.
373 "sha256": "A String",
374 },
375 },
376 ],
377 "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
378 # are not the actual result of the step.
379 # fields are "stderr", "stdout", and "return-value".
380 "customValues": {
381 "a_key": "A String",
382 },
383 },
384 },
385 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]386 "build": { # Details of a build occurrence. # Describes a verifiable build.
387 "provenance": { # Provenance of a build. Contains all information needed to verify the full # Required. The actual provenance for the build.
388 # details about the build from source to completion.
389 "commands": [ # Commands requested by the build.
390 { # Command describes a step performed as part of the build pipeline.
391 "waitFor": [ # The ID(s) of the command(s) that this command depends on.
392 "A String",
393 ],
394 "name": "A String", # Required. Name of the command, as presented on the command line, or if the
395 # command is packaged as a Docker container, as presented to `docker pull`.
396 "args": [ # Command-line arguments used when executing this command.
397 "A String",
398 ],
399 "env": [ # Environment variables set before running this command.
400 "A String",
401 ],
402 "id": "A String", # Optional unique identifier for this command, used in wait_for to reference
403 # this command as a dependency.
404 "dir": "A String", # Working directory (relative to project source root) used when running this
405 # command.
406 },
407 ],
408 "sourceProvenance": { # Source describes the location of the source used for the build. # Details of the Source input to the build.
409 "fileHashes": { # Hash(es) of the build source, which can be used to verify that the original
410 # source integrity was maintained in the build.
411 #
412 # The keys to this map are file paths used as build source and the values
413 # contain the hash values for those files.
414 #
415 # If the build source came in a single package such as a gzipped tarfile
416 # (.tar.gz), the FileHash will be for the single path to that file.
417 "a_key": { # Container message for hashes of byte content of files, used in source
418 # messages to verify integrity of source input to the build.
419 "fileHash": [ # Required. Collection of file hashes.
420 { # Container message for hash values.
421 "type": "A String", # Required. The type of hash that was performed.
422 "value": "A String", # Required. The hash value.
423 },
424 ],
425 },
426 },
427 "artifactStorageSourceUri": "A String", # If provided, the input binary artifacts for the build came from this
428 # location.
429 "additionalContexts": [ # If provided, some of the source code used for the build may be found in
430 # these locations, in the case where the source repository had multiple
431 # remotes or submodules. This list will not include the context specified in
432 # the context field.
433 { # A SourceContext is a reference to a tree of files. A SourceContext together
434 # with a path point to a unique revision of a single file or directory.
435 "git": { # A GitSourceContext denotes a particular revision in a third party Git # A SourceContext referring to any third party Git repo (e.g., GitHub).
436 # repository (e.g., GitHub).
437 "url": "A String", # Git repository URL.
438 "revisionId": "A String", # Git commit hash.
439 },
440 "cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud # A SourceContext referring to a revision in a Google Cloud Source Repo.
441 # Source Repo.
442 "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
443 "kind": "A String", # The alias kind.
444 "name": "A String", # The alias name.
445 },
446 "revisionId": "A String", # A revision ID.
447 "repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.
448 "uid": "A String", # A server-assigned, globally unique identifier.
449 "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., # A combination of a project ID and a repo name.
450 # winged-cargo-31) and a repo name within that project.
451 "projectId": "A String", # The ID of the project.
452 "repoName": "A String", # The name of the repo. Leave empty for the default repo.
453 },
454 },
455 },
456 "labels": { # Labels with user defined metadata.
457 "a_key": "A String",
458 },
459 "gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.
460 "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
461 "kind": "A String", # The alias kind.
462 "name": "A String", # The alias name.
463 },
464 "revisionId": "A String", # A revision (commit) ID.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]465 "gerritProject": "A String", # The full project name within the host. Projects may be nested, so
466 # "project/subproject" is a valid project name. The "repo name" is the
467 # hostURI/project.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]468 "hostUri": "A String", # The URI of a running Gerrit instance.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]469 },
470 },
471 ],
472 "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.
473 # with a path point to a unique revision of a single file or directory.
474 "git": { # A GitSourceContext denotes a particular revision in a third party Git # A SourceContext referring to any third party Git repo (e.g., GitHub).
475 # repository (e.g., GitHub).
476 "url": "A String", # Git repository URL.
477 "revisionId": "A String", # Git commit hash.
478 },
479 "cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud # A SourceContext referring to a revision in a Google Cloud Source Repo.
480 # Source Repo.
481 "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
482 "kind": "A String", # The alias kind.
483 "name": "A String", # The alias name.
484 },
485 "revisionId": "A String", # A revision ID.
486 "repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.
487 "uid": "A String", # A server-assigned, globally unique identifier.
488 "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., # A combination of a project ID and a repo name.
489 # winged-cargo-31) and a repo name within that project.
490 "projectId": "A String", # The ID of the project.
491 "repoName": "A String", # The name of the repo. Leave empty for the default repo.
492 },
493 },
494 },
495 "labels": { # Labels with user defined metadata.
496 "a_key": "A String",
497 },
498 "gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.
499 "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
500 "kind": "A String", # The alias kind.
501 "name": "A String", # The alias name.
502 },
503 "revisionId": "A String", # A revision (commit) ID.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]504 "gerritProject": "A String", # The full project name within the host. Projects may be nested, so
505 # "project/subproject" is a valid project name. The "repo name" is the
506 # hostURI/project.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]507 "hostUri": "A String", # The URI of a running Gerrit instance.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]508 },
509 },
510 },
511 "buildOptions": { # Special options applied to this build. This is a catch-all field where
512 # build providers can enter any desired additional details.
513 "a_key": "A String",
514 },
515 "creator": "A String", # E-mail address of the user who initiated this build. Note that this was the
516 # user's e-mail address at the time the build was initiated; this address may
517 # not represent the same end-user for all time.
518 "projectId": "A String", # ID of the project.
519 "builderVersion": "A String", # Version string of the builder at the time this build was executed.
520 "createTime": "A String", # Time at which the build was created.
521 "builtArtifacts": [ # Output of the build.
522 { # Artifact describes a build product.
523 "checksum": "A String", # Hash or checksum value of a binary, or Docker Registry 2.0 digest of a
524 # container.
525 "id": "A String", # Artifact ID, if any; for container images, this will be a URL by digest
526 # like `gcr.io/projectID/imagename@sha256:123456`.
527 "names": [ # Related artifact names. This may be the path to a binary or jar file, or in
528 # the case of a container build, the name used to push the container image to
529 # Google Container Registry, as presented to `docker push`. Note that a
530 # single Artifact ID can have multiple names, for example if two tags are
531 # applied to one image.
532 "A String",
533 ],
534 },
535 ],
536 "triggerId": "A String", # Trigger identifier if the build was triggered automatically; empty if not.
537 "startTime": "A String", # Time at which execution of the build was started.
538 "endTime": "A String", # Time at which execution of the build was finished.
539 "id": "A String", # Required. Unique identifier of the build.
540 "logsUri": "A String", # URI where any logs for this provenance were written.
541 },
542 "provenanceBytes": "A String", # Serialized JSON representation of the provenance, used in generating the
543 # build signature in the corresponding build note. After verifying the
544 # signature, `provenance_bytes` can be unmarshalled and compared to the
545 # provenance to confirm that it is unchanged. A base64-encoded string
546 # representation of the provenance bytes is used for the signature in order
547 # to interoperate with openssl which expects this format for signature
548 # verification.
549 #
550 # The serialized form is captured both to avoid ambiguity in how the
551 # provenance is marshalled to json as well to prevent incompatibilities with
552 # future changes.
553 },
554 "deployment": { # Details of a deployment occurrence. # Describes the deployment of an artifact on a runtime.
555 "deployment": { # The period during which some deployable was active in a runtime. # Required. Deployment history for the resource.
556 "resourceUri": [ # Output only. Resource URI for the artifact being deployed taken from
557 # the deployable field with the same name.
558 "A String",
559 ],
560 "userEmail": "A String", # Identity of the user that triggered this deployment.
561 "address": "A String", # Address of the runtime element hosting this deployment.
562 "platform": "A String", # Platform hosting this deployment.
563 "deployTime": "A String", # Required. Beginning of the lifetime of this deployment.
564 "undeployTime": "A String", # End of the lifetime of this deployment.
565 "config": "A String", # Configuration used to create this deployment.
566 },
567 },
568 "remediation": "A String", # A description of actions that can be taken to remedy the note.
569 "installation": { # Details of a package occurrence. # Describes the installation of a package on the linked resource.
570 "installation": { # This represents how a particular software package may be installed on a # Required. Where the package was installed.
571 # system.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]572 "name": "A String", # Output only. The name of the installed package.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]573 "location": [ # Required. All of the places within the filesystem versions of this package
574 # have been found.
575 { # An occurrence of a particular package installation found within a system's
576 # filesystem. E.g., glibc was found in `/var/lib/dpkg/status`.
577 "path": "A String", # The path from which we gathered that this package/version is installed.
578 "cpeUri": "A String", # Required. The CPE URI in [CPE format](https://cpe.mitre.org/specification/)
579 # denoting the package manager version distributing a package.
580 "version": { # Version contains structured information about the version of a package. # The version installed at this location.
581 "epoch": 42, # Used to correct mistakes in the version numbering scheme.
582 "kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
583 # versions.
584 "name": "A String", # Required only when version kind is NORMAL. The main part of the version
585 # name.
586 "revision": "A String", # The iteration of the package build from the above version.
587 },
588 },
589 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]590 },
591 },
592 "createTime": "A String", # Output only. The time this occurrence was created.
593 "derivedImage": { # Details of an image occurrence. # Describes how this resource derives from the basis in the associated
594 # note.
595 "derivedImage": { # Derived describes the derived image portion (Occurrence) of the DockerImage # Required. Immutable. The child image derived from the base image.
596 # relationship. This image would be produced from a Dockerfile with FROM
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]597 # &lt;DockerImage.Basis in attached Note&gt;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]598 "distance": 42, # Output only. The number of layers by which this image differs from the
599 # associated image basis.
600 "baseResourceUrl": "A String", # Output only. This contains the base image URL for the derived image
601 # occurrence.
602 "layerInfo": [ # This contains layer-specific metadata, if populated it has length
603 # "distance" and is ordered with [distance] being the layer immediately
604 # following the base image and [1] being the final layer.
605 { # Layer holds metadata specific to a layer of a Docker image.
606 "arguments": "A String", # The recovered arguments to the Dockerfile directive.
607 "directive": "A String", # Required. The recovered Dockerfile directive used to construct this layer.
608 },
609 ],
610 "fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. The fingerprint of the derived image.
611 "v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1
612 # representation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]613 "v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image.
614 "A String",
615 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]616 "v2Name": "A String", # Output only. The name of the image's v2 blobs computed via:
617 # [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1])
618 # Only the name of the final blob is kept.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]619 },
620 },
621 },
622 "noteName": "A String", # Required. Immutable. The analysis note associated with this occurrence, in
623 # the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. This field can be
624 # used as a filter in list requests.
625 },
626 ],
627 }</pre>
628</div>
629
630<div class="method">
631 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
632 <pre>Retrieves the next page of results.
633
634Args:
635 previous_request: The request for the previous page. (required)
636 previous_response: The response from the request for the previous page. (required)
637
638Returns:
639 A request object that you can call 'execute()' on to request the next
640 page. Returns None if there are no more items in the collection.
641 </pre>
642</div>
643
644</body></html>