Debian Codegraph @

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