Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / containeranalysis_v1alpha1.projects.notes.occurrences.html
blob: 59cef8a096c11d78d96ebbf28514de3f2f4b79da [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_v1alpha1.html">Container Analysis API</a> . <a href="containeranalysis_v1alpha1.projects.html">projects</a> . <a href="containeranalysis_v1alpha1.projects.notes.html">notes</a> . <a href="containeranalysis_v1alpha1.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`. Use this method to</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`. Use this method to
87get all occurrences referencing your `Note` across all your customer
88projects.
89
90Args:
91 name: string, The name field will contain the note name for example:
92 "provider/{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 notes to return in the list.
99 filter: string, The filter expression.
100
101Returns:
102 An object of the form:
103
104 { # Response including listed occurrences for a note.
105 "nextPageToken": "A String", # Token to receive the next page of notes.
106 "occurrences": [ # The occurrences attached to the specified note.
107 { # `Occurrence` includes information about analysis occurrences for an image.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]108 "vulnerabilityDetails": { # Used by Occurrence to point to where the vulnerability exists and how # Details of a security vulnerability note.
109 # to fix it.
110 "packageIssue": [ # The set of affected locations and their fixes (if available) within
111 # the associated resource.
112 { # This message wraps a location affected by a vulnerability and its
113 # associated fix (if one is available).
114 "severityName": "A String",
115 "affectedLocation": { # The location of the vulnerability # The location of the vulnerability.
116 "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/)
117 # format. Examples include distro or storage location for vulnerable jar.
118 # This field can be used as a filter in list requests.
119 "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
120 # filter in list requests.
121 # For a discussion of this in Debian/Ubuntu:
122 # http://serverfault.com/questions/604541/debian-packages-version-convention
123 # For a discussion of this in Redhat/Fedora/Centos:
124 # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
125 "epoch": 42, # Used to correct mistakes in the version numbering scheme.
126 "name": "A String", # The main part of the version name.
127 "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
128 # If kind is not NORMAL, then the other fields are ignored.
129 "revision": "A String", # The iteration of the package build from the above version.
130 },
131 "package": "A String", # The package being described.
132 },
133 "fixedLocation": { # The location of the vulnerability # The location of the available fix for vulnerability.
134 "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/)
135 # format. Examples include distro or storage location for vulnerable jar.
136 # This field can be used as a filter in list requests.
137 "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
138 # filter in list requests.
139 # For a discussion of this in Debian/Ubuntu:
140 # http://serverfault.com/questions/604541/debian-packages-version-convention
141 # For a discussion of this in Redhat/Fedora/Centos:
142 # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
143 "epoch": 42, # Used to correct mistakes in the version numbering scheme.
144 "name": "A String", # The main part of the version name.
145 "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
146 # If kind is not NORMAL, then the other fields are ignored.
147 "revision": "A String", # The iteration of the package build from the above version.
148 },
149 "package": "A String", # The package being described.
150 },
151 },
152 ],
153 "type": "A String", # The type of package; whether native or non native(ruby gems,
154 # node.js packages etc)
155 "cvssScore": 3.14, # Output only. The CVSS score of this vulnerability. CVSS score is on a
156 # scale of 0-10 where 0 indicates low severity and 10 indicates high
157 # severity.
158 "severity": "A String", # Output only. The note provider assigned Severity of the vulnerability.
159 "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when that is
160 # available and note provider assigned severity when distro has not yet
161 # assigned a severity for this vulnerability.
162 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]163 "resource": { # #
164 # The resource for which the `Occurrence` applies.
165 # Resource is an entity that can have metadata. E.g., a Docker image.
166 "contentHash": { # Container message for hash values. # The hash of the resource content. E.g., the Docker digest.
167 "type": "A String", # The type of hash that was performed.
168 "value": "A String", # The hash value.
169 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]170 "name": "A String", # The name of the resource. E.g., the name of a Docker image - "Debian".
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]171 "uri": "A String", # The unique URI of the resource. E.g.,
172 # "https://gcr.io/project/image@sha256:foo" for a Docker image.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]173 },
174 "updateTime": "A String", # Output only. The time this `Occurrence` was last updated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]175 "upgrade": { # An Upgrade Occurrence represents that a specific resource_url could install a # Describes an upgrade.
176 # specific upgrade. This presence is supplied via local sources (i.e. it is
177 # present in the mirror and the running system has noticed its availability).
178 "distribution": { # The Upgrade Distribution represents metadata about the Upgrade for each # Metadata about the upgrade for available for the specific operating system
179 # for the resource_url. This allows efficient filtering, as well as
180 # making it easier to use the occurrence.
181 # operating system (CPE). Some distributions have additional metadata around
182 # updates, classifying them into various categories and severities.
183 "cpeUri": "A String", # Required - The specific operating system this metadata applies to. See
184 # https://cpe.mitre.org/specification/.
185 "cve": [ # The cve that would be resolved by this upgrade.
186 "A String",
187 ],
188 "severity": "A String", # The severity as specified by the upstream operating system.
189 "classification": "A String", # The operating system classification of this Upgrade, as specified by the
190 # upstream operating system upgrade feed.
191 },
192 "parsedVersion": { # Version contains structured information about the version of the package. # Required - The version of the package in a machine + human readable form.
193 # For a discussion of this in Debian/Ubuntu:
194 # http://serverfault.com/questions/604541/debian-packages-version-convention
195 # For a discussion of this in Redhat/Fedora/Centos:
196 # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
197 "epoch": 42, # Used to correct mistakes in the version numbering scheme.
198 "name": "A String", # The main part of the version name.
199 "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
200 # If kind is not NORMAL, then the other fields are ignored.
201 "revision": "A String", # The iteration of the package build from the above version.
202 },
203 "package": "A String", # Required - The package this Upgrade is for.
204 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]205 "installation": { # This represents how a particular software package may be installed on # Describes the installation of a package on the linked resource.
206 # a system.
207 "location": [ # All of the places within the filesystem versions of this package
208 # have been found.
209 { # An occurrence of a particular package installation found within a
210 # system's filesystem.
211 # e.g. glibc was found in /var/lib/dpkg/status
212 "path": "A String", # The path from which we gathered that this package/version is installed.
213 "cpeUri": "A String", # The cpe_uri in [cpe format](https://cpe.mitre.org/specification/)
214 # denoting the package manager version distributing a package.
215 "version": { # Version contains structured information about the version of the package. # The version installed at this location.
216 # For a discussion of this in Debian/Ubuntu:
217 # http://serverfault.com/questions/604541/debian-packages-version-convention
218 # For a discussion of this in Redhat/Fedora/Centos:
219 # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]220 "epoch": 42, # Used to correct mistakes in the version numbering scheme.
221 "name": "A String", # The main part of the version name.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]222 "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
223 # If kind is not NORMAL, then the other fields are ignored.
224 "revision": "A String", # The iteration of the package build from the above version.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]225 },
226 },
227 ],
228 "name": "A String", # Output only. The name of the installed package.
229 },
230 "name": "A String", # Output only. The name of the `Occurrence` in the form
231 # "projects/{project_id}/occurrences/{OCCURRENCE_ID}"
232 "kind": "A String", # Output only. This explicitly denotes which of the `Occurrence` details are
233 # specified. This field can be used as a filter in list requests.
234 "buildDetails": { # Message encapsulating build provenance details. # Build details for a verifiable build.
235 "provenance": { # Provenance of a build. Contains all information needed to verify the full # The actual provenance
236 # details about the build from source to completion.
237 "finishTime": "A String", # Time at which execution of the build was finished.
238 "commands": [ # Commands requested by the build.
239 { # Command describes a step performed as part of the build pipeline.
240 "waitFor": [ # The ID(s) of the Command(s) that this Command depends on.
241 "A String",
242 ],
243 "name": "A String", # Name of the command, as presented on the command line, or if the command is
244 # packaged as a Docker container, as presented to `docker pull`.
245 "args": [ # Command-line arguments used when executing this Command.
246 "A String",
247 ],
248 "env": [ # Environment variables set before running this Command.
249 "A String",
250 ],
251 "id": "A String", # Optional unique identifier for this Command, used in wait_for to reference
252 # this Command as a dependency.
253 "dir": "A String", # Working directory (relative to project source root) used when running
254 # this Command.
255 },
256 ],
257 "sourceProvenance": { # Source describes the location of the source used for the build. # Details of the Source input to the build.
258 "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
259 # location.
260 # Google Cloud Storage.
261 "generation": "A String", # Google Cloud Storage generation for the object.
262 "object": "A String", # Google Cloud Storage object containing source.
263 "bucket": "A String", # Google Cloud Storage bucket containing source (see [Bucket Name
264 # Requirements]
265 # (https://cloud.google.com/storage/docs/bucket-naming#requirements)).
266 },
267 "repoSource": { # RepoSource describes the location of the source in a Google Cloud Source # If provided, get source from this location in a Cloud Repo.
268 # Repository.
269 "projectId": "A String", # ID of the project that owns the repo.
270 "branchName": "A String", # Name of the branch to build.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]271 "commitSha": "A String", # Explicit commit SHA to build.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]272 "tagName": "A String", # Name of the tag to build.
273 "repoName": "A String", # Name of the repo.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]274 },
275 "fileHashes": { # Hash(es) of the build source, which can be used to verify that the original
276 # source integrity was maintained in the build.
277 #
278 # The keys to this map are file paths used as build source and the values
279 # contain the hash values for those files.
280 #
281 # If the build source came in a single package such as a gzipped tarfile
282 # (.tar.gz), the FileHash will be for the single path to that file.
283 "a_key": { # Container message for hashes of byte content of files, used in Source
284 # messages to verify integrity of source input to the build.
285 "fileHash": [ # Collection of file hashes.
286 { # Container message for hash values.
287 "type": "A String", # The type of hash that was performed.
288 "value": "A String", # The hash value.
289 },
290 ],
291 },
292 },
293 "additionalContexts": [ # If provided, some of the source code used for the build may be found in
294 # these locations, in the case where the source repository had multiple
295 # remotes or submodules. This list will not include the context specified in
296 # the context field.
297 { # A SourceContext is a reference to a tree of files. A SourceContext together
298 # with a path point to a unique revision of a single file or directory.
299 "git": { # A GitSourceContext denotes a particular revision in a third party Git # A SourceContext referring to any third party Git repo (e.g., GitHub).
300 # repository (e.g., GitHub).
301 "url": "A String", # Git repository URL.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]302 "revisionId": "A String", # Required. Git commit hash.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]303 },
304 "cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud # A SourceContext referring to a revision in a Google Cloud Source Repo.
305 # Source Repo.
306 "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
307 "kind": "A String", # The alias kind.
308 "name": "A String", # The alias name.
309 },
310 "revisionId": "A String", # A revision ID.
311 "repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]312 "uid": "A String", # A server-assigned, globally unique identifier.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]313 "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., # A combination of a project ID and a repo name.
314 # winged-cargo-31) and a repo name within that project.
315 "projectId": "A String", # The ID of the project.
316 "repoName": "A String", # The name of the repo. Leave empty for the default repo.
317 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]318 },
319 },
320 "labels": { # Labels with user defined metadata.
321 "a_key": "A String",
322 },
323 "gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.
324 "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
325 "kind": "A String", # The alias kind.
326 "name": "A String", # The alias name.
327 },
328 "revisionId": "A String", # A revision (commit) ID.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]329 "hostUri": "A String", # The URI of a running Gerrit instance.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]330 "gerritProject": "A String", # The full project name within the host. Projects may be nested, so
331 # "project/subproject" is a valid project name. The "repo name" is
332 # the hostURI/project.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]333 },
334 },
335 ],
336 "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.
337 # with a path point to a unique revision of a single file or directory.
338 "git": { # A GitSourceContext denotes a particular revision in a third party Git # A SourceContext referring to any third party Git repo (e.g., GitHub).
339 # repository (e.g., GitHub).
340 "url": "A String", # Git repository URL.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]341 "revisionId": "A String", # Required. Git commit hash.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]342 },
343 "cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud # A SourceContext referring to a revision in a Google Cloud Source Repo.
344 # Source Repo.
345 "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
346 "kind": "A String", # The alias kind.
347 "name": "A String", # The alias name.
348 },
349 "revisionId": "A String", # A revision ID.
350 "repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]351 "uid": "A String", # A server-assigned, globally unique identifier.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]352 "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., # A combination of a project ID and a repo name.
353 # winged-cargo-31) and a repo name within that project.
354 "projectId": "A String", # The ID of the project.
355 "repoName": "A String", # The name of the repo. Leave empty for the default repo.
356 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]357 },
358 },
359 "labels": { # Labels with user defined metadata.
360 "a_key": "A String",
361 },
362 "gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.
363 "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
364 "kind": "A String", # The alias kind.
365 "name": "A String", # The alias name.
366 },
367 "revisionId": "A String", # A revision (commit) ID.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]368 "hostUri": "A String", # The URI of a running Gerrit instance.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]369 "gerritProject": "A String", # The full project name within the host. Projects may be nested, so
370 # "project/subproject" is a valid project name. The "repo name" is
371 # the hostURI/project.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]372 },
373 },
374 "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
375 # Storage.
376 # Google Cloud Storage.
377 "generation": "A String", # Google Cloud Storage generation for the object.
378 "object": "A String", # Google Cloud Storage object containing source.
379 "bucket": "A String", # Google Cloud Storage bucket containing source (see [Bucket Name
380 # Requirements]
381 # (https://cloud.google.com/storage/docs/bucket-naming#requirements)).
382 },
383 },
384 "buildOptions": { # Special options applied to this build. This is a catch-all field where
385 # build providers can enter any desired additional details.
386 "a_key": "A String",
387 },
388 "creator": "A String", # E-mail address of the user who initiated this build. Note that this was the
389 # user's e-mail address at the time the build was initiated; this address may
390 # not represent the same end-user for all time.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]391 "projectId": "A String", # ID of the project.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]392 "builderVersion": "A String", # Version string of the builder at the time this build was executed.
393 "createTime": "A String", # Time at which the build was created.
394 "builtArtifacts": [ # Output of the build.
395 { # Artifact describes a build product.
396 "checksum": "A String", # Hash or checksum value of a binary, or Docker Registry 2.0 digest of a
397 # container.
398 "id": "A String", # Artifact ID, if any; for container images, this will be a URL by digest
399 # like gcr.io/projectID/imagename@sha256:123456
400 "name": "A String", # Name of the artifact. This may be the path to a binary or jar file, or in
401 # the case of a container build, the name used to push the container image to
402 # Google Container Registry, as presented to `docker push`.
403 #
404 # This field is deprecated in favor of the plural `names` field; it continues
405 # to exist here to allow existing BuildProvenance serialized to json in
406 # google.devtools.containeranalysis.v1alpha1.BuildDetails.provenance_bytes to
407 # deserialize back into proto.
408 "names": [ # Related artifact names. This may be the path to a binary or jar file, or in
409 # the case of a container build, the name used to push the container image to
410 # Google Container Registry, as presented to `docker push`. Note that a
411 # single Artifact ID can have multiple names, for example if two tags are
412 # applied to one image.
413 "A String",
414 ],
415 },
416 ],
417 "triggerId": "A String", # Trigger identifier if the build was triggered automatically; empty if not.
418 "startTime": "A String", # Time at which execution of the build was started.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]419 "logsBucket": "A String", # Google Cloud Storage bucket where logs were written.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]420 "id": "A String", # Unique identifier of the build.
421 },
422 "provenanceBytes": "A String", # Serialized JSON representation of the provenance, used in generating the
423 # `BuildSignature` in the corresponding Result. After verifying the
424 # signature, `provenance_bytes` can be unmarshalled and compared to the
425 # provenance to confirm that it is unchanged. A base64-encoded string
426 # representation of the provenance bytes is used for the signature in order
427 # to interoperate with openssl which expects this format for signature
428 # verification.
429 #
430 # The serialized form is captured both to avoid ambiguity in how the
431 # provenance is marshalled to json as well to prevent incompatibilities with
432 # future changes.
433 },
434 "discovered": { # Provides information about the scan status of a discovered resource. # Describes the initial scan status for this resource.
435 "analysisStatus": "A String", # The status of discovery for the resource.
436 "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.
437 # This field is deprecated, do not use.
438 # network API call.
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 "message": "A String", # A developer-facing error message, which should be in English. Any
447 # user-facing error message should be localized and sent in the
448 # google.rpc.Status.details field, or localized by the client.
449 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
450 "details": [ # A list of messages that carry the error details. There is a common set of
451 # message types for APIs to use.
452 {
453 "a_key": "", # Properties of the object. Contains field @type with type URL.
454 },
455 ],
456 },
457 "done": True or False, # If the value is `false`, it means the operation is still in progress.
458 # If `true`, the operation is completed, and either `error` or `response` is
459 # available.
460 "response": { # The normal response of the operation in case of success. If the original
461 # method returns no data on success, such as `Delete`, the response is
462 # `google.protobuf.Empty`. If the original method is standard
463 # `Get`/`Create`/`Update`, the response should be the resource. For other
464 # methods, the response should have the type `XxxResponse`, where `Xxx`
465 # is the original method name. For example, if the original method name
466 # is `TakeSnapshot()`, the inferred response type is
467 # `TakeSnapshotResponse`.
468 "a_key": "", # Properties of the object. Contains field @type with type URL.
469 },
470 "name": "A String", # The server-assigned name, which is only unique within the same service that
471 # originally returns it. If you use the default HTTP mapping, the
472 # `name` should be a resource name ending with `operations/{unique_id}`.
473 "metadata": { # Service-specific metadata associated with the operation. It typically
474 # contains progress information and common metadata such as create time.
475 # Some services might not provide such metadata. Any method that returns a
476 # long-running operation should document the metadata type, if any.
477 "a_key": "", # Properties of the object. Contains field @type with type URL.
478 },
479 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]480 "continuousAnalysis": "A String", # Whether the resource is continuously analyzed.
481 "cpe": "A String", # The CPE of the resource being scanned.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]482 "analysisStatusError": { # The `Status` type defines a logical error model that is suitable for # When an error is encountered this will contain a LocalizedMessage under
483 # details to show to the user. The LocalizedMessage output only and
484 # populated by the API.
485 # different programming environments, including REST APIs and RPC APIs. It is
486 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
487 # three pieces of data: error code, error message, and error details.
488 #
489 # You can find out more about this error model and how to work with it in the
490 # [API Design Guide](https://cloud.google.com/apis/design/errors).
491 "message": "A String", # A developer-facing error message, which should be in English. Any
492 # user-facing error message should be localized and sent in the
493 # google.rpc.Status.details field, or localized by the client.
494 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
495 "details": [ # A list of messages that carry the error details. There is a common set of
496 # message types for APIs to use.
497 {
498 "a_key": "", # Properties of the object. Contains field @type with type URL.
499 },
500 ],
501 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]502 },
503 "attestation": { # Occurrence that represents a single "attestation". The authenticity of an # Describes an attestation of an artifact.
504 # Attestation can be verified using the attached signature. If the verifier
505 # trusts the public key of the signer, then verifying the signature is
506 # sufficient to establish trust. In this circumstance, the
507 # AttestationAuthority to which this Attestation is attached is primarily
508 # useful for look-up (how to find this Attestation if you already know the
509 # Authority and artifact to be verified) and intent (which authority was this
510 # attestation intended to sign for).
511 "pgpSignedAttestation": { # An attestation wrapper with a PGP-compatible signature.
512 # This message only supports `ATTACHED` signatures, where the payload that is
513 # signed is included alongside the signature itself in the same file.
514 "pgpKeyId": "A String", # The cryptographic fingerprint of the key used to generate the signature,
515 # as output by, e.g. `gpg --list-keys`. This should be the version 4, full
516 # 160-bit fingerprint, expressed as a 40 character hexadecimal string. See
517 # https://tools.ietf.org/html/rfc4880#section-12.2 for details.
518 # Implementations may choose to acknowledge "LONG", "SHORT", or other
519 # abbreviated key IDs, but only the full fingerprint is guaranteed to work.
520 # In gpg, the full fingerprint can be retrieved from the `fpr` field
521 # returned when calling --list-keys with --with-colons. For example:
522 # ```
523 # gpg --with-colons --with-fingerprint --force-v4-certs \
524 # --list-keys attester@example.com
525 # tru::1:1513631572:0:3:1:5
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]526 # pub:...&lt;SNIP&gt;...
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]527 # fpr:::::::::24FF6481B76AC91E66A00AC657A93A81EF3AE6FB:
528 # ```
529 # Above, the fingerprint is `24FF6481B76AC91E66A00AC657A93A81EF3AE6FB`.
530 "contentType": "A String", # Type (for example schema) of the attestation payload that was signed.
531 # The verifier must ensure that the provided type is one that the verifier
532 # supports, and that the attestation payload is a valid instantiation of that
533 # type (for example by validating a JSON schema).
534 "signature": "A String", # The raw content of the signature, as output by GNU Privacy Guard (GPG) or
535 # equivalent. Since this message only supports attached signatures, the
536 # payload that was signed must be attached. While the signature format
537 # supported is dependent on the verification implementation, currently only
538 # ASCII-armored (`--armor` to gpg), non-clearsigned (`--sign` rather than
539 # `--clearsign` to gpg) are supported. Concretely, `gpg --sign --armor
540 # --output=signature.gpg payload.json` will create the signature content
541 # expected in this field in `signature.gpg` for the `payload.json`
542 # attestation payload.
543 },
544 },
545 "noteName": "A String", # An analysis note associated with this image, in the form
546 # "providers/{provider_id}/notes/{NOTE_ID}"
547 # This field can be used as a filter in list requests.
548 "deployment": { # The period during which some deployable was active in a runtime. # Describes the deployment of an artifact on a runtime.
549 "resourceUri": [ # Output only. Resource URI for the artifact being deployed taken from the
550 # deployable field with the same name.
551 "A String",
552 ],
553 "userEmail": "A String", # Identity of the user that triggered this deployment.
554 "address": "A String", # Address of the runtime element hosting this deployment.
555 "platform": "A String", # Platform hosting this deployment.
556 "deployTime": "A String", # Beginning of the lifetime of this deployment.
557 "undeployTime": "A String", # End of the lifetime of this deployment.
558 "config": "A String", # Configuration used to create this deployment.
559 },
560 "remediation": "A String", # A description of actions that can be taken to remedy the `Note`
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]561 "resourceUrl": "A String", # The unique URL of the image or the container for which the `Occurrence`
562 # applies. For example, https://gcr.io/project/image@sha256:foo This field
563 # can be used as a filter in list requests.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]564 "createTime": "A String", # Output only. The time this `Occurrence` was created.
565 "derivedImage": { # Derived describes the derived image portion (Occurrence) of the # Describes how this resource derives from the basis
566 # in the associated note.
567 # DockerImage relationship. This image would be produced from a Dockerfile
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]568 # with FROM &lt;DockerImage.Basis in attached Note&gt;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]569 "distance": 42, # Output only. The number of layers by which this image differs from the
570 # associated image basis.
571 "baseResourceUrl": "A String", # Output only. This contains the base image URL for the derived image
572 # occurrence.
573 "layerInfo": [ # This contains layer-specific metadata, if populated it has length
574 # "distance" and is ordered with [distance] being the layer immediately
575 # following the base image and [1] being the final layer.
576 { # Layer holds metadata specific to a layer of a Docker image.
577 "arguments": "A String", # The recovered arguments to the Dockerfile directive.
578 "directive": "A String", # The recovered Dockerfile directive used to construct this layer.
579 },
580 ],
581 "fingerprint": { # A set of properties that uniquely identify a given Docker image. # The fingerprint of the derived image.
582 "v1Name": "A String", # The layer-id of the final layer in the Docker image's v1
583 # representation.
584 # This field can be used as a filter in list requests.
585 "v2Blob": [ # The ordered list of v2 blobs that represent a given image.
586 "A String",
587 ],
588 "v2Name": "A String", # Output only. The name of the image's v2 blobs computed via:
589 # [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1])
590 # Only the name of the final blob is kept.
591 # This field can be used as a filter in list requests.
592 },
593 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]594 },
595 ],
596 }</pre>
597</div>
598
599<div class="method">
600 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
601 <pre>Retrieves the next page of results.
602
603Args:
604 previous_request: The request for the previous page. (required)
605 previous_response: The response from the request for the previous page. (required)
606
607Returns:
608 A request object that you can call 'execute()' on to request the next
609 page. Returns None if there are no more items in the collection.
610 </pre>
611</div>
612
613</body></html>