Debian Codegraph @

docs/dyn/compute_alpha.images.html

raw
1 <html><body>
2 <style>
3
4 body, 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
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, 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="compute_alpha.html">Compute Engine API</a> . <a href="compute_alpha.images.html">images</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#delete">delete(project, image, requestId=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Deletes the specified image.</p>
83 <p class="toc_element">
84 <code><a href="#deprecate">deprecate(project, image, body=None, requestId=None, x__xgafv=None)</a></code></p>
85 <p class="firstline">Sets the deprecation status of an image.</p>
86 <p class="toc_element">
87 <code><a href="#get">get(project, image, x__xgafv=None)</a></code></p>
88 <p class="firstline">Returns the specified image.</p>
89 <p class="toc_element">
90 <code><a href="#getFromFamily">getFromFamily(project, family, x__xgafv=None)</a></code></p>
91 <p class="firstline">Returns the latest image that is part of an image family and is not</p>
92 <p class="toc_element">
93 <code><a href="#getIamPolicy">getIamPolicy(project, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</a></code></p>
94 <p class="firstline">Gets the access control policy for a resource. May be empty if no such</p>
95 <p class="toc_element">
96 <code><a href="#insert">insert(project, body=None, forceCreate=None, requestId=None, x__xgafv=None)</a></code></p>
97 <p class="firstline">Creates an image in the specified project using the data included</p>
98 <p class="toc_element">
99 <code><a href="#list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None, zone=None)</a></code></p>
100 <p class="firstline">Retrieves the list of custom images</p>
101 <p class="toc_element">
102 <code><a href="#list_next">list_next()</a></code></p>
103 <p class="firstline">Retrieves the next page of results.</p>
104 <p class="toc_element">
105 <code><a href="#patch">patch(project, image, body=None, requestId=None, x__xgafv=None)</a></code></p>
106 <p class="firstline">Patches the specified image with the data included in the request.</p>
107 <p class="toc_element">
108 <code><a href="#setIamPolicy">setIamPolicy(project, resource, body=None, x__xgafv=None)</a></code></p>
109 <p class="firstline">Sets the access control policy on the specified resource.</p>
110 <p class="toc_element">
111 <code><a href="#setLabels">setLabels(project, resource, body=None, x__xgafv=None)</a></code></p>
112 <p class="firstline">Sets the labels on an image. To learn more about labels, read theLabeling</p>
113 <p class="toc_element">
114 <code><a href="#testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</a></code></p>
115 <p class="firstline">Returns permissions that a caller has on the specified resource.</p>
116 <h3>Method Details</h3>
117 <div class="method">
118 <code class="details" id="close">close()</code>
119 <pre>Close httplib2 connections.</pre>
120 </div>
121
122 <div class="method">
123 <code class="details" id="delete">delete(project, image, requestId=None, x__xgafv=None)</code>
124 <pre>Deletes the specified image.
125
126 Args:
127 project: string, Project ID for this request. (required)
128 image: string, Name of the image resource to delete. (required)
129 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
130 that if you must retry your request, the server will know to ignore the
131 request if it has already been completed.
132
133 For example, consider a situation where you make an initial request and
134 the request times out. If you make the request again with the same
135 request ID, the server can check if original operation with the same
136 request ID was received, and if so, will ignore the second request. This
137 prevents clients from accidentally creating duplicate commitments.
138
139 The request ID must be
140 a valid UUID with the exception that zero UUID is not supported
141 (00000000-0000-0000-0000-000000000000).
142 x__xgafv: string, V1 error format.
143 Allowed values
144 1 - v1 error format
145 2 - v2 error format
146
147 Returns:
148 An object of the form:
149
150 { # Represents an Operation resource.
151 #
152 # Google Compute Engine has three Operation resources:
153 #
154 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
155 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
156 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
157 #
158 # You can use an operation resource to manage asynchronous API requests.
159 # For more information, readHandling
160 # API responses.
161 #
162 # Operations can be global, regional or zonal.
163 #
164 # - For global operations, use the `globalOperations`
165 # resource.
166 # - For regional operations, use the
167 # `regionOperations` resource.
168 # - For zonal operations, use
169 # the `zoneOperations` resource.
170 #
171 #
172 #
173 # For more information, read
174 # Global, Regional, and Zonal Resources.
175 #
176 # Note that completed Operation resources have a limited
177 # retention period.
178 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
179 # Not present otherwise.
180 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
181 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
182 # set when the operation is created.
183 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
184 # text format.
185 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
186 # this field will be populated.
187 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
188 # operation.
189 {
190 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
191 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
192 # details. There is a set of defined message types to use for providing
193 # details.The syntax depends on the error code. For example,
194 # QuotaExceededInfo will have details when the error code is
195 # QUOTA_EXCEEDED.
196 {
197 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
198 #
199 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
200 # is not enabled:
201 #
202 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
203 # &quot;domain&quot;: &quot;googleapis.com&quot;
204 # &quot;metadata&quot;: {
205 # &quot;resource&quot;: &quot;projects/123&quot;,
206 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
207 # }
208 # }
209 #
210 # This response indicates that the pubsub.googleapis.com API is not enabled.
211 #
212 # Example of an error that is returned when attempting to create a Spanner
213 # instance in a region that is out of stock:
214 #
215 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
216 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
217 # &quot;metadata&quot;: {
218 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
219 # }
220 # }
221 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
222 # is typically the registered service name of the tool or product that
223 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
224 # generated by some common infrastructure, the error domain must be a
225 # globally unique value that identifies the infrastructure. For Google API
226 # infrastructure, the error domain is &quot;googleapis.com&quot;.
227 &quot;metadatas&quot;: { # Additional structured details about this error.
228 #
229 # Keys must match a regular expression of `a-z+` but should
230 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
231 # length. When identifying the current value of an exceeded limit, the units
232 # should be contained in the key, not the value. For example, rather than
233 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
234 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
235 # instances that can be created in a single (batch) request.
236 &quot;a_key&quot;: &quot;A String&quot;,
237 },
238 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
239 # proximate cause of the error. Error reasons are unique within a particular
240 # domain of errors. This should be at most 63 characters and match a
241 # regular expression of `A-Z+[A-Z0-9]`, which represents
242 # UPPER_SNAKE_CASE.
243 },
244 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
245 #
246 # For example, if a quota check failed with an error indicating the calling
247 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
248 # directly to the right place in the developer console to flip the bit.
249 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
250 { # Describes a URL link.
251 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
252 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
253 },
254 ],
255 },
256 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
257 # which can be attached to an RPC error.
258 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
259 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
260 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
261 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
262 },
263 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
264 &quot;dimensions&quot;: { # The map holding related quota dimensions.
265 &quot;a_key&quot;: &quot;A String&quot;,
266 },
267 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
268 # type or metric.
269 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
270 # or metric.
271 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
272 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
273 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
274 },
275 },
276 ],
277 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
278 # This property is optional.
279 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
280 },
281 ],
282 },
283 &quot;getVersionOperationMetadata&quot;: {
284 &quot;inlineSbomInfo&quot;: {
285 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
286 # appropriate identifiers.
287 &quot;a_key&quot;: &quot;A String&quot;,
288 },
289 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
290 # identifiers.
291 &quot;a_key&quot;: &quot;A String&quot;,
292 },
293 },
294 },
295 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
296 # message that was returned, such as `NOT FOUND`.
297 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
298 # status code that was returned. For example, a `404` means the
299 # resource was not found.
300 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
301 # defined by the server.
302 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
303 # This value is inRFC3339
304 # text format.
305 &quot;instancesBulkInsertOperationMetadata&quot;: {
306 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
307 # Example key: zones/us-central1-a
308 &quot;a_key&quot;: {
309 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
310 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
311 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
312 # error.
313 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
314 # if the flow is rolling forward or rolling back.
315 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
316 },
317 },
318 },
319 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
320 # Operation resources.
321 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
322 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
323 # group of operations results from a `bulkInsert` API request.
324 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
325 # `update`, or `delete`, and so on.
326 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
327 # There is no requirement that this be linear or support any granularity of
328 # operations. This should not be used to guess when the operation will be
329 # complete. This number should monotonically increase as the operation
330 # progresses.
331 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
332 # applicable when performing regional operations.
333 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
334 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
335 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
336 # this field will contain information on all underlying zonal actions and
337 # their state.
338 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
339 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
340 # Example key: zones/us-central1-a
341 &quot;a_key&quot;: {
342 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
343 # populated.
344 # different programming environments, including REST APIs and RPC APIs. It is
345 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
346 # three pieces of data: error code, error message, and error details.
347 #
348 # You can find out more about this error model and how to work with it in the
349 # [API Design Guide](https://cloud.google.com/apis/design/errors).
350 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
351 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
352 # message types for APIs to use.
353 {
354 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
355 },
356 ],
357 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
358 # user-facing error message should be localized and sent in the
359 # google.rpc.Status.details field, or localized by the client.
360 },
361 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
362 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
363 },
364 },
365 },
366 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
367 # This value is inRFC3339
368 # text format.
369 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
370 # following:
371 # `PENDING`, `RUNNING`, or `DONE`.
372 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
373 # operation.
374 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
375 # of the target resource.
376 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
377 # operations related to creating a snapshot, this points to the disk
378 # that the snapshot was created from.
379 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
380 # `[email protected]` or
381 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
382 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
383 # operation, this field will be populated.
384 {
385 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
386 # Engine returns NO_RESULTS_ON_PAGE if there
387 # are no results in the response.
388 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
389 # value format. For example:
390 #
391 # &quot;data&quot;: [
392 # {
393 # &quot;key&quot;: &quot;scope&quot;,
394 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
395 # }
396 {
397 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
398 # returned. For example, for warnings where there are no results in a list
399 # request for a particular zone, this key might be scope and
400 # the key value might be the zone name. Other examples might be a key
401 # indicating a deprecated resource and a suggested replacement, or a
402 # warning about invalid network settings (for example, if an instance
403 # attempts to perform IP forwarding but is not enabled for IP forwarding).
404 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
405 },
406 ],
407 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
408 },
409 ],
410 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
411 # applicable when performing per-zone operations.
412 }</pre>
413 </div>
414
415 <div class="method">
416 <code class="details" id="deprecate">deprecate(project, image, body=None, requestId=None, x__xgafv=None)</code>
417 <pre>Sets the deprecation status of an image.
418
419 If an empty request body is given, clears the deprecation status instead.
420
421 Args:
422 project: string, Project ID for this request. (required)
423 image: string, Image name. (required)
424 body: object, The request body.
425 The object takes the form of:
426
427 { # Deprecation status for a public resource.
428 &quot;deleted&quot;: &quot;A String&quot;, # An optional RFC3339 timestamp on or after which the state of this
429 # resource is intended to change to DELETED. This is only
430 # informational and the status will not change unless the client explicitly
431 # changes it.
432 &quot;deprecated&quot;: &quot;A String&quot;, # An optional RFC3339 timestamp on or after which the state of this
433 # resource is intended to change to DEPRECATED. This is only
434 # informational and the status will not change unless the client explicitly
435 # changes it.
436 &quot;obsolete&quot;: &quot;A String&quot;, # An optional RFC3339 timestamp on or after which the state of this
437 # resource is intended to change to OBSOLETE. This is only
438 # informational and the status will not change unless the client explicitly
439 # changes it.
440 &quot;replacement&quot;: &quot;A String&quot;, # The URL of the suggested replacement for a deprecated resource.
441 # The suggested replacement resource must be the same kind of resource as the
442 # deprecated resource.
443 &quot;state&quot;: &quot;A String&quot;, # The deprecation state of this resource. This can be ACTIVE,DEPRECATED, OBSOLETE, or DELETED.
444 # Operations which communicate the end of life date for an image, can useACTIVE. Operations which create a new resource using aDEPRECATED resource will return successfully, but with a
445 # warning indicating the deprecated resource and recommending its
446 # replacement. Operations which use OBSOLETE orDELETED resources will be rejected and result in an error.
447 &quot;stateOverride&quot;: { # A rollout policy configuration. # The rollout policy for this deprecation. This policy is only enforced by
448 # image family views. The rollout policy restricts the zones where the
449 # associated resource is considered in a deprecated state. When the rollout
450 # policy does not include the user specified zone, or if the zone is rolled
451 # out, the associated resource is considered in a deprecated state.
452 #
453 # The rollout policy for this deprecation is read-only, except for
454 # allowlisted users. This field might not be configured. To view the latest
455 # non-deprecated image in a specific zone, use theimageFamilyViews.get method.
456 &quot;defaultRolloutTime&quot;: &quot;A String&quot;, # An optional RFC3339 timestamp on or after which the update is
457 # considered rolled out to any zone that is not explicitly stated.
458 &quot;locationRolloutPolicies&quot;: { # Location based rollout policies to apply to the resource.
459 #
460 # Currently only zone names are supported and must be represented
461 # as valid URLs, like: zones/us-central1-a.
462 #
463 # The value expects an RFC3339 timestamp on or after which the update is
464 # considered rolled out to the specified location.
465 &quot;a_key&quot;: &quot;A String&quot;,
466 },
467 },
468 }
469
470 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
471 that if you must retry your request, the server will know to ignore the
472 request if it has already been completed.
473
474 For example, consider a situation where you make an initial request and
475 the request times out. If you make the request again with the same
476 request ID, the server can check if original operation with the same
477 request ID was received, and if so, will ignore the second request. This
478 prevents clients from accidentally creating duplicate commitments.
479
480 The request ID must be
481 a valid UUID with the exception that zero UUID is not supported
482 (00000000-0000-0000-0000-000000000000).
483 x__xgafv: string, V1 error format.
484 Allowed values
485 1 - v1 error format
486 2 - v2 error format
487
488 Returns:
489 An object of the form:
490
491 { # Represents an Operation resource.
492 #
493 # Google Compute Engine has three Operation resources:
494 #
495 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
496 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
497 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
498 #
499 # You can use an operation resource to manage asynchronous API requests.
500 # For more information, readHandling
501 # API responses.
502 #
503 # Operations can be global, regional or zonal.
504 #
505 # - For global operations, use the `globalOperations`
506 # resource.
507 # - For regional operations, use the
508 # `regionOperations` resource.
509 # - For zonal operations, use
510 # the `zoneOperations` resource.
511 #
512 #
513 #
514 # For more information, read
515 # Global, Regional, and Zonal Resources.
516 #
517 # Note that completed Operation resources have a limited
518 # retention period.
519 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
520 # Not present otherwise.
521 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
522 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
523 # set when the operation is created.
524 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
525 # text format.
526 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
527 # this field will be populated.
528 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
529 # operation.
530 {
531 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
532 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
533 # details. There is a set of defined message types to use for providing
534 # details.The syntax depends on the error code. For example,
535 # QuotaExceededInfo will have details when the error code is
536 # QUOTA_EXCEEDED.
537 {
538 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
539 #
540 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
541 # is not enabled:
542 #
543 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
544 # &quot;domain&quot;: &quot;googleapis.com&quot;
545 # &quot;metadata&quot;: {
546 # &quot;resource&quot;: &quot;projects/123&quot;,
547 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
548 # }
549 # }
550 #
551 # This response indicates that the pubsub.googleapis.com API is not enabled.
552 #
553 # Example of an error that is returned when attempting to create a Spanner
554 # instance in a region that is out of stock:
555 #
556 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
557 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
558 # &quot;metadata&quot;: {
559 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
560 # }
561 # }
562 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
563 # is typically the registered service name of the tool or product that
564 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
565 # generated by some common infrastructure, the error domain must be a
566 # globally unique value that identifies the infrastructure. For Google API
567 # infrastructure, the error domain is &quot;googleapis.com&quot;.
568 &quot;metadatas&quot;: { # Additional structured details about this error.
569 #
570 # Keys must match a regular expression of `a-z+` but should
571 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
572 # length. When identifying the current value of an exceeded limit, the units
573 # should be contained in the key, not the value. For example, rather than
574 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
575 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
576 # instances that can be created in a single (batch) request.
577 &quot;a_key&quot;: &quot;A String&quot;,
578 },
579 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
580 # proximate cause of the error. Error reasons are unique within a particular
581 # domain of errors. This should be at most 63 characters and match a
582 # regular expression of `A-Z+[A-Z0-9]`, which represents
583 # UPPER_SNAKE_CASE.
584 },
585 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
586 #
587 # For example, if a quota check failed with an error indicating the calling
588 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
589 # directly to the right place in the developer console to flip the bit.
590 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
591 { # Describes a URL link.
592 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
593 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
594 },
595 ],
596 },
597 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
598 # which can be attached to an RPC error.
599 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
600 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
601 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
602 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
603 },
604 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
605 &quot;dimensions&quot;: { # The map holding related quota dimensions.
606 &quot;a_key&quot;: &quot;A String&quot;,
607 },
608 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
609 # type or metric.
610 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
611 # or metric.
612 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
613 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
614 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
615 },
616 },
617 ],
618 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
619 # This property is optional.
620 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
621 },
622 ],
623 },
624 &quot;getVersionOperationMetadata&quot;: {
625 &quot;inlineSbomInfo&quot;: {
626 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
627 # appropriate identifiers.
628 &quot;a_key&quot;: &quot;A String&quot;,
629 },
630 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
631 # identifiers.
632 &quot;a_key&quot;: &quot;A String&quot;,
633 },
634 },
635 },
636 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
637 # message that was returned, such as `NOT FOUND`.
638 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
639 # status code that was returned. For example, a `404` means the
640 # resource was not found.
641 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
642 # defined by the server.
643 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
644 # This value is inRFC3339
645 # text format.
646 &quot;instancesBulkInsertOperationMetadata&quot;: {
647 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
648 # Example key: zones/us-central1-a
649 &quot;a_key&quot;: {
650 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
651 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
652 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
653 # error.
654 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
655 # if the flow is rolling forward or rolling back.
656 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
657 },
658 },
659 },
660 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
661 # Operation resources.
662 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
663 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
664 # group of operations results from a `bulkInsert` API request.
665 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
666 # `update`, or `delete`, and so on.
667 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
668 # There is no requirement that this be linear or support any granularity of
669 # operations. This should not be used to guess when the operation will be
670 # complete. This number should monotonically increase as the operation
671 # progresses.
672 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
673 # applicable when performing regional operations.
674 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
675 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
676 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
677 # this field will contain information on all underlying zonal actions and
678 # their state.
679 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
680 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
681 # Example key: zones/us-central1-a
682 &quot;a_key&quot;: {
683 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
684 # populated.
685 # different programming environments, including REST APIs and RPC APIs. It is
686 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
687 # three pieces of data: error code, error message, and error details.
688 #
689 # You can find out more about this error model and how to work with it in the
690 # [API Design Guide](https://cloud.google.com/apis/design/errors).
691 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
692 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
693 # message types for APIs to use.
694 {
695 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
696 },
697 ],
698 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
699 # user-facing error message should be localized and sent in the
700 # google.rpc.Status.details field, or localized by the client.
701 },
702 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
703 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
704 },
705 },
706 },
707 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
708 # This value is inRFC3339
709 # text format.
710 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
711 # following:
712 # `PENDING`, `RUNNING`, or `DONE`.
713 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
714 # operation.
715 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
716 # of the target resource.
717 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
718 # operations related to creating a snapshot, this points to the disk
719 # that the snapshot was created from.
720 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
721 # `[email protected]` or
722 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
723 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
724 # operation, this field will be populated.
725 {
726 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
727 # Engine returns NO_RESULTS_ON_PAGE if there
728 # are no results in the response.
729 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
730 # value format. For example:
731 #
732 # &quot;data&quot;: [
733 # {
734 # &quot;key&quot;: &quot;scope&quot;,
735 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
736 # }
737 {
738 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
739 # returned. For example, for warnings where there are no results in a list
740 # request for a particular zone, this key might be scope and
741 # the key value might be the zone name. Other examples might be a key
742 # indicating a deprecated resource and a suggested replacement, or a
743 # warning about invalid network settings (for example, if an instance
744 # attempts to perform IP forwarding but is not enabled for IP forwarding).
745 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
746 },
747 ],
748 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
749 },
750 ],
751 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
752 # applicable when performing per-zone operations.
753 }</pre>
754 </div>
755
756 <div class="method">
757 <code class="details" id="get">get(project, image, x__xgafv=None)</code>
758 <pre>Returns the specified image.
759
760 Args:
761 project: string, Project ID for this request. (required)
762 image: string, Name of the image resource to return. (required)
763 x__xgafv: string, V1 error format.
764 Allowed values
765 1 - v1 error format
766 2 - v2 error format
767
768 Returns:
769 An object of the form:
770
771 { # Represents an Image resource.
772 #
773 # You can use images to create boot disks for your VM instances.
774 # For more information, read Images.
775 &quot;architecture&quot;: &quot;A String&quot;, # The architecture of the image. Valid values are
776 # ARM64 or X86_64.
777 &quot;archiveSizeBytes&quot;: &quot;A String&quot;, # Size of the image tar.gz archive stored in Google Cloud
778 # Storage (in bytes).
779 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
780 # text format.
781 &quot;deprecated&quot;: { # Deprecation status for a public resource. # Output only. The deprecation status associated with this image.
782 &quot;deleted&quot;: &quot;A String&quot;, # An optional RFC3339 timestamp on or after which the state of this
783 # resource is intended to change to DELETED. This is only
784 # informational and the status will not change unless the client explicitly
785 # changes it.
786 &quot;deprecated&quot;: &quot;A String&quot;, # An optional RFC3339 timestamp on or after which the state of this
787 # resource is intended to change to DEPRECATED. This is only
788 # informational and the status will not change unless the client explicitly
789 # changes it.
790 &quot;obsolete&quot;: &quot;A String&quot;, # An optional RFC3339 timestamp on or after which the state of this
791 # resource is intended to change to OBSOLETE. This is only
792 # informational and the status will not change unless the client explicitly
793 # changes it.
794 &quot;replacement&quot;: &quot;A String&quot;, # The URL of the suggested replacement for a deprecated resource.
795 # The suggested replacement resource must be the same kind of resource as the
796 # deprecated resource.
797 &quot;state&quot;: &quot;A String&quot;, # The deprecation state of this resource. This can be ACTIVE,DEPRECATED, OBSOLETE, or DELETED.
798 # Operations which communicate the end of life date for an image, can useACTIVE. Operations which create a new resource using aDEPRECATED resource will return successfully, but with a
799 # warning indicating the deprecated resource and recommending its
800 # replacement. Operations which use OBSOLETE orDELETED resources will be rejected and result in an error.
801 &quot;stateOverride&quot;: { # A rollout policy configuration. # The rollout policy for this deprecation. This policy is only enforced by
802 # image family views. The rollout policy restricts the zones where the
803 # associated resource is considered in a deprecated state. When the rollout
804 # policy does not include the user specified zone, or if the zone is rolled
805 # out, the associated resource is considered in a deprecated state.
806 #
807 # The rollout policy for this deprecation is read-only, except for
808 # allowlisted users. This field might not be configured. To view the latest
809 # non-deprecated image in a specific zone, use theimageFamilyViews.get method.
810 &quot;defaultRolloutTime&quot;: &quot;A String&quot;, # An optional RFC3339 timestamp on or after which the update is
811 # considered rolled out to any zone that is not explicitly stated.
812 &quot;locationRolloutPolicies&quot;: { # Location based rollout policies to apply to the resource.
813 #
814 # Currently only zone names are supported and must be represented
815 # as valid URLs, like: zones/us-central1-a.
816 #
817 # The value expects an RFC3339 timestamp on or after which the update is
818 # considered rolled out to the specified location.
819 &quot;a_key&quot;: &quot;A String&quot;,
820 },
821 },
822 },
823 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
824 # create the resource.
825 &quot;diskSizeGb&quot;: &quot;A String&quot;, # Size of the image when restored onto a persistent disk (in GB).
826 &quot;enableConfidentialCompute&quot;: True or False, # Output only. Whether this image is created from a confidential compute mode disk.
827 # [Output Only]: This field is not set by user, but from source disk.
828 &quot;family&quot;: &quot;A String&quot;, # The name of the image family to which this image belongs. The image
829 # family name can be from a publicly managed image family provided by
830 # Compute Engine, or from a custom image family you create. For example,centos-stream-9 is a publicly available image family.
831 # For more information, see Image
832 # family best practices.
833 #
834 # When creating disks, you can specify an image family instead of a specific
835 # image name. The image family always returns its latest image that is not
836 # deprecated. The name of the image family must comply with RFC1035.
837 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable
838 # only for bootable images. To see a list of available options, see theguestOSfeatures[].type parameter.
839 { # Guest OS features.
840 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
841 # separate values. Set to one or more of the following values:
842 #
843 # - VIRTIO_SCSI_MULTIQUEUE
844 # - WINDOWS
845 # - MULTI_IP_SUBNET
846 # - UEFI_COMPATIBLE
847 # - GVNIC
848 # - SEV_CAPABLE
849 # - SUSPEND_RESUME_COMPATIBLE
850 # - SEV_LIVE_MIGRATABLE_V2
851 # - SEV_SNP_CAPABLE
852 # - TDX_CAPABLE
853 # - IDPF
854 # - SNP_SVSM_CAPABLE
855 # - CCA_CAPABLE
856 #
857 #
858 # For more information, see
859 # Enabling guest operating system features.
860 },
861 ],
862 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
863 # defined by the server.
864 &quot;imageEncryptionKey&quot;: { # Encrypts the image using acustomer-supplied
865 # encryption key.
866 #
867 # After you encrypt an image with a customer-supplied key, you must provide
868 # the same key if you use the image later (e.g. to create a disk from
869 # the image).
870 #
871 # Customer-supplied encryption keys do not protect access to metadata
872 # of the disk.
873 #
874 # If you do not provide an encryption key when creating the image, then the
875 # disk will be encrypted using an automatically generated key and you do not
876 # need to provide a key to use the image later.
877 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
878 # For example:
879 #
880 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
881 # key_region/cryptoKeys/key
882 #
883 # The fully-qualifed key name may be returned for resource GET requests. For
884 # example:
885 #
886 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
887 # key_region/cryptoKeys/key
888 # /cryptoKeyVersions/1
889 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
890 # key. If absent, the Compute Engine default service account is used.
891 # For example:
892 #
893 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
894 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
895 # encryption key, encoded in RFC
896 # 4648 base64 to either encrypt or decrypt this resource. You can
897 # provide either the rawKey or thersaEncryptedKey.
898 # For example:
899 #
900 # &quot;rawKey&quot;:
901 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
902 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
903 # customer-supplied encryption key to either encrypt or decrypt this
904 # resource. You can provide either the rawKey or thersaEncryptedKey.
905 # For example:
906 #
907 # &quot;rsaEncryptedKey&quot;:
908 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
909 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
910 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
911 #
912 # The key must meet the following requirements before you can provide it to
913 # Compute Engine:
914 #
915 # 1. The key is wrapped using a RSA public key certificate provided by
916 # Google.
917 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
918 # encoding.
919 #
920 # Gets the RSA public key certificate provided by Google at:
921 #
922 #
923 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
924 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
925 # 4648 base64 encoded SHA-256 hash of the customer-supplied
926 # encryption key that protects this resource.
927 },
928 &quot;kind&quot;: &quot;compute#image&quot;, # Output only. [Output Only] Type of the resource. Always compute#image for
929 # images.
930 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for the labels being applied to this image, which is
931 # essentially a hash of the labels used for optimistic locking. The
932 # fingerprint is initially generated by Compute Engine and changes after
933 # every request to modify or update labels. You must always provide an
934 # up-to-date fingerprint hash in order to update or change labels,
935 # otherwise the request will fail with error412 conditionNotMet.
936 #
937 # To see the latest fingerprint, make a get() request to
938 # retrieve an image.
939 &quot;labels&quot;: { # Labels to apply to this image. These can be later modified by
940 # the setLabels method.
941 &quot;a_key&quot;: &quot;A String&quot;,
942 },
943 &quot;licenseCodes&quot;: [ # Integer license codes indicating which licenses are attached to this image.
944 &quot;A String&quot;,
945 ],
946 &quot;licenses&quot;: [ # Any applicable license URI.
947 &quot;A String&quot;,
948 ],
949 &quot;locked&quot;: True or False, # A flag for marketplace VM disk created from the image, which is designed
950 # for marketplace VM disk to prevent the proprietary data on the disk from
951 # being accessed unwantedly. The flag will be inherited by the disk created
952 # from the image.
953 #
954 # The disk with locked flag set to true will be prohibited from performing
955 # the operations below:
956 #
957 # - R/W or R/O disk attach
958 # - Disk detach, if disk is created via create-on-create
959 # - Create images
960 # - Create snapshots
961 # - Create disk clone (create disk from the current disk)
962 #
963 #
964 #
965 # The image with the locked field set to true will be prohibited from
966 # performing the operations below:
967 #
968 # - Create images from the current image
969 # - Update the locked field for the current image
970 #
971 #
972 #
973 # The instance with at least one disk with locked flag set to true will be
974 # prohibited from performing the operations below:
975 #
976 # - Secondary disk attach
977 # - Create instant snapshot
978 # - Create machine images
979 # - Create instance template
980 # - Delete the instance with --keep-disk parameter set to true
981 &quot;name&quot;: &quot;A String&quot;, # Name of the resource; provided by the client when the resource is created.
982 # The name must be 1-63 characters long, and comply withRFC1035.
983 # Specifically, the name must be 1-63 characters long and match the regular
984 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
985 # character must be a lowercase letter, and all following characters must be
986 # a dash, lowercase letter, or digit, except the last character, which cannot
987 # be a dash.
988 &quot;params&quot;: { # Additional image params. # Input only. [Input Only] Additional params passed with the request, but not persisted
989 # as part of resource payload.
990 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the image. Tag keys and values have
991 # the same definition as resource
992 # manager tags. Keys and values can be either in numeric format,
993 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
994 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
995 # `{tag_value_short_name}`. The field is ignored (both PUT &amp;
996 # PATCH) when empty.
997 &quot;a_key&quot;: &quot;A String&quot;,
998 },
999 },
1000 &quot;rawDisk&quot;: { # The parameters of the raw disk image.
1001 &quot;containerType&quot;: &quot;A String&quot;, # The format used to encode and transmit the block device, which should beTAR. This is just a container and transmission format and not
1002 # a runtime format. Provided by the client when the disk image is created.
1003 &quot;sha1Checksum&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1004 # An optional SHA1 checksum of the disk image before unpackaging provided
1005 # by the client when the disk image is created.
1006 &quot;source&quot;: &quot;A String&quot;, # The full Google Cloud Storage URL or Artifact Registry path where the raw
1007 # disk image archive is stored.
1008 # The following are valid formats:
1009 #
1010 # - https://storage.googleapis.com/bucket_name/image_archive_name
1011 # - https://storage.googleapis.com/bucket_name/folder_name/image_archive_name
1012 # - projects/project/locations/location/repositories/repo/packages/package/versions/version_id
1013 # - projects/project/locations/location/repositories/repo/packages/package/versions/version_id@dirsum_sha256:hex_value
1014 #
1015 #
1016 #
1017 # In order to create an image, you must provide the full or partial URL of
1018 # one of the following:
1019 #
1020 # - The rawDisk.source URL
1021 # - The sourceDisk URL
1022 # - The sourceImage URL
1023 # - The sourceSnapshot URL
1024 },
1025 &quot;rolloutOverride&quot;: { # A rollout policy configuration. # A rollout policy to apply to this image. When specified, the rollout policy
1026 # overrides per-zone references to the image via the associated image family.
1027 # The rollout policy restricts the zones where this image is accessible when
1028 # using a zonal image family reference. When the rollout policy does not
1029 # include the user specified zone, or if the zone is rolled out, this image
1030 # is accessible.
1031 #
1032 # The rollout policy for this image is read-only, except for allowlisted
1033 # users. This field might not be configured. To view the latest
1034 # non-deprecated image in a specific zone, use theimageFamilyViews.get method.
1035 &quot;defaultRolloutTime&quot;: &quot;A String&quot;, # An optional RFC3339 timestamp on or after which the update is
1036 # considered rolled out to any zone that is not explicitly stated.
1037 &quot;locationRolloutPolicies&quot;: { # Location based rollout policies to apply to the resource.
1038 #
1039 # Currently only zone names are supported and must be represented
1040 # as valid URLs, like: zones/us-central1-a.
1041 #
1042 # The value expects an RFC3339 timestamp on or after which the update is
1043 # considered rolled out to the specified location.
1044 &quot;a_key&quot;: &quot;A String&quot;,
1045 },
1046 },
1047 &quot;satisfiesPzi&quot;: True or False, # Output only. Reserved for future use.
1048 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
1049 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
1050 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource&#x27;s resource id.
1051 &quot;shieldedInstanceInitialState&quot;: { # Initial State for shielded instance, # Set the secure boot keys of shielded instance.
1052 # these are public keys which are safe to store in public
1053 &quot;dbs&quot;: [ # The Key Database (db).
1054 {
1055 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
1056 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
1057 },
1058 ],
1059 &quot;dbxs&quot;: [ # The forbidden key database (dbx).
1060 {
1061 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
1062 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
1063 },
1064 ],
1065 &quot;keks&quot;: [ # The Key Exchange Key (KEK).
1066 {
1067 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
1068 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
1069 },
1070 ],
1071 &quot;pk&quot;: { # The Platform Key (PK).
1072 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
1073 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
1074 },
1075 },
1076 &quot;sourceDisk&quot;: &quot;A String&quot;, # URL of the source disk used to create this image.
1077 # For example, the following are valid values:
1078 #
1079 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
1080 # - projects/project/zones/zone/disks/disk
1081 # - zones/zone/disks/disk
1082 #
1083 #
1084 #
1085 # In order to create an image, you must provide the full or partial URL of
1086 # one of the following:
1087 #
1088 # - The rawDisk.source URL
1089 # - The sourceDisk URL
1090 # - The sourceImage URL
1091 # - The sourceSnapshot URL
1092 &quot;sourceDiskEncryptionKey&quot;: { # Thecustomer-supplied
1093 # encryption key of the source disk. Required if the source disk is
1094 # protected by a customer-supplied encryption key.
1095 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
1096 # For example:
1097 #
1098 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
1099 # key_region/cryptoKeys/key
1100 #
1101 # The fully-qualifed key name may be returned for resource GET requests. For
1102 # example:
1103 #
1104 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
1105 # key_region/cryptoKeys/key
1106 # /cryptoKeyVersions/1
1107 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
1108 # key. If absent, the Compute Engine default service account is used.
1109 # For example:
1110 #
1111 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
1112 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
1113 # encryption key, encoded in RFC
1114 # 4648 base64 to either encrypt or decrypt this resource. You can
1115 # provide either the rawKey or thersaEncryptedKey.
1116 # For example:
1117 #
1118 # &quot;rawKey&quot;:
1119 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
1120 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
1121 # customer-supplied encryption key to either encrypt or decrypt this
1122 # resource. You can provide either the rawKey or thersaEncryptedKey.
1123 # For example:
1124 #
1125 # &quot;rsaEncryptedKey&quot;:
1126 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
1127 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
1128 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
1129 #
1130 # The key must meet the following requirements before you can provide it to
1131 # Compute Engine:
1132 #
1133 # 1. The key is wrapped using a RSA public key certificate provided by
1134 # Google.
1135 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
1136 # encoding.
1137 #
1138 # Gets the RSA public key certificate provided by Google at:
1139 #
1140 #
1141 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
1142 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
1143 # 4648 base64 encoded SHA-256 hash of the customer-supplied
1144 # encryption key that protects this resource.
1145 },
1146 &quot;sourceDiskId&quot;: &quot;A String&quot;, # Output only. [Output Only]
1147 # The ID value of the disk used to create this image. This value may be used
1148 # to determine whether the image was taken from the current or a previous
1149 # instance of a given disk name.
1150 &quot;sourceImage&quot;: &quot;A String&quot;, # URL of the source image used to create this image.
1151 # The following are valid formats for the URL:
1152 #
1153 # - https://www.googleapis.com/compute/v1/projects/project_id/global/
1154 # images/image_name
1155 # - projects/project_id/global/images/image_name
1156 #
1157 #
1158 #
1159 # In order to create an image, you must provide the full or partial URL of
1160 # one of the following:
1161 #
1162 # - The rawDisk.source URL
1163 # - The sourceDisk URL
1164 # - The sourceImage URL
1165 # - The sourceSnapshot URL
1166 &quot;sourceImageEncryptionKey&quot;: { # The customer-supplied encryption key of the source image. Required if the
1167 # source image is protected by a customer-supplied encryption key.
1168 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
1169 # For example:
1170 #
1171 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
1172 # key_region/cryptoKeys/key
1173 #
1174 # The fully-qualifed key name may be returned for resource GET requests. For
1175 # example:
1176 #
1177 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
1178 # key_region/cryptoKeys/key
1179 # /cryptoKeyVersions/1
1180 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
1181 # key. If absent, the Compute Engine default service account is used.
1182 # For example:
1183 #
1184 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
1185 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
1186 # encryption key, encoded in RFC
1187 # 4648 base64 to either encrypt or decrypt this resource. You can
1188 # provide either the rawKey or thersaEncryptedKey.
1189 # For example:
1190 #
1191 # &quot;rawKey&quot;:
1192 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
1193 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
1194 # customer-supplied encryption key to either encrypt or decrypt this
1195 # resource. You can provide either the rawKey or thersaEncryptedKey.
1196 # For example:
1197 #
1198 # &quot;rsaEncryptedKey&quot;:
1199 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
1200 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
1201 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
1202 #
1203 # The key must meet the following requirements before you can provide it to
1204 # Compute Engine:
1205 #
1206 # 1. The key is wrapped using a RSA public key certificate provided by
1207 # Google.
1208 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
1209 # encoding.
1210 #
1211 # Gets the RSA public key certificate provided by Google at:
1212 #
1213 #
1214 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
1215 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
1216 # 4648 base64 encoded SHA-256 hash of the customer-supplied
1217 # encryption key that protects this resource.
1218 },
1219 &quot;sourceImageId&quot;: &quot;A String&quot;, # Output only. [Output Only]
1220 # The ID value of the image used to create this image. This value may be used
1221 # to determine whether the image was taken from the current or a previous
1222 # instance of a given image name.
1223 &quot;sourceSnapshot&quot;: &quot;A String&quot;, # URL of the source snapshot used to create this image.
1224 # The following are valid formats for the URL:
1225 #
1226 # - https://www.googleapis.com/compute/v1/projects/project_id/global/
1227 # snapshots/snapshot_name
1228 # - projects/project_id/global/snapshots/snapshot_name
1229 #
1230 #
1231 #
1232 # In order to create an image, you must provide the full or partial URL of
1233 # one of the following:
1234 #
1235 # - The rawDisk.source URL
1236 # - The sourceDisk URL
1237 # - The sourceImage URL
1238 # - The sourceSnapshot URL
1239 &quot;sourceSnapshotEncryptionKey&quot;: { # The customer-supplied encryption key of the source snapshot. Required if
1240 # the source snapshot is protected by a customer-supplied encryption key.
1241 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
1242 # For example:
1243 #
1244 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
1245 # key_region/cryptoKeys/key
1246 #
1247 # The fully-qualifed key name may be returned for resource GET requests. For
1248 # example:
1249 #
1250 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
1251 # key_region/cryptoKeys/key
1252 # /cryptoKeyVersions/1
1253 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
1254 # key. If absent, the Compute Engine default service account is used.
1255 # For example:
1256 #
1257 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
1258 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
1259 # encryption key, encoded in RFC
1260 # 4648 base64 to either encrypt or decrypt this resource. You can
1261 # provide either the rawKey or thersaEncryptedKey.
1262 # For example:
1263 #
1264 # &quot;rawKey&quot;:
1265 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
1266 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
1267 # customer-supplied encryption key to either encrypt or decrypt this
1268 # resource. You can provide either the rawKey or thersaEncryptedKey.
1269 # For example:
1270 #
1271 # &quot;rsaEncryptedKey&quot;:
1272 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
1273 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
1274 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
1275 #
1276 # The key must meet the following requirements before you can provide it to
1277 # Compute Engine:
1278 #
1279 # 1. The key is wrapped using a RSA public key certificate provided by
1280 # Google.
1281 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
1282 # encoding.
1283 #
1284 # Gets the RSA public key certificate provided by Google at:
1285 #
1286 #
1287 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
1288 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
1289 # 4648 base64 encoded SHA-256 hash of the customer-supplied
1290 # encryption key that protects this resource.
1291 },
1292 &quot;sourceSnapshotId&quot;: &quot;A String&quot;, # Output only. [Output Only]
1293 # The ID value of the snapshot used to create this image. This value may be
1294 # used to determine whether the snapshot was taken from the current or a
1295 # previous instance of a given snapshot name.
1296 &quot;sourceType&quot;: &quot;RAW&quot;, # The type of the image used to create this disk. The
1297 # default and only valid value is RAW.
1298 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only] The status of the image. An image can be used to create other
1299 # resources, such as instances, only after the image has been successfully
1300 # created and the status is set to READY. Possible
1301 # values are FAILED, PENDING, orREADY.
1302 &quot;storageLocations&quot;: [ # Cloud Storage bucket storage location of the image (regional or
1303 # multi-regional).
1304 &quot;A String&quot;,
1305 ],
1306 }</pre>
1307 </div>
1308
1309 <div class="method">
1310 <code class="details" id="getFromFamily">getFromFamily(project, family, x__xgafv=None)</code>
1311 <pre>Returns the latest image that is part of an image family and is not
1312 deprecated. For more information on image families, seePublic
1313 image families documentation.
1314
1315 Args:
1316 project: string, The image project that the image belongs to. For example, to get a CentOS
1317 image, specify centos-cloud as the image project. (required)
1318 family: string, Name of the image family to search for. (required)
1319 x__xgafv: string, V1 error format.
1320 Allowed values
1321 1 - v1 error format
1322 2 - v2 error format
1323
1324 Returns:
1325 An object of the form:
1326
1327 { # Represents an Image resource.
1328 #
1329 # You can use images to create boot disks for your VM instances.
1330 # For more information, read Images.
1331 &quot;architecture&quot;: &quot;A String&quot;, # The architecture of the image. Valid values are
1332 # ARM64 or X86_64.
1333 &quot;archiveSizeBytes&quot;: &quot;A String&quot;, # Size of the image tar.gz archive stored in Google Cloud
1334 # Storage (in bytes).
1335 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
1336 # text format.
1337 &quot;deprecated&quot;: { # Deprecation status for a public resource. # Output only. The deprecation status associated with this image.
1338 &quot;deleted&quot;: &quot;A String&quot;, # An optional RFC3339 timestamp on or after which the state of this
1339 # resource is intended to change to DELETED. This is only
1340 # informational and the status will not change unless the client explicitly
1341 # changes it.
1342 &quot;deprecated&quot;: &quot;A String&quot;, # An optional RFC3339 timestamp on or after which the state of this
1343 # resource is intended to change to DEPRECATED. This is only
1344 # informational and the status will not change unless the client explicitly
1345 # changes it.
1346 &quot;obsolete&quot;: &quot;A String&quot;, # An optional RFC3339 timestamp on or after which the state of this
1347 # resource is intended to change to OBSOLETE. This is only
1348 # informational and the status will not change unless the client explicitly
1349 # changes it.
1350 &quot;replacement&quot;: &quot;A String&quot;, # The URL of the suggested replacement for a deprecated resource.
1351 # The suggested replacement resource must be the same kind of resource as the
1352 # deprecated resource.
1353 &quot;state&quot;: &quot;A String&quot;, # The deprecation state of this resource. This can be ACTIVE,DEPRECATED, OBSOLETE, or DELETED.
1354 # Operations which communicate the end of life date for an image, can useACTIVE. Operations which create a new resource using aDEPRECATED resource will return successfully, but with a
1355 # warning indicating the deprecated resource and recommending its
1356 # replacement. Operations which use OBSOLETE orDELETED resources will be rejected and result in an error.
1357 &quot;stateOverride&quot;: { # A rollout policy configuration. # The rollout policy for this deprecation. This policy is only enforced by
1358 # image family views. The rollout policy restricts the zones where the
1359 # associated resource is considered in a deprecated state. When the rollout
1360 # policy does not include the user specified zone, or if the zone is rolled
1361 # out, the associated resource is considered in a deprecated state.
1362 #
1363 # The rollout policy for this deprecation is read-only, except for
1364 # allowlisted users. This field might not be configured. To view the latest
1365 # non-deprecated image in a specific zone, use theimageFamilyViews.get method.
1366 &quot;defaultRolloutTime&quot;: &quot;A String&quot;, # An optional RFC3339 timestamp on or after which the update is
1367 # considered rolled out to any zone that is not explicitly stated.
1368 &quot;locationRolloutPolicies&quot;: { # Location based rollout policies to apply to the resource.
1369 #
1370 # Currently only zone names are supported and must be represented
1371 # as valid URLs, like: zones/us-central1-a.
1372 #
1373 # The value expects an RFC3339 timestamp on or after which the update is
1374 # considered rolled out to the specified location.
1375 &quot;a_key&quot;: &quot;A String&quot;,
1376 },
1377 },
1378 },
1379 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
1380 # create the resource.
1381 &quot;diskSizeGb&quot;: &quot;A String&quot;, # Size of the image when restored onto a persistent disk (in GB).
1382 &quot;enableConfidentialCompute&quot;: True or False, # Output only. Whether this image is created from a confidential compute mode disk.
1383 # [Output Only]: This field is not set by user, but from source disk.
1384 &quot;family&quot;: &quot;A String&quot;, # The name of the image family to which this image belongs. The image
1385 # family name can be from a publicly managed image family provided by
1386 # Compute Engine, or from a custom image family you create. For example,centos-stream-9 is a publicly available image family.
1387 # For more information, see Image
1388 # family best practices.
1389 #
1390 # When creating disks, you can specify an image family instead of a specific
1391 # image name. The image family always returns its latest image that is not
1392 # deprecated. The name of the image family must comply with RFC1035.
1393 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable
1394 # only for bootable images. To see a list of available options, see theguestOSfeatures[].type parameter.
1395 { # Guest OS features.
1396 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
1397 # separate values. Set to one or more of the following values:
1398 #
1399 # - VIRTIO_SCSI_MULTIQUEUE
1400 # - WINDOWS
1401 # - MULTI_IP_SUBNET
1402 # - UEFI_COMPATIBLE
1403 # - GVNIC
1404 # - SEV_CAPABLE
1405 # - SUSPEND_RESUME_COMPATIBLE
1406 # - SEV_LIVE_MIGRATABLE_V2
1407 # - SEV_SNP_CAPABLE
1408 # - TDX_CAPABLE
1409 # - IDPF
1410 # - SNP_SVSM_CAPABLE
1411 # - CCA_CAPABLE
1412 #
1413 #
1414 # For more information, see
1415 # Enabling guest operating system features.
1416 },
1417 ],
1418 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
1419 # defined by the server.
1420 &quot;imageEncryptionKey&quot;: { # Encrypts the image using acustomer-supplied
1421 # encryption key.
1422 #
1423 # After you encrypt an image with a customer-supplied key, you must provide
1424 # the same key if you use the image later (e.g. to create a disk from
1425 # the image).
1426 #
1427 # Customer-supplied encryption keys do not protect access to metadata
1428 # of the disk.
1429 #
1430 # If you do not provide an encryption key when creating the image, then the
1431 # disk will be encrypted using an automatically generated key and you do not
1432 # need to provide a key to use the image later.
1433 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
1434 # For example:
1435 #
1436 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
1437 # key_region/cryptoKeys/key
1438 #
1439 # The fully-qualifed key name may be returned for resource GET requests. For
1440 # example:
1441 #
1442 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
1443 # key_region/cryptoKeys/key
1444 # /cryptoKeyVersions/1
1445 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
1446 # key. If absent, the Compute Engine default service account is used.
1447 # For example:
1448 #
1449 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
1450 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
1451 # encryption key, encoded in RFC
1452 # 4648 base64 to either encrypt or decrypt this resource. You can
1453 # provide either the rawKey or thersaEncryptedKey.
1454 # For example:
1455 #
1456 # &quot;rawKey&quot;:
1457 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
1458 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
1459 # customer-supplied encryption key to either encrypt or decrypt this
1460 # resource. You can provide either the rawKey or thersaEncryptedKey.
1461 # For example:
1462 #
1463 # &quot;rsaEncryptedKey&quot;:
1464 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
1465 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
1466 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
1467 #
1468 # The key must meet the following requirements before you can provide it to
1469 # Compute Engine:
1470 #
1471 # 1. The key is wrapped using a RSA public key certificate provided by
1472 # Google.
1473 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
1474 # encoding.
1475 #
1476 # Gets the RSA public key certificate provided by Google at:
1477 #
1478 #
1479 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
1480 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
1481 # 4648 base64 encoded SHA-256 hash of the customer-supplied
1482 # encryption key that protects this resource.
1483 },
1484 &quot;kind&quot;: &quot;compute#image&quot;, # Output only. [Output Only] Type of the resource. Always compute#image for
1485 # images.
1486 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for the labels being applied to this image, which is
1487 # essentially a hash of the labels used for optimistic locking. The
1488 # fingerprint is initially generated by Compute Engine and changes after
1489 # every request to modify or update labels. You must always provide an
1490 # up-to-date fingerprint hash in order to update or change labels,
1491 # otherwise the request will fail with error412 conditionNotMet.
1492 #
1493 # To see the latest fingerprint, make a get() request to
1494 # retrieve an image.
1495 &quot;labels&quot;: { # Labels to apply to this image. These can be later modified by
1496 # the setLabels method.
1497 &quot;a_key&quot;: &quot;A String&quot;,
1498 },
1499 &quot;licenseCodes&quot;: [ # Integer license codes indicating which licenses are attached to this image.
1500 &quot;A String&quot;,
1501 ],
1502 &quot;licenses&quot;: [ # Any applicable license URI.
1503 &quot;A String&quot;,
1504 ],
1505 &quot;locked&quot;: True or False, # A flag for marketplace VM disk created from the image, which is designed
1506 # for marketplace VM disk to prevent the proprietary data on the disk from
1507 # being accessed unwantedly. The flag will be inherited by the disk created
1508 # from the image.
1509 #
1510 # The disk with locked flag set to true will be prohibited from performing
1511 # the operations below:
1512 #
1513 # - R/W or R/O disk attach
1514 # - Disk detach, if disk is created via create-on-create
1515 # - Create images
1516 # - Create snapshots
1517 # - Create disk clone (create disk from the current disk)
1518 #
1519 #
1520 #
1521 # The image with the locked field set to true will be prohibited from
1522 # performing the operations below:
1523 #
1524 # - Create images from the current image
1525 # - Update the locked field for the current image
1526 #
1527 #
1528 #
1529 # The instance with at least one disk with locked flag set to true will be
1530 # prohibited from performing the operations below:
1531 #
1532 # - Secondary disk attach
1533 # - Create instant snapshot
1534 # - Create machine images
1535 # - Create instance template
1536 # - Delete the instance with --keep-disk parameter set to true
1537 &quot;name&quot;: &quot;A String&quot;, # Name of the resource; provided by the client when the resource is created.
1538 # The name must be 1-63 characters long, and comply withRFC1035.
1539 # Specifically, the name must be 1-63 characters long and match the regular
1540 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
1541 # character must be a lowercase letter, and all following characters must be
1542 # a dash, lowercase letter, or digit, except the last character, which cannot
1543 # be a dash.
1544 &quot;params&quot;: { # Additional image params. # Input only. [Input Only] Additional params passed with the request, but not persisted
1545 # as part of resource payload.
1546 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the image. Tag keys and values have
1547 # the same definition as resource
1548 # manager tags. Keys and values can be either in numeric format,
1549 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
1550 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
1551 # `{tag_value_short_name}`. The field is ignored (both PUT &amp;
1552 # PATCH) when empty.
1553 &quot;a_key&quot;: &quot;A String&quot;,
1554 },
1555 },
1556 &quot;rawDisk&quot;: { # The parameters of the raw disk image.
1557 &quot;containerType&quot;: &quot;A String&quot;, # The format used to encode and transmit the block device, which should beTAR. This is just a container and transmission format and not
1558 # a runtime format. Provided by the client when the disk image is created.
1559 &quot;sha1Checksum&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1560 # An optional SHA1 checksum of the disk image before unpackaging provided
1561 # by the client when the disk image is created.
1562 &quot;source&quot;: &quot;A String&quot;, # The full Google Cloud Storage URL or Artifact Registry path where the raw
1563 # disk image archive is stored.
1564 # The following are valid formats:
1565 #
1566 # - https://storage.googleapis.com/bucket_name/image_archive_name
1567 # - https://storage.googleapis.com/bucket_name/folder_name/image_archive_name
1568 # - projects/project/locations/location/repositories/repo/packages/package/versions/version_id
1569 # - projects/project/locations/location/repositories/repo/packages/package/versions/version_id@dirsum_sha256:hex_value
1570 #
1571 #
1572 #
1573 # In order to create an image, you must provide the full or partial URL of
1574 # one of the following:
1575 #
1576 # - The rawDisk.source URL
1577 # - The sourceDisk URL
1578 # - The sourceImage URL
1579 # - The sourceSnapshot URL
1580 },
1581 &quot;rolloutOverride&quot;: { # A rollout policy configuration. # A rollout policy to apply to this image. When specified, the rollout policy
1582 # overrides per-zone references to the image via the associated image family.
1583 # The rollout policy restricts the zones where this image is accessible when
1584 # using a zonal image family reference. When the rollout policy does not
1585 # include the user specified zone, or if the zone is rolled out, this image
1586 # is accessible.
1587 #
1588 # The rollout policy for this image is read-only, except for allowlisted
1589 # users. This field might not be configured. To view the latest
1590 # non-deprecated image in a specific zone, use theimageFamilyViews.get method.
1591 &quot;defaultRolloutTime&quot;: &quot;A String&quot;, # An optional RFC3339 timestamp on or after which the update is
1592 # considered rolled out to any zone that is not explicitly stated.
1593 &quot;locationRolloutPolicies&quot;: { # Location based rollout policies to apply to the resource.
1594 #
1595 # Currently only zone names are supported and must be represented
1596 # as valid URLs, like: zones/us-central1-a.
1597 #
1598 # The value expects an RFC3339 timestamp on or after which the update is
1599 # considered rolled out to the specified location.
1600 &quot;a_key&quot;: &quot;A String&quot;,
1601 },
1602 },
1603 &quot;satisfiesPzi&quot;: True or False, # Output only. Reserved for future use.
1604 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
1605 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
1606 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource&#x27;s resource id.
1607 &quot;shieldedInstanceInitialState&quot;: { # Initial State for shielded instance, # Set the secure boot keys of shielded instance.
1608 # these are public keys which are safe to store in public
1609 &quot;dbs&quot;: [ # The Key Database (db).
1610 {
1611 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
1612 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
1613 },
1614 ],
1615 &quot;dbxs&quot;: [ # The forbidden key database (dbx).
1616 {
1617 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
1618 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
1619 },
1620 ],
1621 &quot;keks&quot;: [ # The Key Exchange Key (KEK).
1622 {
1623 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
1624 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
1625 },
1626 ],
1627 &quot;pk&quot;: { # The Platform Key (PK).
1628 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
1629 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
1630 },
1631 },
1632 &quot;sourceDisk&quot;: &quot;A String&quot;, # URL of the source disk used to create this image.
1633 # For example, the following are valid values:
1634 #
1635 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
1636 # - projects/project/zones/zone/disks/disk
1637 # - zones/zone/disks/disk
1638 #
1639 #
1640 #
1641 # In order to create an image, you must provide the full or partial URL of
1642 # one of the following:
1643 #
1644 # - The rawDisk.source URL
1645 # - The sourceDisk URL
1646 # - The sourceImage URL
1647 # - The sourceSnapshot URL
1648 &quot;sourceDiskEncryptionKey&quot;: { # Thecustomer-supplied
1649 # encryption key of the source disk. Required if the source disk is
1650 # protected by a customer-supplied encryption key.
1651 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
1652 # For example:
1653 #
1654 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
1655 # key_region/cryptoKeys/key
1656 #
1657 # The fully-qualifed key name may be returned for resource GET requests. For
1658 # example:
1659 #
1660 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
1661 # key_region/cryptoKeys/key
1662 # /cryptoKeyVersions/1
1663 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
1664 # key. If absent, the Compute Engine default service account is used.
1665 # For example:
1666 #
1667 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
1668 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
1669 # encryption key, encoded in RFC
1670 # 4648 base64 to either encrypt or decrypt this resource. You can
1671 # provide either the rawKey or thersaEncryptedKey.
1672 # For example:
1673 #
1674 # &quot;rawKey&quot;:
1675 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
1676 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
1677 # customer-supplied encryption key to either encrypt or decrypt this
1678 # resource. You can provide either the rawKey or thersaEncryptedKey.
1679 # For example:
1680 #
1681 # &quot;rsaEncryptedKey&quot;:
1682 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
1683 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
1684 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
1685 #
1686 # The key must meet the following requirements before you can provide it to
1687 # Compute Engine:
1688 #
1689 # 1. The key is wrapped using a RSA public key certificate provided by
1690 # Google.
1691 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
1692 # encoding.
1693 #
1694 # Gets the RSA public key certificate provided by Google at:
1695 #
1696 #
1697 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
1698 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
1699 # 4648 base64 encoded SHA-256 hash of the customer-supplied
1700 # encryption key that protects this resource.
1701 },
1702 &quot;sourceDiskId&quot;: &quot;A String&quot;, # Output only. [Output Only]
1703 # The ID value of the disk used to create this image. This value may be used
1704 # to determine whether the image was taken from the current or a previous
1705 # instance of a given disk name.
1706 &quot;sourceImage&quot;: &quot;A String&quot;, # URL of the source image used to create this image.
1707 # The following are valid formats for the URL:
1708 #
1709 # - https://www.googleapis.com/compute/v1/projects/project_id/global/
1710 # images/image_name
1711 # - projects/project_id/global/images/image_name
1712 #
1713 #
1714 #
1715 # In order to create an image, you must provide the full or partial URL of
1716 # one of the following:
1717 #
1718 # - The rawDisk.source URL
1719 # - The sourceDisk URL
1720 # - The sourceImage URL
1721 # - The sourceSnapshot URL
1722 &quot;sourceImageEncryptionKey&quot;: { # The customer-supplied encryption key of the source image. Required if the
1723 # source image is protected by a customer-supplied encryption key.
1724 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
1725 # For example:
1726 #
1727 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
1728 # key_region/cryptoKeys/key
1729 #
1730 # The fully-qualifed key name may be returned for resource GET requests. For
1731 # example:
1732 #
1733 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
1734 # key_region/cryptoKeys/key
1735 # /cryptoKeyVersions/1
1736 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
1737 # key. If absent, the Compute Engine default service account is used.
1738 # For example:
1739 #
1740 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
1741 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
1742 # encryption key, encoded in RFC
1743 # 4648 base64 to either encrypt or decrypt this resource. You can
1744 # provide either the rawKey or thersaEncryptedKey.
1745 # For example:
1746 #
1747 # &quot;rawKey&quot;:
1748 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
1749 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
1750 # customer-supplied encryption key to either encrypt or decrypt this
1751 # resource. You can provide either the rawKey or thersaEncryptedKey.
1752 # For example:
1753 #
1754 # &quot;rsaEncryptedKey&quot;:
1755 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
1756 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
1757 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
1758 #
1759 # The key must meet the following requirements before you can provide it to
1760 # Compute Engine:
1761 #
1762 # 1. The key is wrapped using a RSA public key certificate provided by
1763 # Google.
1764 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
1765 # encoding.
1766 #
1767 # Gets the RSA public key certificate provided by Google at:
1768 #
1769 #
1770 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
1771 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
1772 # 4648 base64 encoded SHA-256 hash of the customer-supplied
1773 # encryption key that protects this resource.
1774 },
1775 &quot;sourceImageId&quot;: &quot;A String&quot;, # Output only. [Output Only]
1776 # The ID value of the image used to create this image. This value may be used
1777 # to determine whether the image was taken from the current or a previous
1778 # instance of a given image name.
1779 &quot;sourceSnapshot&quot;: &quot;A String&quot;, # URL of the source snapshot used to create this image.
1780 # The following are valid formats for the URL:
1781 #
1782 # - https://www.googleapis.com/compute/v1/projects/project_id/global/
1783 # snapshots/snapshot_name
1784 # - projects/project_id/global/snapshots/snapshot_name
1785 #
1786 #
1787 #
1788 # In order to create an image, you must provide the full or partial URL of
1789 # one of the following:
1790 #
1791 # - The rawDisk.source URL
1792 # - The sourceDisk URL
1793 # - The sourceImage URL
1794 # - The sourceSnapshot URL
1795 &quot;sourceSnapshotEncryptionKey&quot;: { # The customer-supplied encryption key of the source snapshot. Required if
1796 # the source snapshot is protected by a customer-supplied encryption key.
1797 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
1798 # For example:
1799 #
1800 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
1801 # key_region/cryptoKeys/key
1802 #
1803 # The fully-qualifed key name may be returned for resource GET requests. For
1804 # example:
1805 #
1806 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
1807 # key_region/cryptoKeys/key
1808 # /cryptoKeyVersions/1
1809 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
1810 # key. If absent, the Compute Engine default service account is used.
1811 # For example:
1812 #
1813 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
1814 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
1815 # encryption key, encoded in RFC
1816 # 4648 base64 to either encrypt or decrypt this resource. You can
1817 # provide either the rawKey or thersaEncryptedKey.
1818 # For example:
1819 #
1820 # &quot;rawKey&quot;:
1821 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
1822 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
1823 # customer-supplied encryption key to either encrypt or decrypt this
1824 # resource. You can provide either the rawKey or thersaEncryptedKey.
1825 # For example:
1826 #
1827 # &quot;rsaEncryptedKey&quot;:
1828 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
1829 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
1830 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
1831 #
1832 # The key must meet the following requirements before you can provide it to
1833 # Compute Engine:
1834 #
1835 # 1. The key is wrapped using a RSA public key certificate provided by
1836 # Google.
1837 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
1838 # encoding.
1839 #
1840 # Gets the RSA public key certificate provided by Google at:
1841 #
1842 #
1843 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
1844 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
1845 # 4648 base64 encoded SHA-256 hash of the customer-supplied
1846 # encryption key that protects this resource.
1847 },
1848 &quot;sourceSnapshotId&quot;: &quot;A String&quot;, # Output only. [Output Only]
1849 # The ID value of the snapshot used to create this image. This value may be
1850 # used to determine whether the snapshot was taken from the current or a
1851 # previous instance of a given snapshot name.
1852 &quot;sourceType&quot;: &quot;RAW&quot;, # The type of the image used to create this disk. The
1853 # default and only valid value is RAW.
1854 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only] The status of the image. An image can be used to create other
1855 # resources, such as instances, only after the image has been successfully
1856 # created and the status is set to READY. Possible
1857 # values are FAILED, PENDING, orREADY.
1858 &quot;storageLocations&quot;: [ # Cloud Storage bucket storage location of the image (regional or
1859 # multi-regional).
1860 &quot;A String&quot;,
1861 ],
1862 }</pre>
1863 </div>
1864
1865 <div class="method">
1866 <code class="details" id="getIamPolicy">getIamPolicy(project, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</code>
1867 <pre>Gets the access control policy for a resource. May be empty if no such
1868 policy or resource exists.
1869
1870 Args:
1871 project: string, Project ID for this request. (required)
1872 resource: string, Name or id of the resource for this request. (required)
1873 optionsRequestedPolicyVersion: integer, Requested IAM Policy version.
1874 x__xgafv: string, V1 error format.
1875 Allowed values
1876 1 - v1 error format
1877 2 - v2 error format
1878
1879 Returns:
1880 An object of the form:
1881
1882 { # An Identity and Access Management (IAM) policy, which specifies access
1883 # controls for Google Cloud resources.
1884 #
1885 #
1886 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
1887 # `members`, or principals, to a single `role`. Principals can be user
1888 # accounts, service accounts, Google groups, and domains (such as G Suite). A
1889 # `role` is a named list of permissions; each `role` can be an IAM predefined
1890 # role or a user-created custom role.
1891 #
1892 # For some types of Google Cloud resources, a `binding` can also specify a
1893 # `condition`, which is a logical expression that allows access to a resource
1894 # only if the expression evaluates to `true`. A condition can add constraints
1895 # based on attributes of the request, the resource, or both. To learn which
1896 # resources support conditions in their IAM policies, see the
1897 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
1898 #
1899 # **JSON example:**
1900 #
1901 # ```
1902 # {
1903 # &quot;bindings&quot;: [
1904 # {
1905 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
1906 # &quot;members&quot;: [
1907 # &quot;user:[email protected]&quot;,
1908 # &quot;group:[email protected]&quot;,
1909 # &quot;domain:google.com&quot;,
1910 # &quot;serviceAccount:[email protected]&quot;
1911 # ]
1912 # },
1913 # {
1914 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
1915 # &quot;members&quot;: [
1916 # &quot;user:[email protected]&quot;
1917 # ],
1918 # &quot;condition&quot;: {
1919 # &quot;title&quot;: &quot;expirable access&quot;,
1920 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
1921 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
1922 # }
1923 # }
1924 # ],
1925 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
1926 # &quot;version&quot;: 3
1927 # }
1928 # ```
1929 #
1930 # **YAML example:**
1931 #
1932 # ```
1933 # bindings:
1934 # - members:
1935 # - user:[email protected]
1936 # - group:[email protected]
1937 # - domain:google.com
1938 # - serviceAccount:[email protected]
1939 # role: roles/resourcemanager.organizationAdmin
1940 # - members:
1941 # - user:[email protected]
1942 # role: roles/resourcemanager.organizationViewer
1943 # condition:
1944 # title: expirable access
1945 # description: Does not grant access after Sep 2020
1946 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
1947 # etag: BwWWja0YfJA=
1948 # version: 3
1949 # ```
1950 #
1951 # For a description of IAM and its features, see the
1952 # [IAM documentation](https://cloud.google.com/iam/docs/).
1953 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
1954 { # Specifies the audit configuration for a service.
1955 # The configuration determines which permission types are logged, and what
1956 # identities, if any, are exempted from logging.
1957 # An AuditConfig must have one or more AuditLogConfigs.
1958 #
1959 # If there are AuditConfigs for both `allServices` and a specific service,
1960 # the union of the two AuditConfigs is used for that service: the log_types
1961 # specified in each AuditConfig are enabled, and the exempted_members in each
1962 # AuditLogConfig are exempted.
1963 #
1964 # Example Policy with multiple AuditConfigs:
1965 #
1966 # {
1967 # &quot;audit_configs&quot;: [
1968 # {
1969 # &quot;service&quot;: &quot;allServices&quot;,
1970 # &quot;audit_log_configs&quot;: [
1971 # {
1972 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
1973 # &quot;exempted_members&quot;: [
1974 # &quot;user:[email protected]&quot;
1975 # ]
1976 # },
1977 # {
1978 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
1979 # },
1980 # {
1981 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
1982 # }
1983 # ]
1984 # },
1985 # {
1986 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
1987 # &quot;audit_log_configs&quot;: [
1988 # {
1989 # &quot;log_type&quot;: &quot;DATA_READ&quot;
1990 # },
1991 # {
1992 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
1993 # &quot;exempted_members&quot;: [
1994 # &quot;user:[email protected]&quot;
1995 # ]
1996 # }
1997 # ]
1998 # }
1999 # ]
2000 # }
2001 #
2002 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
2003 # logging. It also exempts `[email protected]` from DATA_READ logging, and
2004 # `[email protected]` from DATA_WRITE logging.
2005 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
2006 { # Provides the configuration for logging a type of permissions.
2007 # Example:
2008 #
2009 # {
2010 # &quot;audit_log_configs&quot;: [
2011 # {
2012 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
2013 # &quot;exempted_members&quot;: [
2014 # &quot;user:[email protected]&quot;
2015 # ]
2016 # },
2017 # {
2018 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
2019 # }
2020 # ]
2021 # }
2022 #
2023 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
2024 # [email protected] from DATA_READ logging.
2025 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
2026 # permission.
2027 # Follows the same format of Binding.members.
2028 &quot;A String&quot;,
2029 ],
2030 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
2031 },
2032 ],
2033 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
2034 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
2035 # `allServices` is a special value that covers all services.
2036 },
2037 ],
2038 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
2039 # may specify a `condition` that determines how and when the `bindings` are
2040 # applied. Each of the `bindings` must contain at least one principal.
2041 #
2042 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
2043 # of these principals can be Google groups. Each occurrence of a principal
2044 # counts towards these limits. For example, if the `bindings` grant 50
2045 # different roles to `user:[email protected]`, and not to any other
2046 # principal, then you can add another 1,450 principals to the `bindings` in
2047 # the `Policy`.
2048 { # Associates `members`, or principals, with a `role`.
2049 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
2050 #
2051 # If the condition evaluates to `true`, then this binding applies to the
2052 # current request.
2053 #
2054 # If the condition evaluates to `false`, then this binding does not apply to
2055 # the current request. However, a different role binding might grant the same
2056 # role to one or more of the principals in this binding.
2057 #
2058 # To learn which resources support conditions in their IAM policies, see the
2059 # [IAM
2060 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
2061 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
2062 # are documented at https://github.com/google/cel-spec.
2063 #
2064 # Example (Comparison):
2065 #
2066 # title: &quot;Summary size limit&quot;
2067 # description: &quot;Determines if a summary is less than 100 chars&quot;
2068 # expression: &quot;document.summary.size() &lt; 100&quot;
2069 #
2070 # Example (Equality):
2071 #
2072 # title: &quot;Requestor is owner&quot;
2073 # description: &quot;Determines if requestor is the document owner&quot;
2074 # expression: &quot;document.owner == request.auth.claims.email&quot;
2075 #
2076 # Example (Logic):
2077 #
2078 # title: &quot;Public documents&quot;
2079 # description: &quot;Determine whether the document should be publicly visible&quot;
2080 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
2081 #
2082 # Example (Data Manipulation):
2083 #
2084 # title: &quot;Notification string&quot;
2085 # description: &quot;Create a notification string with a timestamp.&quot;
2086 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
2087 #
2088 # The exact variables and functions that may be referenced within an expression
2089 # are determined by the service that evaluates it. See the service
2090 # documentation for additional information.
2091 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
2092 # describes the expression, e.g. when hovered over it in a UI.
2093 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
2094 # syntax.
2095 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
2096 # reporting, e.g. a file name and a position in the file.
2097 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
2098 # its purpose. This can be used e.g. in UIs which allow to enter the
2099 # expression.
2100 },
2101 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
2102 # `members` can have the following values:
2103 #
2104 # * `allUsers`: A special identifier that represents anyone who is
2105 # on the internet; with or without a Google account.
2106 #
2107 # * `allAuthenticatedUsers`: A special identifier that represents anyone
2108 # who is authenticated with a Google account or a service account.
2109 # Does not include identities that come from external identity providers
2110 # (IdPs) through identity federation.
2111 #
2112 # * `user:{emailid}`: An email address that represents a specific Google
2113 # account. For example, `[email protected]` .
2114 #
2115 #
2116 # * `serviceAccount:{emailid}`: An email address that represents a Google
2117 # service account. For example,
2118 # `[email protected]`.
2119 #
2120 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
2121 # identifier for a
2122 # [Kubernetes service
2123 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
2124 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
2125 #
2126 # * `group:{emailid}`: An email address that represents a Google group.
2127 # For example, `[email protected]`.
2128 #
2129 #
2130 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
2131 # users of that domain. For example, `google.com` or `example.com`.
2132 #
2133 #
2134 #
2135 #
2136 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
2137 # A single identity in a workforce identity pool.
2138 #
2139 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
2140 # All workforce identities in a group.
2141 #
2142 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
2143 # All workforce identities with a specific attribute value.
2144 #
2145 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
2146 # All identities in a workforce identity pool.
2147 #
2148 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
2149 # A single identity in a workload identity pool.
2150 #
2151 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
2152 # A workload identity pool group.
2153 #
2154 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
2155 # All identities in a workload identity pool with a certain attribute.
2156 #
2157 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
2158 # All identities in a workload identity pool.
2159 #
2160 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
2161 # identifier) representing a user that has been recently deleted. For
2162 # example, `[email protected]?uid=123456789012345678901`. If the user is
2163 # recovered, this value reverts to `user:{emailid}` and the recovered user
2164 # retains the role in the binding.
2165 #
2166 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
2167 # unique identifier) representing a service account that has been recently
2168 # deleted. For example,
2169 # `[email protected]?uid=123456789012345678901`.
2170 # If the service account is undeleted, this value reverts to
2171 # `serviceAccount:{emailid}` and the undeleted service account retains the
2172 # role in the binding.
2173 #
2174 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
2175 # identifier) representing a Google group that has been recently
2176 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
2177 # the group is recovered, this value reverts to `group:{emailid}` and the
2178 # recovered group retains the role in the binding.
2179 #
2180 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
2181 # Deleted single identity in a workforce identity pool. For example,
2182 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
2183 &quot;A String&quot;,
2184 ],
2185 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
2186 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
2187 #
2188 # For an overview of the IAM roles and permissions, see the
2189 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
2190 # a list of the available pre-defined roles, see
2191 # [here](https://cloud.google.com/iam/docs/understanding-roles).
2192 },
2193 ],
2194 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
2195 # prevent simultaneous updates of a policy from overwriting each other.
2196 # It is strongly suggested that systems make use of the `etag` in the
2197 # read-modify-write cycle to perform policy updates in order to avoid race
2198 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
2199 # systems are expected to put that etag in the request to `setIamPolicy` to
2200 # ensure that their change will be applied to the same version of the policy.
2201 #
2202 # **Important:** If you use IAM Conditions, you must include the `etag` field
2203 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
2204 # you to overwrite a version `3` policy with a version `1` policy, and all of
2205 # the conditions in the version `3` policy are lost.
2206 &quot;version&quot;: 42, # Specifies the format of the policy.
2207 #
2208 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
2209 # are rejected.
2210 #
2211 # Any operation that affects conditional role bindings must specify version
2212 # `3`. This requirement applies to the following operations:
2213 #
2214 # * Getting a policy that includes a conditional role binding
2215 # * Adding a conditional role binding to a policy
2216 # * Changing a conditional role binding in a policy
2217 # * Removing any role binding, with or without a condition, from a policy
2218 # that includes conditions
2219 #
2220 # **Important:** If you use IAM Conditions, you must include the `etag` field
2221 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
2222 # you to overwrite a version `3` policy with a version `1` policy, and all of
2223 # the conditions in the version `3` policy are lost.
2224 #
2225 # If a policy does not include any conditions, operations on that policy may
2226 # specify any valid version or leave the field unset.
2227 #
2228 # To learn which resources support conditions in their IAM policies, see the
2229 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
2230 }</pre>
2231 </div>
2232
2233 <div class="method">
2234 <code class="details" id="insert">insert(project, body=None, forceCreate=None, requestId=None, x__xgafv=None)</code>
2235 <pre>Creates an image in the specified project using the data included
2236 in the request.
2237
2238 Args:
2239 project: string, Project ID for this request. (required)
2240 body: object, The request body.
2241 The object takes the form of:
2242
2243 { # Represents an Image resource.
2244 #
2245 # You can use images to create boot disks for your VM instances.
2246 # For more information, read Images.
2247 &quot;architecture&quot;: &quot;A String&quot;, # The architecture of the image. Valid values are
2248 # ARM64 or X86_64.
2249 &quot;archiveSizeBytes&quot;: &quot;A String&quot;, # Size of the image tar.gz archive stored in Google Cloud
2250 # Storage (in bytes).
2251 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
2252 # text format.
2253 &quot;deprecated&quot;: { # Deprecation status for a public resource. # Output only. The deprecation status associated with this image.
2254 &quot;deleted&quot;: &quot;A String&quot;, # An optional RFC3339 timestamp on or after which the state of this
2255 # resource is intended to change to DELETED. This is only
2256 # informational and the status will not change unless the client explicitly
2257 # changes it.
2258 &quot;deprecated&quot;: &quot;A String&quot;, # An optional RFC3339 timestamp on or after which the state of this
2259 # resource is intended to change to DEPRECATED. This is only
2260 # informational and the status will not change unless the client explicitly
2261 # changes it.
2262 &quot;obsolete&quot;: &quot;A String&quot;, # An optional RFC3339 timestamp on or after which the state of this
2263 # resource is intended to change to OBSOLETE. This is only
2264 # informational and the status will not change unless the client explicitly
2265 # changes it.
2266 &quot;replacement&quot;: &quot;A String&quot;, # The URL of the suggested replacement for a deprecated resource.
2267 # The suggested replacement resource must be the same kind of resource as the
2268 # deprecated resource.
2269 &quot;state&quot;: &quot;A String&quot;, # The deprecation state of this resource. This can be ACTIVE,DEPRECATED, OBSOLETE, or DELETED.
2270 # Operations which communicate the end of life date for an image, can useACTIVE. Operations which create a new resource using aDEPRECATED resource will return successfully, but with a
2271 # warning indicating the deprecated resource and recommending its
2272 # replacement. Operations which use OBSOLETE orDELETED resources will be rejected and result in an error.
2273 &quot;stateOverride&quot;: { # A rollout policy configuration. # The rollout policy for this deprecation. This policy is only enforced by
2274 # image family views. The rollout policy restricts the zones where the
2275 # associated resource is considered in a deprecated state. When the rollout
2276 # policy does not include the user specified zone, or if the zone is rolled
2277 # out, the associated resource is considered in a deprecated state.
2278 #
2279 # The rollout policy for this deprecation is read-only, except for
2280 # allowlisted users. This field might not be configured. To view the latest
2281 # non-deprecated image in a specific zone, use theimageFamilyViews.get method.
2282 &quot;defaultRolloutTime&quot;: &quot;A String&quot;, # An optional RFC3339 timestamp on or after which the update is
2283 # considered rolled out to any zone that is not explicitly stated.
2284 &quot;locationRolloutPolicies&quot;: { # Location based rollout policies to apply to the resource.
2285 #
2286 # Currently only zone names are supported and must be represented
2287 # as valid URLs, like: zones/us-central1-a.
2288 #
2289 # The value expects an RFC3339 timestamp on or after which the update is
2290 # considered rolled out to the specified location.
2291 &quot;a_key&quot;: &quot;A String&quot;,
2292 },
2293 },
2294 },
2295 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
2296 # create the resource.
2297 &quot;diskSizeGb&quot;: &quot;A String&quot;, # Size of the image when restored onto a persistent disk (in GB).
2298 &quot;enableConfidentialCompute&quot;: True or False, # Output only. Whether this image is created from a confidential compute mode disk.
2299 # [Output Only]: This field is not set by user, but from source disk.
2300 &quot;family&quot;: &quot;A String&quot;, # The name of the image family to which this image belongs. The image
2301 # family name can be from a publicly managed image family provided by
2302 # Compute Engine, or from a custom image family you create. For example,centos-stream-9 is a publicly available image family.
2303 # For more information, see Image
2304 # family best practices.
2305 #
2306 # When creating disks, you can specify an image family instead of a specific
2307 # image name. The image family always returns its latest image that is not
2308 # deprecated. The name of the image family must comply with RFC1035.
2309 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable
2310 # only for bootable images. To see a list of available options, see theguestOSfeatures[].type parameter.
2311 { # Guest OS features.
2312 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
2313 # separate values. Set to one or more of the following values:
2314 #
2315 # - VIRTIO_SCSI_MULTIQUEUE
2316 # - WINDOWS
2317 # - MULTI_IP_SUBNET
2318 # - UEFI_COMPATIBLE
2319 # - GVNIC
2320 # - SEV_CAPABLE
2321 # - SUSPEND_RESUME_COMPATIBLE
2322 # - SEV_LIVE_MIGRATABLE_V2
2323 # - SEV_SNP_CAPABLE
2324 # - TDX_CAPABLE
2325 # - IDPF
2326 # - SNP_SVSM_CAPABLE
2327 # - CCA_CAPABLE
2328 #
2329 #
2330 # For more information, see
2331 # Enabling guest operating system features.
2332 },
2333 ],
2334 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
2335 # defined by the server.
2336 &quot;imageEncryptionKey&quot;: { # Encrypts the image using acustomer-supplied
2337 # encryption key.
2338 #
2339 # After you encrypt an image with a customer-supplied key, you must provide
2340 # the same key if you use the image later (e.g. to create a disk from
2341 # the image).
2342 #
2343 # Customer-supplied encryption keys do not protect access to metadata
2344 # of the disk.
2345 #
2346 # If you do not provide an encryption key when creating the image, then the
2347 # disk will be encrypted using an automatically generated key and you do not
2348 # need to provide a key to use the image later.
2349 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
2350 # For example:
2351 #
2352 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
2353 # key_region/cryptoKeys/key
2354 #
2355 # The fully-qualifed key name may be returned for resource GET requests. For
2356 # example:
2357 #
2358 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
2359 # key_region/cryptoKeys/key
2360 # /cryptoKeyVersions/1
2361 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
2362 # key. If absent, the Compute Engine default service account is used.
2363 # For example:
2364 #
2365 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
2366 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
2367 # encryption key, encoded in RFC
2368 # 4648 base64 to either encrypt or decrypt this resource. You can
2369 # provide either the rawKey or thersaEncryptedKey.
2370 # For example:
2371 #
2372 # &quot;rawKey&quot;:
2373 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
2374 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
2375 # customer-supplied encryption key to either encrypt or decrypt this
2376 # resource. You can provide either the rawKey or thersaEncryptedKey.
2377 # For example:
2378 #
2379 # &quot;rsaEncryptedKey&quot;:
2380 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
2381 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
2382 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
2383 #
2384 # The key must meet the following requirements before you can provide it to
2385 # Compute Engine:
2386 #
2387 # 1. The key is wrapped using a RSA public key certificate provided by
2388 # Google.
2389 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
2390 # encoding.
2391 #
2392 # Gets the RSA public key certificate provided by Google at:
2393 #
2394 #
2395 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
2396 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
2397 # 4648 base64 encoded SHA-256 hash of the customer-supplied
2398 # encryption key that protects this resource.
2399 },
2400 &quot;kind&quot;: &quot;compute#image&quot;, # Output only. [Output Only] Type of the resource. Always compute#image for
2401 # images.
2402 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for the labels being applied to this image, which is
2403 # essentially a hash of the labels used for optimistic locking. The
2404 # fingerprint is initially generated by Compute Engine and changes after
2405 # every request to modify or update labels. You must always provide an
2406 # up-to-date fingerprint hash in order to update or change labels,
2407 # otherwise the request will fail with error412 conditionNotMet.
2408 #
2409 # To see the latest fingerprint, make a get() request to
2410 # retrieve an image.
2411 &quot;labels&quot;: { # Labels to apply to this image. These can be later modified by
2412 # the setLabels method.
2413 &quot;a_key&quot;: &quot;A String&quot;,
2414 },
2415 &quot;licenseCodes&quot;: [ # Integer license codes indicating which licenses are attached to this image.
2416 &quot;A String&quot;,
2417 ],
2418 &quot;licenses&quot;: [ # Any applicable license URI.
2419 &quot;A String&quot;,
2420 ],
2421 &quot;locked&quot;: True or False, # A flag for marketplace VM disk created from the image, which is designed
2422 # for marketplace VM disk to prevent the proprietary data on the disk from
2423 # being accessed unwantedly. The flag will be inherited by the disk created
2424 # from the image.
2425 #
2426 # The disk with locked flag set to true will be prohibited from performing
2427 # the operations below:
2428 #
2429 # - R/W or R/O disk attach
2430 # - Disk detach, if disk is created via create-on-create
2431 # - Create images
2432 # - Create snapshots
2433 # - Create disk clone (create disk from the current disk)
2434 #
2435 #
2436 #
2437 # The image with the locked field set to true will be prohibited from
2438 # performing the operations below:
2439 #
2440 # - Create images from the current image
2441 # - Update the locked field for the current image
2442 #
2443 #
2444 #
2445 # The instance with at least one disk with locked flag set to true will be
2446 # prohibited from performing the operations below:
2447 #
2448 # - Secondary disk attach
2449 # - Create instant snapshot
2450 # - Create machine images
2451 # - Create instance template
2452 # - Delete the instance with --keep-disk parameter set to true
2453 &quot;name&quot;: &quot;A String&quot;, # Name of the resource; provided by the client when the resource is created.
2454 # The name must be 1-63 characters long, and comply withRFC1035.
2455 # Specifically, the name must be 1-63 characters long and match the regular
2456 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
2457 # character must be a lowercase letter, and all following characters must be
2458 # a dash, lowercase letter, or digit, except the last character, which cannot
2459 # be a dash.
2460 &quot;params&quot;: { # Additional image params. # Input only. [Input Only] Additional params passed with the request, but not persisted
2461 # as part of resource payload.
2462 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the image. Tag keys and values have
2463 # the same definition as resource
2464 # manager tags. Keys and values can be either in numeric format,
2465 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
2466 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
2467 # `{tag_value_short_name}`. The field is ignored (both PUT &amp;
2468 # PATCH) when empty.
2469 &quot;a_key&quot;: &quot;A String&quot;,
2470 },
2471 },
2472 &quot;rawDisk&quot;: { # The parameters of the raw disk image.
2473 &quot;containerType&quot;: &quot;A String&quot;, # The format used to encode and transmit the block device, which should beTAR. This is just a container and transmission format and not
2474 # a runtime format. Provided by the client when the disk image is created.
2475 &quot;sha1Checksum&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
2476 # An optional SHA1 checksum of the disk image before unpackaging provided
2477 # by the client when the disk image is created.
2478 &quot;source&quot;: &quot;A String&quot;, # The full Google Cloud Storage URL or Artifact Registry path where the raw
2479 # disk image archive is stored.
2480 # The following are valid formats:
2481 #
2482 # - https://storage.googleapis.com/bucket_name/image_archive_name
2483 # - https://storage.googleapis.com/bucket_name/folder_name/image_archive_name
2484 # - projects/project/locations/location/repositories/repo/packages/package/versions/version_id
2485 # - projects/project/locations/location/repositories/repo/packages/package/versions/version_id@dirsum_sha256:hex_value
2486 #
2487 #
2488 #
2489 # In order to create an image, you must provide the full or partial URL of
2490 # one of the following:
2491 #
2492 # - The rawDisk.source URL
2493 # - The sourceDisk URL
2494 # - The sourceImage URL
2495 # - The sourceSnapshot URL
2496 },
2497 &quot;rolloutOverride&quot;: { # A rollout policy configuration. # A rollout policy to apply to this image. When specified, the rollout policy
2498 # overrides per-zone references to the image via the associated image family.
2499 # The rollout policy restricts the zones where this image is accessible when
2500 # using a zonal image family reference. When the rollout policy does not
2501 # include the user specified zone, or if the zone is rolled out, this image
2502 # is accessible.
2503 #
2504 # The rollout policy for this image is read-only, except for allowlisted
2505 # users. This field might not be configured. To view the latest
2506 # non-deprecated image in a specific zone, use theimageFamilyViews.get method.
2507 &quot;defaultRolloutTime&quot;: &quot;A String&quot;, # An optional RFC3339 timestamp on or after which the update is
2508 # considered rolled out to any zone that is not explicitly stated.
2509 &quot;locationRolloutPolicies&quot;: { # Location based rollout policies to apply to the resource.
2510 #
2511 # Currently only zone names are supported and must be represented
2512 # as valid URLs, like: zones/us-central1-a.
2513 #
2514 # The value expects an RFC3339 timestamp on or after which the update is
2515 # considered rolled out to the specified location.
2516 &quot;a_key&quot;: &quot;A String&quot;,
2517 },
2518 },
2519 &quot;satisfiesPzi&quot;: True or False, # Output only. Reserved for future use.
2520 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
2521 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
2522 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource&#x27;s resource id.
2523 &quot;shieldedInstanceInitialState&quot;: { # Initial State for shielded instance, # Set the secure boot keys of shielded instance.
2524 # these are public keys which are safe to store in public
2525 &quot;dbs&quot;: [ # The Key Database (db).
2526 {
2527 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
2528 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
2529 },
2530 ],
2531 &quot;dbxs&quot;: [ # The forbidden key database (dbx).
2532 {
2533 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
2534 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
2535 },
2536 ],
2537 &quot;keks&quot;: [ # The Key Exchange Key (KEK).
2538 {
2539 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
2540 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
2541 },
2542 ],
2543 &quot;pk&quot;: { # The Platform Key (PK).
2544 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
2545 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
2546 },
2547 },
2548 &quot;sourceDisk&quot;: &quot;A String&quot;, # URL of the source disk used to create this image.
2549 # For example, the following are valid values:
2550 #
2551 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
2552 # - projects/project/zones/zone/disks/disk
2553 # - zones/zone/disks/disk
2554 #
2555 #
2556 #
2557 # In order to create an image, you must provide the full or partial URL of
2558 # one of the following:
2559 #
2560 # - The rawDisk.source URL
2561 # - The sourceDisk URL
2562 # - The sourceImage URL
2563 # - The sourceSnapshot URL
2564 &quot;sourceDiskEncryptionKey&quot;: { # Thecustomer-supplied
2565 # encryption key of the source disk. Required if the source disk is
2566 # protected by a customer-supplied encryption key.
2567 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
2568 # For example:
2569 #
2570 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
2571 # key_region/cryptoKeys/key
2572 #
2573 # The fully-qualifed key name may be returned for resource GET requests. For
2574 # example:
2575 #
2576 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
2577 # key_region/cryptoKeys/key
2578 # /cryptoKeyVersions/1
2579 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
2580 # key. If absent, the Compute Engine default service account is used.
2581 # For example:
2582 #
2583 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
2584 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
2585 # encryption key, encoded in RFC
2586 # 4648 base64 to either encrypt or decrypt this resource. You can
2587 # provide either the rawKey or thersaEncryptedKey.
2588 # For example:
2589 #
2590 # &quot;rawKey&quot;:
2591 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
2592 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
2593 # customer-supplied encryption key to either encrypt or decrypt this
2594 # resource. You can provide either the rawKey or thersaEncryptedKey.
2595 # For example:
2596 #
2597 # &quot;rsaEncryptedKey&quot;:
2598 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
2599 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
2600 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
2601 #
2602 # The key must meet the following requirements before you can provide it to
2603 # Compute Engine:
2604 #
2605 # 1. The key is wrapped using a RSA public key certificate provided by
2606 # Google.
2607 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
2608 # encoding.
2609 #
2610 # Gets the RSA public key certificate provided by Google at:
2611 #
2612 #
2613 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
2614 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
2615 # 4648 base64 encoded SHA-256 hash of the customer-supplied
2616 # encryption key that protects this resource.
2617 },
2618 &quot;sourceDiskId&quot;: &quot;A String&quot;, # Output only. [Output Only]
2619 # The ID value of the disk used to create this image. This value may be used
2620 # to determine whether the image was taken from the current or a previous
2621 # instance of a given disk name.
2622 &quot;sourceImage&quot;: &quot;A String&quot;, # URL of the source image used to create this image.
2623 # The following are valid formats for the URL:
2624 #
2625 # - https://www.googleapis.com/compute/v1/projects/project_id/global/
2626 # images/image_name
2627 # - projects/project_id/global/images/image_name
2628 #
2629 #
2630 #
2631 # In order to create an image, you must provide the full or partial URL of
2632 # one of the following:
2633 #
2634 # - The rawDisk.source URL
2635 # - The sourceDisk URL
2636 # - The sourceImage URL
2637 # - The sourceSnapshot URL
2638 &quot;sourceImageEncryptionKey&quot;: { # The customer-supplied encryption key of the source image. Required if the
2639 # source image is protected by a customer-supplied encryption key.
2640 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
2641 # For example:
2642 #
2643 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
2644 # key_region/cryptoKeys/key
2645 #
2646 # The fully-qualifed key name may be returned for resource GET requests. For
2647 # example:
2648 #
2649 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
2650 # key_region/cryptoKeys/key
2651 # /cryptoKeyVersions/1
2652 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
2653 # key. If absent, the Compute Engine default service account is used.
2654 # For example:
2655 #
2656 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
2657 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
2658 # encryption key, encoded in RFC
2659 # 4648 base64 to either encrypt or decrypt this resource. You can
2660 # provide either the rawKey or thersaEncryptedKey.
2661 # For example:
2662 #
2663 # &quot;rawKey&quot;:
2664 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
2665 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
2666 # customer-supplied encryption key to either encrypt or decrypt this
2667 # resource. You can provide either the rawKey or thersaEncryptedKey.
2668 # For example:
2669 #
2670 # &quot;rsaEncryptedKey&quot;:
2671 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
2672 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
2673 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
2674 #
2675 # The key must meet the following requirements before you can provide it to
2676 # Compute Engine:
2677 #
2678 # 1. The key is wrapped using a RSA public key certificate provided by
2679 # Google.
2680 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
2681 # encoding.
2682 #
2683 # Gets the RSA public key certificate provided by Google at:
2684 #
2685 #
2686 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
2687 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
2688 # 4648 base64 encoded SHA-256 hash of the customer-supplied
2689 # encryption key that protects this resource.
2690 },
2691 &quot;sourceImageId&quot;: &quot;A String&quot;, # Output only. [Output Only]
2692 # The ID value of the image used to create this image. This value may be used
2693 # to determine whether the image was taken from the current or a previous
2694 # instance of a given image name.
2695 &quot;sourceSnapshot&quot;: &quot;A String&quot;, # URL of the source snapshot used to create this image.
2696 # The following are valid formats for the URL:
2697 #
2698 # - https://www.googleapis.com/compute/v1/projects/project_id/global/
2699 # snapshots/snapshot_name
2700 # - projects/project_id/global/snapshots/snapshot_name
2701 #
2702 #
2703 #
2704 # In order to create an image, you must provide the full or partial URL of
2705 # one of the following:
2706 #
2707 # - The rawDisk.source URL
2708 # - The sourceDisk URL
2709 # - The sourceImage URL
2710 # - The sourceSnapshot URL
2711 &quot;sourceSnapshotEncryptionKey&quot;: { # The customer-supplied encryption key of the source snapshot. Required if
2712 # the source snapshot is protected by a customer-supplied encryption key.
2713 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
2714 # For example:
2715 #
2716 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
2717 # key_region/cryptoKeys/key
2718 #
2719 # The fully-qualifed key name may be returned for resource GET requests. For
2720 # example:
2721 #
2722 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
2723 # key_region/cryptoKeys/key
2724 # /cryptoKeyVersions/1
2725 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
2726 # key. If absent, the Compute Engine default service account is used.
2727 # For example:
2728 #
2729 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
2730 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
2731 # encryption key, encoded in RFC
2732 # 4648 base64 to either encrypt or decrypt this resource. You can
2733 # provide either the rawKey or thersaEncryptedKey.
2734 # For example:
2735 #
2736 # &quot;rawKey&quot;:
2737 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
2738 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
2739 # customer-supplied encryption key to either encrypt or decrypt this
2740 # resource. You can provide either the rawKey or thersaEncryptedKey.
2741 # For example:
2742 #
2743 # &quot;rsaEncryptedKey&quot;:
2744 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
2745 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
2746 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
2747 #
2748 # The key must meet the following requirements before you can provide it to
2749 # Compute Engine:
2750 #
2751 # 1. The key is wrapped using a RSA public key certificate provided by
2752 # Google.
2753 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
2754 # encoding.
2755 #
2756 # Gets the RSA public key certificate provided by Google at:
2757 #
2758 #
2759 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
2760 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
2761 # 4648 base64 encoded SHA-256 hash of the customer-supplied
2762 # encryption key that protects this resource.
2763 },
2764 &quot;sourceSnapshotId&quot;: &quot;A String&quot;, # Output only. [Output Only]
2765 # The ID value of the snapshot used to create this image. This value may be
2766 # used to determine whether the snapshot was taken from the current or a
2767 # previous instance of a given snapshot name.
2768 &quot;sourceType&quot;: &quot;RAW&quot;, # The type of the image used to create this disk. The
2769 # default and only valid value is RAW.
2770 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only] The status of the image. An image can be used to create other
2771 # resources, such as instances, only after the image has been successfully
2772 # created and the status is set to READY. Possible
2773 # values are FAILED, PENDING, orREADY.
2774 &quot;storageLocations&quot;: [ # Cloud Storage bucket storage location of the image (regional or
2775 # multi-regional).
2776 &quot;A String&quot;,
2777 ],
2778 }
2779
2780 forceCreate: boolean, Force image creation if true.
2781 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
2782 that if you must retry your request, the server will know to ignore the
2783 request if it has already been completed.
2784
2785 For example, consider a situation where you make an initial request and
2786 the request times out. If you make the request again with the same
2787 request ID, the server can check if original operation with the same
2788 request ID was received, and if so, will ignore the second request. This
2789 prevents clients from accidentally creating duplicate commitments.
2790
2791 The request ID must be
2792 a valid UUID with the exception that zero UUID is not supported
2793 (00000000-0000-0000-0000-000000000000).
2794 x__xgafv: string, V1 error format.
2795 Allowed values
2796 1 - v1 error format
2797 2 - v2 error format
2798
2799 Returns:
2800 An object of the form:
2801
2802 { # Represents an Operation resource.
2803 #
2804 # Google Compute Engine has three Operation resources:
2805 #
2806 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
2807 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
2808 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
2809 #
2810 # You can use an operation resource to manage asynchronous API requests.
2811 # For more information, readHandling
2812 # API responses.
2813 #
2814 # Operations can be global, regional or zonal.
2815 #
2816 # - For global operations, use the `globalOperations`
2817 # resource.
2818 # - For regional operations, use the
2819 # `regionOperations` resource.
2820 # - For zonal operations, use
2821 # the `zoneOperations` resource.
2822 #
2823 #
2824 #
2825 # For more information, read
2826 # Global, Regional, and Zonal Resources.
2827 #
2828 # Note that completed Operation resources have a limited
2829 # retention period.
2830 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
2831 # Not present otherwise.
2832 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
2833 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
2834 # set when the operation is created.
2835 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
2836 # text format.
2837 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
2838 # this field will be populated.
2839 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
2840 # operation.
2841 {
2842 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
2843 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
2844 # details. There is a set of defined message types to use for providing
2845 # details.The syntax depends on the error code. For example,
2846 # QuotaExceededInfo will have details when the error code is
2847 # QUOTA_EXCEEDED.
2848 {
2849 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
2850 #
2851 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
2852 # is not enabled:
2853 #
2854 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
2855 # &quot;domain&quot;: &quot;googleapis.com&quot;
2856 # &quot;metadata&quot;: {
2857 # &quot;resource&quot;: &quot;projects/123&quot;,
2858 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
2859 # }
2860 # }
2861 #
2862 # This response indicates that the pubsub.googleapis.com API is not enabled.
2863 #
2864 # Example of an error that is returned when attempting to create a Spanner
2865 # instance in a region that is out of stock:
2866 #
2867 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
2868 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
2869 # &quot;metadata&quot;: {
2870 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
2871 # }
2872 # }
2873 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
2874 # is typically the registered service name of the tool or product that
2875 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
2876 # generated by some common infrastructure, the error domain must be a
2877 # globally unique value that identifies the infrastructure. For Google API
2878 # infrastructure, the error domain is &quot;googleapis.com&quot;.
2879 &quot;metadatas&quot;: { # Additional structured details about this error.
2880 #
2881 # Keys must match a regular expression of `a-z+` but should
2882 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
2883 # length. When identifying the current value of an exceeded limit, the units
2884 # should be contained in the key, not the value. For example, rather than
2885 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
2886 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
2887 # instances that can be created in a single (batch) request.
2888 &quot;a_key&quot;: &quot;A String&quot;,
2889 },
2890 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
2891 # proximate cause of the error. Error reasons are unique within a particular
2892 # domain of errors. This should be at most 63 characters and match a
2893 # regular expression of `A-Z+[A-Z0-9]`, which represents
2894 # UPPER_SNAKE_CASE.
2895 },
2896 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
2897 #
2898 # For example, if a quota check failed with an error indicating the calling
2899 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
2900 # directly to the right place in the developer console to flip the bit.
2901 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
2902 { # Describes a URL link.
2903 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
2904 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
2905 },
2906 ],
2907 },
2908 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
2909 # which can be attached to an RPC error.
2910 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
2911 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
2912 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
2913 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
2914 },
2915 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
2916 &quot;dimensions&quot;: { # The map holding related quota dimensions.
2917 &quot;a_key&quot;: &quot;A String&quot;,
2918 },
2919 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
2920 # type or metric.
2921 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
2922 # or metric.
2923 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
2924 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
2925 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
2926 },
2927 },
2928 ],
2929 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
2930 # This property is optional.
2931 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
2932 },
2933 ],
2934 },
2935 &quot;getVersionOperationMetadata&quot;: {
2936 &quot;inlineSbomInfo&quot;: {
2937 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
2938 # appropriate identifiers.
2939 &quot;a_key&quot;: &quot;A String&quot;,
2940 },
2941 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
2942 # identifiers.
2943 &quot;a_key&quot;: &quot;A String&quot;,
2944 },
2945 },
2946 },
2947 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
2948 # message that was returned, such as `NOT FOUND`.
2949 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
2950 # status code that was returned. For example, a `404` means the
2951 # resource was not found.
2952 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
2953 # defined by the server.
2954 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
2955 # This value is inRFC3339
2956 # text format.
2957 &quot;instancesBulkInsertOperationMetadata&quot;: {
2958 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
2959 # Example key: zones/us-central1-a
2960 &quot;a_key&quot;: {
2961 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
2962 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
2963 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
2964 # error.
2965 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
2966 # if the flow is rolling forward or rolling back.
2967 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
2968 },
2969 },
2970 },
2971 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
2972 # Operation resources.
2973 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
2974 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
2975 # group of operations results from a `bulkInsert` API request.
2976 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
2977 # `update`, or `delete`, and so on.
2978 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
2979 # There is no requirement that this be linear or support any granularity of
2980 # operations. This should not be used to guess when the operation will be
2981 # complete. This number should monotonically increase as the operation
2982 # progresses.
2983 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
2984 # applicable when performing regional operations.
2985 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
2986 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
2987 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
2988 # this field will contain information on all underlying zonal actions and
2989 # their state.
2990 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
2991 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
2992 # Example key: zones/us-central1-a
2993 &quot;a_key&quot;: {
2994 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
2995 # populated.
2996 # different programming environments, including REST APIs and RPC APIs. It is
2997 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
2998 # three pieces of data: error code, error message, and error details.
2999 #
3000 # You can find out more about this error model and how to work with it in the
3001 # [API Design Guide](https://cloud.google.com/apis/design/errors).
3002 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
3003 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
3004 # message types for APIs to use.
3005 {
3006 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
3007 },
3008 ],
3009 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
3010 # user-facing error message should be localized and sent in the
3011 # google.rpc.Status.details field, or localized by the client.
3012 },
3013 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
3014 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
3015 },
3016 },
3017 },
3018 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
3019 # This value is inRFC3339
3020 # text format.
3021 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
3022 # following:
3023 # `PENDING`, `RUNNING`, or `DONE`.
3024 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
3025 # operation.
3026 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
3027 # of the target resource.
3028 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
3029 # operations related to creating a snapshot, this points to the disk
3030 # that the snapshot was created from.
3031 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
3032 # `[email protected]` or
3033 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
3034 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
3035 # operation, this field will be populated.
3036 {
3037 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
3038 # Engine returns NO_RESULTS_ON_PAGE if there
3039 # are no results in the response.
3040 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
3041 # value format. For example:
3042 #
3043 # &quot;data&quot;: [
3044 # {
3045 # &quot;key&quot;: &quot;scope&quot;,
3046 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
3047 # }
3048 {
3049 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
3050 # returned. For example, for warnings where there are no results in a list
3051 # request for a particular zone, this key might be scope and
3052 # the key value might be the zone name. Other examples might be a key
3053 # indicating a deprecated resource and a suggested replacement, or a
3054 # warning about invalid network settings (for example, if an instance
3055 # attempts to perform IP forwarding but is not enabled for IP forwarding).
3056 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
3057 },
3058 ],
3059 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
3060 },
3061 ],
3062 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
3063 # applicable when performing per-zone operations.
3064 }</pre>
3065 </div>
3066
3067 <div class="method">
3068 <code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None, zone=None)</code>
3069 <pre>Retrieves the list of custom images
3070 available to the specified project. Custom images are images you
3071 create that belong to your project. This method does not
3072 get any images that belong to other projects, including publicly-available
3073 images, like Debian 8. If you want to get a list of publicly-available
3074 images, use this method to make a request to the respective image project,
3075 such as debian-cloud or windows-cloud.
3076
3077 Args:
3078 project: string, Project ID for this request. (required)
3079 filter: string, A filter expression that filters resources listed in the response. Most
3080 Compute resources support two types of filter expressions:
3081 expressions that support regular expressions and expressions that follow
3082 API improvement proposal AIP-160.
3083 These two types of filter expressions cannot be mixed in one request.
3084
3085 If you want to use AIP-160, your expression must specify the field name, an
3086 operator, and the value that you want to use for filtering. The value
3087 must be a string, a number, or a boolean. The operator
3088 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
3089
3090 For example, if you are filtering Compute Engine instances, you can
3091 exclude instances named `example-instance` by specifying
3092 `name != example-instance`.
3093
3094 The `:*` comparison can be used to test whether a key has been defined.
3095 For example, to find all objects with `owner` label use:
3096 ```
3097 labels.owner:*
3098 ```
3099
3100 You can also filter nested fields. For example, you could specify
3101 `scheduling.automaticRestart = false` to include instances only
3102 if they are not scheduled for automatic restarts. You can use filtering
3103 on nested fields to filter based onresource labels.
3104
3105 To filter on multiple expressions, provide each separate expression within
3106 parentheses. For example:
3107 ```
3108 (scheduling.automaticRestart = true)
3109 (cpuPlatform = &quot;Intel Skylake&quot;)
3110 ```
3111 By default, each expression is an `AND` expression. However, you
3112 can include `AND` and `OR` expressions explicitly.
3113 For example:
3114 ```
3115 (cpuPlatform = &quot;Intel Skylake&quot;) OR
3116 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
3117 (scheduling.automaticRestart = true)
3118 ```
3119
3120 If you want to use a regular expression, use the `eq` (equal) or `ne`
3121 (not equal) operator against a single un-parenthesized expression with or
3122 without quotes or against multiple parenthesized expressions. Examples:
3123
3124 `fieldname eq unquoted literal`
3125 `fieldname eq &#x27;single quoted literal&#x27;`
3126 `fieldname eq &quot;double quoted literal&quot;`
3127 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
3128
3129 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
3130 The literal value must match the entire field.
3131
3132 For example, to filter for instances that do not end with name &quot;instance&quot;,
3133 you would use `name ne .*instance`.
3134
3135 You cannot combine constraints on multiple fields using regular
3136 expressions.
3137 maxResults: integer, The maximum number of results per page that should be returned.
3138 If the number of available results is larger than `maxResults`,
3139 Compute Engine returns a `nextPageToken` that can be used to get
3140 the next page of results in subsequent list requests. Acceptable values are
3141 `0` to `500`, inclusive. (Default: `500`)
3142 orderBy: string, Sorts list results by a certain order. By default, results
3143 are returned in alphanumerical order based on the resource name.
3144
3145 You can also sort results in descending order based on the creation
3146 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
3147 results based on the `creationTimestamp` field in
3148 reverse chronological order (newest result first). Use this to sort
3149 resources like operations so that the newest operation is returned first.
3150
3151 Currently, only sorting by `name` or
3152 `creationTimestamp desc` is supported.
3153 pageToken: string, Specifies a page token to use. Set `pageToken` to the
3154 `nextPageToken` returned by a previous list request to get
3155 the next page of results.
3156 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
3157 of failure. The default value is false.
3158
3159 For example, when partial success behavior is enabled, aggregatedList for a
3160 single zone scope either returns all resources in the zone or no resources,
3161 with an error code.
3162 x__xgafv: string, V1 error format.
3163 Allowed values
3164 1 - v1 error format
3165 2 - v2 error format
3166 zone: string, The zone query parameter.
3167
3168 Returns:
3169 An object of the form:
3170
3171 { # Contains a list of images.
3172 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
3173 &quot;items&quot;: [ # A list of Image resources.
3174 { # Represents an Image resource.
3175 #
3176 # You can use images to create boot disks for your VM instances.
3177 # For more information, read Images.
3178 &quot;architecture&quot;: &quot;A String&quot;, # The architecture of the image. Valid values are
3179 # ARM64 or X86_64.
3180 &quot;archiveSizeBytes&quot;: &quot;A String&quot;, # Size of the image tar.gz archive stored in Google Cloud
3181 # Storage (in bytes).
3182 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
3183 # text format.
3184 &quot;deprecated&quot;: { # Deprecation status for a public resource. # Output only. The deprecation status associated with this image.
3185 &quot;deleted&quot;: &quot;A String&quot;, # An optional RFC3339 timestamp on or after which the state of this
3186 # resource is intended to change to DELETED. This is only
3187 # informational and the status will not change unless the client explicitly
3188 # changes it.
3189 &quot;deprecated&quot;: &quot;A String&quot;, # An optional RFC3339 timestamp on or after which the state of this
3190 # resource is intended to change to DEPRECATED. This is only
3191 # informational and the status will not change unless the client explicitly
3192 # changes it.
3193 &quot;obsolete&quot;: &quot;A String&quot;, # An optional RFC3339 timestamp on or after which the state of this
3194 # resource is intended to change to OBSOLETE. This is only
3195 # informational and the status will not change unless the client explicitly
3196 # changes it.
3197 &quot;replacement&quot;: &quot;A String&quot;, # The URL of the suggested replacement for a deprecated resource.
3198 # The suggested replacement resource must be the same kind of resource as the
3199 # deprecated resource.
3200 &quot;state&quot;: &quot;A String&quot;, # The deprecation state of this resource. This can be ACTIVE,DEPRECATED, OBSOLETE, or DELETED.
3201 # Operations which communicate the end of life date for an image, can useACTIVE. Operations which create a new resource using aDEPRECATED resource will return successfully, but with a
3202 # warning indicating the deprecated resource and recommending its
3203 # replacement. Operations which use OBSOLETE orDELETED resources will be rejected and result in an error.
3204 &quot;stateOverride&quot;: { # A rollout policy configuration. # The rollout policy for this deprecation. This policy is only enforced by
3205 # image family views. The rollout policy restricts the zones where the
3206 # associated resource is considered in a deprecated state. When the rollout
3207 # policy does not include the user specified zone, or if the zone is rolled
3208 # out, the associated resource is considered in a deprecated state.
3209 #
3210 # The rollout policy for this deprecation is read-only, except for
3211 # allowlisted users. This field might not be configured. To view the latest
3212 # non-deprecated image in a specific zone, use theimageFamilyViews.get method.
3213 &quot;defaultRolloutTime&quot;: &quot;A String&quot;, # An optional RFC3339 timestamp on or after which the update is
3214 # considered rolled out to any zone that is not explicitly stated.
3215 &quot;locationRolloutPolicies&quot;: { # Location based rollout policies to apply to the resource.
3216 #
3217 # Currently only zone names are supported and must be represented
3218 # as valid URLs, like: zones/us-central1-a.
3219 #
3220 # The value expects an RFC3339 timestamp on or after which the update is
3221 # considered rolled out to the specified location.
3222 &quot;a_key&quot;: &quot;A String&quot;,
3223 },
3224 },
3225 },
3226 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
3227 # create the resource.
3228 &quot;diskSizeGb&quot;: &quot;A String&quot;, # Size of the image when restored onto a persistent disk (in GB).
3229 &quot;enableConfidentialCompute&quot;: True or False, # Output only. Whether this image is created from a confidential compute mode disk.
3230 # [Output Only]: This field is not set by user, but from source disk.
3231 &quot;family&quot;: &quot;A String&quot;, # The name of the image family to which this image belongs. The image
3232 # family name can be from a publicly managed image family provided by
3233 # Compute Engine, or from a custom image family you create. For example,centos-stream-9 is a publicly available image family.
3234 # For more information, see Image
3235 # family best practices.
3236 #
3237 # When creating disks, you can specify an image family instead of a specific
3238 # image name. The image family always returns its latest image that is not
3239 # deprecated. The name of the image family must comply with RFC1035.
3240 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable
3241 # only for bootable images. To see a list of available options, see theguestOSfeatures[].type parameter.
3242 { # Guest OS features.
3243 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
3244 # separate values. Set to one or more of the following values:
3245 #
3246 # - VIRTIO_SCSI_MULTIQUEUE
3247 # - WINDOWS
3248 # - MULTI_IP_SUBNET
3249 # - UEFI_COMPATIBLE
3250 # - GVNIC
3251 # - SEV_CAPABLE
3252 # - SUSPEND_RESUME_COMPATIBLE
3253 # - SEV_LIVE_MIGRATABLE_V2
3254 # - SEV_SNP_CAPABLE
3255 # - TDX_CAPABLE
3256 # - IDPF
3257 # - SNP_SVSM_CAPABLE
3258 # - CCA_CAPABLE
3259 #
3260 #
3261 # For more information, see
3262 # Enabling guest operating system features.
3263 },
3264 ],
3265 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
3266 # defined by the server.
3267 &quot;imageEncryptionKey&quot;: { # Encrypts the image using acustomer-supplied
3268 # encryption key.
3269 #
3270 # After you encrypt an image with a customer-supplied key, you must provide
3271 # the same key if you use the image later (e.g. to create a disk from
3272 # the image).
3273 #
3274 # Customer-supplied encryption keys do not protect access to metadata
3275 # of the disk.
3276 #
3277 # If you do not provide an encryption key when creating the image, then the
3278 # disk will be encrypted using an automatically generated key and you do not
3279 # need to provide a key to use the image later.
3280 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
3281 # For example:
3282 #
3283 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
3284 # key_region/cryptoKeys/key
3285 #
3286 # The fully-qualifed key name may be returned for resource GET requests. For
3287 # example:
3288 #
3289 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
3290 # key_region/cryptoKeys/key
3291 # /cryptoKeyVersions/1
3292 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
3293 # key. If absent, the Compute Engine default service account is used.
3294 # For example:
3295 #
3296 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
3297 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
3298 # encryption key, encoded in RFC
3299 # 4648 base64 to either encrypt or decrypt this resource. You can
3300 # provide either the rawKey or thersaEncryptedKey.
3301 # For example:
3302 #
3303 # &quot;rawKey&quot;:
3304 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
3305 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
3306 # customer-supplied encryption key to either encrypt or decrypt this
3307 # resource. You can provide either the rawKey or thersaEncryptedKey.
3308 # For example:
3309 #
3310 # &quot;rsaEncryptedKey&quot;:
3311 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
3312 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
3313 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
3314 #
3315 # The key must meet the following requirements before you can provide it to
3316 # Compute Engine:
3317 #
3318 # 1. The key is wrapped using a RSA public key certificate provided by
3319 # Google.
3320 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
3321 # encoding.
3322 #
3323 # Gets the RSA public key certificate provided by Google at:
3324 #
3325 #
3326 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
3327 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
3328 # 4648 base64 encoded SHA-256 hash of the customer-supplied
3329 # encryption key that protects this resource.
3330 },
3331 &quot;kind&quot;: &quot;compute#image&quot;, # Output only. [Output Only] Type of the resource. Always compute#image for
3332 # images.
3333 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for the labels being applied to this image, which is
3334 # essentially a hash of the labels used for optimistic locking. The
3335 # fingerprint is initially generated by Compute Engine and changes after
3336 # every request to modify or update labels. You must always provide an
3337 # up-to-date fingerprint hash in order to update or change labels,
3338 # otherwise the request will fail with error412 conditionNotMet.
3339 #
3340 # To see the latest fingerprint, make a get() request to
3341 # retrieve an image.
3342 &quot;labels&quot;: { # Labels to apply to this image. These can be later modified by
3343 # the setLabels method.
3344 &quot;a_key&quot;: &quot;A String&quot;,
3345 },
3346 &quot;licenseCodes&quot;: [ # Integer license codes indicating which licenses are attached to this image.
3347 &quot;A String&quot;,
3348 ],
3349 &quot;licenses&quot;: [ # Any applicable license URI.
3350 &quot;A String&quot;,
3351 ],
3352 &quot;locked&quot;: True or False, # A flag for marketplace VM disk created from the image, which is designed
3353 # for marketplace VM disk to prevent the proprietary data on the disk from
3354 # being accessed unwantedly. The flag will be inherited by the disk created
3355 # from the image.
3356 #
3357 # The disk with locked flag set to true will be prohibited from performing
3358 # the operations below:
3359 #
3360 # - R/W or R/O disk attach
3361 # - Disk detach, if disk is created via create-on-create
3362 # - Create images
3363 # - Create snapshots
3364 # - Create disk clone (create disk from the current disk)
3365 #
3366 #
3367 #
3368 # The image with the locked field set to true will be prohibited from
3369 # performing the operations below:
3370 #
3371 # - Create images from the current image
3372 # - Update the locked field for the current image
3373 #
3374 #
3375 #
3376 # The instance with at least one disk with locked flag set to true will be
3377 # prohibited from performing the operations below:
3378 #
3379 # - Secondary disk attach
3380 # - Create instant snapshot
3381 # - Create machine images
3382 # - Create instance template
3383 # - Delete the instance with --keep-disk parameter set to true
3384 &quot;name&quot;: &quot;A String&quot;, # Name of the resource; provided by the client when the resource is created.
3385 # The name must be 1-63 characters long, and comply withRFC1035.
3386 # Specifically, the name must be 1-63 characters long and match the regular
3387 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
3388 # character must be a lowercase letter, and all following characters must be
3389 # a dash, lowercase letter, or digit, except the last character, which cannot
3390 # be a dash.
3391 &quot;params&quot;: { # Additional image params. # Input only. [Input Only] Additional params passed with the request, but not persisted
3392 # as part of resource payload.
3393 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the image. Tag keys and values have
3394 # the same definition as resource
3395 # manager tags. Keys and values can be either in numeric format,
3396 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
3397 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
3398 # `{tag_value_short_name}`. The field is ignored (both PUT &amp;
3399 # PATCH) when empty.
3400 &quot;a_key&quot;: &quot;A String&quot;,
3401 },
3402 },
3403 &quot;rawDisk&quot;: { # The parameters of the raw disk image.
3404 &quot;containerType&quot;: &quot;A String&quot;, # The format used to encode and transmit the block device, which should beTAR. This is just a container and transmission format and not
3405 # a runtime format. Provided by the client when the disk image is created.
3406 &quot;sha1Checksum&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
3407 # An optional SHA1 checksum of the disk image before unpackaging provided
3408 # by the client when the disk image is created.
3409 &quot;source&quot;: &quot;A String&quot;, # The full Google Cloud Storage URL or Artifact Registry path where the raw
3410 # disk image archive is stored.
3411 # The following are valid formats:
3412 #
3413 # - https://storage.googleapis.com/bucket_name/image_archive_name
3414 # - https://storage.googleapis.com/bucket_name/folder_name/image_archive_name
3415 # - projects/project/locations/location/repositories/repo/packages/package/versions/version_id
3416 # - projects/project/locations/location/repositories/repo/packages/package/versions/version_id@dirsum_sha256:hex_value
3417 #
3418 #
3419 #
3420 # In order to create an image, you must provide the full or partial URL of
3421 # one of the following:
3422 #
3423 # - The rawDisk.source URL
3424 # - The sourceDisk URL
3425 # - The sourceImage URL
3426 # - The sourceSnapshot URL
3427 },
3428 &quot;rolloutOverride&quot;: { # A rollout policy configuration. # A rollout policy to apply to this image. When specified, the rollout policy
3429 # overrides per-zone references to the image via the associated image family.
3430 # The rollout policy restricts the zones where this image is accessible when
3431 # using a zonal image family reference. When the rollout policy does not
3432 # include the user specified zone, or if the zone is rolled out, this image
3433 # is accessible.
3434 #
3435 # The rollout policy for this image is read-only, except for allowlisted
3436 # users. This field might not be configured. To view the latest
3437 # non-deprecated image in a specific zone, use theimageFamilyViews.get method.
3438 &quot;defaultRolloutTime&quot;: &quot;A String&quot;, # An optional RFC3339 timestamp on or after which the update is
3439 # considered rolled out to any zone that is not explicitly stated.
3440 &quot;locationRolloutPolicies&quot;: { # Location based rollout policies to apply to the resource.
3441 #
3442 # Currently only zone names are supported and must be represented
3443 # as valid URLs, like: zones/us-central1-a.
3444 #
3445 # The value expects an RFC3339 timestamp on or after which the update is
3446 # considered rolled out to the specified location.
3447 &quot;a_key&quot;: &quot;A String&quot;,
3448 },
3449 },
3450 &quot;satisfiesPzi&quot;: True or False, # Output only. Reserved for future use.
3451 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
3452 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
3453 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource&#x27;s resource id.
3454 &quot;shieldedInstanceInitialState&quot;: { # Initial State for shielded instance, # Set the secure boot keys of shielded instance.
3455 # these are public keys which are safe to store in public
3456 &quot;dbs&quot;: [ # The Key Database (db).
3457 {
3458 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
3459 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
3460 },
3461 ],
3462 &quot;dbxs&quot;: [ # The forbidden key database (dbx).
3463 {
3464 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
3465 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
3466 },
3467 ],
3468 &quot;keks&quot;: [ # The Key Exchange Key (KEK).
3469 {
3470 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
3471 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
3472 },
3473 ],
3474 &quot;pk&quot;: { # The Platform Key (PK).
3475 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
3476 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
3477 },
3478 },
3479 &quot;sourceDisk&quot;: &quot;A String&quot;, # URL of the source disk used to create this image.
3480 # For example, the following are valid values:
3481 #
3482 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
3483 # - projects/project/zones/zone/disks/disk
3484 # - zones/zone/disks/disk
3485 #
3486 #
3487 #
3488 # In order to create an image, you must provide the full or partial URL of
3489 # one of the following:
3490 #
3491 # - The rawDisk.source URL
3492 # - The sourceDisk URL
3493 # - The sourceImage URL
3494 # - The sourceSnapshot URL
3495 &quot;sourceDiskEncryptionKey&quot;: { # Thecustomer-supplied
3496 # encryption key of the source disk. Required if the source disk is
3497 # protected by a customer-supplied encryption key.
3498 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
3499 # For example:
3500 #
3501 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
3502 # key_region/cryptoKeys/key
3503 #
3504 # The fully-qualifed key name may be returned for resource GET requests. For
3505 # example:
3506 #
3507 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
3508 # key_region/cryptoKeys/key
3509 # /cryptoKeyVersions/1
3510 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
3511 # key. If absent, the Compute Engine default service account is used.
3512 # For example:
3513 #
3514 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
3515 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
3516 # encryption key, encoded in RFC
3517 # 4648 base64 to either encrypt or decrypt this resource. You can
3518 # provide either the rawKey or thersaEncryptedKey.
3519 # For example:
3520 #
3521 # &quot;rawKey&quot;:
3522 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
3523 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
3524 # customer-supplied encryption key to either encrypt or decrypt this
3525 # resource. You can provide either the rawKey or thersaEncryptedKey.
3526 # For example:
3527 #
3528 # &quot;rsaEncryptedKey&quot;:
3529 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
3530 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
3531 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
3532 #
3533 # The key must meet the following requirements before you can provide it to
3534 # Compute Engine:
3535 #
3536 # 1. The key is wrapped using a RSA public key certificate provided by
3537 # Google.
3538 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
3539 # encoding.
3540 #
3541 # Gets the RSA public key certificate provided by Google at:
3542 #
3543 #
3544 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
3545 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
3546 # 4648 base64 encoded SHA-256 hash of the customer-supplied
3547 # encryption key that protects this resource.
3548 },
3549 &quot;sourceDiskId&quot;: &quot;A String&quot;, # Output only. [Output Only]
3550 # The ID value of the disk used to create this image. This value may be used
3551 # to determine whether the image was taken from the current or a previous
3552 # instance of a given disk name.
3553 &quot;sourceImage&quot;: &quot;A String&quot;, # URL of the source image used to create this image.
3554 # The following are valid formats for the URL:
3555 #
3556 # - https://www.googleapis.com/compute/v1/projects/project_id/global/
3557 # images/image_name
3558 # - projects/project_id/global/images/image_name
3559 #
3560 #
3561 #
3562 # In order to create an image, you must provide the full or partial URL of
3563 # one of the following:
3564 #
3565 # - The rawDisk.source URL
3566 # - The sourceDisk URL
3567 # - The sourceImage URL
3568 # - The sourceSnapshot URL
3569 &quot;sourceImageEncryptionKey&quot;: { # The customer-supplied encryption key of the source image. Required if the
3570 # source image is protected by a customer-supplied encryption key.
3571 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
3572 # For example:
3573 #
3574 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
3575 # key_region/cryptoKeys/key
3576 #
3577 # The fully-qualifed key name may be returned for resource GET requests. For
3578 # example:
3579 #
3580 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
3581 # key_region/cryptoKeys/key
3582 # /cryptoKeyVersions/1
3583 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
3584 # key. If absent, the Compute Engine default service account is used.
3585 # For example:
3586 #
3587 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
3588 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
3589 # encryption key, encoded in RFC
3590 # 4648 base64 to either encrypt or decrypt this resource. You can
3591 # provide either the rawKey or thersaEncryptedKey.
3592 # For example:
3593 #
3594 # &quot;rawKey&quot;:
3595 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
3596 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
3597 # customer-supplied encryption key to either encrypt or decrypt this
3598 # resource. You can provide either the rawKey or thersaEncryptedKey.
3599 # For example:
3600 #
3601 # &quot;rsaEncryptedKey&quot;:
3602 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
3603 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
3604 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
3605 #
3606 # The key must meet the following requirements before you can provide it to
3607 # Compute Engine:
3608 #
3609 # 1. The key is wrapped using a RSA public key certificate provided by
3610 # Google.
3611 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
3612 # encoding.
3613 #
3614 # Gets the RSA public key certificate provided by Google at:
3615 #
3616 #
3617 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
3618 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
3619 # 4648 base64 encoded SHA-256 hash of the customer-supplied
3620 # encryption key that protects this resource.
3621 },
3622 &quot;sourceImageId&quot;: &quot;A String&quot;, # Output only. [Output Only]
3623 # The ID value of the image used to create this image. This value may be used
3624 # to determine whether the image was taken from the current or a previous
3625 # instance of a given image name.
3626 &quot;sourceSnapshot&quot;: &quot;A String&quot;, # URL of the source snapshot used to create this image.
3627 # The following are valid formats for the URL:
3628 #
3629 # - https://www.googleapis.com/compute/v1/projects/project_id/global/
3630 # snapshots/snapshot_name
3631 # - projects/project_id/global/snapshots/snapshot_name
3632 #
3633 #
3634 #
3635 # In order to create an image, you must provide the full or partial URL of
3636 # one of the following:
3637 #
3638 # - The rawDisk.source URL
3639 # - The sourceDisk URL
3640 # - The sourceImage URL
3641 # - The sourceSnapshot URL
3642 &quot;sourceSnapshotEncryptionKey&quot;: { # The customer-supplied encryption key of the source snapshot. Required if
3643 # the source snapshot is protected by a customer-supplied encryption key.
3644 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
3645 # For example:
3646 #
3647 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
3648 # key_region/cryptoKeys/key
3649 #
3650 # The fully-qualifed key name may be returned for resource GET requests. For
3651 # example:
3652 #
3653 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
3654 # key_region/cryptoKeys/key
3655 # /cryptoKeyVersions/1
3656 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
3657 # key. If absent, the Compute Engine default service account is used.
3658 # For example:
3659 #
3660 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
3661 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
3662 # encryption key, encoded in RFC
3663 # 4648 base64 to either encrypt or decrypt this resource. You can
3664 # provide either the rawKey or thersaEncryptedKey.
3665 # For example:
3666 #
3667 # &quot;rawKey&quot;:
3668 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
3669 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
3670 # customer-supplied encryption key to either encrypt or decrypt this
3671 # resource. You can provide either the rawKey or thersaEncryptedKey.
3672 # For example:
3673 #
3674 # &quot;rsaEncryptedKey&quot;:
3675 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
3676 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
3677 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
3678 #
3679 # The key must meet the following requirements before you can provide it to
3680 # Compute Engine:
3681 #
3682 # 1. The key is wrapped using a RSA public key certificate provided by
3683 # Google.
3684 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
3685 # encoding.
3686 #
3687 # Gets the RSA public key certificate provided by Google at:
3688 #
3689 #
3690 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
3691 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
3692 # 4648 base64 encoded SHA-256 hash of the customer-supplied
3693 # encryption key that protects this resource.
3694 },
3695 &quot;sourceSnapshotId&quot;: &quot;A String&quot;, # Output only. [Output Only]
3696 # The ID value of the snapshot used to create this image. This value may be
3697 # used to determine whether the snapshot was taken from the current or a
3698 # previous instance of a given snapshot name.
3699 &quot;sourceType&quot;: &quot;RAW&quot;, # The type of the image used to create this disk. The
3700 # default and only valid value is RAW.
3701 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only] The status of the image. An image can be used to create other
3702 # resources, such as instances, only after the image has been successfully
3703 # created and the status is set to READY. Possible
3704 # values are FAILED, PENDING, orREADY.
3705 &quot;storageLocations&quot;: [ # Cloud Storage bucket storage location of the image (regional or
3706 # multi-regional).
3707 &quot;A String&quot;,
3708 ],
3709 },
3710 ],
3711 &quot;kind&quot;: &quot;compute#imageList&quot;, # Output only. Type of resource.
3712 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
3713 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
3714 # the query parameter pageToken in the next list request.
3715 # Subsequent list requests will have their own nextPageToken to
3716 # continue paging through the results.
3717 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
3718 &quot;warning&quot;: { # [Output Only] Informational warning message.
3719 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
3720 # Engine returns NO_RESULTS_ON_PAGE if there
3721 # are no results in the response.
3722 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
3723 # value format. For example:
3724 #
3725 # &quot;data&quot;: [
3726 # {
3727 # &quot;key&quot;: &quot;scope&quot;,
3728 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
3729 # }
3730 {
3731 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
3732 # returned. For example, for warnings where there are no results in a list
3733 # request for a particular zone, this key might be scope and
3734 # the key value might be the zone name. Other examples might be a key
3735 # indicating a deprecated resource and a suggested replacement, or a
3736 # warning about invalid network settings (for example, if an instance
3737 # attempts to perform IP forwarding but is not enabled for IP forwarding).
3738 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
3739 },
3740 ],
3741 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
3742 },
3743 }</pre>
3744 </div>
3745
3746 <div class="method">
3747 <code class="details" id="list_next">list_next()</code>
3748 <pre>Retrieves the next page of results.
3749
3750 Args:
3751 previous_request: The request for the previous page. (required)
3752 previous_response: The response from the request for the previous page. (required)
3753
3754 Returns:
3755 A request object that you can call &#x27;execute()&#x27; on to request the next
3756 page. Returns None if there are no more items in the collection.
3757 </pre>
3758 </div>
3759
3760 <div class="method">
3761 <code class="details" id="patch">patch(project, image, body=None, requestId=None, x__xgafv=None)</code>
3762 <pre>Patches the specified image with the data included in the request.
3763 Only the following fields can be modified: family, description,
3764 deprecation status.
3765
3766 Args:
3767 project: string, Project ID for this request. (required)
3768 image: string, Name of the image resource to patch. (required)
3769 body: object, The request body.
3770 The object takes the form of:
3771
3772 { # Represents an Image resource.
3773 #
3774 # You can use images to create boot disks for your VM instances.
3775 # For more information, read Images.
3776 &quot;architecture&quot;: &quot;A String&quot;, # The architecture of the image. Valid values are
3777 # ARM64 or X86_64.
3778 &quot;archiveSizeBytes&quot;: &quot;A String&quot;, # Size of the image tar.gz archive stored in Google Cloud
3779 # Storage (in bytes).
3780 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
3781 # text format.
3782 &quot;deprecated&quot;: { # Deprecation status for a public resource. # Output only. The deprecation status associated with this image.
3783 &quot;deleted&quot;: &quot;A String&quot;, # An optional RFC3339 timestamp on or after which the state of this
3784 # resource is intended to change to DELETED. This is only
3785 # informational and the status will not change unless the client explicitly
3786 # changes it.
3787 &quot;deprecated&quot;: &quot;A String&quot;, # An optional RFC3339 timestamp on or after which the state of this
3788 # resource is intended to change to DEPRECATED. This is only
3789 # informational and the status will not change unless the client explicitly
3790 # changes it.
3791 &quot;obsolete&quot;: &quot;A String&quot;, # An optional RFC3339 timestamp on or after which the state of this
3792 # resource is intended to change to OBSOLETE. This is only
3793 # informational and the status will not change unless the client explicitly
3794 # changes it.
3795 &quot;replacement&quot;: &quot;A String&quot;, # The URL of the suggested replacement for a deprecated resource.
3796 # The suggested replacement resource must be the same kind of resource as the
3797 # deprecated resource.
3798 &quot;state&quot;: &quot;A String&quot;, # The deprecation state of this resource. This can be ACTIVE,DEPRECATED, OBSOLETE, or DELETED.
3799 # Operations which communicate the end of life date for an image, can useACTIVE. Operations which create a new resource using aDEPRECATED resource will return successfully, but with a
3800 # warning indicating the deprecated resource and recommending its
3801 # replacement. Operations which use OBSOLETE orDELETED resources will be rejected and result in an error.
3802 &quot;stateOverride&quot;: { # A rollout policy configuration. # The rollout policy for this deprecation. This policy is only enforced by
3803 # image family views. The rollout policy restricts the zones where the
3804 # associated resource is considered in a deprecated state. When the rollout
3805 # policy does not include the user specified zone, or if the zone is rolled
3806 # out, the associated resource is considered in a deprecated state.
3807 #
3808 # The rollout policy for this deprecation is read-only, except for
3809 # allowlisted users. This field might not be configured. To view the latest
3810 # non-deprecated image in a specific zone, use theimageFamilyViews.get method.
3811 &quot;defaultRolloutTime&quot;: &quot;A String&quot;, # An optional RFC3339 timestamp on or after which the update is
3812 # considered rolled out to any zone that is not explicitly stated.
3813 &quot;locationRolloutPolicies&quot;: { # Location based rollout policies to apply to the resource.
3814 #
3815 # Currently only zone names are supported and must be represented
3816 # as valid URLs, like: zones/us-central1-a.
3817 #
3818 # The value expects an RFC3339 timestamp on or after which the update is
3819 # considered rolled out to the specified location.
3820 &quot;a_key&quot;: &quot;A String&quot;,
3821 },
3822 },
3823 },
3824 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
3825 # create the resource.
3826 &quot;diskSizeGb&quot;: &quot;A String&quot;, # Size of the image when restored onto a persistent disk (in GB).
3827 &quot;enableConfidentialCompute&quot;: True or False, # Output only. Whether this image is created from a confidential compute mode disk.
3828 # [Output Only]: This field is not set by user, but from source disk.
3829 &quot;family&quot;: &quot;A String&quot;, # The name of the image family to which this image belongs. The image
3830 # family name can be from a publicly managed image family provided by
3831 # Compute Engine, or from a custom image family you create. For example,centos-stream-9 is a publicly available image family.
3832 # For more information, see Image
3833 # family best practices.
3834 #
3835 # When creating disks, you can specify an image family instead of a specific
3836 # image name. The image family always returns its latest image that is not
3837 # deprecated. The name of the image family must comply with RFC1035.
3838 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable
3839 # only for bootable images. To see a list of available options, see theguestOSfeatures[].type parameter.
3840 { # Guest OS features.
3841 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
3842 # separate values. Set to one or more of the following values:
3843 #
3844 # - VIRTIO_SCSI_MULTIQUEUE
3845 # - WINDOWS
3846 # - MULTI_IP_SUBNET
3847 # - UEFI_COMPATIBLE
3848 # - GVNIC
3849 # - SEV_CAPABLE
3850 # - SUSPEND_RESUME_COMPATIBLE
3851 # - SEV_LIVE_MIGRATABLE_V2
3852 # - SEV_SNP_CAPABLE
3853 # - TDX_CAPABLE
3854 # - IDPF
3855 # - SNP_SVSM_CAPABLE
3856 # - CCA_CAPABLE
3857 #
3858 #
3859 # For more information, see
3860 # Enabling guest operating system features.
3861 },
3862 ],
3863 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
3864 # defined by the server.
3865 &quot;imageEncryptionKey&quot;: { # Encrypts the image using acustomer-supplied
3866 # encryption key.
3867 #
3868 # After you encrypt an image with a customer-supplied key, you must provide
3869 # the same key if you use the image later (e.g. to create a disk from
3870 # the image).
3871 #
3872 # Customer-supplied encryption keys do not protect access to metadata
3873 # of the disk.
3874 #
3875 # If you do not provide an encryption key when creating the image, then the
3876 # disk will be encrypted using an automatically generated key and you do not
3877 # need to provide a key to use the image later.
3878 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
3879 # For example:
3880 #
3881 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
3882 # key_region/cryptoKeys/key
3883 #
3884 # The fully-qualifed key name may be returned for resource GET requests. For
3885 # example:
3886 #
3887 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
3888 # key_region/cryptoKeys/key
3889 # /cryptoKeyVersions/1
3890 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
3891 # key. If absent, the Compute Engine default service account is used.
3892 # For example:
3893 #
3894 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
3895 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
3896 # encryption key, encoded in RFC
3897 # 4648 base64 to either encrypt or decrypt this resource. You can
3898 # provide either the rawKey or thersaEncryptedKey.
3899 # For example:
3900 #
3901 # &quot;rawKey&quot;:
3902 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
3903 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
3904 # customer-supplied encryption key to either encrypt or decrypt this
3905 # resource. You can provide either the rawKey or thersaEncryptedKey.
3906 # For example:
3907 #
3908 # &quot;rsaEncryptedKey&quot;:
3909 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
3910 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
3911 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
3912 #
3913 # The key must meet the following requirements before you can provide it to
3914 # Compute Engine:
3915 #
3916 # 1. The key is wrapped using a RSA public key certificate provided by
3917 # Google.
3918 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
3919 # encoding.
3920 #
3921 # Gets the RSA public key certificate provided by Google at:
3922 #
3923 #
3924 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
3925 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
3926 # 4648 base64 encoded SHA-256 hash of the customer-supplied
3927 # encryption key that protects this resource.
3928 },
3929 &quot;kind&quot;: &quot;compute#image&quot;, # Output only. [Output Only] Type of the resource. Always compute#image for
3930 # images.
3931 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for the labels being applied to this image, which is
3932 # essentially a hash of the labels used for optimistic locking. The
3933 # fingerprint is initially generated by Compute Engine and changes after
3934 # every request to modify or update labels. You must always provide an
3935 # up-to-date fingerprint hash in order to update or change labels,
3936 # otherwise the request will fail with error412 conditionNotMet.
3937 #
3938 # To see the latest fingerprint, make a get() request to
3939 # retrieve an image.
3940 &quot;labels&quot;: { # Labels to apply to this image. These can be later modified by
3941 # the setLabels method.
3942 &quot;a_key&quot;: &quot;A String&quot;,
3943 },
3944 &quot;licenseCodes&quot;: [ # Integer license codes indicating which licenses are attached to this image.
3945 &quot;A String&quot;,
3946 ],
3947 &quot;licenses&quot;: [ # Any applicable license URI.
3948 &quot;A String&quot;,
3949 ],
3950 &quot;locked&quot;: True or False, # A flag for marketplace VM disk created from the image, which is designed
3951 # for marketplace VM disk to prevent the proprietary data on the disk from
3952 # being accessed unwantedly. The flag will be inherited by the disk created
3953 # from the image.
3954 #
3955 # The disk with locked flag set to true will be prohibited from performing
3956 # the operations below:
3957 #
3958 # - R/W or R/O disk attach
3959 # - Disk detach, if disk is created via create-on-create
3960 # - Create images
3961 # - Create snapshots
3962 # - Create disk clone (create disk from the current disk)
3963 #
3964 #
3965 #
3966 # The image with the locked field set to true will be prohibited from
3967 # performing the operations below:
3968 #
3969 # - Create images from the current image
3970 # - Update the locked field for the current image
3971 #
3972 #
3973 #
3974 # The instance with at least one disk with locked flag set to true will be
3975 # prohibited from performing the operations below:
3976 #
3977 # - Secondary disk attach
3978 # - Create instant snapshot
3979 # - Create machine images
3980 # - Create instance template
3981 # - Delete the instance with --keep-disk parameter set to true
3982 &quot;name&quot;: &quot;A String&quot;, # Name of the resource; provided by the client when the resource is created.
3983 # The name must be 1-63 characters long, and comply withRFC1035.
3984 # Specifically, the name must be 1-63 characters long and match the regular
3985 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
3986 # character must be a lowercase letter, and all following characters must be
3987 # a dash, lowercase letter, or digit, except the last character, which cannot
3988 # be a dash.
3989 &quot;params&quot;: { # Additional image params. # Input only. [Input Only] Additional params passed with the request, but not persisted
3990 # as part of resource payload.
3991 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the image. Tag keys and values have
3992 # the same definition as resource
3993 # manager tags. Keys and values can be either in numeric format,
3994 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
3995 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
3996 # `{tag_value_short_name}`. The field is ignored (both PUT &amp;
3997 # PATCH) when empty.
3998 &quot;a_key&quot;: &quot;A String&quot;,
3999 },
4000 },
4001 &quot;rawDisk&quot;: { # The parameters of the raw disk image.
4002 &quot;containerType&quot;: &quot;A String&quot;, # The format used to encode and transmit the block device, which should beTAR. This is just a container and transmission format and not
4003 # a runtime format. Provided by the client when the disk image is created.
4004 &quot;sha1Checksum&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
4005 # An optional SHA1 checksum of the disk image before unpackaging provided
4006 # by the client when the disk image is created.
4007 &quot;source&quot;: &quot;A String&quot;, # The full Google Cloud Storage URL or Artifact Registry path where the raw
4008 # disk image archive is stored.
4009 # The following are valid formats:
4010 #
4011 # - https://storage.googleapis.com/bucket_name/image_archive_name
4012 # - https://storage.googleapis.com/bucket_name/folder_name/image_archive_name
4013 # - projects/project/locations/location/repositories/repo/packages/package/versions/version_id
4014 # - projects/project/locations/location/repositories/repo/packages/package/versions/version_id@dirsum_sha256:hex_value
4015 #
4016 #
4017 #
4018 # In order to create an image, you must provide the full or partial URL of
4019 # one of the following:
4020 #
4021 # - The rawDisk.source URL
4022 # - The sourceDisk URL
4023 # - The sourceImage URL
4024 # - The sourceSnapshot URL
4025 },
4026 &quot;rolloutOverride&quot;: { # A rollout policy configuration. # A rollout policy to apply to this image. When specified, the rollout policy
4027 # overrides per-zone references to the image via the associated image family.
4028 # The rollout policy restricts the zones where this image is accessible when
4029 # using a zonal image family reference. When the rollout policy does not
4030 # include the user specified zone, or if the zone is rolled out, this image
4031 # is accessible.
4032 #
4033 # The rollout policy for this image is read-only, except for allowlisted
4034 # users. This field might not be configured. To view the latest
4035 # non-deprecated image in a specific zone, use theimageFamilyViews.get method.
4036 &quot;defaultRolloutTime&quot;: &quot;A String&quot;, # An optional RFC3339 timestamp on or after which the update is
4037 # considered rolled out to any zone that is not explicitly stated.
4038 &quot;locationRolloutPolicies&quot;: { # Location based rollout policies to apply to the resource.
4039 #
4040 # Currently only zone names are supported and must be represented
4041 # as valid URLs, like: zones/us-central1-a.
4042 #
4043 # The value expects an RFC3339 timestamp on or after which the update is
4044 # considered rolled out to the specified location.
4045 &quot;a_key&quot;: &quot;A String&quot;,
4046 },
4047 },
4048 &quot;satisfiesPzi&quot;: True or False, # Output only. Reserved for future use.
4049 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
4050 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
4051 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource&#x27;s resource id.
4052 &quot;shieldedInstanceInitialState&quot;: { # Initial State for shielded instance, # Set the secure boot keys of shielded instance.
4053 # these are public keys which are safe to store in public
4054 &quot;dbs&quot;: [ # The Key Database (db).
4055 {
4056 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
4057 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
4058 },
4059 ],
4060 &quot;dbxs&quot;: [ # The forbidden key database (dbx).
4061 {
4062 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
4063 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
4064 },
4065 ],
4066 &quot;keks&quot;: [ # The Key Exchange Key (KEK).
4067 {
4068 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
4069 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
4070 },
4071 ],
4072 &quot;pk&quot;: { # The Platform Key (PK).
4073 &quot;content&quot;: &quot;A String&quot;, # The raw content in the secure keys file.
4074 &quot;fileType&quot;: &quot;A String&quot;, # The file type of source file.
4075 },
4076 },
4077 &quot;sourceDisk&quot;: &quot;A String&quot;, # URL of the source disk used to create this image.
4078 # For example, the following are valid values:
4079 #
4080 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
4081 # - projects/project/zones/zone/disks/disk
4082 # - zones/zone/disks/disk
4083 #
4084 #
4085 #
4086 # In order to create an image, you must provide the full or partial URL of
4087 # one of the following:
4088 #
4089 # - The rawDisk.source URL
4090 # - The sourceDisk URL
4091 # - The sourceImage URL
4092 # - The sourceSnapshot URL
4093 &quot;sourceDiskEncryptionKey&quot;: { # Thecustomer-supplied
4094 # encryption key of the source disk. Required if the source disk is
4095 # protected by a customer-supplied encryption key.
4096 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
4097 # For example:
4098 #
4099 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
4100 # key_region/cryptoKeys/key
4101 #
4102 # The fully-qualifed key name may be returned for resource GET requests. For
4103 # example:
4104 #
4105 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
4106 # key_region/cryptoKeys/key
4107 # /cryptoKeyVersions/1
4108 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
4109 # key. If absent, the Compute Engine default service account is used.
4110 # For example:
4111 #
4112 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
4113 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
4114 # encryption key, encoded in RFC
4115 # 4648 base64 to either encrypt or decrypt this resource. You can
4116 # provide either the rawKey or thersaEncryptedKey.
4117 # For example:
4118 #
4119 # &quot;rawKey&quot;:
4120 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
4121 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
4122 # customer-supplied encryption key to either encrypt or decrypt this
4123 # resource. You can provide either the rawKey or thersaEncryptedKey.
4124 # For example:
4125 #
4126 # &quot;rsaEncryptedKey&quot;:
4127 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
4128 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
4129 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
4130 #
4131 # The key must meet the following requirements before you can provide it to
4132 # Compute Engine:
4133 #
4134 # 1. The key is wrapped using a RSA public key certificate provided by
4135 # Google.
4136 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
4137 # encoding.
4138 #
4139 # Gets the RSA public key certificate provided by Google at:
4140 #
4141 #
4142 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
4143 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
4144 # 4648 base64 encoded SHA-256 hash of the customer-supplied
4145 # encryption key that protects this resource.
4146 },
4147 &quot;sourceDiskId&quot;: &quot;A String&quot;, # Output only. [Output Only]
4148 # The ID value of the disk used to create this image. This value may be used
4149 # to determine whether the image was taken from the current or a previous
4150 # instance of a given disk name.
4151 &quot;sourceImage&quot;: &quot;A String&quot;, # URL of the source image used to create this image.
4152 # The following are valid formats for the URL:
4153 #
4154 # - https://www.googleapis.com/compute/v1/projects/project_id/global/
4155 # images/image_name
4156 # - projects/project_id/global/images/image_name
4157 #
4158 #
4159 #
4160 # In order to create an image, you must provide the full or partial URL of
4161 # one of the following:
4162 #
4163 # - The rawDisk.source URL
4164 # - The sourceDisk URL
4165 # - The sourceImage URL
4166 # - The sourceSnapshot URL
4167 &quot;sourceImageEncryptionKey&quot;: { # The customer-supplied encryption key of the source image. Required if the
4168 # source image is protected by a customer-supplied encryption key.
4169 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
4170 # For example:
4171 #
4172 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
4173 # key_region/cryptoKeys/key
4174 #
4175 # The fully-qualifed key name may be returned for resource GET requests. For
4176 # example:
4177 #
4178 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
4179 # key_region/cryptoKeys/key
4180 # /cryptoKeyVersions/1
4181 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
4182 # key. If absent, the Compute Engine default service account is used.
4183 # For example:
4184 #
4185 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
4186 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
4187 # encryption key, encoded in RFC
4188 # 4648 base64 to either encrypt or decrypt this resource. You can
4189 # provide either the rawKey or thersaEncryptedKey.
4190 # For example:
4191 #
4192 # &quot;rawKey&quot;:
4193 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
4194 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
4195 # customer-supplied encryption key to either encrypt or decrypt this
4196 # resource. You can provide either the rawKey or thersaEncryptedKey.
4197 # For example:
4198 #
4199 # &quot;rsaEncryptedKey&quot;:
4200 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
4201 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
4202 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
4203 #
4204 # The key must meet the following requirements before you can provide it to
4205 # Compute Engine:
4206 #
4207 # 1. The key is wrapped using a RSA public key certificate provided by
4208 # Google.
4209 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
4210 # encoding.
4211 #
4212 # Gets the RSA public key certificate provided by Google at:
4213 #
4214 #
4215 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
4216 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
4217 # 4648 base64 encoded SHA-256 hash of the customer-supplied
4218 # encryption key that protects this resource.
4219 },
4220 &quot;sourceImageId&quot;: &quot;A String&quot;, # Output only. [Output Only]
4221 # The ID value of the image used to create this image. This value may be used
4222 # to determine whether the image was taken from the current or a previous
4223 # instance of a given image name.
4224 &quot;sourceSnapshot&quot;: &quot;A String&quot;, # URL of the source snapshot used to create this image.
4225 # The following are valid formats for the URL:
4226 #
4227 # - https://www.googleapis.com/compute/v1/projects/project_id/global/
4228 # snapshots/snapshot_name
4229 # - projects/project_id/global/snapshots/snapshot_name
4230 #
4231 #
4232 #
4233 # In order to create an image, you must provide the full or partial URL of
4234 # one of the following:
4235 #
4236 # - The rawDisk.source URL
4237 # - The sourceDisk URL
4238 # - The sourceImage URL
4239 # - The sourceSnapshot URL
4240 &quot;sourceSnapshotEncryptionKey&quot;: { # The customer-supplied encryption key of the source snapshot. Required if
4241 # the source snapshot is protected by a customer-supplied encryption key.
4242 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
4243 # For example:
4244 #
4245 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
4246 # key_region/cryptoKeys/key
4247 #
4248 # The fully-qualifed key name may be returned for resource GET requests. For
4249 # example:
4250 #
4251 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
4252 # key_region/cryptoKeys/key
4253 # /cryptoKeyVersions/1
4254 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
4255 # key. If absent, the Compute Engine default service account is used.
4256 # For example:
4257 #
4258 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
4259 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
4260 # encryption key, encoded in RFC
4261 # 4648 base64 to either encrypt or decrypt this resource. You can
4262 # provide either the rawKey or thersaEncryptedKey.
4263 # For example:
4264 #
4265 # &quot;rawKey&quot;:
4266 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
4267 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
4268 # customer-supplied encryption key to either encrypt or decrypt this
4269 # resource. You can provide either the rawKey or thersaEncryptedKey.
4270 # For example:
4271 #
4272 # &quot;rsaEncryptedKey&quot;:
4273 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
4274 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
4275 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
4276 #
4277 # The key must meet the following requirements before you can provide it to
4278 # Compute Engine:
4279 #
4280 # 1. The key is wrapped using a RSA public key certificate provided by
4281 # Google.
4282 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
4283 # encoding.
4284 #
4285 # Gets the RSA public key certificate provided by Google at:
4286 #
4287 #
4288 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
4289 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
4290 # 4648 base64 encoded SHA-256 hash of the customer-supplied
4291 # encryption key that protects this resource.
4292 },
4293 &quot;sourceSnapshotId&quot;: &quot;A String&quot;, # Output only. [Output Only]
4294 # The ID value of the snapshot used to create this image. This value may be
4295 # used to determine whether the snapshot was taken from the current or a
4296 # previous instance of a given snapshot name.
4297 &quot;sourceType&quot;: &quot;RAW&quot;, # The type of the image used to create this disk. The
4298 # default and only valid value is RAW.
4299 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only] The status of the image. An image can be used to create other
4300 # resources, such as instances, only after the image has been successfully
4301 # created and the status is set to READY. Possible
4302 # values are FAILED, PENDING, orREADY.
4303 &quot;storageLocations&quot;: [ # Cloud Storage bucket storage location of the image (regional or
4304 # multi-regional).
4305 &quot;A String&quot;,
4306 ],
4307 }
4308
4309 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
4310 that if you must retry your request, the server will know to ignore the
4311 request if it has already been completed.
4312
4313 For example, consider a situation where you make an initial request and
4314 the request times out. If you make the request again with the same
4315 request ID, the server can check if original operation with the same
4316 request ID was received, and if so, will ignore the second request. This
4317 prevents clients from accidentally creating duplicate commitments.
4318
4319 The request ID must be
4320 a valid UUID with the exception that zero UUID is not supported
4321 (00000000-0000-0000-0000-000000000000).
4322 x__xgafv: string, V1 error format.
4323 Allowed values
4324 1 - v1 error format
4325 2 - v2 error format
4326
4327 Returns:
4328 An object of the form:
4329
4330 { # Represents an Operation resource.
4331 #
4332 # Google Compute Engine has three Operation resources:
4333 #
4334 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
4335 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
4336 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
4337 #
4338 # You can use an operation resource to manage asynchronous API requests.
4339 # For more information, readHandling
4340 # API responses.
4341 #
4342 # Operations can be global, regional or zonal.
4343 #
4344 # - For global operations, use the `globalOperations`
4345 # resource.
4346 # - For regional operations, use the
4347 # `regionOperations` resource.
4348 # - For zonal operations, use
4349 # the `zoneOperations` resource.
4350 #
4351 #
4352 #
4353 # For more information, read
4354 # Global, Regional, and Zonal Resources.
4355 #
4356 # Note that completed Operation resources have a limited
4357 # retention period.
4358 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
4359 # Not present otherwise.
4360 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
4361 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
4362 # set when the operation is created.
4363 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
4364 # text format.
4365 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
4366 # this field will be populated.
4367 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
4368 # operation.
4369 {
4370 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
4371 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
4372 # details. There is a set of defined message types to use for providing
4373 # details.The syntax depends on the error code. For example,
4374 # QuotaExceededInfo will have details when the error code is
4375 # QUOTA_EXCEEDED.
4376 {
4377 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
4378 #
4379 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
4380 # is not enabled:
4381 #
4382 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
4383 # &quot;domain&quot;: &quot;googleapis.com&quot;
4384 # &quot;metadata&quot;: {
4385 # &quot;resource&quot;: &quot;projects/123&quot;,
4386 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
4387 # }
4388 # }
4389 #
4390 # This response indicates that the pubsub.googleapis.com API is not enabled.
4391 #
4392 # Example of an error that is returned when attempting to create a Spanner
4393 # instance in a region that is out of stock:
4394 #
4395 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
4396 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
4397 # &quot;metadata&quot;: {
4398 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
4399 # }
4400 # }
4401 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
4402 # is typically the registered service name of the tool or product that
4403 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
4404 # generated by some common infrastructure, the error domain must be a
4405 # globally unique value that identifies the infrastructure. For Google API
4406 # infrastructure, the error domain is &quot;googleapis.com&quot;.
4407 &quot;metadatas&quot;: { # Additional structured details about this error.
4408 #
4409 # Keys must match a regular expression of `a-z+` but should
4410 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
4411 # length. When identifying the current value of an exceeded limit, the units
4412 # should be contained in the key, not the value. For example, rather than
4413 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
4414 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
4415 # instances that can be created in a single (batch) request.
4416 &quot;a_key&quot;: &quot;A String&quot;,
4417 },
4418 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
4419 # proximate cause of the error. Error reasons are unique within a particular
4420 # domain of errors. This should be at most 63 characters and match a
4421 # regular expression of `A-Z+[A-Z0-9]`, which represents
4422 # UPPER_SNAKE_CASE.
4423 },
4424 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
4425 #
4426 # For example, if a quota check failed with an error indicating the calling
4427 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
4428 # directly to the right place in the developer console to flip the bit.
4429 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
4430 { # Describes a URL link.
4431 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
4432 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
4433 },
4434 ],
4435 },
4436 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
4437 # which can be attached to an RPC error.
4438 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
4439 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
4440 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
4441 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
4442 },
4443 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
4444 &quot;dimensions&quot;: { # The map holding related quota dimensions.
4445 &quot;a_key&quot;: &quot;A String&quot;,
4446 },
4447 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
4448 # type or metric.
4449 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
4450 # or metric.
4451 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
4452 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
4453 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
4454 },
4455 },
4456 ],
4457 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
4458 # This property is optional.
4459 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
4460 },
4461 ],
4462 },
4463 &quot;getVersionOperationMetadata&quot;: {
4464 &quot;inlineSbomInfo&quot;: {
4465 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
4466 # appropriate identifiers.
4467 &quot;a_key&quot;: &quot;A String&quot;,
4468 },
4469 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
4470 # identifiers.
4471 &quot;a_key&quot;: &quot;A String&quot;,
4472 },
4473 },
4474 },
4475 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
4476 # message that was returned, such as `NOT FOUND`.
4477 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
4478 # status code that was returned. For example, a `404` means the
4479 # resource was not found.
4480 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
4481 # defined by the server.
4482 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
4483 # This value is inRFC3339
4484 # text format.
4485 &quot;instancesBulkInsertOperationMetadata&quot;: {
4486 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
4487 # Example key: zones/us-central1-a
4488 &quot;a_key&quot;: {
4489 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
4490 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
4491 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
4492 # error.
4493 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
4494 # if the flow is rolling forward or rolling back.
4495 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
4496 },
4497 },
4498 },
4499 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
4500 # Operation resources.
4501 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
4502 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
4503 # group of operations results from a `bulkInsert` API request.
4504 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
4505 # `update`, or `delete`, and so on.
4506 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
4507 # There is no requirement that this be linear or support any granularity of
4508 # operations. This should not be used to guess when the operation will be
4509 # complete. This number should monotonically increase as the operation
4510 # progresses.
4511 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
4512 # applicable when performing regional operations.
4513 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
4514 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
4515 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
4516 # this field will contain information on all underlying zonal actions and
4517 # their state.
4518 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
4519 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
4520 # Example key: zones/us-central1-a
4521 &quot;a_key&quot;: {
4522 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
4523 # populated.
4524 # different programming environments, including REST APIs and RPC APIs. It is
4525 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
4526 # three pieces of data: error code, error message, and error details.
4527 #
4528 # You can find out more about this error model and how to work with it in the
4529 # [API Design Guide](https://cloud.google.com/apis/design/errors).
4530 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
4531 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
4532 # message types for APIs to use.
4533 {
4534 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
4535 },
4536 ],
4537 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
4538 # user-facing error message should be localized and sent in the
4539 # google.rpc.Status.details field, or localized by the client.
4540 },
4541 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
4542 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
4543 },
4544 },
4545 },
4546 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
4547 # This value is inRFC3339
4548 # text format.
4549 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
4550 # following:
4551 # `PENDING`, `RUNNING`, or `DONE`.
4552 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
4553 # operation.
4554 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
4555 # of the target resource.
4556 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
4557 # operations related to creating a snapshot, this points to the disk
4558 # that the snapshot was created from.
4559 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
4560 # `[email protected]` or
4561 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
4562 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
4563 # operation, this field will be populated.
4564 {
4565 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
4566 # Engine returns NO_RESULTS_ON_PAGE if there
4567 # are no results in the response.
4568 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
4569 # value format. For example:
4570 #
4571 # &quot;data&quot;: [
4572 # {
4573 # &quot;key&quot;: &quot;scope&quot;,
4574 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
4575 # }
4576 {
4577 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
4578 # returned. For example, for warnings where there are no results in a list
4579 # request for a particular zone, this key might be scope and
4580 # the key value might be the zone name. Other examples might be a key
4581 # indicating a deprecated resource and a suggested replacement, or a
4582 # warning about invalid network settings (for example, if an instance
4583 # attempts to perform IP forwarding but is not enabled for IP forwarding).
4584 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
4585 },
4586 ],
4587 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
4588 },
4589 ],
4590 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
4591 # applicable when performing per-zone operations.
4592 }</pre>
4593 </div>
4594
4595 <div class="method">
4596 <code class="details" id="setIamPolicy">setIamPolicy(project, resource, body=None, x__xgafv=None)</code>
4597 <pre>Sets the access control policy on the specified resource.
4598 Replaces any existing policy.
4599
4600 Args:
4601 project: string, Project ID for this request. (required)
4602 resource: string, Name or id of the resource for this request. (required)
4603 body: object, The request body.
4604 The object takes the form of:
4605
4606 {
4607 &quot;bindings&quot;: [ # Flatten Policy to create a backward compatible wire-format.
4608 # Deprecated. Use &#x27;policy&#x27; to specify bindings.
4609 { # Associates `members`, or principals, with a `role`.
4610 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
4611 #
4612 # If the condition evaluates to `true`, then this binding applies to the
4613 # current request.
4614 #
4615 # If the condition evaluates to `false`, then this binding does not apply to
4616 # the current request. However, a different role binding might grant the same
4617 # role to one or more of the principals in this binding.
4618 #
4619 # To learn which resources support conditions in their IAM policies, see the
4620 # [IAM
4621 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
4622 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
4623 # are documented at https://github.com/google/cel-spec.
4624 #
4625 # Example (Comparison):
4626 #
4627 # title: &quot;Summary size limit&quot;
4628 # description: &quot;Determines if a summary is less than 100 chars&quot;
4629 # expression: &quot;document.summary.size() &lt; 100&quot;
4630 #
4631 # Example (Equality):
4632 #
4633 # title: &quot;Requestor is owner&quot;
4634 # description: &quot;Determines if requestor is the document owner&quot;
4635 # expression: &quot;document.owner == request.auth.claims.email&quot;
4636 #
4637 # Example (Logic):
4638 #
4639 # title: &quot;Public documents&quot;
4640 # description: &quot;Determine whether the document should be publicly visible&quot;
4641 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
4642 #
4643 # Example (Data Manipulation):
4644 #
4645 # title: &quot;Notification string&quot;
4646 # description: &quot;Create a notification string with a timestamp.&quot;
4647 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
4648 #
4649 # The exact variables and functions that may be referenced within an expression
4650 # are determined by the service that evaluates it. See the service
4651 # documentation for additional information.
4652 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
4653 # describes the expression, e.g. when hovered over it in a UI.
4654 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
4655 # syntax.
4656 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
4657 # reporting, e.g. a file name and a position in the file.
4658 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
4659 # its purpose. This can be used e.g. in UIs which allow to enter the
4660 # expression.
4661 },
4662 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
4663 # `members` can have the following values:
4664 #
4665 # * `allUsers`: A special identifier that represents anyone who is
4666 # on the internet; with or without a Google account.
4667 #
4668 # * `allAuthenticatedUsers`: A special identifier that represents anyone
4669 # who is authenticated with a Google account or a service account.
4670 # Does not include identities that come from external identity providers
4671 # (IdPs) through identity federation.
4672 #
4673 # * `user:{emailid}`: An email address that represents a specific Google
4674 # account. For example, `[email protected]` .
4675 #
4676 #
4677 # * `serviceAccount:{emailid}`: An email address that represents a Google
4678 # service account. For example,
4679 # `[email protected]`.
4680 #
4681 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
4682 # identifier for a
4683 # [Kubernetes service
4684 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
4685 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
4686 #
4687 # * `group:{emailid}`: An email address that represents a Google group.
4688 # For example, `[email protected]`.
4689 #
4690 #
4691 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
4692 # users of that domain. For example, `google.com` or `example.com`.
4693 #
4694 #
4695 #
4696 #
4697 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
4698 # A single identity in a workforce identity pool.
4699 #
4700 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
4701 # All workforce identities in a group.
4702 #
4703 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
4704 # All workforce identities with a specific attribute value.
4705 #
4706 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
4707 # All identities in a workforce identity pool.
4708 #
4709 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
4710 # A single identity in a workload identity pool.
4711 #
4712 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
4713 # A workload identity pool group.
4714 #
4715 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
4716 # All identities in a workload identity pool with a certain attribute.
4717 #
4718 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
4719 # All identities in a workload identity pool.
4720 #
4721 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
4722 # identifier) representing a user that has been recently deleted. For
4723 # example, `[email protected]?uid=123456789012345678901`. If the user is
4724 # recovered, this value reverts to `user:{emailid}` and the recovered user
4725 # retains the role in the binding.
4726 #
4727 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
4728 # unique identifier) representing a service account that has been recently
4729 # deleted. For example,
4730 # `[email protected]?uid=123456789012345678901`.
4731 # If the service account is undeleted, this value reverts to
4732 # `serviceAccount:{emailid}` and the undeleted service account retains the
4733 # role in the binding.
4734 #
4735 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
4736 # identifier) representing a Google group that has been recently
4737 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
4738 # the group is recovered, this value reverts to `group:{emailid}` and the
4739 # recovered group retains the role in the binding.
4740 #
4741 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
4742 # Deleted single identity in a workforce identity pool. For example,
4743 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
4744 &quot;A String&quot;,
4745 ],
4746 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
4747 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
4748 #
4749 # For an overview of the IAM roles and permissions, see the
4750 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
4751 # a list of the available pre-defined roles, see
4752 # [here](https://cloud.google.com/iam/docs/understanding-roles).
4753 },
4754 ],
4755 &quot;etag&quot;: &quot;A String&quot;, # Flatten Policy to create a backward compatible wire-format.
4756 # Deprecated. Use &#x27;policy&#x27; to specify the etag.
4757 &quot;policy&quot;: { # An Identity and Access Management (IAM) policy, which specifies access # REQUIRED: The complete policy to be applied to the &#x27;resource&#x27;. The size of
4758 # the policy is limited to a few 10s of KB. An empty policy is in general a
4759 # valid policy but certain services (like Projects) might reject them.
4760 # controls for Google Cloud resources.
4761 #
4762 #
4763 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
4764 # `members`, or principals, to a single `role`. Principals can be user
4765 # accounts, service accounts, Google groups, and domains (such as G Suite). A
4766 # `role` is a named list of permissions; each `role` can be an IAM predefined
4767 # role or a user-created custom role.
4768 #
4769 # For some types of Google Cloud resources, a `binding` can also specify a
4770 # `condition`, which is a logical expression that allows access to a resource
4771 # only if the expression evaluates to `true`. A condition can add constraints
4772 # based on attributes of the request, the resource, or both. To learn which
4773 # resources support conditions in their IAM policies, see the
4774 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
4775 #
4776 # **JSON example:**
4777 #
4778 # ```
4779 # {
4780 # &quot;bindings&quot;: [
4781 # {
4782 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
4783 # &quot;members&quot;: [
4784 # &quot;user:[email protected]&quot;,
4785 # &quot;group:[email protected]&quot;,
4786 # &quot;domain:google.com&quot;,
4787 # &quot;serviceAccount:[email protected]&quot;
4788 # ]
4789 # },
4790 # {
4791 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
4792 # &quot;members&quot;: [
4793 # &quot;user:[email protected]&quot;
4794 # ],
4795 # &quot;condition&quot;: {
4796 # &quot;title&quot;: &quot;expirable access&quot;,
4797 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
4798 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
4799 # }
4800 # }
4801 # ],
4802 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
4803 # &quot;version&quot;: 3
4804 # }
4805 # ```
4806 #
4807 # **YAML example:**
4808 #
4809 # ```
4810 # bindings:
4811 # - members:
4812 # - user:[email protected]
4813 # - group:[email protected]
4814 # - domain:google.com
4815 # - serviceAccount:[email protected]
4816 # role: roles/resourcemanager.organizationAdmin
4817 # - members:
4818 # - user:[email protected]
4819 # role: roles/resourcemanager.organizationViewer
4820 # condition:
4821 # title: expirable access
4822 # description: Does not grant access after Sep 2020
4823 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
4824 # etag: BwWWja0YfJA=
4825 # version: 3
4826 # ```
4827 #
4828 # For a description of IAM and its features, see the
4829 # [IAM documentation](https://cloud.google.com/iam/docs/).
4830 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
4831 { # Specifies the audit configuration for a service.
4832 # The configuration determines which permission types are logged, and what
4833 # identities, if any, are exempted from logging.
4834 # An AuditConfig must have one or more AuditLogConfigs.
4835 #
4836 # If there are AuditConfigs for both `allServices` and a specific service,
4837 # the union of the two AuditConfigs is used for that service: the log_types
4838 # specified in each AuditConfig are enabled, and the exempted_members in each
4839 # AuditLogConfig are exempted.
4840 #
4841 # Example Policy with multiple AuditConfigs:
4842 #
4843 # {
4844 # &quot;audit_configs&quot;: [
4845 # {
4846 # &quot;service&quot;: &quot;allServices&quot;,
4847 # &quot;audit_log_configs&quot;: [
4848 # {
4849 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
4850 # &quot;exempted_members&quot;: [
4851 # &quot;user:[email protected]&quot;
4852 # ]
4853 # },
4854 # {
4855 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
4856 # },
4857 # {
4858 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
4859 # }
4860 # ]
4861 # },
4862 # {
4863 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
4864 # &quot;audit_log_configs&quot;: [
4865 # {
4866 # &quot;log_type&quot;: &quot;DATA_READ&quot;
4867 # },
4868 # {
4869 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
4870 # &quot;exempted_members&quot;: [
4871 # &quot;user:[email protected]&quot;
4872 # ]
4873 # }
4874 # ]
4875 # }
4876 # ]
4877 # }
4878 #
4879 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
4880 # logging. It also exempts `[email protected]` from DATA_READ logging, and
4881 # `[email protected]` from DATA_WRITE logging.
4882 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
4883 { # Provides the configuration for logging a type of permissions.
4884 # Example:
4885 #
4886 # {
4887 # &quot;audit_log_configs&quot;: [
4888 # {
4889 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
4890 # &quot;exempted_members&quot;: [
4891 # &quot;user:[email protected]&quot;
4892 # ]
4893 # },
4894 # {
4895 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
4896 # }
4897 # ]
4898 # }
4899 #
4900 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
4901 # [email protected] from DATA_READ logging.
4902 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
4903 # permission.
4904 # Follows the same format of Binding.members.
4905 &quot;A String&quot;,
4906 ],
4907 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
4908 },
4909 ],
4910 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
4911 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
4912 # `allServices` is a special value that covers all services.
4913 },
4914 ],
4915 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
4916 # may specify a `condition` that determines how and when the `bindings` are
4917 # applied. Each of the `bindings` must contain at least one principal.
4918 #
4919 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
4920 # of these principals can be Google groups. Each occurrence of a principal
4921 # counts towards these limits. For example, if the `bindings` grant 50
4922 # different roles to `user:[email protected]`, and not to any other
4923 # principal, then you can add another 1,450 principals to the `bindings` in
4924 # the `Policy`.
4925 { # Associates `members`, or principals, with a `role`.
4926 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
4927 #
4928 # If the condition evaluates to `true`, then this binding applies to the
4929 # current request.
4930 #
4931 # If the condition evaluates to `false`, then this binding does not apply to
4932 # the current request. However, a different role binding might grant the same
4933 # role to one or more of the principals in this binding.
4934 #
4935 # To learn which resources support conditions in their IAM policies, see the
4936 # [IAM
4937 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
4938 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
4939 # are documented at https://github.com/google/cel-spec.
4940 #
4941 # Example (Comparison):
4942 #
4943 # title: &quot;Summary size limit&quot;
4944 # description: &quot;Determines if a summary is less than 100 chars&quot;
4945 # expression: &quot;document.summary.size() &lt; 100&quot;
4946 #
4947 # Example (Equality):
4948 #
4949 # title: &quot;Requestor is owner&quot;
4950 # description: &quot;Determines if requestor is the document owner&quot;
4951 # expression: &quot;document.owner == request.auth.claims.email&quot;
4952 #
4953 # Example (Logic):
4954 #
4955 # title: &quot;Public documents&quot;
4956 # description: &quot;Determine whether the document should be publicly visible&quot;
4957 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
4958 #
4959 # Example (Data Manipulation):
4960 #
4961 # title: &quot;Notification string&quot;
4962 # description: &quot;Create a notification string with a timestamp.&quot;
4963 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
4964 #
4965 # The exact variables and functions that may be referenced within an expression
4966 # are determined by the service that evaluates it. See the service
4967 # documentation for additional information.
4968 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
4969 # describes the expression, e.g. when hovered over it in a UI.
4970 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
4971 # syntax.
4972 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
4973 # reporting, e.g. a file name and a position in the file.
4974 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
4975 # its purpose. This can be used e.g. in UIs which allow to enter the
4976 # expression.
4977 },
4978 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
4979 # `members` can have the following values:
4980 #
4981 # * `allUsers`: A special identifier that represents anyone who is
4982 # on the internet; with or without a Google account.
4983 #
4984 # * `allAuthenticatedUsers`: A special identifier that represents anyone
4985 # who is authenticated with a Google account or a service account.
4986 # Does not include identities that come from external identity providers
4987 # (IdPs) through identity federation.
4988 #
4989 # * `user:{emailid}`: An email address that represents a specific Google
4990 # account. For example, `[email protected]` .
4991 #
4992 #
4993 # * `serviceAccount:{emailid}`: An email address that represents a Google
4994 # service account. For example,
4995 # `[email protected]`.
4996 #
4997 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
4998 # identifier for a
4999 # [Kubernetes service
5000 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
5001 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
5002 #
5003 # * `group:{emailid}`: An email address that represents a Google group.
5004 # For example, `[email protected]`.
5005 #
5006 #
5007 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
5008 # users of that domain. For example, `google.com` or `example.com`.
5009 #
5010 #
5011 #
5012 #
5013 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
5014 # A single identity in a workforce identity pool.
5015 #
5016 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
5017 # All workforce identities in a group.
5018 #
5019 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
5020 # All workforce identities with a specific attribute value.
5021 #
5022 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
5023 # All identities in a workforce identity pool.
5024 #
5025 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
5026 # A single identity in a workload identity pool.
5027 #
5028 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
5029 # A workload identity pool group.
5030 #
5031 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
5032 # All identities in a workload identity pool with a certain attribute.
5033 #
5034 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
5035 # All identities in a workload identity pool.
5036 #
5037 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
5038 # identifier) representing a user that has been recently deleted. For
5039 # example, `[email protected]?uid=123456789012345678901`. If the user is
5040 # recovered, this value reverts to `user:{emailid}` and the recovered user
5041 # retains the role in the binding.
5042 #
5043 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
5044 # unique identifier) representing a service account that has been recently
5045 # deleted. For example,
5046 # `[email protected]?uid=123456789012345678901`.
5047 # If the service account is undeleted, this value reverts to
5048 # `serviceAccount:{emailid}` and the undeleted service account retains the
5049 # role in the binding.
5050 #
5051 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
5052 # identifier) representing a Google group that has been recently
5053 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
5054 # the group is recovered, this value reverts to `group:{emailid}` and the
5055 # recovered group retains the role in the binding.
5056 #
5057 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
5058 # Deleted single identity in a workforce identity pool. For example,
5059 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
5060 &quot;A String&quot;,
5061 ],
5062 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
5063 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
5064 #
5065 # For an overview of the IAM roles and permissions, see the
5066 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
5067 # a list of the available pre-defined roles, see
5068 # [here](https://cloud.google.com/iam/docs/understanding-roles).
5069 },
5070 ],
5071 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
5072 # prevent simultaneous updates of a policy from overwriting each other.
5073 # It is strongly suggested that systems make use of the `etag` in the
5074 # read-modify-write cycle to perform policy updates in order to avoid race
5075 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
5076 # systems are expected to put that etag in the request to `setIamPolicy` to
5077 # ensure that their change will be applied to the same version of the policy.
5078 #
5079 # **Important:** If you use IAM Conditions, you must include the `etag` field
5080 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
5081 # you to overwrite a version `3` policy with a version `1` policy, and all of
5082 # the conditions in the version `3` policy are lost.
5083 &quot;version&quot;: 42, # Specifies the format of the policy.
5084 #
5085 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
5086 # are rejected.
5087 #
5088 # Any operation that affects conditional role bindings must specify version
5089 # `3`. This requirement applies to the following operations:
5090 #
5091 # * Getting a policy that includes a conditional role binding
5092 # * Adding a conditional role binding to a policy
5093 # * Changing a conditional role binding in a policy
5094 # * Removing any role binding, with or without a condition, from a policy
5095 # that includes conditions
5096 #
5097 # **Important:** If you use IAM Conditions, you must include the `etag` field
5098 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
5099 # you to overwrite a version `3` policy with a version `1` policy, and all of
5100 # the conditions in the version `3` policy are lost.
5101 #
5102 # If a policy does not include any conditions, operations on that policy may
5103 # specify any valid version or leave the field unset.
5104 #
5105 # To learn which resources support conditions in their IAM policies, see the
5106 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
5107 },
5108 }
5109
5110 x__xgafv: string, V1 error format.
5111 Allowed values
5112 1 - v1 error format
5113 2 - v2 error format
5114
5115 Returns:
5116 An object of the form:
5117
5118 { # An Identity and Access Management (IAM) policy, which specifies access
5119 # controls for Google Cloud resources.
5120 #
5121 #
5122 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
5123 # `members`, or principals, to a single `role`. Principals can be user
5124 # accounts, service accounts, Google groups, and domains (such as G Suite). A
5125 # `role` is a named list of permissions; each `role` can be an IAM predefined
5126 # role or a user-created custom role.
5127 #
5128 # For some types of Google Cloud resources, a `binding` can also specify a
5129 # `condition`, which is a logical expression that allows access to a resource
5130 # only if the expression evaluates to `true`. A condition can add constraints
5131 # based on attributes of the request, the resource, or both. To learn which
5132 # resources support conditions in their IAM policies, see the
5133 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
5134 #
5135 # **JSON example:**
5136 #
5137 # ```
5138 # {
5139 # &quot;bindings&quot;: [
5140 # {
5141 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
5142 # &quot;members&quot;: [
5143 # &quot;user:[email protected]&quot;,
5144 # &quot;group:[email protected]&quot;,
5145 # &quot;domain:google.com&quot;,
5146 # &quot;serviceAccount:[email protected]&quot;
5147 # ]
5148 # },
5149 # {
5150 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
5151 # &quot;members&quot;: [
5152 # &quot;user:[email protected]&quot;
5153 # ],
5154 # &quot;condition&quot;: {
5155 # &quot;title&quot;: &quot;expirable access&quot;,
5156 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
5157 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
5158 # }
5159 # }
5160 # ],
5161 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
5162 # &quot;version&quot;: 3
5163 # }
5164 # ```
5165 #
5166 # **YAML example:**
5167 #
5168 # ```
5169 # bindings:
5170 # - members:
5171 # - user:[email protected]
5172 # - group:[email protected]
5173 # - domain:google.com
5174 # - serviceAccount:[email protected]
5175 # role: roles/resourcemanager.organizationAdmin
5176 # - members:
5177 # - user:[email protected]
5178 # role: roles/resourcemanager.organizationViewer
5179 # condition:
5180 # title: expirable access
5181 # description: Does not grant access after Sep 2020
5182 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
5183 # etag: BwWWja0YfJA=
5184 # version: 3
5185 # ```
5186 #
5187 # For a description of IAM and its features, see the
5188 # [IAM documentation](https://cloud.google.com/iam/docs/).
5189 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
5190 { # Specifies the audit configuration for a service.
5191 # The configuration determines which permission types are logged, and what
5192 # identities, if any, are exempted from logging.
5193 # An AuditConfig must have one or more AuditLogConfigs.
5194 #
5195 # If there are AuditConfigs for both `allServices` and a specific service,
5196 # the union of the two AuditConfigs is used for that service: the log_types
5197 # specified in each AuditConfig are enabled, and the exempted_members in each
5198 # AuditLogConfig are exempted.
5199 #
5200 # Example Policy with multiple AuditConfigs:
5201 #
5202 # {
5203 # &quot;audit_configs&quot;: [
5204 # {
5205 # &quot;service&quot;: &quot;allServices&quot;,
5206 # &quot;audit_log_configs&quot;: [
5207 # {
5208 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
5209 # &quot;exempted_members&quot;: [
5210 # &quot;user:[email protected]&quot;
5211 # ]
5212 # },
5213 # {
5214 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
5215 # },
5216 # {
5217 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
5218 # }
5219 # ]
5220 # },
5221 # {
5222 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
5223 # &quot;audit_log_configs&quot;: [
5224 # {
5225 # &quot;log_type&quot;: &quot;DATA_READ&quot;
5226 # },
5227 # {
5228 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
5229 # &quot;exempted_members&quot;: [
5230 # &quot;user:[email protected]&quot;
5231 # ]
5232 # }
5233 # ]
5234 # }
5235 # ]
5236 # }
5237 #
5238 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
5239 # logging. It also exempts `[email protected]` from DATA_READ logging, and
5240 # `[email protected]` from DATA_WRITE logging.
5241 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
5242 { # Provides the configuration for logging a type of permissions.
5243 # Example:
5244 #
5245 # {
5246 # &quot;audit_log_configs&quot;: [
5247 # {
5248 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
5249 # &quot;exempted_members&quot;: [
5250 # &quot;user:[email protected]&quot;
5251 # ]
5252 # },
5253 # {
5254 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
5255 # }
5256 # ]
5257 # }
5258 #
5259 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
5260 # [email protected] from DATA_READ logging.
5261 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
5262 # permission.
5263 # Follows the same format of Binding.members.
5264 &quot;A String&quot;,
5265 ],
5266 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
5267 },
5268 ],
5269 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
5270 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
5271 # `allServices` is a special value that covers all services.
5272 },
5273 ],
5274 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
5275 # may specify a `condition` that determines how and when the `bindings` are
5276 # applied. Each of the `bindings` must contain at least one principal.
5277 #
5278 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
5279 # of these principals can be Google groups. Each occurrence of a principal
5280 # counts towards these limits. For example, if the `bindings` grant 50
5281 # different roles to `user:[email protected]`, and not to any other
5282 # principal, then you can add another 1,450 principals to the `bindings` in
5283 # the `Policy`.
5284 { # Associates `members`, or principals, with a `role`.
5285 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
5286 #
5287 # If the condition evaluates to `true`, then this binding applies to the
5288 # current request.
5289 #
5290 # If the condition evaluates to `false`, then this binding does not apply to
5291 # the current request. However, a different role binding might grant the same
5292 # role to one or more of the principals in this binding.
5293 #
5294 # To learn which resources support conditions in their IAM policies, see the
5295 # [IAM
5296 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
5297 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
5298 # are documented at https://github.com/google/cel-spec.
5299 #
5300 # Example (Comparison):
5301 #
5302 # title: &quot;Summary size limit&quot;
5303 # description: &quot;Determines if a summary is less than 100 chars&quot;
5304 # expression: &quot;document.summary.size() &lt; 100&quot;
5305 #
5306 # Example (Equality):
5307 #
5308 # title: &quot;Requestor is owner&quot;
5309 # description: &quot;Determines if requestor is the document owner&quot;
5310 # expression: &quot;document.owner == request.auth.claims.email&quot;
5311 #
5312 # Example (Logic):
5313 #
5314 # title: &quot;Public documents&quot;
5315 # description: &quot;Determine whether the document should be publicly visible&quot;
5316 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
5317 #
5318 # Example (Data Manipulation):
5319 #
5320 # title: &quot;Notification string&quot;
5321 # description: &quot;Create a notification string with a timestamp.&quot;
5322 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
5323 #
5324 # The exact variables and functions that may be referenced within an expression
5325 # are determined by the service that evaluates it. See the service
5326 # documentation for additional information.
5327 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
5328 # describes the expression, e.g. when hovered over it in a UI.
5329 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
5330 # syntax.
5331 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
5332 # reporting, e.g. a file name and a position in the file.
5333 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
5334 # its purpose. This can be used e.g. in UIs which allow to enter the
5335 # expression.
5336 },
5337 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
5338 # `members` can have the following values:
5339 #
5340 # * `allUsers`: A special identifier that represents anyone who is
5341 # on the internet; with or without a Google account.
5342 #
5343 # * `allAuthenticatedUsers`: A special identifier that represents anyone
5344 # who is authenticated with a Google account or a service account.
5345 # Does not include identities that come from external identity providers
5346 # (IdPs) through identity federation.
5347 #
5348 # * `user:{emailid}`: An email address that represents a specific Google
5349 # account. For example, `[email protected]` .
5350 #
5351 #
5352 # * `serviceAccount:{emailid}`: An email address that represents a Google
5353 # service account. For example,
5354 # `[email protected]`.
5355 #
5356 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
5357 # identifier for a
5358 # [Kubernetes service
5359 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
5360 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
5361 #
5362 # * `group:{emailid}`: An email address that represents a Google group.
5363 # For example, `[email protected]`.
5364 #
5365 #
5366 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
5367 # users of that domain. For example, `google.com` or `example.com`.
5368 #
5369 #
5370 #
5371 #
5372 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
5373 # A single identity in a workforce identity pool.
5374 #
5375 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
5376 # All workforce identities in a group.
5377 #
5378 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
5379 # All workforce identities with a specific attribute value.
5380 #
5381 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
5382 # All identities in a workforce identity pool.
5383 #
5384 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
5385 # A single identity in a workload identity pool.
5386 #
5387 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
5388 # A workload identity pool group.
5389 #
5390 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
5391 # All identities in a workload identity pool with a certain attribute.
5392 #
5393 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
5394 # All identities in a workload identity pool.
5395 #
5396 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
5397 # identifier) representing a user that has been recently deleted. For
5398 # example, `[email protected]?uid=123456789012345678901`. If the user is
5399 # recovered, this value reverts to `user:{emailid}` and the recovered user
5400 # retains the role in the binding.
5401 #
5402 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
5403 # unique identifier) representing a service account that has been recently
5404 # deleted. For example,
5405 # `[email protected]?uid=123456789012345678901`.
5406 # If the service account is undeleted, this value reverts to
5407 # `serviceAccount:{emailid}` and the undeleted service account retains the
5408 # role in the binding.
5409 #
5410 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
5411 # identifier) representing a Google group that has been recently
5412 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
5413 # the group is recovered, this value reverts to `group:{emailid}` and the
5414 # recovered group retains the role in the binding.
5415 #
5416 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
5417 # Deleted single identity in a workforce identity pool. For example,
5418 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
5419 &quot;A String&quot;,
5420 ],
5421 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
5422 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
5423 #
5424 # For an overview of the IAM roles and permissions, see the
5425 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
5426 # a list of the available pre-defined roles, see
5427 # [here](https://cloud.google.com/iam/docs/understanding-roles).
5428 },
5429 ],
5430 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
5431 # prevent simultaneous updates of a policy from overwriting each other.
5432 # It is strongly suggested that systems make use of the `etag` in the
5433 # read-modify-write cycle to perform policy updates in order to avoid race
5434 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
5435 # systems are expected to put that etag in the request to `setIamPolicy` to
5436 # ensure that their change will be applied to the same version of the policy.
5437 #
5438 # **Important:** If you use IAM Conditions, you must include the `etag` field
5439 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
5440 # you to overwrite a version `3` policy with a version `1` policy, and all of
5441 # the conditions in the version `3` policy are lost.
5442 &quot;version&quot;: 42, # Specifies the format of the policy.
5443 #
5444 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
5445 # are rejected.
5446 #
5447 # Any operation that affects conditional role bindings must specify version
5448 # `3`. This requirement applies to the following operations:
5449 #
5450 # * Getting a policy that includes a conditional role binding
5451 # * Adding a conditional role binding to a policy
5452 # * Changing a conditional role binding in a policy
5453 # * Removing any role binding, with or without a condition, from a policy
5454 # that includes conditions
5455 #
5456 # **Important:** If you use IAM Conditions, you must include the `etag` field
5457 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
5458 # you to overwrite a version `3` policy with a version `1` policy, and all of
5459 # the conditions in the version `3` policy are lost.
5460 #
5461 # If a policy does not include any conditions, operations on that policy may
5462 # specify any valid version or leave the field unset.
5463 #
5464 # To learn which resources support conditions in their IAM policies, see the
5465 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
5466 }</pre>
5467 </div>
5468
5469 <div class="method">
5470 <code class="details" id="setLabels">setLabels(project, resource, body=None, x__xgafv=None)</code>
5471 <pre>Sets the labels on an image. To learn more about labels, read theLabeling
5472 Resources documentation.
5473
5474 Args:
5475 project: string, Project ID for this request. (required)
5476 resource: string, Name or id of the resource for this request. (required)
5477 body: object, The request body.
5478 The object takes the form of:
5479
5480 {
5481 &quot;labelFingerprint&quot;: &quot;A String&quot;, # The fingerprint of the previous set of labels for this resource,
5482 # used to detect conflicts. The fingerprint is initially generated by Compute
5483 # Engine and changes after every request to modify or update labels. You must
5484 # always provide an up-to-date fingerprint hash when updating or changing
5485 # labels, otherwise the request will fail with error412 conditionNotMet. Make a get() request to the
5486 # resource to get the latest fingerprint.
5487 &quot;labels&quot;: { # A list of labels to apply for this resource. Each label must comply with
5488 # the
5489 # requirements for labels. For example,&quot;webserver-frontend&quot;: &quot;images&quot;. A label value can also be
5490 # empty (e.g. &quot;my-label&quot;: &quot;&quot;).
5491 &quot;a_key&quot;: &quot;A String&quot;,
5492 },
5493 }
5494
5495 x__xgafv: string, V1 error format.
5496 Allowed values
5497 1 - v1 error format
5498 2 - v2 error format
5499
5500 Returns:
5501 An object of the form:
5502
5503 { # Represents an Operation resource.
5504 #
5505 # Google Compute Engine has three Operation resources:
5506 #
5507 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
5508 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
5509 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
5510 #
5511 # You can use an operation resource to manage asynchronous API requests.
5512 # For more information, readHandling
5513 # API responses.
5514 #
5515 # Operations can be global, regional or zonal.
5516 #
5517 # - For global operations, use the `globalOperations`
5518 # resource.
5519 # - For regional operations, use the
5520 # `regionOperations` resource.
5521 # - For zonal operations, use
5522 # the `zoneOperations` resource.
5523 #
5524 #
5525 #
5526 # For more information, read
5527 # Global, Regional, and Zonal Resources.
5528 #
5529 # Note that completed Operation resources have a limited
5530 # retention period.
5531 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
5532 # Not present otherwise.
5533 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
5534 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
5535 # set when the operation is created.
5536 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
5537 # text format.
5538 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
5539 # this field will be populated.
5540 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
5541 # operation.
5542 {
5543 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
5544 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
5545 # details. There is a set of defined message types to use for providing
5546 # details.The syntax depends on the error code. For example,
5547 # QuotaExceededInfo will have details when the error code is
5548 # QUOTA_EXCEEDED.
5549 {
5550 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
5551 #
5552 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
5553 # is not enabled:
5554 #
5555 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
5556 # &quot;domain&quot;: &quot;googleapis.com&quot;
5557 # &quot;metadata&quot;: {
5558 # &quot;resource&quot;: &quot;projects/123&quot;,
5559 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
5560 # }
5561 # }
5562 #
5563 # This response indicates that the pubsub.googleapis.com API is not enabled.
5564 #
5565 # Example of an error that is returned when attempting to create a Spanner
5566 # instance in a region that is out of stock:
5567 #
5568 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
5569 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
5570 # &quot;metadata&quot;: {
5571 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
5572 # }
5573 # }
5574 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
5575 # is typically the registered service name of the tool or product that
5576 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
5577 # generated by some common infrastructure, the error domain must be a
5578 # globally unique value that identifies the infrastructure. For Google API
5579 # infrastructure, the error domain is &quot;googleapis.com&quot;.
5580 &quot;metadatas&quot;: { # Additional structured details about this error.
5581 #
5582 # Keys must match a regular expression of `a-z+` but should
5583 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
5584 # length. When identifying the current value of an exceeded limit, the units
5585 # should be contained in the key, not the value. For example, rather than
5586 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
5587 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
5588 # instances that can be created in a single (batch) request.
5589 &quot;a_key&quot;: &quot;A String&quot;,
5590 },
5591 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
5592 # proximate cause of the error. Error reasons are unique within a particular
5593 # domain of errors. This should be at most 63 characters and match a
5594 # regular expression of `A-Z+[A-Z0-9]`, which represents
5595 # UPPER_SNAKE_CASE.
5596 },
5597 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
5598 #
5599 # For example, if a quota check failed with an error indicating the calling
5600 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
5601 # directly to the right place in the developer console to flip the bit.
5602 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
5603 { # Describes a URL link.
5604 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
5605 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
5606 },
5607 ],
5608 },
5609 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
5610 # which can be attached to an RPC error.
5611 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
5612 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
5613 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
5614 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
5615 },
5616 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
5617 &quot;dimensions&quot;: { # The map holding related quota dimensions.
5618 &quot;a_key&quot;: &quot;A String&quot;,
5619 },
5620 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
5621 # type or metric.
5622 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
5623 # or metric.
5624 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
5625 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
5626 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
5627 },
5628 },
5629 ],
5630 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
5631 # This property is optional.
5632 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
5633 },
5634 ],
5635 },
5636 &quot;getVersionOperationMetadata&quot;: {
5637 &quot;inlineSbomInfo&quot;: {
5638 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
5639 # appropriate identifiers.
5640 &quot;a_key&quot;: &quot;A String&quot;,
5641 },
5642 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
5643 # identifiers.
5644 &quot;a_key&quot;: &quot;A String&quot;,
5645 },
5646 },
5647 },
5648 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
5649 # message that was returned, such as `NOT FOUND`.
5650 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
5651 # status code that was returned. For example, a `404` means the
5652 # resource was not found.
5653 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
5654 # defined by the server.
5655 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
5656 # This value is inRFC3339
5657 # text format.
5658 &quot;instancesBulkInsertOperationMetadata&quot;: {
5659 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
5660 # Example key: zones/us-central1-a
5661 &quot;a_key&quot;: {
5662 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
5663 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
5664 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
5665 # error.
5666 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
5667 # if the flow is rolling forward or rolling back.
5668 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
5669 },
5670 },
5671 },
5672 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
5673 # Operation resources.
5674 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
5675 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
5676 # group of operations results from a `bulkInsert` API request.
5677 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
5678 # `update`, or `delete`, and so on.
5679 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
5680 # There is no requirement that this be linear or support any granularity of
5681 # operations. This should not be used to guess when the operation will be
5682 # complete. This number should monotonically increase as the operation
5683 # progresses.
5684 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
5685 # applicable when performing regional operations.
5686 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
5687 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
5688 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
5689 # this field will contain information on all underlying zonal actions and
5690 # their state.
5691 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
5692 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
5693 # Example key: zones/us-central1-a
5694 &quot;a_key&quot;: {
5695 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
5696 # populated.
5697 # different programming environments, including REST APIs and RPC APIs. It is
5698 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
5699 # three pieces of data: error code, error message, and error details.
5700 #
5701 # You can find out more about this error model and how to work with it in the
5702 # [API Design Guide](https://cloud.google.com/apis/design/errors).
5703 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
5704 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
5705 # message types for APIs to use.
5706 {
5707 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
5708 },
5709 ],
5710 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
5711 # user-facing error message should be localized and sent in the
5712 # google.rpc.Status.details field, or localized by the client.
5713 },
5714 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
5715 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
5716 },
5717 },
5718 },
5719 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
5720 # This value is inRFC3339
5721 # text format.
5722 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
5723 # following:
5724 # `PENDING`, `RUNNING`, or `DONE`.
5725 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
5726 # operation.
5727 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
5728 # of the target resource.
5729 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
5730 # operations related to creating a snapshot, this points to the disk
5731 # that the snapshot was created from.
5732 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
5733 # `[email protected]` or
5734 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
5735 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
5736 # operation, this field will be populated.
5737 {
5738 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
5739 # Engine returns NO_RESULTS_ON_PAGE if there
5740 # are no results in the response.
5741 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
5742 # value format. For example:
5743 #
5744 # &quot;data&quot;: [
5745 # {
5746 # &quot;key&quot;: &quot;scope&quot;,
5747 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
5748 # }
5749 {
5750 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
5751 # returned. For example, for warnings where there are no results in a list
5752 # request for a particular zone, this key might be scope and
5753 # the key value might be the zone name. Other examples might be a key
5754 # indicating a deprecated resource and a suggested replacement, or a
5755 # warning about invalid network settings (for example, if an instance
5756 # attempts to perform IP forwarding but is not enabled for IP forwarding).
5757 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
5758 },
5759 ],
5760 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
5761 },
5762 ],
5763 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
5764 # applicable when performing per-zone operations.
5765 }</pre>
5766 </div>
5767
5768 <div class="method">
5769 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</code>
5770 <pre>Returns permissions that a caller has on the specified resource.
5771
5772 Args:
5773 project: string, Project ID for this request. (required)
5774 resource: string, Name or id of the resource for this request. (required)
5775 body: object, The request body.
5776 The object takes the form of:
5777
5778 {
5779 &quot;permissions&quot;: [ # The set of permissions to check for the &#x27;resource&#x27;. Permissions with
5780 # wildcards (such as &#x27;*&#x27; or &#x27;storage.*&#x27;) are not allowed.
5781 &quot;A String&quot;,
5782 ],
5783 }
5784
5785 x__xgafv: string, V1 error format.
5786 Allowed values
5787 1 - v1 error format
5788 2 - v2 error format
5789
5790 Returns:
5791 An object of the form:
5792
5793 {
5794 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is
5795 # allowed.
5796 &quot;A String&quot;,
5797 ],
5798 }</pre>
5799 </div>
5800
5801 </body></html>