blob: fda9acc509529f1f0115b295799fb015938c01e3 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001<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></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="containeranalysis_v1alpha1.projects.notes.occurrences.html">occurrences()</a></code>
79</p>
80<p class="firstline">Returns the occurrences Resource.</p>
81
82<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070083 <code><a href="#close">close()</a></code></p>
84<p class="firstline">Close httplib2 connections.</p>
85<p class="toc_element">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -070086 <code><a href="#create">create(parent, body=None, name=None, noteId=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070087<p class="firstline">Creates a new `Note`.</p>
88<p class="toc_element">
89 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
90<p class="firstline">Deletes the given `Note` from the system.</p>
91<p class="toc_element">
92 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
93<p class="firstline">Returns the requested `Note`.</p>
94<p class="toc_element">
95 <code><a href="#getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070096<p class="firstline">Gets the access control policy for a note or an `Occurrence` resource. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a note or occurrence, respectively. Attempting to call this method on a resource without the required permission will result in a `PERMISSION_DENIED` error. Attempting to call this method on a non-existent resource will result in a `NOT_FOUND` error if the user has list permission on the project, or a `PERMISSION_DENIED` error otherwise. The resource takes the following formats: `projects/{PROJECT_ID}/occurrences/{OCCURRENCE_ID}` for occurrences and projects/{PROJECT_ID}/notes/{NOTE_ID} for notes</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070097<p class="toc_element">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -070098 <code><a href="#list">list(parent, filter=None, name=None, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070099<p class="firstline">Lists all `Notes` for a given project.</p>
100<p class="toc_element">
101 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
102<p class="firstline">Retrieves the next page of results.</p>
103<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700104 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700105<p class="firstline">Updates an existing `Note`.</p>
106<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700107 <code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700108<p class="firstline">Sets the access control policy on the specified `Note` or `Occurrence`. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a `Note` or an `Occurrence`, respectively. Attempting to call this method without these permissions will result in a ` `PERMISSION_DENIED` error. Attempting to call this method on a non-existent resource will result in a `NOT_FOUND` error if the user has `containeranalysis.notes.list` permission on a `Note` or `containeranalysis.occurrences.list` on an `Occurrence`, or a `PERMISSION_DENIED` error otherwise. The resource takes the following formats: `projects/{projectid}/occurrences/{occurrenceid}` for occurrences and projects/{projectid}/notes/{noteid} for notes</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700109<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700110 <code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700111<p class="firstline">Returns the permissions that a caller has on the specified note or occurrence resource. Requires list permission on the project (for example, "storage.objects.list" on the containing bucket for testing permission of an object). Attempting to call this method on a non-existent resource will result in a `NOT_FOUND` error if the user has list permission on the project, or a `PERMISSION_DENIED` error otherwise. The resource takes the following formats: `projects/{PROJECT_ID}/occurrences/{OCCURRENCE_ID}` for `Occurrences` and `projects/{PROJECT_ID}/notes/{NOTE_ID}` for `Notes`</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700112<h3>Method Details</h3>
113<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700114 <code class="details" id="close">close()</code>
115 <pre>Close httplib2 connections.</pre>
116</div>
117
118<div class="method">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700119 <code class="details" id="create">create(parent, body=None, name=None, noteId=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700120 <pre>Creates a new `Note`.
121
122Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700123 parent: string, This field contains the project Id for example: &quot;projects/{project_id} (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700124 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700125 The object takes the form of:
126
127{ # Provides a detailed description of a `Note`.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700128 &quot;baseImage&quot;: { # Basis describes the base image portion (Note) of the DockerImage relationship. Linked occurrences are derived from this or an equivalent image via: FROM Or an equivalent reference, e.g. a tag of the resource_url. # A note describing a base image.
129 &quot;fingerprint&quot;: { # A set of properties that uniquely identify a given Docker image. # The fingerprint of the base image.
130 &quot;v2Name&quot;: &quot;A String&quot;, # Output only. The name of the image&#x27;s v2 blobs computed via: [bottom] := v2_blobbottom := sha256(v2_blob[N] + &quot; &quot; + v2_name[N+1]) Only the name of the final blob is kept. This field can be used as a filter in list requests.
131 &quot;v1Name&quot;: &quot;A String&quot;, # The layer-id of the final layer in the Docker image&#x27;s v1 representation. This field can be used as a filter in list requests.
132 &quot;v2Blob&quot;: [ # The ordered list of v2 blobs that represent a given image.
133 &quot;A String&quot;,
134 ],
135 },
136 &quot;resourceUrl&quot;: &quot;A String&quot;, # The resource_url for the resource representing the basis of associated occurrence images.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700137 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700138 &quot;kind&quot;: &quot;A String&quot;, # Output only. This explicitly denotes which kind of note is specified. This field can be used as a filter in list requests.
139 &quot;expirationTime&quot;: &quot;A String&quot;, # Time of expiration for this note, null if note does not expire.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700140 &quot;attestationAuthority&quot;: { # Note kind that represents a logical attestation &quot;role&quot; or &quot;authority&quot;. For example, an organization might have one `AttestationAuthority` for &quot;QA&quot; and one for &quot;build&quot;. This Note is intended to act strictly as a grouping mechanism for the attached Occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an Occurrence to a given Note. It also provides a single point of lookup to find all attached Attestation Occurrences, even if they don&#x27;t all live in the same project. # A note describing an attestation role.
141 &quot;hint&quot;: { # This submessage provides human-readable hints about the purpose of the AttestationAuthority. Because the name of a Note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from &quot;readable&quot; names more suitable for debug output. Note that these hints should NOT be used to look up AttestationAuthorities in security sensitive contexts, such as when looking up Attestations to verify.
Bu Sun Kim65020912020-05-20 12:08:20 -0700142 &quot;humanReadableName&quot;: &quot;A String&quot;, # The human readable name of this Attestation Authority, for example &quot;qa&quot;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700143 },
144 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700145 &quot;relatedUrl&quot;: [ # URLs associated with this note
146 { # Metadata for any related URL information
147 &quot;label&quot;: &quot;A String&quot;, # Label to describe usage of the URL
148 &quot;url&quot;: &quot;A String&quot;, # Specific URL to associate with the note
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700149 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700150 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700151 &quot;discovery&quot;: { # A note that indicates a type of analysis a provider would perform. This note exists in a provider&#x27;s project. A `Discovery` occurrence is created in a consumer&#x27;s project at the start of analysis. The occurrence&#x27;s operation will indicate the status of the analysis. Absence of an occurrence linked to this note for a resource indicates that analysis hasn&#x27;t started. # A note describing a provider/analysis type.
152 &quot;analysisKind&quot;: &quot;A String&quot;, # The kind of analysis that is handled by this discovery.
153 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700154 &quot;name&quot;: &quot;A String&quot;, # The name of the note in the form &quot;projects/{provider_project_id}/notes/{NOTE_ID}&quot;
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700155 &quot;package&quot;: { # This represents a particular package that is distributed over various channels. e.g. glibc (aka libc6) is distributed by many, at various versions. # A note describing a package hosted by various package managers.
156 &quot;distribution&quot;: [ # The various channels by which a package is distributed.
157 { # This represents a particular channel of distribution for a given package. e.g. Debian&#x27;s jessie-backports dpkg mirror
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700158 &quot;architecture&quot;: &quot;A String&quot;, # The CPU architecture for which packages in this distribution channel were built
159 &quot;url&quot;: &quot;A String&quot;, # The distribution channel-specific homepage for this package.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700160 &quot;maintainer&quot;: &quot;A String&quot;, # A freeform string denoting the maintainer of this package.
161 &quot;description&quot;: &quot;A String&quot;, # The distribution channel-specific description of this package.
162 &quot;cpeUri&quot;: &quot;A String&quot;, # The cpe_uri in [cpe format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package.
163 &quot;latestVersion&quot;: { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The latest available version of this package in this distribution channel.
164 &quot;revision&quot;: &quot;A String&quot;, # The iteration of the package build from the above version.
165 &quot;kind&quot;: &quot;A String&quot;, # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored.
166 &quot;name&quot;: &quot;A String&quot;, # The main part of the version name.
167 &quot;epoch&quot;: 42, # Used to correct mistakes in the version numbering scheme.
168 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700169 },
170 ],
171 &quot;name&quot;: &quot;A String&quot;, # The name of the package.
172 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700173 &quot;shortDescription&quot;: &quot;A String&quot;, # A one sentence description of this `Note`.
174 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time this note was created. This field can be used as a filter in list requests.
175 &quot;deployable&quot;: { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed.
176 &quot;resourceUri&quot;: [ # Resource URI for the artifact being deployed.
177 &quot;A String&quot;,
178 ],
179 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700180 &quot;vulnerabilityType&quot;: { # VulnerabilityType provides metadata about a security vulnerability. # A package vulnerability type of note.
181 &quot;details&quot;: [ # All information about the package to specifically identify this vulnerability. One entry per (version range and cpe_uri) the package vulnerability has manifested in.
182 { # Identifies all occurrences of this vulnerability in the package for a specific distro/location For example: glibc in cpe:/o:debian:debian_linux:8 for versions 2.1 - 2.2
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700183 &quot;isObsolete&quot;: True or False, # Whether this Detail is obsolete. Occurrences are expected not to point to obsolete details.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700184 &quot;fixedLocation&quot;: { # The location of the vulnerability # The fix for this specific package version.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700185 &quot;version&quot;: { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The version of the package being described. This field can be used as a filter in list requests.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700186 &quot;revision&quot;: &quot;A String&quot;, # The iteration of the package build from the above version.
187 &quot;kind&quot;: &quot;A String&quot;, # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700188 &quot;name&quot;: &quot;A String&quot;, # The main part of the version name.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700189 &quot;epoch&quot;: 42, # Used to correct mistakes in the version numbering scheme.
190 },
191 &quot;cpeUri&quot;: &quot;A String&quot;, # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar. This field can be used as a filter in list requests.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700192 &quot;package&quot;: &quot;A String&quot;, # The package being described.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700193 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700194 &quot;cpeUri&quot;: &quot;A String&quot;, # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar. This field can be used as a filter in list requests.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700195 &quot;minAffectedVersion&quot;: { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The min version of the package in which the vulnerability exists.
196 &quot;revision&quot;: &quot;A String&quot;, # The iteration of the package build from the above version.
197 &quot;kind&quot;: &quot;A String&quot;, # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored.
198 &quot;name&quot;: &quot;A String&quot;, # The main part of the version name.
199 &quot;epoch&quot;: 42, # Used to correct mistakes in the version numbering scheme.
200 },
201 &quot;package&quot;: &quot;A String&quot;, # The name of the package where the vulnerability was found. This field can be used as a filter in list requests.
202 &quot;maxAffectedVersion&quot;: { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The max version of the package in which the vulnerability exists.
203 &quot;revision&quot;: &quot;A String&quot;, # The iteration of the package build from the above version.
204 &quot;kind&quot;: &quot;A String&quot;, # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored.
205 &quot;name&quot;: &quot;A String&quot;, # The main part of the version name.
206 &quot;epoch&quot;: 42, # Used to correct mistakes in the version numbering scheme.
207 },
208 &quot;packageType&quot;: &quot;A String&quot;, # The type of package; whether native or non native(ruby gems, node.js packages etc)
209 &quot;severityName&quot;: &quot;A String&quot;, # The severity (eg: distro assigned severity) for this vulnerability.
210 &quot;description&quot;: &quot;A String&quot;, # A vendor-specific description of this note.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700211 },
212 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700213 &quot;severity&quot;: &quot;A String&quot;, # Note provider assigned impact of the vulnerability
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700214 &quot;cvssScore&quot;: 3.14, # The CVSS score for this Vulnerability.
215 },
216 &quot;longDescription&quot;: &quot;A String&quot;, # A detailed description of this `Note`.
217 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time this note was last updated. This field can be used as a filter in list requests.
218 &quot;upgrade&quot;: { # An Upgrade Note represents a potential upgrade of a package to a given version. For each package version combination (i.e. bash 4.0, bash 4.1, bash 4.1.2), there will be a Upgrade Note. # A note describing an upgrade.
219 &quot;distributions&quot;: [ # Metadata about the upgrade for each specific operating system.
220 { # The Upgrade Distribution represents metadata about the Upgrade for each operating system (CPE). Some distributions have additional metadata around updates, classifying them into various categories and severities.
221 &quot;classification&quot;: &quot;A String&quot;, # The operating system classification of this Upgrade, as specified by the upstream operating system upgrade feed.
222 &quot;cpeUri&quot;: &quot;A String&quot;, # Required - The specific operating system this metadata applies to. See https://cpe.mitre.org/specification/.
223 &quot;severity&quot;: &quot;A String&quot;, # The severity as specified by the upstream operating system.
224 &quot;cve&quot;: [ # The cve that would be resolved by this upgrade.
225 &quot;A String&quot;,
226 ],
227 },
228 ],
229 &quot;package&quot;: &quot;A String&quot;, # Required - The package this Upgrade is for.
230 &quot;version&quot;: { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # Required - The version of the package in machine + human readable form.
231 &quot;revision&quot;: &quot;A String&quot;, # The iteration of the package build from the above version.
232 &quot;kind&quot;: &quot;A String&quot;, # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored.
233 &quot;name&quot;: &quot;A String&quot;, # The main part of the version name.
234 &quot;epoch&quot;: 42, # Used to correct mistakes in the version numbering scheme.
235 },
236 },
237 &quot;buildType&quot;: { # Note holding the version of the provider&#x27;s builder and the signature of the provenance message in linked BuildDetails. # Build provenance type for a verifiable build.
238 &quot;builderVersion&quot;: &quot;A String&quot;, # Version of the builder which produced this Note.
239 &quot;signature&quot;: { # Message encapsulating the signature of the verified build. # Signature of the build in Occurrences pointing to the Note containing this `BuilderDetails`.
240 &quot;publicKey&quot;: &quot;A String&quot;, # Public key of the builder which can be used to verify that the related findings are valid and unchanged. If `key_type` is empty, this defaults to PEM encoded public keys. This field may be empty if `key_id` references an external key. For Cloud Build based signatures, this is a PEM encoded public key. To verify the Cloud Build signature, place the contents of this field into a file (public.pem). The signature field is base64-decoded into its binary representation in signature.bin, and the provenance bytes from `BuildDetails` are base64-decoded into a binary representation in signed.bin. OpenSSL can then verify the signature: `openssl sha256 -verify public.pem -signature signature.bin signed.bin`
241 &quot;keyType&quot;: &quot;A String&quot;, # The type of the key, either stored in `public_key` or referenced in `key_id`
242 &quot;signature&quot;: &quot;A String&quot;, # Signature of the related `BuildProvenance`, encoded in a base64 string.
243 &quot;keyId&quot;: &quot;A String&quot;, # An Id for the key used to sign. This could be either an Id for the key stored in `public_key` (such as the Id or fingerprint for a PGP key, or the CN for a cert), or a reference to an external key (such as a reference to a key in Cloud Key Management Service).
244 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700245 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700246 }
247
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700248 name: string, The name of the project. Should be of the form &quot;providers/{provider_id}&quot;. @Deprecated
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700249 noteId: string, The ID to use for this note.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700250 x__xgafv: string, V1 error format.
251 Allowed values
252 1 - v1 error format
253 2 - v2 error format
254
255Returns:
256 An object of the form:
257
258 { # Provides a detailed description of a `Note`.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700259 &quot;baseImage&quot;: { # Basis describes the base image portion (Note) of the DockerImage relationship. Linked occurrences are derived from this or an equivalent image via: FROM Or an equivalent reference, e.g. a tag of the resource_url. # A note describing a base image.
260 &quot;fingerprint&quot;: { # A set of properties that uniquely identify a given Docker image. # The fingerprint of the base image.
261 &quot;v2Name&quot;: &quot;A String&quot;, # Output only. The name of the image&#x27;s v2 blobs computed via: [bottom] := v2_blobbottom := sha256(v2_blob[N] + &quot; &quot; + v2_name[N+1]) Only the name of the final blob is kept. This field can be used as a filter in list requests.
262 &quot;v1Name&quot;: &quot;A String&quot;, # The layer-id of the final layer in the Docker image&#x27;s v1 representation. This field can be used as a filter in list requests.
263 &quot;v2Blob&quot;: [ # The ordered list of v2 blobs that represent a given image.
264 &quot;A String&quot;,
265 ],
266 },
267 &quot;resourceUrl&quot;: &quot;A String&quot;, # The resource_url for the resource representing the basis of associated occurrence images.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700268 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700269 &quot;kind&quot;: &quot;A String&quot;, # Output only. This explicitly denotes which kind of note is specified. This field can be used as a filter in list requests.
270 &quot;expirationTime&quot;: &quot;A String&quot;, # Time of expiration for this note, null if note does not expire.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700271 &quot;attestationAuthority&quot;: { # Note kind that represents a logical attestation &quot;role&quot; or &quot;authority&quot;. For example, an organization might have one `AttestationAuthority` for &quot;QA&quot; and one for &quot;build&quot;. This Note is intended to act strictly as a grouping mechanism for the attached Occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an Occurrence to a given Note. It also provides a single point of lookup to find all attached Attestation Occurrences, even if they don&#x27;t all live in the same project. # A note describing an attestation role.
272 &quot;hint&quot;: { # This submessage provides human-readable hints about the purpose of the AttestationAuthority. Because the name of a Note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from &quot;readable&quot; names more suitable for debug output. Note that these hints should NOT be used to look up AttestationAuthorities in security sensitive contexts, such as when looking up Attestations to verify.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700273 &quot;humanReadableName&quot;: &quot;A String&quot;, # The human readable name of this Attestation Authority, for example &quot;qa&quot;.
274 },
275 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700276 &quot;relatedUrl&quot;: [ # URLs associated with this note
277 { # Metadata for any related URL information
278 &quot;label&quot;: &quot;A String&quot;, # Label to describe usage of the URL
279 &quot;url&quot;: &quot;A String&quot;, # Specific URL to associate with the note
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700280 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700281 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700282 &quot;discovery&quot;: { # A note that indicates a type of analysis a provider would perform. This note exists in a provider&#x27;s project. A `Discovery` occurrence is created in a consumer&#x27;s project at the start of analysis. The occurrence&#x27;s operation will indicate the status of the analysis. Absence of an occurrence linked to this note for a resource indicates that analysis hasn&#x27;t started. # A note describing a provider/analysis type.
283 &quot;analysisKind&quot;: &quot;A String&quot;, # The kind of analysis that is handled by this discovery.
284 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700285 &quot;name&quot;: &quot;A String&quot;, # The name of the note in the form &quot;projects/{provider_project_id}/notes/{NOTE_ID}&quot;
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700286 &quot;package&quot;: { # This represents a particular package that is distributed over various channels. e.g. glibc (aka libc6) is distributed by many, at various versions. # A note describing a package hosted by various package managers.
287 &quot;distribution&quot;: [ # The various channels by which a package is distributed.
288 { # This represents a particular channel of distribution for a given package. e.g. Debian&#x27;s jessie-backports dpkg mirror
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700289 &quot;architecture&quot;: &quot;A String&quot;, # The CPU architecture for which packages in this distribution channel were built
290 &quot;url&quot;: &quot;A String&quot;, # The distribution channel-specific homepage for this package.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700291 &quot;maintainer&quot;: &quot;A String&quot;, # A freeform string denoting the maintainer of this package.
292 &quot;description&quot;: &quot;A String&quot;, # The distribution channel-specific description of this package.
293 &quot;cpeUri&quot;: &quot;A String&quot;, # The cpe_uri in [cpe format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package.
294 &quot;latestVersion&quot;: { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The latest available version of this package in this distribution channel.
295 &quot;revision&quot;: &quot;A String&quot;, # The iteration of the package build from the above version.
296 &quot;kind&quot;: &quot;A String&quot;, # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored.
297 &quot;name&quot;: &quot;A String&quot;, # The main part of the version name.
298 &quot;epoch&quot;: 42, # Used to correct mistakes in the version numbering scheme.
299 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700300 },
301 ],
302 &quot;name&quot;: &quot;A String&quot;, # The name of the package.
303 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700304 &quot;shortDescription&quot;: &quot;A String&quot;, # A one sentence description of this `Note`.
305 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time this note was created. This field can be used as a filter in list requests.
306 &quot;deployable&quot;: { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed.
307 &quot;resourceUri&quot;: [ # Resource URI for the artifact being deployed.
308 &quot;A String&quot;,
309 ],
310 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700311 &quot;vulnerabilityType&quot;: { # VulnerabilityType provides metadata about a security vulnerability. # A package vulnerability type of note.
312 &quot;details&quot;: [ # All information about the package to specifically identify this vulnerability. One entry per (version range and cpe_uri) the package vulnerability has manifested in.
313 { # Identifies all occurrences of this vulnerability in the package for a specific distro/location For example: glibc in cpe:/o:debian:debian_linux:8 for versions 2.1 - 2.2
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700314 &quot;isObsolete&quot;: True or False, # Whether this Detail is obsolete. Occurrences are expected not to point to obsolete details.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700315 &quot;fixedLocation&quot;: { # The location of the vulnerability # The fix for this specific package version.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700316 &quot;version&quot;: { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The version of the package being described. This field can be used as a filter in list requests.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700317 &quot;revision&quot;: &quot;A String&quot;, # The iteration of the package build from the above version.
318 &quot;kind&quot;: &quot;A String&quot;, # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700319 &quot;name&quot;: &quot;A String&quot;, # The main part of the version name.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700320 &quot;epoch&quot;: 42, # Used to correct mistakes in the version numbering scheme.
321 },
322 &quot;cpeUri&quot;: &quot;A String&quot;, # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar. This field can be used as a filter in list requests.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700323 &quot;package&quot;: &quot;A String&quot;, # The package being described.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700324 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700325 &quot;cpeUri&quot;: &quot;A String&quot;, # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar. This field can be used as a filter in list requests.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700326 &quot;minAffectedVersion&quot;: { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The min version of the package in which the vulnerability exists.
327 &quot;revision&quot;: &quot;A String&quot;, # The iteration of the package build from the above version.
328 &quot;kind&quot;: &quot;A String&quot;, # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored.
329 &quot;name&quot;: &quot;A String&quot;, # The main part of the version name.
330 &quot;epoch&quot;: 42, # Used to correct mistakes in the version numbering scheme.
331 },
332 &quot;package&quot;: &quot;A String&quot;, # The name of the package where the vulnerability was found. This field can be used as a filter in list requests.
333 &quot;maxAffectedVersion&quot;: { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The max version of the package in which the vulnerability exists.
334 &quot;revision&quot;: &quot;A String&quot;, # The iteration of the package build from the above version.
335 &quot;kind&quot;: &quot;A String&quot;, # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored.
336 &quot;name&quot;: &quot;A String&quot;, # The main part of the version name.
337 &quot;epoch&quot;: 42, # Used to correct mistakes in the version numbering scheme.
338 },
339 &quot;packageType&quot;: &quot;A String&quot;, # The type of package; whether native or non native(ruby gems, node.js packages etc)
340 &quot;severityName&quot;: &quot;A String&quot;, # The severity (eg: distro assigned severity) for this vulnerability.
341 &quot;description&quot;: &quot;A String&quot;, # A vendor-specific description of this note.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700342 },
343 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700344 &quot;severity&quot;: &quot;A String&quot;, # Note provider assigned impact of the vulnerability
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700345 &quot;cvssScore&quot;: 3.14, # The CVSS score for this Vulnerability.
346 },
347 &quot;longDescription&quot;: &quot;A String&quot;, # A detailed description of this `Note`.
348 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time this note was last updated. This field can be used as a filter in list requests.
349 &quot;upgrade&quot;: { # An Upgrade Note represents a potential upgrade of a package to a given version. For each package version combination (i.e. bash 4.0, bash 4.1, bash 4.1.2), there will be a Upgrade Note. # A note describing an upgrade.
350 &quot;distributions&quot;: [ # Metadata about the upgrade for each specific operating system.
351 { # The Upgrade Distribution represents metadata about the Upgrade for each operating system (CPE). Some distributions have additional metadata around updates, classifying them into various categories and severities.
352 &quot;classification&quot;: &quot;A String&quot;, # The operating system classification of this Upgrade, as specified by the upstream operating system upgrade feed.
353 &quot;cpeUri&quot;: &quot;A String&quot;, # Required - The specific operating system this metadata applies to. See https://cpe.mitre.org/specification/.
354 &quot;severity&quot;: &quot;A String&quot;, # The severity as specified by the upstream operating system.
355 &quot;cve&quot;: [ # The cve that would be resolved by this upgrade.
356 &quot;A String&quot;,
357 ],
358 },
359 ],
360 &quot;package&quot;: &quot;A String&quot;, # Required - The package this Upgrade is for.
361 &quot;version&quot;: { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # Required - The version of the package in machine + human readable form.
362 &quot;revision&quot;: &quot;A String&quot;, # The iteration of the package build from the above version.
363 &quot;kind&quot;: &quot;A String&quot;, # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored.
364 &quot;name&quot;: &quot;A String&quot;, # The main part of the version name.
365 &quot;epoch&quot;: 42, # Used to correct mistakes in the version numbering scheme.
366 },
367 },
368 &quot;buildType&quot;: { # Note holding the version of the provider&#x27;s builder and the signature of the provenance message in linked BuildDetails. # Build provenance type for a verifiable build.
369 &quot;builderVersion&quot;: &quot;A String&quot;, # Version of the builder which produced this Note.
370 &quot;signature&quot;: { # Message encapsulating the signature of the verified build. # Signature of the build in Occurrences pointing to the Note containing this `BuilderDetails`.
371 &quot;publicKey&quot;: &quot;A String&quot;, # Public key of the builder which can be used to verify that the related findings are valid and unchanged. If `key_type` is empty, this defaults to PEM encoded public keys. This field may be empty if `key_id` references an external key. For Cloud Build based signatures, this is a PEM encoded public key. To verify the Cloud Build signature, place the contents of this field into a file (public.pem). The signature field is base64-decoded into its binary representation in signature.bin, and the provenance bytes from `BuildDetails` are base64-decoded into a binary representation in signed.bin. OpenSSL can then verify the signature: `openssl sha256 -verify public.pem -signature signature.bin signed.bin`
372 &quot;keyType&quot;: &quot;A String&quot;, # The type of the key, either stored in `public_key` or referenced in `key_id`
373 &quot;signature&quot;: &quot;A String&quot;, # Signature of the related `BuildProvenance`, encoded in a base64 string.
374 &quot;keyId&quot;: &quot;A String&quot;, # An Id for the key used to sign. This could be either an Id for the key stored in `public_key` (such as the Id or fingerprint for a PGP key, or the CN for a cert), or a reference to an external key (such as a reference to a key in Cloud Key Management Service).
375 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700376 },
377 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700378</div>
379
380<div class="method">
381 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
382 <pre>Deletes the given `Note` from the system.
383
384Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700385 name: string, The name of the note in the form of &quot;providers/{provider_id}/notes/{NOTE_ID}&quot; (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700386 x__xgafv: string, V1 error format.
387 Allowed values
388 1 - v1 error format
389 2 - v2 error format
390
391Returns:
392 An object of the form:
393
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700394 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700395 }</pre>
396</div>
397
398<div class="method">
399 <code class="details" id="get">get(name, x__xgafv=None)</code>
400 <pre>Returns the requested `Note`.
401
402Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700403 name: string, The name of the note in the form of &quot;providers/{provider_id}/notes/{NOTE_ID}&quot; (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700404 x__xgafv: string, V1 error format.
405 Allowed values
406 1 - v1 error format
407 2 - v2 error format
408
409Returns:
410 An object of the form:
411
412 { # Provides a detailed description of a `Note`.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700413 &quot;baseImage&quot;: { # Basis describes the base image portion (Note) of the DockerImage relationship. Linked occurrences are derived from this or an equivalent image via: FROM Or an equivalent reference, e.g. a tag of the resource_url. # A note describing a base image.
414 &quot;fingerprint&quot;: { # A set of properties that uniquely identify a given Docker image. # The fingerprint of the base image.
415 &quot;v2Name&quot;: &quot;A String&quot;, # Output only. The name of the image&#x27;s v2 blobs computed via: [bottom] := v2_blobbottom := sha256(v2_blob[N] + &quot; &quot; + v2_name[N+1]) Only the name of the final blob is kept. This field can be used as a filter in list requests.
416 &quot;v1Name&quot;: &quot;A String&quot;, # The layer-id of the final layer in the Docker image&#x27;s v1 representation. This field can be used as a filter in list requests.
417 &quot;v2Blob&quot;: [ # The ordered list of v2 blobs that represent a given image.
418 &quot;A String&quot;,
419 ],
420 },
421 &quot;resourceUrl&quot;: &quot;A String&quot;, # The resource_url for the resource representing the basis of associated occurrence images.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700422 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700423 &quot;kind&quot;: &quot;A String&quot;, # Output only. This explicitly denotes which kind of note is specified. This field can be used as a filter in list requests.
424 &quot;expirationTime&quot;: &quot;A String&quot;, # Time of expiration for this note, null if note does not expire.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700425 &quot;attestationAuthority&quot;: { # Note kind that represents a logical attestation &quot;role&quot; or &quot;authority&quot;. For example, an organization might have one `AttestationAuthority` for &quot;QA&quot; and one for &quot;build&quot;. This Note is intended to act strictly as a grouping mechanism for the attached Occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an Occurrence to a given Note. It also provides a single point of lookup to find all attached Attestation Occurrences, even if they don&#x27;t all live in the same project. # A note describing an attestation role.
426 &quot;hint&quot;: { # This submessage provides human-readable hints about the purpose of the AttestationAuthority. Because the name of a Note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from &quot;readable&quot; names more suitable for debug output. Note that these hints should NOT be used to look up AttestationAuthorities in security sensitive contexts, such as when looking up Attestations to verify.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700427 &quot;humanReadableName&quot;: &quot;A String&quot;, # The human readable name of this Attestation Authority, for example &quot;qa&quot;.
428 },
429 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700430 &quot;relatedUrl&quot;: [ # URLs associated with this note
431 { # Metadata for any related URL information
432 &quot;label&quot;: &quot;A String&quot;, # Label to describe usage of the URL
433 &quot;url&quot;: &quot;A String&quot;, # Specific URL to associate with the note
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700434 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700435 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700436 &quot;discovery&quot;: { # A note that indicates a type of analysis a provider would perform. This note exists in a provider&#x27;s project. A `Discovery` occurrence is created in a consumer&#x27;s project at the start of analysis. The occurrence&#x27;s operation will indicate the status of the analysis. Absence of an occurrence linked to this note for a resource indicates that analysis hasn&#x27;t started. # A note describing a provider/analysis type.
437 &quot;analysisKind&quot;: &quot;A String&quot;, # The kind of analysis that is handled by this discovery.
438 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700439 &quot;name&quot;: &quot;A String&quot;, # The name of the note in the form &quot;projects/{provider_project_id}/notes/{NOTE_ID}&quot;
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700440 &quot;package&quot;: { # This represents a particular package that is distributed over various channels. e.g. glibc (aka libc6) is distributed by many, at various versions. # A note describing a package hosted by various package managers.
441 &quot;distribution&quot;: [ # The various channels by which a package is distributed.
442 { # This represents a particular channel of distribution for a given package. e.g. Debian&#x27;s jessie-backports dpkg mirror
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700443 &quot;architecture&quot;: &quot;A String&quot;, # The CPU architecture for which packages in this distribution channel were built
444 &quot;url&quot;: &quot;A String&quot;, # The distribution channel-specific homepage for this package.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700445 &quot;maintainer&quot;: &quot;A String&quot;, # A freeform string denoting the maintainer of this package.
446 &quot;description&quot;: &quot;A String&quot;, # The distribution channel-specific description of this package.
447 &quot;cpeUri&quot;: &quot;A String&quot;, # The cpe_uri in [cpe format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package.
448 &quot;latestVersion&quot;: { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The latest available version of this package in this distribution channel.
449 &quot;revision&quot;: &quot;A String&quot;, # The iteration of the package build from the above version.
450 &quot;kind&quot;: &quot;A String&quot;, # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored.
451 &quot;name&quot;: &quot;A String&quot;, # The main part of the version name.
452 &quot;epoch&quot;: 42, # Used to correct mistakes in the version numbering scheme.
453 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700454 },
455 ],
456 &quot;name&quot;: &quot;A String&quot;, # The name of the package.
457 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700458 &quot;shortDescription&quot;: &quot;A String&quot;, # A one sentence description of this `Note`.
459 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time this note was created. This field can be used as a filter in list requests.
460 &quot;deployable&quot;: { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed.
461 &quot;resourceUri&quot;: [ # Resource URI for the artifact being deployed.
462 &quot;A String&quot;,
463 ],
464 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700465 &quot;vulnerabilityType&quot;: { # VulnerabilityType provides metadata about a security vulnerability. # A package vulnerability type of note.
466 &quot;details&quot;: [ # All information about the package to specifically identify this vulnerability. One entry per (version range and cpe_uri) the package vulnerability has manifested in.
467 { # Identifies all occurrences of this vulnerability in the package for a specific distro/location For example: glibc in cpe:/o:debian:debian_linux:8 for versions 2.1 - 2.2
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700468 &quot;isObsolete&quot;: True or False, # Whether this Detail is obsolete. Occurrences are expected not to point to obsolete details.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700469 &quot;fixedLocation&quot;: { # The location of the vulnerability # The fix for this specific package version.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700470 &quot;version&quot;: { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The version of the package being described. This field can be used as a filter in list requests.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700471 &quot;revision&quot;: &quot;A String&quot;, # The iteration of the package build from the above version.
472 &quot;kind&quot;: &quot;A String&quot;, # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700473 &quot;name&quot;: &quot;A String&quot;, # The main part of the version name.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700474 &quot;epoch&quot;: 42, # Used to correct mistakes in the version numbering scheme.
475 },
476 &quot;cpeUri&quot;: &quot;A String&quot;, # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar. This field can be used as a filter in list requests.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700477 &quot;package&quot;: &quot;A String&quot;, # The package being described.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700478 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700479 &quot;cpeUri&quot;: &quot;A String&quot;, # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar. This field can be used as a filter in list requests.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700480 &quot;minAffectedVersion&quot;: { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The min version of the package in which the vulnerability exists.
481 &quot;revision&quot;: &quot;A String&quot;, # The iteration of the package build from the above version.
482 &quot;kind&quot;: &quot;A String&quot;, # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored.
483 &quot;name&quot;: &quot;A String&quot;, # The main part of the version name.
484 &quot;epoch&quot;: 42, # Used to correct mistakes in the version numbering scheme.
485 },
486 &quot;package&quot;: &quot;A String&quot;, # The name of the package where the vulnerability was found. This field can be used as a filter in list requests.
487 &quot;maxAffectedVersion&quot;: { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The max version of the package in which the vulnerability exists.
488 &quot;revision&quot;: &quot;A String&quot;, # The iteration of the package build from the above version.
489 &quot;kind&quot;: &quot;A String&quot;, # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored.
490 &quot;name&quot;: &quot;A String&quot;, # The main part of the version name.
491 &quot;epoch&quot;: 42, # Used to correct mistakes in the version numbering scheme.
492 },
493 &quot;packageType&quot;: &quot;A String&quot;, # The type of package; whether native or non native(ruby gems, node.js packages etc)
494 &quot;severityName&quot;: &quot;A String&quot;, # The severity (eg: distro assigned severity) for this vulnerability.
495 &quot;description&quot;: &quot;A String&quot;, # A vendor-specific description of this note.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700496 },
497 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700498 &quot;severity&quot;: &quot;A String&quot;, # Note provider assigned impact of the vulnerability
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700499 &quot;cvssScore&quot;: 3.14, # The CVSS score for this Vulnerability.
500 },
501 &quot;longDescription&quot;: &quot;A String&quot;, # A detailed description of this `Note`.
502 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time this note was last updated. This field can be used as a filter in list requests.
503 &quot;upgrade&quot;: { # An Upgrade Note represents a potential upgrade of a package to a given version. For each package version combination (i.e. bash 4.0, bash 4.1, bash 4.1.2), there will be a Upgrade Note. # A note describing an upgrade.
504 &quot;distributions&quot;: [ # Metadata about the upgrade for each specific operating system.
505 { # The Upgrade Distribution represents metadata about the Upgrade for each operating system (CPE). Some distributions have additional metadata around updates, classifying them into various categories and severities.
506 &quot;classification&quot;: &quot;A String&quot;, # The operating system classification of this Upgrade, as specified by the upstream operating system upgrade feed.
507 &quot;cpeUri&quot;: &quot;A String&quot;, # Required - The specific operating system this metadata applies to. See https://cpe.mitre.org/specification/.
508 &quot;severity&quot;: &quot;A String&quot;, # The severity as specified by the upstream operating system.
509 &quot;cve&quot;: [ # The cve that would be resolved by this upgrade.
510 &quot;A String&quot;,
511 ],
512 },
513 ],
514 &quot;package&quot;: &quot;A String&quot;, # Required - The package this Upgrade is for.
515 &quot;version&quot;: { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # Required - The version of the package in machine + human readable form.
516 &quot;revision&quot;: &quot;A String&quot;, # The iteration of the package build from the above version.
517 &quot;kind&quot;: &quot;A String&quot;, # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored.
518 &quot;name&quot;: &quot;A String&quot;, # The main part of the version name.
519 &quot;epoch&quot;: 42, # Used to correct mistakes in the version numbering scheme.
520 },
521 },
522 &quot;buildType&quot;: { # Note holding the version of the provider&#x27;s builder and the signature of the provenance message in linked BuildDetails. # Build provenance type for a verifiable build.
523 &quot;builderVersion&quot;: &quot;A String&quot;, # Version of the builder which produced this Note.
524 &quot;signature&quot;: { # Message encapsulating the signature of the verified build. # Signature of the build in Occurrences pointing to the Note containing this `BuilderDetails`.
525 &quot;publicKey&quot;: &quot;A String&quot;, # Public key of the builder which can be used to verify that the related findings are valid and unchanged. If `key_type` is empty, this defaults to PEM encoded public keys. This field may be empty if `key_id` references an external key. For Cloud Build based signatures, this is a PEM encoded public key. To verify the Cloud Build signature, place the contents of this field into a file (public.pem). The signature field is base64-decoded into its binary representation in signature.bin, and the provenance bytes from `BuildDetails` are base64-decoded into a binary representation in signed.bin. OpenSSL can then verify the signature: `openssl sha256 -verify public.pem -signature signature.bin signed.bin`
526 &quot;keyType&quot;: &quot;A String&quot;, # The type of the key, either stored in `public_key` or referenced in `key_id`
527 &quot;signature&quot;: &quot;A String&quot;, # Signature of the related `BuildProvenance`, encoded in a base64 string.
528 &quot;keyId&quot;: &quot;A String&quot;, # An Id for the key used to sign. This could be either an Id for the key stored in `public_key` (such as the Id or fingerprint for a PGP key, or the CN for a cert), or a reference to an external key (such as a reference to a key in Cloud Key Management Service).
529 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700530 },
531 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700532</div>
533
534<div class="method">
535 <code class="details" id="getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700536 <pre>Gets the access control policy for a note or an `Occurrence` resource. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a note or occurrence, respectively. Attempting to call this method on a resource without the required permission will result in a `PERMISSION_DENIED` error. Attempting to call this method on a non-existent resource will result in a `NOT_FOUND` error if the user has list permission on the project, or a `PERMISSION_DENIED` error otherwise. The resource takes the following formats: `projects/{PROJECT_ID}/occurrences/{OCCURRENCE_ID}` for occurrences and projects/{PROJECT_ID}/notes/{NOTE_ID} for notes
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700537
538Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700539 resource: string, REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700540 body: object, The request body.
541 The object takes the form of:
542
543{ # Request message for `GetIamPolicy` method.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700544 &quot;options&quot;: { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`.
545 &quot;requestedPolicyVersion&quot;: 42, # Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Dan O'Mearadd494642020-05-01 07:42:23 -0700546 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700547 }
548
549 x__xgafv: string, V1 error format.
550 Allowed values
551 1 - v1 error format
552 2 - v2 error format
553
554Returns:
555 An object of the form:
556
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700557 { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { &quot;bindings&quot;: [ { &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;, &quot;members&quot;: [ &quot;user:mike@example.com&quot;, &quot;group:admins@example.com&quot;, &quot;domain:google.com&quot;, &quot;serviceAccount:my-project-id@appspot.gserviceaccount.com&quot; ] }, { &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;, &quot;members&quot;: [ &quot;user:eve@example.com&quot; ], &quot;condition&quot;: { &quot;title&quot;: &quot;expirable access&quot;, &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;, &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;, } } ], &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;, &quot;version&quot;: 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;) - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
558 &quot;version&quot;: 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700559 &quot;bindings&quot;: [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700560 { # Associates `members` with a `role`.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700561 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: &quot;Summary size limit&quot; description: &quot;Determines if a summary is less than 100 chars&quot; expression: &quot;document.summary.size() &lt; 100&quot; Example (Equality): title: &quot;Requestor is owner&quot; description: &quot;Determines if requestor is the document owner&quot; expression: &quot;document.owner == request.auth.claims.email&quot; Example (Logic): title: &quot;Public documents&quot; description: &quot;Determine whether the document should be publicly visible&quot; expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot; Example (Data Manipulation): title: &quot;Notification string&quot; description: &quot;Create a notification string with a timestamp.&quot; expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot; The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
562 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
563 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language syntax.
564 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
565 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
566 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700567 &quot;members&quot;: [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700568 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700569 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700570 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700571 &quot;bindingId&quot;: &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700572 },
573 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700574 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700575 }</pre>
576</div>
577
578<div class="method">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700579 <code class="details" id="list">list(parent, filter=None, name=None, pageToken=None, pageSize=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700580 <pre>Lists all `Notes` for a given project.
581
582Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700583 parent: string, This field contains the project Id for example: &quot;projects/{PROJECT_ID}&quot;. (required)
584 filter: string, The filter expression.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700585 name: string, The name field will contain the project Id for example: &quot;providers/{provider_id} @Deprecated
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700586 pageToken: string, Token to provide to skip to a particular spot in the list.
587 pageSize: integer, Number of notes to return in the list.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700588 x__xgafv: string, V1 error format.
589 Allowed values
590 1 - v1 error format
591 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700592
593Returns:
594 An object of the form:
595
596 { # Response including listed notes.
Bu Sun Kim65020912020-05-20 12:08:20 -0700597 &quot;notes&quot;: [ # The occurrences requested
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700598 { # Provides a detailed description of a `Note`.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700599 &quot;baseImage&quot;: { # Basis describes the base image portion (Note) of the DockerImage relationship. Linked occurrences are derived from this or an equivalent image via: FROM Or an equivalent reference, e.g. a tag of the resource_url. # A note describing a base image.
600 &quot;fingerprint&quot;: { # A set of properties that uniquely identify a given Docker image. # The fingerprint of the base image.
601 &quot;v2Name&quot;: &quot;A String&quot;, # Output only. The name of the image&#x27;s v2 blobs computed via: [bottom] := v2_blobbottom := sha256(v2_blob[N] + &quot; &quot; + v2_name[N+1]) Only the name of the final blob is kept. This field can be used as a filter in list requests.
602 &quot;v1Name&quot;: &quot;A String&quot;, # The layer-id of the final layer in the Docker image&#x27;s v1 representation. This field can be used as a filter in list requests.
603 &quot;v2Blob&quot;: [ # The ordered list of v2 blobs that represent a given image.
604 &quot;A String&quot;,
605 ],
606 },
607 &quot;resourceUrl&quot;: &quot;A String&quot;, # The resource_url for the resource representing the basis of associated occurrence images.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700608 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700609 &quot;kind&quot;: &quot;A String&quot;, # Output only. This explicitly denotes which kind of note is specified. This field can be used as a filter in list requests.
610 &quot;expirationTime&quot;: &quot;A String&quot;, # Time of expiration for this note, null if note does not expire.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700611 &quot;attestationAuthority&quot;: { # Note kind that represents a logical attestation &quot;role&quot; or &quot;authority&quot;. For example, an organization might have one `AttestationAuthority` for &quot;QA&quot; and one for &quot;build&quot;. This Note is intended to act strictly as a grouping mechanism for the attached Occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an Occurrence to a given Note. It also provides a single point of lookup to find all attached Attestation Occurrences, even if they don&#x27;t all live in the same project. # A note describing an attestation role.
612 &quot;hint&quot;: { # This submessage provides human-readable hints about the purpose of the AttestationAuthority. Because the name of a Note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from &quot;readable&quot; names more suitable for debug output. Note that these hints should NOT be used to look up AttestationAuthorities in security sensitive contexts, such as when looking up Attestations to verify.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700613 &quot;humanReadableName&quot;: &quot;A String&quot;, # The human readable name of this Attestation Authority, for example &quot;qa&quot;.
614 },
615 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700616 &quot;relatedUrl&quot;: [ # URLs associated with this note
617 { # Metadata for any related URL information
618 &quot;label&quot;: &quot;A String&quot;, # Label to describe usage of the URL
619 &quot;url&quot;: &quot;A String&quot;, # Specific URL to associate with the note
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700620 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700621 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700622 &quot;discovery&quot;: { # A note that indicates a type of analysis a provider would perform. This note exists in a provider&#x27;s project. A `Discovery` occurrence is created in a consumer&#x27;s project at the start of analysis. The occurrence&#x27;s operation will indicate the status of the analysis. Absence of an occurrence linked to this note for a resource indicates that analysis hasn&#x27;t started. # A note describing a provider/analysis type.
623 &quot;analysisKind&quot;: &quot;A String&quot;, # The kind of analysis that is handled by this discovery.
624 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700625 &quot;name&quot;: &quot;A String&quot;, # The name of the note in the form &quot;projects/{provider_project_id}/notes/{NOTE_ID}&quot;
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700626 &quot;package&quot;: { # This represents a particular package that is distributed over various channels. e.g. glibc (aka libc6) is distributed by many, at various versions. # A note describing a package hosted by various package managers.
627 &quot;distribution&quot;: [ # The various channels by which a package is distributed.
628 { # This represents a particular channel of distribution for a given package. e.g. Debian&#x27;s jessie-backports dpkg mirror
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700629 &quot;architecture&quot;: &quot;A String&quot;, # The CPU architecture for which packages in this distribution channel were built
630 &quot;url&quot;: &quot;A String&quot;, # The distribution channel-specific homepage for this package.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700631 &quot;maintainer&quot;: &quot;A String&quot;, # A freeform string denoting the maintainer of this package.
632 &quot;description&quot;: &quot;A String&quot;, # The distribution channel-specific description of this package.
633 &quot;cpeUri&quot;: &quot;A String&quot;, # The cpe_uri in [cpe format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package.
634 &quot;latestVersion&quot;: { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The latest available version of this package in this distribution channel.
635 &quot;revision&quot;: &quot;A String&quot;, # The iteration of the package build from the above version.
636 &quot;kind&quot;: &quot;A String&quot;, # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored.
637 &quot;name&quot;: &quot;A String&quot;, # The main part of the version name.
638 &quot;epoch&quot;: 42, # Used to correct mistakes in the version numbering scheme.
639 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700640 },
641 ],
642 &quot;name&quot;: &quot;A String&quot;, # The name of the package.
643 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700644 &quot;shortDescription&quot;: &quot;A String&quot;, # A one sentence description of this `Note`.
645 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time this note was created. This field can be used as a filter in list requests.
646 &quot;deployable&quot;: { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed.
647 &quot;resourceUri&quot;: [ # Resource URI for the artifact being deployed.
648 &quot;A String&quot;,
649 ],
650 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700651 &quot;vulnerabilityType&quot;: { # VulnerabilityType provides metadata about a security vulnerability. # A package vulnerability type of note.
652 &quot;details&quot;: [ # All information about the package to specifically identify this vulnerability. One entry per (version range and cpe_uri) the package vulnerability has manifested in.
653 { # Identifies all occurrences of this vulnerability in the package for a specific distro/location For example: glibc in cpe:/o:debian:debian_linux:8 for versions 2.1 - 2.2
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700654 &quot;isObsolete&quot;: True or False, # Whether this Detail is obsolete. Occurrences are expected not to point to obsolete details.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700655 &quot;fixedLocation&quot;: { # The location of the vulnerability # The fix for this specific package version.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700656 &quot;version&quot;: { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The version of the package being described. This field can be used as a filter in list requests.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700657 &quot;revision&quot;: &quot;A String&quot;, # The iteration of the package build from the above version.
658 &quot;kind&quot;: &quot;A String&quot;, # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700659 &quot;name&quot;: &quot;A String&quot;, # The main part of the version name.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700660 &quot;epoch&quot;: 42, # Used to correct mistakes in the version numbering scheme.
661 },
662 &quot;cpeUri&quot;: &quot;A String&quot;, # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar. This field can be used as a filter in list requests.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700663 &quot;package&quot;: &quot;A String&quot;, # The package being described.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700664 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700665 &quot;cpeUri&quot;: &quot;A String&quot;, # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar. This field can be used as a filter in list requests.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700666 &quot;minAffectedVersion&quot;: { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The min version of the package in which the vulnerability exists.
667 &quot;revision&quot;: &quot;A String&quot;, # The iteration of the package build from the above version.
668 &quot;kind&quot;: &quot;A String&quot;, # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored.
669 &quot;name&quot;: &quot;A String&quot;, # The main part of the version name.
670 &quot;epoch&quot;: 42, # Used to correct mistakes in the version numbering scheme.
671 },
672 &quot;package&quot;: &quot;A String&quot;, # The name of the package where the vulnerability was found. This field can be used as a filter in list requests.
673 &quot;maxAffectedVersion&quot;: { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The max version of the package in which the vulnerability exists.
674 &quot;revision&quot;: &quot;A String&quot;, # The iteration of the package build from the above version.
675 &quot;kind&quot;: &quot;A String&quot;, # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored.
676 &quot;name&quot;: &quot;A String&quot;, # The main part of the version name.
677 &quot;epoch&quot;: 42, # Used to correct mistakes in the version numbering scheme.
678 },
679 &quot;packageType&quot;: &quot;A String&quot;, # The type of package; whether native or non native(ruby gems, node.js packages etc)
680 &quot;severityName&quot;: &quot;A String&quot;, # The severity (eg: distro assigned severity) for this vulnerability.
681 &quot;description&quot;: &quot;A String&quot;, # A vendor-specific description of this note.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700682 },
683 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700684 &quot;severity&quot;: &quot;A String&quot;, # Note provider assigned impact of the vulnerability
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700685 &quot;cvssScore&quot;: 3.14, # The CVSS score for this Vulnerability.
686 },
687 &quot;longDescription&quot;: &quot;A String&quot;, # A detailed description of this `Note`.
688 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time this note was last updated. This field can be used as a filter in list requests.
689 &quot;upgrade&quot;: { # An Upgrade Note represents a potential upgrade of a package to a given version. For each package version combination (i.e. bash 4.0, bash 4.1, bash 4.1.2), there will be a Upgrade Note. # A note describing an upgrade.
690 &quot;distributions&quot;: [ # Metadata about the upgrade for each specific operating system.
691 { # The Upgrade Distribution represents metadata about the Upgrade for each operating system (CPE). Some distributions have additional metadata around updates, classifying them into various categories and severities.
692 &quot;classification&quot;: &quot;A String&quot;, # The operating system classification of this Upgrade, as specified by the upstream operating system upgrade feed.
693 &quot;cpeUri&quot;: &quot;A String&quot;, # Required - The specific operating system this metadata applies to. See https://cpe.mitre.org/specification/.
694 &quot;severity&quot;: &quot;A String&quot;, # The severity as specified by the upstream operating system.
695 &quot;cve&quot;: [ # The cve that would be resolved by this upgrade.
696 &quot;A String&quot;,
697 ],
698 },
699 ],
700 &quot;package&quot;: &quot;A String&quot;, # Required - The package this Upgrade is for.
701 &quot;version&quot;: { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # Required - The version of the package in machine + human readable form.
702 &quot;revision&quot;: &quot;A String&quot;, # The iteration of the package build from the above version.
703 &quot;kind&quot;: &quot;A String&quot;, # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored.
704 &quot;name&quot;: &quot;A String&quot;, # The main part of the version name.
705 &quot;epoch&quot;: 42, # Used to correct mistakes in the version numbering scheme.
706 },
707 },
708 &quot;buildType&quot;: { # Note holding the version of the provider&#x27;s builder and the signature of the provenance message in linked BuildDetails. # Build provenance type for a verifiable build.
709 &quot;builderVersion&quot;: &quot;A String&quot;, # Version of the builder which produced this Note.
710 &quot;signature&quot;: { # Message encapsulating the signature of the verified build. # Signature of the build in Occurrences pointing to the Note containing this `BuilderDetails`.
711 &quot;publicKey&quot;: &quot;A String&quot;, # Public key of the builder which can be used to verify that the related findings are valid and unchanged. If `key_type` is empty, this defaults to PEM encoded public keys. This field may be empty if `key_id` references an external key. For Cloud Build based signatures, this is a PEM encoded public key. To verify the Cloud Build signature, place the contents of this field into a file (public.pem). The signature field is base64-decoded into its binary representation in signature.bin, and the provenance bytes from `BuildDetails` are base64-decoded into a binary representation in signed.bin. OpenSSL can then verify the signature: `openssl sha256 -verify public.pem -signature signature.bin signed.bin`
712 &quot;keyType&quot;: &quot;A String&quot;, # The type of the key, either stored in `public_key` or referenced in `key_id`
713 &quot;signature&quot;: &quot;A String&quot;, # Signature of the related `BuildProvenance`, encoded in a base64 string.
714 &quot;keyId&quot;: &quot;A String&quot;, # An Id for the key used to sign. This could be either an Id for the key stored in `public_key` (such as the Id or fingerprint for a PGP key, or the CN for a cert), or a reference to an external key (such as a reference to a key in Cloud Key Management Service).
715 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700716 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700717 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700718 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700719 &quot;nextPageToken&quot;: &quot;A String&quot;, # The next pagination token in the list response. It should be used as page_token for the following request. An empty value means no more result.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700720 }</pre>
721</div>
722
723<div class="method">
724 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
725 <pre>Retrieves the next page of results.
726
727Args:
728 previous_request: The request for the previous page. (required)
729 previous_response: The response from the request for the previous page. (required)
730
731Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700732 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700733 page. Returns None if there are no more items in the collection.
734 </pre>
735</div>
736
737<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700738 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700739 <pre>Updates an existing `Note`.
740
741Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700742 name: string, The name of the note. Should be of the form &quot;projects/{provider_id}/notes/{note_id}&quot;. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700743 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700744 The object takes the form of:
745
746{ # Provides a detailed description of a `Note`.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700747 &quot;baseImage&quot;: { # Basis describes the base image portion (Note) of the DockerImage relationship. Linked occurrences are derived from this or an equivalent image via: FROM Or an equivalent reference, e.g. a tag of the resource_url. # A note describing a base image.
748 &quot;fingerprint&quot;: { # A set of properties that uniquely identify a given Docker image. # The fingerprint of the base image.
749 &quot;v2Name&quot;: &quot;A String&quot;, # Output only. The name of the image&#x27;s v2 blobs computed via: [bottom] := v2_blobbottom := sha256(v2_blob[N] + &quot; &quot; + v2_name[N+1]) Only the name of the final blob is kept. This field can be used as a filter in list requests.
750 &quot;v1Name&quot;: &quot;A String&quot;, # The layer-id of the final layer in the Docker image&#x27;s v1 representation. This field can be used as a filter in list requests.
751 &quot;v2Blob&quot;: [ # The ordered list of v2 blobs that represent a given image.
752 &quot;A String&quot;,
753 ],
754 },
755 &quot;resourceUrl&quot;: &quot;A String&quot;, # The resource_url for the resource representing the basis of associated occurrence images.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700756 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700757 &quot;kind&quot;: &quot;A String&quot;, # Output only. This explicitly denotes which kind of note is specified. This field can be used as a filter in list requests.
758 &quot;expirationTime&quot;: &quot;A String&quot;, # Time of expiration for this note, null if note does not expire.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700759 &quot;attestationAuthority&quot;: { # Note kind that represents a logical attestation &quot;role&quot; or &quot;authority&quot;. For example, an organization might have one `AttestationAuthority` for &quot;QA&quot; and one for &quot;build&quot;. This Note is intended to act strictly as a grouping mechanism for the attached Occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an Occurrence to a given Note. It also provides a single point of lookup to find all attached Attestation Occurrences, even if they don&#x27;t all live in the same project. # A note describing an attestation role.
760 &quot;hint&quot;: { # This submessage provides human-readable hints about the purpose of the AttestationAuthority. Because the name of a Note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from &quot;readable&quot; names more suitable for debug output. Note that these hints should NOT be used to look up AttestationAuthorities in security sensitive contexts, such as when looking up Attestations to verify.
Bu Sun Kim65020912020-05-20 12:08:20 -0700761 &quot;humanReadableName&quot;: &quot;A String&quot;, # The human readable name of this Attestation Authority, for example &quot;qa&quot;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700762 },
763 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700764 &quot;relatedUrl&quot;: [ # URLs associated with this note
765 { # Metadata for any related URL information
766 &quot;label&quot;: &quot;A String&quot;, # Label to describe usage of the URL
767 &quot;url&quot;: &quot;A String&quot;, # Specific URL to associate with the note
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700768 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700769 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700770 &quot;discovery&quot;: { # A note that indicates a type of analysis a provider would perform. This note exists in a provider&#x27;s project. A `Discovery` occurrence is created in a consumer&#x27;s project at the start of analysis. The occurrence&#x27;s operation will indicate the status of the analysis. Absence of an occurrence linked to this note for a resource indicates that analysis hasn&#x27;t started. # A note describing a provider/analysis type.
771 &quot;analysisKind&quot;: &quot;A String&quot;, # The kind of analysis that is handled by this discovery.
772 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700773 &quot;name&quot;: &quot;A String&quot;, # The name of the note in the form &quot;projects/{provider_project_id}/notes/{NOTE_ID}&quot;
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700774 &quot;package&quot;: { # This represents a particular package that is distributed over various channels. e.g. glibc (aka libc6) is distributed by many, at various versions. # A note describing a package hosted by various package managers.
775 &quot;distribution&quot;: [ # The various channels by which a package is distributed.
776 { # This represents a particular channel of distribution for a given package. e.g. Debian&#x27;s jessie-backports dpkg mirror
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700777 &quot;architecture&quot;: &quot;A String&quot;, # The CPU architecture for which packages in this distribution channel were built
778 &quot;url&quot;: &quot;A String&quot;, # The distribution channel-specific homepage for this package.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700779 &quot;maintainer&quot;: &quot;A String&quot;, # A freeform string denoting the maintainer of this package.
780 &quot;description&quot;: &quot;A String&quot;, # The distribution channel-specific description of this package.
781 &quot;cpeUri&quot;: &quot;A String&quot;, # The cpe_uri in [cpe format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package.
782 &quot;latestVersion&quot;: { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The latest available version of this package in this distribution channel.
783 &quot;revision&quot;: &quot;A String&quot;, # The iteration of the package build from the above version.
784 &quot;kind&quot;: &quot;A String&quot;, # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored.
785 &quot;name&quot;: &quot;A String&quot;, # The main part of the version name.
786 &quot;epoch&quot;: 42, # Used to correct mistakes in the version numbering scheme.
787 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700788 },
789 ],
790 &quot;name&quot;: &quot;A String&quot;, # The name of the package.
791 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700792 &quot;shortDescription&quot;: &quot;A String&quot;, # A one sentence description of this `Note`.
793 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time this note was created. This field can be used as a filter in list requests.
794 &quot;deployable&quot;: { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed.
795 &quot;resourceUri&quot;: [ # Resource URI for the artifact being deployed.
796 &quot;A String&quot;,
797 ],
798 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700799 &quot;vulnerabilityType&quot;: { # VulnerabilityType provides metadata about a security vulnerability. # A package vulnerability type of note.
800 &quot;details&quot;: [ # All information about the package to specifically identify this vulnerability. One entry per (version range and cpe_uri) the package vulnerability has manifested in.
801 { # Identifies all occurrences of this vulnerability in the package for a specific distro/location For example: glibc in cpe:/o:debian:debian_linux:8 for versions 2.1 - 2.2
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700802 &quot;isObsolete&quot;: True or False, # Whether this Detail is obsolete. Occurrences are expected not to point to obsolete details.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700803 &quot;fixedLocation&quot;: { # The location of the vulnerability # The fix for this specific package version.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700804 &quot;version&quot;: { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The version of the package being described. This field can be used as a filter in list requests.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700805 &quot;revision&quot;: &quot;A String&quot;, # The iteration of the package build from the above version.
806 &quot;kind&quot;: &quot;A String&quot;, # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700807 &quot;name&quot;: &quot;A String&quot;, # The main part of the version name.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700808 &quot;epoch&quot;: 42, # Used to correct mistakes in the version numbering scheme.
809 },
810 &quot;cpeUri&quot;: &quot;A String&quot;, # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar. This field can be used as a filter in list requests.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700811 &quot;package&quot;: &quot;A String&quot;, # The package being described.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700812 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700813 &quot;cpeUri&quot;: &quot;A String&quot;, # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar. This field can be used as a filter in list requests.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700814 &quot;minAffectedVersion&quot;: { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The min version of the package in which the vulnerability exists.
815 &quot;revision&quot;: &quot;A String&quot;, # The iteration of the package build from the above version.
816 &quot;kind&quot;: &quot;A String&quot;, # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored.
817 &quot;name&quot;: &quot;A String&quot;, # The main part of the version name.
818 &quot;epoch&quot;: 42, # Used to correct mistakes in the version numbering scheme.
819 },
820 &quot;package&quot;: &quot;A String&quot;, # The name of the package where the vulnerability was found. This field can be used as a filter in list requests.
821 &quot;maxAffectedVersion&quot;: { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The max version of the package in which the vulnerability exists.
822 &quot;revision&quot;: &quot;A String&quot;, # The iteration of the package build from the above version.
823 &quot;kind&quot;: &quot;A String&quot;, # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored.
824 &quot;name&quot;: &quot;A String&quot;, # The main part of the version name.
825 &quot;epoch&quot;: 42, # Used to correct mistakes in the version numbering scheme.
826 },
827 &quot;packageType&quot;: &quot;A String&quot;, # The type of package; whether native or non native(ruby gems, node.js packages etc)
828 &quot;severityName&quot;: &quot;A String&quot;, # The severity (eg: distro assigned severity) for this vulnerability.
829 &quot;description&quot;: &quot;A String&quot;, # A vendor-specific description of this note.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700830 },
831 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700832 &quot;severity&quot;: &quot;A String&quot;, # Note provider assigned impact of the vulnerability
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700833 &quot;cvssScore&quot;: 3.14, # The CVSS score for this Vulnerability.
834 },
835 &quot;longDescription&quot;: &quot;A String&quot;, # A detailed description of this `Note`.
836 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time this note was last updated. This field can be used as a filter in list requests.
837 &quot;upgrade&quot;: { # An Upgrade Note represents a potential upgrade of a package to a given version. For each package version combination (i.e. bash 4.0, bash 4.1, bash 4.1.2), there will be a Upgrade Note. # A note describing an upgrade.
838 &quot;distributions&quot;: [ # Metadata about the upgrade for each specific operating system.
839 { # The Upgrade Distribution represents metadata about the Upgrade for each operating system (CPE). Some distributions have additional metadata around updates, classifying them into various categories and severities.
840 &quot;classification&quot;: &quot;A String&quot;, # The operating system classification of this Upgrade, as specified by the upstream operating system upgrade feed.
841 &quot;cpeUri&quot;: &quot;A String&quot;, # Required - The specific operating system this metadata applies to. See https://cpe.mitre.org/specification/.
842 &quot;severity&quot;: &quot;A String&quot;, # The severity as specified by the upstream operating system.
843 &quot;cve&quot;: [ # The cve that would be resolved by this upgrade.
844 &quot;A String&quot;,
845 ],
846 },
847 ],
848 &quot;package&quot;: &quot;A String&quot;, # Required - The package this Upgrade is for.
849 &quot;version&quot;: { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # Required - The version of the package in machine + human readable form.
850 &quot;revision&quot;: &quot;A String&quot;, # The iteration of the package build from the above version.
851 &quot;kind&quot;: &quot;A String&quot;, # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored.
852 &quot;name&quot;: &quot;A String&quot;, # The main part of the version name.
853 &quot;epoch&quot;: 42, # Used to correct mistakes in the version numbering scheme.
854 },
855 },
856 &quot;buildType&quot;: { # Note holding the version of the provider&#x27;s builder and the signature of the provenance message in linked BuildDetails. # Build provenance type for a verifiable build.
857 &quot;builderVersion&quot;: &quot;A String&quot;, # Version of the builder which produced this Note.
858 &quot;signature&quot;: { # Message encapsulating the signature of the verified build. # Signature of the build in Occurrences pointing to the Note containing this `BuilderDetails`.
859 &quot;publicKey&quot;: &quot;A String&quot;, # Public key of the builder which can be used to verify that the related findings are valid and unchanged. If `key_type` is empty, this defaults to PEM encoded public keys. This field may be empty if `key_id` references an external key. For Cloud Build based signatures, this is a PEM encoded public key. To verify the Cloud Build signature, place the contents of this field into a file (public.pem). The signature field is base64-decoded into its binary representation in signature.bin, and the provenance bytes from `BuildDetails` are base64-decoded into a binary representation in signed.bin. OpenSSL can then verify the signature: `openssl sha256 -verify public.pem -signature signature.bin signed.bin`
860 &quot;keyType&quot;: &quot;A String&quot;, # The type of the key, either stored in `public_key` or referenced in `key_id`
861 &quot;signature&quot;: &quot;A String&quot;, # Signature of the related `BuildProvenance`, encoded in a base64 string.
862 &quot;keyId&quot;: &quot;A String&quot;, # An Id for the key used to sign. This could be either an Id for the key stored in `public_key` (such as the Id or fingerprint for a PGP key, or the CN for a cert), or a reference to an external key (such as a reference to a key in Cloud Key Management Service).
863 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700864 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700865 }
866
867 updateMask: string, The fields to update.
868 x__xgafv: string, V1 error format.
869 Allowed values
870 1 - v1 error format
871 2 - v2 error format
872
873Returns:
874 An object of the form:
875
876 { # Provides a detailed description of a `Note`.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700877 &quot;baseImage&quot;: { # Basis describes the base image portion (Note) of the DockerImage relationship. Linked occurrences are derived from this or an equivalent image via: FROM Or an equivalent reference, e.g. a tag of the resource_url. # A note describing a base image.
878 &quot;fingerprint&quot;: { # A set of properties that uniquely identify a given Docker image. # The fingerprint of the base image.
879 &quot;v2Name&quot;: &quot;A String&quot;, # Output only. The name of the image&#x27;s v2 blobs computed via: [bottom] := v2_blobbottom := sha256(v2_blob[N] + &quot; &quot; + v2_name[N+1]) Only the name of the final blob is kept. This field can be used as a filter in list requests.
880 &quot;v1Name&quot;: &quot;A String&quot;, # The layer-id of the final layer in the Docker image&#x27;s v1 representation. This field can be used as a filter in list requests.
881 &quot;v2Blob&quot;: [ # The ordered list of v2 blobs that represent a given image.
882 &quot;A String&quot;,
883 ],
884 },
885 &quot;resourceUrl&quot;: &quot;A String&quot;, # The resource_url for the resource representing the basis of associated occurrence images.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700886 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700887 &quot;kind&quot;: &quot;A String&quot;, # Output only. This explicitly denotes which kind of note is specified. This field can be used as a filter in list requests.
888 &quot;expirationTime&quot;: &quot;A String&quot;, # Time of expiration for this note, null if note does not expire.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700889 &quot;attestationAuthority&quot;: { # Note kind that represents a logical attestation &quot;role&quot; or &quot;authority&quot;. For example, an organization might have one `AttestationAuthority` for &quot;QA&quot; and one for &quot;build&quot;. This Note is intended to act strictly as a grouping mechanism for the attached Occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an Occurrence to a given Note. It also provides a single point of lookup to find all attached Attestation Occurrences, even if they don&#x27;t all live in the same project. # A note describing an attestation role.
890 &quot;hint&quot;: { # This submessage provides human-readable hints about the purpose of the AttestationAuthority. Because the name of a Note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from &quot;readable&quot; names more suitable for debug output. Note that these hints should NOT be used to look up AttestationAuthorities in security sensitive contexts, such as when looking up Attestations to verify.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700891 &quot;humanReadableName&quot;: &quot;A String&quot;, # The human readable name of this Attestation Authority, for example &quot;qa&quot;.
892 },
893 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700894 &quot;relatedUrl&quot;: [ # URLs associated with this note
895 { # Metadata for any related URL information
896 &quot;label&quot;: &quot;A String&quot;, # Label to describe usage of the URL
897 &quot;url&quot;: &quot;A String&quot;, # Specific URL to associate with the note
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700898 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700899 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700900 &quot;discovery&quot;: { # A note that indicates a type of analysis a provider would perform. This note exists in a provider&#x27;s project. A `Discovery` occurrence is created in a consumer&#x27;s project at the start of analysis. The occurrence&#x27;s operation will indicate the status of the analysis. Absence of an occurrence linked to this note for a resource indicates that analysis hasn&#x27;t started. # A note describing a provider/analysis type.
901 &quot;analysisKind&quot;: &quot;A String&quot;, # The kind of analysis that is handled by this discovery.
902 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700903 &quot;name&quot;: &quot;A String&quot;, # The name of the note in the form &quot;projects/{provider_project_id}/notes/{NOTE_ID}&quot;
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700904 &quot;package&quot;: { # This represents a particular package that is distributed over various channels. e.g. glibc (aka libc6) is distributed by many, at various versions. # A note describing a package hosted by various package managers.
905 &quot;distribution&quot;: [ # The various channels by which a package is distributed.
906 { # This represents a particular channel of distribution for a given package. e.g. Debian&#x27;s jessie-backports dpkg mirror
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700907 &quot;architecture&quot;: &quot;A String&quot;, # The CPU architecture for which packages in this distribution channel were built
908 &quot;url&quot;: &quot;A String&quot;, # The distribution channel-specific homepage for this package.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700909 &quot;maintainer&quot;: &quot;A String&quot;, # A freeform string denoting the maintainer of this package.
910 &quot;description&quot;: &quot;A String&quot;, # The distribution channel-specific description of this package.
911 &quot;cpeUri&quot;: &quot;A String&quot;, # The cpe_uri in [cpe format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package.
912 &quot;latestVersion&quot;: { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The latest available version of this package in this distribution channel.
913 &quot;revision&quot;: &quot;A String&quot;, # The iteration of the package build from the above version.
914 &quot;kind&quot;: &quot;A String&quot;, # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored.
915 &quot;name&quot;: &quot;A String&quot;, # The main part of the version name.
916 &quot;epoch&quot;: 42, # Used to correct mistakes in the version numbering scheme.
917 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700918 },
919 ],
920 &quot;name&quot;: &quot;A String&quot;, # The name of the package.
921 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700922 &quot;shortDescription&quot;: &quot;A String&quot;, # A one sentence description of this `Note`.
923 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time this note was created. This field can be used as a filter in list requests.
924 &quot;deployable&quot;: { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed.
925 &quot;resourceUri&quot;: [ # Resource URI for the artifact being deployed.
926 &quot;A String&quot;,
927 ],
928 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700929 &quot;vulnerabilityType&quot;: { # VulnerabilityType provides metadata about a security vulnerability. # A package vulnerability type of note.
930 &quot;details&quot;: [ # All information about the package to specifically identify this vulnerability. One entry per (version range and cpe_uri) the package vulnerability has manifested in.
931 { # Identifies all occurrences of this vulnerability in the package for a specific distro/location For example: glibc in cpe:/o:debian:debian_linux:8 for versions 2.1 - 2.2
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700932 &quot;isObsolete&quot;: True or False, # Whether this Detail is obsolete. Occurrences are expected not to point to obsolete details.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700933 &quot;fixedLocation&quot;: { # The location of the vulnerability # The fix for this specific package version.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700934 &quot;version&quot;: { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The version of the package being described. This field can be used as a filter in list requests.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700935 &quot;revision&quot;: &quot;A String&quot;, # The iteration of the package build from the above version.
936 &quot;kind&quot;: &quot;A String&quot;, # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700937 &quot;name&quot;: &quot;A String&quot;, # The main part of the version name.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700938 &quot;epoch&quot;: 42, # Used to correct mistakes in the version numbering scheme.
939 },
940 &quot;cpeUri&quot;: &quot;A String&quot;, # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar. This field can be used as a filter in list requests.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700941 &quot;package&quot;: &quot;A String&quot;, # The package being described.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700942 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700943 &quot;cpeUri&quot;: &quot;A String&quot;, # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar. This field can be used as a filter in list requests.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700944 &quot;minAffectedVersion&quot;: { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The min version of the package in which the vulnerability exists.
945 &quot;revision&quot;: &quot;A String&quot;, # The iteration of the package build from the above version.
946 &quot;kind&quot;: &quot;A String&quot;, # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored.
947 &quot;name&quot;: &quot;A String&quot;, # The main part of the version name.
948 &quot;epoch&quot;: 42, # Used to correct mistakes in the version numbering scheme.
949 },
950 &quot;package&quot;: &quot;A String&quot;, # The name of the package where the vulnerability was found. This field can be used as a filter in list requests.
951 &quot;maxAffectedVersion&quot;: { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The max version of the package in which the vulnerability exists.
952 &quot;revision&quot;: &quot;A String&quot;, # The iteration of the package build from the above version.
953 &quot;kind&quot;: &quot;A String&quot;, # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored.
954 &quot;name&quot;: &quot;A String&quot;, # The main part of the version name.
955 &quot;epoch&quot;: 42, # Used to correct mistakes in the version numbering scheme.
956 },
957 &quot;packageType&quot;: &quot;A String&quot;, # The type of package; whether native or non native(ruby gems, node.js packages etc)
958 &quot;severityName&quot;: &quot;A String&quot;, # The severity (eg: distro assigned severity) for this vulnerability.
959 &quot;description&quot;: &quot;A String&quot;, # A vendor-specific description of this note.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700960 },
961 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700962 &quot;severity&quot;: &quot;A String&quot;, # Note provider assigned impact of the vulnerability
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700963 &quot;cvssScore&quot;: 3.14, # The CVSS score for this Vulnerability.
964 },
965 &quot;longDescription&quot;: &quot;A String&quot;, # A detailed description of this `Note`.
966 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time this note was last updated. This field can be used as a filter in list requests.
967 &quot;upgrade&quot;: { # An Upgrade Note represents a potential upgrade of a package to a given version. For each package version combination (i.e. bash 4.0, bash 4.1, bash 4.1.2), there will be a Upgrade Note. # A note describing an upgrade.
968 &quot;distributions&quot;: [ # Metadata about the upgrade for each specific operating system.
969 { # The Upgrade Distribution represents metadata about the Upgrade for each operating system (CPE). Some distributions have additional metadata around updates, classifying them into various categories and severities.
970 &quot;classification&quot;: &quot;A String&quot;, # The operating system classification of this Upgrade, as specified by the upstream operating system upgrade feed.
971 &quot;cpeUri&quot;: &quot;A String&quot;, # Required - The specific operating system this metadata applies to. See https://cpe.mitre.org/specification/.
972 &quot;severity&quot;: &quot;A String&quot;, # The severity as specified by the upstream operating system.
973 &quot;cve&quot;: [ # The cve that would be resolved by this upgrade.
974 &quot;A String&quot;,
975 ],
976 },
977 ],
978 &quot;package&quot;: &quot;A String&quot;, # Required - The package this Upgrade is for.
979 &quot;version&quot;: { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # Required - The version of the package in machine + human readable form.
980 &quot;revision&quot;: &quot;A String&quot;, # The iteration of the package build from the above version.
981 &quot;kind&quot;: &quot;A String&quot;, # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored.
982 &quot;name&quot;: &quot;A String&quot;, # The main part of the version name.
983 &quot;epoch&quot;: 42, # Used to correct mistakes in the version numbering scheme.
984 },
985 },
986 &quot;buildType&quot;: { # Note holding the version of the provider&#x27;s builder and the signature of the provenance message in linked BuildDetails. # Build provenance type for a verifiable build.
987 &quot;builderVersion&quot;: &quot;A String&quot;, # Version of the builder which produced this Note.
988 &quot;signature&quot;: { # Message encapsulating the signature of the verified build. # Signature of the build in Occurrences pointing to the Note containing this `BuilderDetails`.
989 &quot;publicKey&quot;: &quot;A String&quot;, # Public key of the builder which can be used to verify that the related findings are valid and unchanged. If `key_type` is empty, this defaults to PEM encoded public keys. This field may be empty if `key_id` references an external key. For Cloud Build based signatures, this is a PEM encoded public key. To verify the Cloud Build signature, place the contents of this field into a file (public.pem). The signature field is base64-decoded into its binary representation in signature.bin, and the provenance bytes from `BuildDetails` are base64-decoded into a binary representation in signed.bin. OpenSSL can then verify the signature: `openssl sha256 -verify public.pem -signature signature.bin signed.bin`
990 &quot;keyType&quot;: &quot;A String&quot;, # The type of the key, either stored in `public_key` or referenced in `key_id`
991 &quot;signature&quot;: &quot;A String&quot;, # Signature of the related `BuildProvenance`, encoded in a base64 string.
992 &quot;keyId&quot;: &quot;A String&quot;, # An Id for the key used to sign. This could be either an Id for the key stored in `public_key` (such as the Id or fingerprint for a PGP key, or the CN for a cert), or a reference to an external key (such as a reference to a key in Cloud Key Management Service).
993 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700994 },
995 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700996</div>
997
998<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700999 <code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -07001000 <pre>Sets the access control policy on the specified `Note` or `Occurrence`. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a `Note` or an `Occurrence`, respectively. Attempting to call this method without these permissions will result in a ` `PERMISSION_DENIED` error. Attempting to call this method on a non-existent resource will result in a `NOT_FOUND` error if the user has `containeranalysis.notes.list` permission on a `Note` or `containeranalysis.occurrences.list` on an `Occurrence`, or a `PERMISSION_DENIED` error otherwise. The resource takes the following formats: `projects/{projectid}/occurrences/{occurrenceid}` for occurrences and projects/{projectid}/notes/{noteid} for notes
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001001
1002Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -07001003 resource: string, REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -07001004 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001005 The object takes the form of:
1006
1007{ # Request message for `SetIamPolicy` method.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -07001008 &quot;policy&quot;: { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { &quot;bindings&quot;: [ { &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;, &quot;members&quot;: [ &quot;user:mike@example.com&quot;, &quot;group:admins@example.com&quot;, &quot;domain:google.com&quot;, &quot;serviceAccount:my-project-id@appspot.gserviceaccount.com&quot; ] }, { &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;, &quot;members&quot;: [ &quot;user:eve@example.com&quot; ], &quot;condition&quot;: { &quot;title&quot;: &quot;expirable access&quot;, &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;, &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;, } } ], &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;, &quot;version&quot;: 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;) - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
1009 &quot;version&quot;: 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Dmitry Frenkel3e17f892020-10-06 16:46:05 -07001010 &quot;bindings&quot;: [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001011 { # Associates `members` with a `role`.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -07001012 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: &quot;Summary size limit&quot; description: &quot;Determines if a summary is less than 100 chars&quot; expression: &quot;document.summary.size() &lt; 100&quot; Example (Equality): title: &quot;Requestor is owner&quot; description: &quot;Determines if requestor is the document owner&quot; expression: &quot;document.owner == request.auth.claims.email&quot; Example (Logic): title: &quot;Public documents&quot; description: &quot;Determine whether the document should be publicly visible&quot; expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot; Example (Data Manipulation): title: &quot;Notification string&quot; description: &quot;Create a notification string with a timestamp.&quot; expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot; The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
1013 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
1014 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language syntax.
1015 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
1016 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
1017 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -07001018 &quot;members&quot;: [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
Bu Sun Kim65020912020-05-20 12:08:20 -07001019 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001020 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -07001021 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -07001022 &quot;bindingId&quot;: &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001023 },
1024 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -07001025 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001026 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001027 }
1028
1029 x__xgafv: string, V1 error format.
1030 Allowed values
1031 1 - v1 error format
1032 2 - v2 error format
1033
1034Returns:
1035 An object of the form:
1036
Dmitry Frenkel3e17f892020-10-06 16:46:05 -07001037 { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { &quot;bindings&quot;: [ { &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;, &quot;members&quot;: [ &quot;user:mike@example.com&quot;, &quot;group:admins@example.com&quot;, &quot;domain:google.com&quot;, &quot;serviceAccount:my-project-id@appspot.gserviceaccount.com&quot; ] }, { &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;, &quot;members&quot;: [ &quot;user:eve@example.com&quot; ], &quot;condition&quot;: { &quot;title&quot;: &quot;expirable access&quot;, &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;, &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;, } } ], &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;, &quot;version&quot;: 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;) - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
1038 &quot;version&quot;: 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Dmitry Frenkel3e17f892020-10-06 16:46:05 -07001039 &quot;bindings&quot;: [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001040 { # Associates `members` with a `role`.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -07001041 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: &quot;Summary size limit&quot; description: &quot;Determines if a summary is less than 100 chars&quot; expression: &quot;document.summary.size() &lt; 100&quot; Example (Equality): title: &quot;Requestor is owner&quot; description: &quot;Determines if requestor is the document owner&quot; expression: &quot;document.owner == request.auth.claims.email&quot; Example (Logic): title: &quot;Public documents&quot; description: &quot;Determine whether the document should be publicly visible&quot; expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot; Example (Data Manipulation): title: &quot;Notification string&quot; description: &quot;Create a notification string with a timestamp.&quot; expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot; The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
1042 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
1043 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language syntax.
1044 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
1045 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
1046 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -07001047 &quot;members&quot;: [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
Bu Sun Kim65020912020-05-20 12:08:20 -07001048 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001049 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -07001050 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -07001051 &quot;bindingId&quot;: &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001052 },
1053 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -07001054 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001055 }</pre>
1056</div>
1057
1058<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -07001059 <code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -07001060 <pre>Returns the permissions that a caller has on the specified note or occurrence resource. Requires list permission on the project (for example, &quot;storage.objects.list&quot; on the containing bucket for testing permission of an object). Attempting to call this method on a non-existent resource will result in a `NOT_FOUND` error if the user has list permission on the project, or a `PERMISSION_DENIED` error otherwise. The resource takes the following formats: `projects/{PROJECT_ID}/occurrences/{OCCURRENCE_ID}` for `Occurrences` and `projects/{PROJECT_ID}/notes/{NOTE_ID}` for `Notes`
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001061
1062Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -07001063 resource: string, REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -07001064 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001065 The object takes the form of:
1066
1067{ # Request message for `TestIamPermissions` method.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -07001068 &quot;permissions&quot;: [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as &#x27;*&#x27; or &#x27;storage.*&#x27;) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
Bu Sun Kim65020912020-05-20 12:08:20 -07001069 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001070 ],
1071 }
1072
1073 x__xgafv: string, V1 error format.
1074 Allowed values
1075 1 - v1 error format
1076 2 - v2 error format
1077
1078Returns:
1079 An object of the form:
1080
1081 { # Response message for `TestIamPermissions` method.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -07001082 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
Bu Sun Kim65020912020-05-20 12:08:20 -07001083 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001084 ],
1085 }</pre>
1086</div>
1087
1088</body></html>