Debian Codegraph @

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