Debian Codegraph @

docs/dyn/compute_v1.snapshots.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.snapshots.html">snapshots</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, snapshot, requestId=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Deletes the specified Snapshot resource. Keep in mind that deleting</p>
83 <p class="toc_element">
84 <code><a href="#get">get(project, snapshot, x__xgafv=None)</a></code></p>
85 <p class="firstline">Returns the specified Snapshot resource.</p>
86 <p class="toc_element">
87 <code><a href="#getIamPolicy">getIamPolicy(project, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Gets the access control policy for a resource. May be empty if no such</p>
89 <p class="toc_element">
90 <code><a href="#insert">insert(project, body=None, requestId=None, x__xgafv=None)</a></code></p>
91 <p class="firstline">Creates a snapshot in the specified project using the data included</p>
92 <p class="toc_element">
93 <code><a href="#list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
94 <p class="firstline">Retrieves the list of Snapshot resources contained within</p>
95 <p class="toc_element">
96 <code><a href="#list_next">list_next()</a></code></p>
97 <p class="firstline">Retrieves the next page of results.</p>
98 <p class="toc_element">
99 <code><a href="#setIamPolicy">setIamPolicy(project, resource, body=None, x__xgafv=None)</a></code></p>
100 <p class="firstline">Sets the access control policy on the specified resource.</p>
101 <p class="toc_element">
102 <code><a href="#setLabels">setLabels(project, resource, body=None, x__xgafv=None)</a></code></p>
103 <p class="firstline">Sets the labels on a snapshot. To learn more about labels, read theLabeling</p>
104 <p class="toc_element">
105 <code><a href="#testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</a></code></p>
106 <p class="firstline">Returns permissions that a caller has on the specified resource.</p>
107 <p class="toc_element">
108 <code><a href="#updateKmsKey">updateKmsKey(project, snapshot, body=None, requestId=None, x__xgafv=None)</a></code></p>
109 <p class="firstline">Rotates the customer-managed</p>
110 <h3>Method Details</h3>
111 <div class="method">
112 <code class="details" id="close">close()</code>
113 <pre>Close httplib2 connections.</pre>
114 </div>
115
116 <div class="method">
117 <code class="details" id="delete">delete(project, snapshot, requestId=None, x__xgafv=None)</code>
118 <pre>Deletes the specified Snapshot resource. Keep in mind that deleting
119 a single snapshot might not necessarily delete all the data on that
120 snapshot. If any data on the snapshot that is marked for deletion is
121 needed for subsequent snapshots, the data will be moved to the next
122 corresponding snapshot.
123
124 For more information, seeDeleting
125 snapshots.
126
127 Args:
128 project: string, Project ID for this request. (required)
129 snapshot: string, Name of the Snapshot resource to delete. (required)
130 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
131 that if you must retry your request, the server will know to ignore the
132 request if it has already been completed.
133
134 For example, consider a situation where you make an initial request and
135 the request times out. If you make the request again with the same
136 request ID, the server can check if original operation with the same
137 request ID was received, and if so, will ignore the second request. This
138 prevents clients from accidentally creating duplicate commitments.
139
140 The request ID must be
141 a valid UUID with the exception that zero UUID is not supported
142 (00000000-0000-0000-0000-000000000000).
143 x__xgafv: string, V1 error format.
144 Allowed values
145 1 - v1 error format
146 2 - v2 error format
147
148 Returns:
149 An object of the form:
150
151 { # Represents an Operation resource.
152 #
153 # Google Compute Engine has three Operation resources:
154 #
155 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
156 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
157 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
158 #
159 # You can use an operation resource to manage asynchronous API requests.
160 # For more information, readHandling
161 # API responses.
162 #
163 # Operations can be global, regional or zonal.
164 #
165 # - For global operations, use the `globalOperations`
166 # resource.
167 # - For regional operations, use the
168 # `regionOperations` resource.
169 # - For zonal operations, use
170 # the `zoneOperations` resource.
171 #
172 #
173 #
174 # For more information, read
175 # Global, Regional, and Zonal Resources.
176 #
177 # Note that completed Operation resources have a limited
178 # retention period.
179 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
180 # Not present otherwise.
181 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
182 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
183 # set when the operation is created.
184 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
185 # text format.
186 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
187 # this field will be populated.
188 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
189 # operation.
190 {
191 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
192 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
193 # details. There is a set of defined message types to use for providing
194 # details.The syntax depends on the error code. For example,
195 # QuotaExceededInfo will have details when the error code is
196 # QUOTA_EXCEEDED.
197 {
198 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
199 #
200 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
201 # is not enabled:
202 #
203 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
204 # &quot;domain&quot;: &quot;googleapis.com&quot;
205 # &quot;metadata&quot;: {
206 # &quot;resource&quot;: &quot;projects/123&quot;,
207 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
208 # }
209 # }
210 #
211 # This response indicates that the pubsub.googleapis.com API is not enabled.
212 #
213 # Example of an error that is returned when attempting to create a Spanner
214 # instance in a region that is out of stock:
215 #
216 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
217 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
218 # &quot;metadata&quot;: {
219 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
220 # }
221 # }
222 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
223 # is typically the registered service name of the tool or product that
224 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
225 # generated by some common infrastructure, the error domain must be a
226 # globally unique value that identifies the infrastructure. For Google API
227 # infrastructure, the error domain is &quot;googleapis.com&quot;.
228 &quot;metadatas&quot;: { # Additional structured details about this error.
229 #
230 # Keys must match a regular expression of `a-z+` but should
231 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
232 # length. When identifying the current value of an exceeded limit, the units
233 # should be contained in the key, not the value. For example, rather than
234 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
235 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
236 # instances that can be created in a single (batch) request.
237 &quot;a_key&quot;: &quot;A String&quot;,
238 },
239 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
240 # proximate cause of the error. Error reasons are unique within a particular
241 # domain of errors. This should be at most 63 characters and match a
242 # regular expression of `A-Z+[A-Z0-9]`, which represents
243 # UPPER_SNAKE_CASE.
244 },
245 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
246 #
247 # For example, if a quota check failed with an error indicating the calling
248 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
249 # directly to the right place in the developer console to flip the bit.
250 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
251 { # Describes a URL link.
252 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
253 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
254 },
255 ],
256 },
257 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
258 # which can be attached to an RPC error.
259 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
260 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
261 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
262 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
263 },
264 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
265 &quot;dimensions&quot;: { # The map holding related quota dimensions.
266 &quot;a_key&quot;: &quot;A String&quot;,
267 },
268 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
269 # type or metric.
270 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
271 # or metric.
272 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
273 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
274 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
275 },
276 },
277 ],
278 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
279 # This property is optional.
280 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
281 },
282 ],
283 },
284 &quot;getVersionOperationMetadata&quot;: {
285 &quot;inlineSbomInfo&quot;: {
286 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
287 # appropriate identifiers.
288 &quot;a_key&quot;: &quot;A String&quot;,
289 },
290 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
291 # identifiers.
292 &quot;a_key&quot;: &quot;A String&quot;,
293 },
294 },
295 },
296 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
297 # message that was returned, such as `NOT FOUND`.
298 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
299 # status code that was returned. For example, a `404` means the
300 # resource was not found.
301 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
302 # defined by the server.
303 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
304 # This value is inRFC3339
305 # text format.
306 &quot;instancesBulkInsertOperationMetadata&quot;: {
307 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
308 # Example key: zones/us-central1-a
309 &quot;a_key&quot;: {
310 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
311 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
312 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
313 # error.
314 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
315 # if the flow is rolling forward or rolling back.
316 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
317 },
318 },
319 },
320 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
321 # Operation resources.
322 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
323 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
324 # group of operations results from a `bulkInsert` API request.
325 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
326 # `update`, or `delete`, and so on.
327 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
328 # There is no requirement that this be linear or support any granularity of
329 # operations. This should not be used to guess when the operation will be
330 # complete. This number should monotonically increase as the operation
331 # progresses.
332 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
333 # applicable when performing regional operations.
334 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
335 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
336 # this field will contain information on all underlying zonal actions and
337 # their state.
338 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
339 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
340 # Example key: zones/us-central1-a
341 &quot;a_key&quot;: {
342 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
343 # populated.
344 # different programming environments, including REST APIs and RPC APIs. It is
345 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
346 # three pieces of data: error code, error message, and error details.
347 #
348 # You can find out more about this error model and how to work with it in the
349 # [API Design Guide](https://cloud.google.com/apis/design/errors).
350 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
351 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
352 # message types for APIs to use.
353 {
354 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
355 },
356 ],
357 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
358 # user-facing error message should be localized and sent in the
359 # google.rpc.Status.details field, or localized by the client.
360 },
361 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
362 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
363 },
364 },
365 },
366 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
367 # This value is inRFC3339
368 # text format.
369 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
370 # following:
371 # `PENDING`, `RUNNING`, or `DONE`.
372 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
373 # operation.
374 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
375 # of the target resource.
376 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
377 # operations related to creating a snapshot, this points to the disk
378 # that the snapshot was created from.
379 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
380 # `[email protected]` or
381 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
382 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
383 # operation, this field will be populated.
384 {
385 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
386 # Engine returns NO_RESULTS_ON_PAGE if there
387 # are no results in the response.
388 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
389 # value format. For example:
390 #
391 # &quot;data&quot;: [
392 # {
393 # &quot;key&quot;: &quot;scope&quot;,
394 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
395 # }
396 {
397 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
398 # returned. For example, for warnings where there are no results in a list
399 # request for a particular zone, this key might be scope and
400 # the key value might be the zone name. Other examples might be a key
401 # indicating a deprecated resource and a suggested replacement, or a
402 # warning about invalid network settings (for example, if an instance
403 # attempts to perform IP forwarding but is not enabled for IP forwarding).
404 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
405 },
406 ],
407 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
408 },
409 ],
410 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
411 # applicable when performing per-zone operations.
412 }</pre>
413 </div>
414
415 <div class="method">
416 <code class="details" id="get">get(project, snapshot, x__xgafv=None)</code>
417 <pre>Returns the specified Snapshot resource.
418
419 Args:
420 project: string, Project ID for this request. (required)
421 snapshot: string, Name of the Snapshot resource to return. (required)
422 x__xgafv: string, V1 error format.
423 Allowed values
424 1 - v1 error format
425 2 - v2 error format
426
427 Returns:
428 An object of the form:
429
430 { # Represents a Persistent Disk Snapshot resource.
431 #
432 # You can use snapshots to back up data on a regular interval. For more
433 # information, read Creating
434 # persistent disk snapshots.
435 &quot;architecture&quot;: &quot;A String&quot;, # Output only. [Output Only] The architecture of the snapshot. Valid values are
436 # ARM64 or X86_64.
437 &quot;autoCreated&quot;: True or False, # Output only. [Output Only] Set to true if snapshots are automatically created by
438 # applying resource policy on the target disk.
439 &quot;chainName&quot;: &quot;A String&quot;, # Creates the new snapshot in the snapshot chain labeled with the
440 # specified name. The chain name must be 1-63 characters long and comply
441 # with RFC1035. This is an uncommon option only for advanced service
442 # owners who needs to create separate snapshot chains, for example,
443 # for chargeback tracking. When you describe your snapshot resource, this
444 # field is visible only if it has a non-empty value.
445 &quot;creationSizeBytes&quot;: &quot;A String&quot;, # Output only. [Output Only] Size in bytes of the snapshot at creation time.
446 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
447 # text format.
448 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
449 # create the resource.
450 &quot;diskSizeGb&quot;: &quot;A String&quot;, # Output only. [Output Only] Size of the source disk, specified in GB.
451 &quot;downloadBytes&quot;: &quot;A String&quot;, # Output only. [Output Only] Number of bytes downloaded to restore a snapshot to a disk.
452 &quot;enableConfidentialCompute&quot;: True or False, # Output only. Whether this snapshot is created from a confidential compute mode disk.
453 # [Output Only]: This field is not set by user, but from source disk.
454 &quot;guestFlush&quot;: True or False, # [Input Only] Whether to attempt an application consistent snapshot by
455 # informing the OS to prepare for the snapshot process.
456 &quot;guestOsFeatures&quot;: [ # Output only. [Output Only] A list of features to enable on the guest operating system.
457 # Applicable only for bootable images. Read
458 # Enabling guest operating system features to see a list of available
459 # options.
460 { # Guest OS features.
461 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
462 # separate values. Set to one or more of the following values:
463 #
464 # - VIRTIO_SCSI_MULTIQUEUE
465 # - WINDOWS
466 # - MULTI_IP_SUBNET
467 # - UEFI_COMPATIBLE
468 # - GVNIC
469 # - SEV_CAPABLE
470 # - SUSPEND_RESUME_COMPATIBLE
471 # - SEV_LIVE_MIGRATABLE_V2
472 # - SEV_SNP_CAPABLE
473 # - TDX_CAPABLE
474 # - IDPF
475 # - SNP_SVSM_CAPABLE
476 # - CCA_CAPABLE
477 #
478 #
479 # For more information, see
480 # Enabling guest operating system features.
481 },
482 ],
483 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
484 # defined by the server.
485 &quot;kind&quot;: &quot;compute#snapshot&quot;, # Output only. [Output Only] Type of the resource. Always compute#snapshot
486 # for Snapshot resources.
487 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for the labels being applied to this snapshot, which is
488 # essentially a hash of the labels set used for optimistic locking. The
489 # fingerprint is initially generated by Compute Engine and changes after
490 # every request to modify or update labels. You must always provide an
491 # up-to-date fingerprint hash in order to update or change labels,
492 # otherwise the request will fail with error412 conditionNotMet.
493 #
494 # To see the latest fingerprint, make a get() request to
495 # retrieve a snapshot.
496 &quot;labels&quot;: { # Labels to apply to this snapshot. These can be later modified by
497 # the setLabels method.
498 # Label values may be empty.
499 &quot;a_key&quot;: &quot;A String&quot;,
500 },
501 &quot;licenseCodes&quot;: [ # Output only. [Output Only] Integer license codes indicating which licenses are attached
502 # to this snapshot.
503 &quot;A String&quot;,
504 ],
505 &quot;licenses&quot;: [ # Output only. [Output Only] A list of public visible licenses that apply to this
506 # snapshot. This can be because the original image had licenses attached
507 # (such as a Windows image).
508 &quot;A String&quot;,
509 ],
510 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the snapshot close to other
511 # resources.
512 # This field is for use by internal tools that use the public API.
513 &quot;name&quot;: &quot;A String&quot;, # Name of the resource; provided by the client when the resource is created.
514 # The name must be 1-63 characters long, and comply withRFC1035.
515 # Specifically, the name must be 1-63 characters long and match the regular
516 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
517 # character must be a lowercase letter, and all following characters must be
518 # a dash, lowercase letter, or digit, except the last character, which cannot
519 # be a dash.
520 &quot;params&quot;: { # Additional snapshot params. # Input only. [Input Only] Additional params passed with the request, but not persisted
521 # as part of resource payload.
522 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the snapshot. Tag keys and values have
523 # the same definition as resource
524 # manager tags. Keys and values can be either in numeric format,
525 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
526 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
527 # `{tag_value_short_name}`. The field is ignored (both PUT &amp;
528 # PATCH) when empty.
529 &quot;a_key&quot;: &quot;A String&quot;,
530 },
531 },
532 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the snapshot resides. Only applicable
533 # for regional snapshots.
534 &quot;satisfiesPzi&quot;: True or False, # Output only. Reserved for future use.
535 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
536 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
537 &quot;snapshotEncryptionKey&quot;: { # Encrypts the snapshot using acustomer-supplied
538 # encryption key.
539 #
540 # After you encrypt a snapshot using a customer-supplied key, you must
541 # provide the same key if you use the snapshot later. For example, you must
542 # provide the encryption key when you create a disk from the encrypted
543 # snapshot in a future request.
544 #
545 # Customer-supplied encryption keys do not protect access to metadata
546 # of the snapshot.
547 #
548 # If you do not provide an encryption key when creating the snapshot, then
549 # the snapshot will be encrypted using an automatically generated key and you
550 # do not need to provide a key to use the snapshot later.
551 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
552 # For example:
553 #
554 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
555 # key_region/cryptoKeys/key
556 #
557 # The fully-qualifed key name may be returned for resource GET requests. For
558 # example:
559 #
560 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
561 # key_region/cryptoKeys/key
562 # /cryptoKeyVersions/1
563 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
564 # key. If absent, the Compute Engine default service account is used.
565 # For example:
566 #
567 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
568 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
569 # encryption key, encoded in RFC
570 # 4648 base64 to either encrypt or decrypt this resource. You can
571 # provide either the rawKey or thersaEncryptedKey.
572 # For example:
573 #
574 # &quot;rawKey&quot;:
575 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
576 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
577 # customer-supplied encryption key to either encrypt or decrypt this
578 # resource. You can provide either the rawKey or thersaEncryptedKey.
579 # For example:
580 #
581 # &quot;rsaEncryptedKey&quot;:
582 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
583 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
584 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
585 #
586 # The key must meet the following requirements before you can provide it to
587 # Compute Engine:
588 #
589 # 1. The key is wrapped using a RSA public key certificate provided by
590 # Google.
591 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
592 # encoding.
593 #
594 # Gets the RSA public key certificate provided by Google at:
595 #
596 #
597 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
598 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
599 # 4648 base64 encoded SHA-256 hash of the customer-supplied
600 # encryption key that protects this resource.
601 },
602 &quot;snapshotGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the snapshot group that this snapshot
603 # belongs to. The usage of snapshot group feature is restricted.
604 &quot;snapshotGroupName&quot;: &quot;A String&quot;, # Output only. [Output only] The snapshot group that this snapshot belongs to. The usage
605 # of snapshot group feature is restricted.
606 &quot;snapshotType&quot;: &quot;A String&quot;, # Indicates the type of the snapshot.
607 &quot;sourceDisk&quot;: &quot;A String&quot;, # The source disk used to create this snapshot.
608 &quot;sourceDiskEncryptionKey&quot;: { # The customer-supplied
609 # encryption key of the source disk. Required if the source disk is
610 # protected by a customer-supplied encryption key.
611 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
612 # For example:
613 #
614 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
615 # key_region/cryptoKeys/key
616 #
617 # The fully-qualifed key name may be returned for resource GET requests. For
618 # example:
619 #
620 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
621 # key_region/cryptoKeys/key
622 # /cryptoKeyVersions/1
623 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
624 # key. If absent, the Compute Engine default service account is used.
625 # For example:
626 #
627 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
628 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
629 # encryption key, encoded in RFC
630 # 4648 base64 to either encrypt or decrypt this resource. You can
631 # provide either the rawKey or thersaEncryptedKey.
632 # For example:
633 #
634 # &quot;rawKey&quot;:
635 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
636 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
637 # customer-supplied encryption key to either encrypt or decrypt this
638 # resource. You can provide either the rawKey or thersaEncryptedKey.
639 # For example:
640 #
641 # &quot;rsaEncryptedKey&quot;:
642 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
643 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
644 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
645 #
646 # The key must meet the following requirements before you can provide it to
647 # Compute Engine:
648 #
649 # 1. The key is wrapped using a RSA public key certificate provided by
650 # Google.
651 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
652 # encoding.
653 #
654 # Gets the RSA public key certificate provided by Google at:
655 #
656 #
657 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
658 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
659 # 4648 base64 encoded SHA-256 hash of the customer-supplied
660 # encryption key that protects this resource.
661 },
662 &quot;sourceDiskForRecoveryCheckpoint&quot;: &quot;A String&quot;, # The source disk whose recovery checkpoint will be used to create this
663 # snapshot.
664 &quot;sourceDiskId&quot;: &quot;A String&quot;, # Output only. [Output Only] The ID value of the disk used to create this snapshot. This
665 # value may be used to determine whether the snapshot was taken from the
666 # current or a previous instance of a given disk name.
667 &quot;sourceInstantSnapshot&quot;: &quot;A String&quot;, # The source instant snapshot used to create this snapshot. You can provide
668 # this as a partial or full URL to the resource. For example, the following
669 # are valid values:
670 #
671 #
672 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instantSnapshots/instantSnapshot
673 # - projects/project/zones/zone/instantSnapshots/instantSnapshot
674 # - zones/zone/instantSnapshots/instantSnapshot
675 &quot;sourceInstantSnapshotEncryptionKey&quot;: { # Customer provided encryption key when creating Snapshot from Instant
676 # Snapshot.
677 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
678 # For example:
679 #
680 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
681 # key_region/cryptoKeys/key
682 #
683 # The fully-qualifed key name may be returned for resource GET requests. For
684 # example:
685 #
686 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
687 # key_region/cryptoKeys/key
688 # /cryptoKeyVersions/1
689 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
690 # key. If absent, the Compute Engine default service account is used.
691 # For example:
692 #
693 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
694 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
695 # encryption key, encoded in RFC
696 # 4648 base64 to either encrypt or decrypt this resource. You can
697 # provide either the rawKey or thersaEncryptedKey.
698 # For example:
699 #
700 # &quot;rawKey&quot;:
701 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
702 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
703 # customer-supplied encryption key to either encrypt or decrypt this
704 # resource. You can provide either the rawKey or thersaEncryptedKey.
705 # For example:
706 #
707 # &quot;rsaEncryptedKey&quot;:
708 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
709 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
710 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
711 #
712 # The key must meet the following requirements before you can provide it to
713 # Compute Engine:
714 #
715 # 1. The key is wrapped using a RSA public key certificate provided by
716 # Google.
717 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
718 # encoding.
719 #
720 # Gets the RSA public key certificate provided by Google at:
721 #
722 #
723 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
724 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
725 # 4648 base64 encoded SHA-256 hash of the customer-supplied
726 # encryption key that protects this resource.
727 },
728 &quot;sourceInstantSnapshotId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the instant snapshot used to create this
729 # snapshot. This value identifies the exact instant snapshot that was used to
730 # create this snapshot. For example, if you created the snapshot from an
731 # instant snapshot that was later deleted and recreated under the same name,
732 # the source instant snapshot ID would identify the exact instant snapshot
733 # that was used.
734 &quot;sourceSnapshotSchedulePolicy&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the resource policy which created this
735 # scheduled snapshot.
736 &quot;sourceSnapshotSchedulePolicyId&quot;: &quot;A String&quot;, # Output only. [Output Only] ID of the resource policy which created this
737 # scheduled snapshot.
738 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only] The status of the snapshot. This can beCREATING, DELETING, FAILED,READY, or UPLOADING.
739 &quot;storageBytes&quot;: &quot;A String&quot;, # Output only. [Output Only] A size of the storage used by the snapshot. As snapshots
740 # share storage, this number is expected to change with snapshot
741 # creation/deletion.
742 &quot;storageBytesStatus&quot;: &quot;A String&quot;, # Output only. [Deprecated] Instead, check the storageBytes field. After
743 # snapshot creation, the storageBytesStatus field is alwaysUP_TO_DATE.
744 # [Output Only] An indicator whether storageBytes is in a
745 # stable state or it is being adjusted as a result of shared storage
746 # reallocation. This status can either be unset, meaning the snapshot is
747 # being created, or UP_TO_DATE, meaning the size of the snapshot
748 # is up-to-date.
749 &quot;storageLocations&quot;: [ # Cloud Storage bucket storage location of the snapshot (regional or
750 # multi-regional).
751 &quot;A String&quot;,
752 ],
753 }</pre>
754 </div>
755
756 <div class="method">
757 <code class="details" id="getIamPolicy">getIamPolicy(project, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</code>
758 <pre>Gets the access control policy for a resource. May be empty if no such
759 policy or resource exists.
760
761 Args:
762 project: string, Project ID for this request. (required)
763 resource: string, Name or id of the resource for this request. (required)
764 optionsRequestedPolicyVersion: integer, Requested IAM Policy version.
765 x__xgafv: string, V1 error format.
766 Allowed values
767 1 - v1 error format
768 2 - v2 error format
769
770 Returns:
771 An object of the form:
772
773 { # An Identity and Access Management (IAM) policy, which specifies access
774 # controls for Google Cloud resources.
775 #
776 #
777 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
778 # `members`, or principals, to a single `role`. Principals can be user
779 # accounts, service accounts, Google groups, and domains (such as G Suite). A
780 # `role` is a named list of permissions; each `role` can be an IAM predefined
781 # role or a user-created custom role.
782 #
783 # For some types of Google Cloud resources, a `binding` can also specify a
784 # `condition`, which is a logical expression that allows access to a resource
785 # only if the expression evaluates to `true`. A condition can add constraints
786 # based on attributes of the request, the resource, or both. To learn which
787 # resources support conditions in their IAM policies, see the
788 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
789 #
790 # **JSON example:**
791 #
792 # ```
793 # {
794 # &quot;bindings&quot;: [
795 # {
796 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
797 # &quot;members&quot;: [
798 # &quot;user:[email protected]&quot;,
799 # &quot;group:[email protected]&quot;,
800 # &quot;domain:google.com&quot;,
801 # &quot;serviceAccount:[email protected]&quot;
802 # ]
803 # },
804 # {
805 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
806 # &quot;members&quot;: [
807 # &quot;user:[email protected]&quot;
808 # ],
809 # &quot;condition&quot;: {
810 # &quot;title&quot;: &quot;expirable access&quot;,
811 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
812 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
813 # }
814 # }
815 # ],
816 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
817 # &quot;version&quot;: 3
818 # }
819 # ```
820 #
821 # **YAML example:**
822 #
823 # ```
824 # bindings:
825 # - members:
826 # - user:[email protected]
827 # - group:[email protected]
828 # - domain:google.com
829 # - serviceAccount:[email protected]
830 # role: roles/resourcemanager.organizationAdmin
831 # - members:
832 # - user:[email protected]
833 # role: roles/resourcemanager.organizationViewer
834 # condition:
835 # title: expirable access
836 # description: Does not grant access after Sep 2020
837 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
838 # etag: BwWWja0YfJA=
839 # version: 3
840 # ```
841 #
842 # For a description of IAM and its features, see the
843 # [IAM documentation](https://cloud.google.com/iam/docs/).
844 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
845 { # Specifies the audit configuration for a service.
846 # The configuration determines which permission types are logged, and what
847 # identities, if any, are exempted from logging.
848 # An AuditConfig must have one or more AuditLogConfigs.
849 #
850 # If there are AuditConfigs for both `allServices` and a specific service,
851 # the union of the two AuditConfigs is used for that service: the log_types
852 # specified in each AuditConfig are enabled, and the exempted_members in each
853 # AuditLogConfig are exempted.
854 #
855 # Example Policy with multiple AuditConfigs:
856 #
857 # {
858 # &quot;audit_configs&quot;: [
859 # {
860 # &quot;service&quot;: &quot;allServices&quot;,
861 # &quot;audit_log_configs&quot;: [
862 # {
863 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
864 # &quot;exempted_members&quot;: [
865 # &quot;user:[email protected]&quot;
866 # ]
867 # },
868 # {
869 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
870 # },
871 # {
872 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
873 # }
874 # ]
875 # },
876 # {
877 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
878 # &quot;audit_log_configs&quot;: [
879 # {
880 # &quot;log_type&quot;: &quot;DATA_READ&quot;
881 # },
882 # {
883 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
884 # &quot;exempted_members&quot;: [
885 # &quot;user:[email protected]&quot;
886 # ]
887 # }
888 # ]
889 # }
890 # ]
891 # }
892 #
893 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
894 # logging. It also exempts `[email protected]` from DATA_READ logging, and
895 # `[email protected]` from DATA_WRITE logging.
896 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
897 { # Provides the configuration for logging a type of permissions.
898 # Example:
899 #
900 # {
901 # &quot;audit_log_configs&quot;: [
902 # {
903 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
904 # &quot;exempted_members&quot;: [
905 # &quot;user:[email protected]&quot;
906 # ]
907 # },
908 # {
909 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
910 # }
911 # ]
912 # }
913 #
914 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
915 # [email protected] from DATA_READ logging.
916 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
917 # permission.
918 # Follows the same format of Binding.members.
919 &quot;A String&quot;,
920 ],
921 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
922 },
923 ],
924 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
925 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
926 # `allServices` is a special value that covers all services.
927 },
928 ],
929 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
930 # may specify a `condition` that determines how and when the `bindings` are
931 # applied. Each of the `bindings` must contain at least one principal.
932 #
933 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
934 # of these principals can be Google groups. Each occurrence of a principal
935 # counts towards these limits. For example, if the `bindings` grant 50
936 # different roles to `user:[email protected]`, and not to any other
937 # principal, then you can add another 1,450 principals to the `bindings` in
938 # the `Policy`.
939 { # Associates `members`, or principals, with a `role`.
940 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
941 #
942 # If the condition evaluates to `true`, then this binding applies to the
943 # current request.
944 #
945 # If the condition evaluates to `false`, then this binding does not apply to
946 # the current request. However, a different role binding might grant the same
947 # role to one or more of the principals in this binding.
948 #
949 # To learn which resources support conditions in their IAM policies, see the
950 # [IAM
951 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
952 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
953 # are documented at https://github.com/google/cel-spec.
954 #
955 # Example (Comparison):
956 #
957 # title: &quot;Summary size limit&quot;
958 # description: &quot;Determines if a summary is less than 100 chars&quot;
959 # expression: &quot;document.summary.size() &lt; 100&quot;
960 #
961 # Example (Equality):
962 #
963 # title: &quot;Requestor is owner&quot;
964 # description: &quot;Determines if requestor is the document owner&quot;
965 # expression: &quot;document.owner == request.auth.claims.email&quot;
966 #
967 # Example (Logic):
968 #
969 # title: &quot;Public documents&quot;
970 # description: &quot;Determine whether the document should be publicly visible&quot;
971 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
972 #
973 # Example (Data Manipulation):
974 #
975 # title: &quot;Notification string&quot;
976 # description: &quot;Create a notification string with a timestamp.&quot;
977 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
978 #
979 # The exact variables and functions that may be referenced within an expression
980 # are determined by the service that evaluates it. See the service
981 # documentation for additional information.
982 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
983 # describes the expression, e.g. when hovered over it in a UI.
984 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
985 # syntax.
986 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
987 # reporting, e.g. a file name and a position in the file.
988 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
989 # its purpose. This can be used e.g. in UIs which allow to enter the
990 # expression.
991 },
992 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
993 # `members` can have the following values:
994 #
995 # * `allUsers`: A special identifier that represents anyone who is
996 # on the internet; with or without a Google account.
997 #
998 # * `allAuthenticatedUsers`: A special identifier that represents anyone
999 # who is authenticated with a Google account or a service account.
1000 # Does not include identities that come from external identity providers
1001 # (IdPs) through identity federation.
1002 #
1003 # * `user:{emailid}`: An email address that represents a specific Google
1004 # account. For example, `[email protected]` .
1005 #
1006 #
1007 # * `serviceAccount:{emailid}`: An email address that represents a Google
1008 # service account. For example,
1009 # `[email protected]`.
1010 #
1011 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
1012 # identifier for a
1013 # [Kubernetes service
1014 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
1015 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
1016 #
1017 # * `group:{emailid}`: An email address that represents a Google group.
1018 # For example, `[email protected]`.
1019 #
1020 #
1021 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
1022 # users of that domain. For example, `google.com` or `example.com`.
1023 #
1024 #
1025 #
1026 #
1027 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
1028 # A single identity in a workforce identity pool.
1029 #
1030 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
1031 # All workforce identities in a group.
1032 #
1033 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
1034 # All workforce identities with a specific attribute value.
1035 #
1036 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
1037 # All identities in a workforce identity pool.
1038 #
1039 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
1040 # A single identity in a workload identity pool.
1041 #
1042 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
1043 # A workload identity pool group.
1044 #
1045 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
1046 # All identities in a workload identity pool with a certain attribute.
1047 #
1048 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
1049 # All identities in a workload identity pool.
1050 #
1051 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
1052 # identifier) representing a user that has been recently deleted. For
1053 # example, `[email protected]?uid=123456789012345678901`. If the user is
1054 # recovered, this value reverts to `user:{emailid}` and the recovered user
1055 # retains the role in the binding.
1056 #
1057 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
1058 # unique identifier) representing a service account that has been recently
1059 # deleted. For example,
1060 # `[email protected]?uid=123456789012345678901`.
1061 # If the service account is undeleted, this value reverts to
1062 # `serviceAccount:{emailid}` and the undeleted service account retains the
1063 # role in the binding.
1064 #
1065 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
1066 # identifier) representing a Google group that has been recently
1067 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
1068 # the group is recovered, this value reverts to `group:{emailid}` and the
1069 # recovered group retains the role in the binding.
1070 #
1071 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
1072 # Deleted single identity in a workforce identity pool. For example,
1073 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
1074 &quot;A String&quot;,
1075 ],
1076 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
1077 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
1078 #
1079 # For an overview of the IAM roles and permissions, see the
1080 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
1081 # a list of the available pre-defined roles, see
1082 # [here](https://cloud.google.com/iam/docs/understanding-roles).
1083 },
1084 ],
1085 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
1086 # prevent simultaneous updates of a policy from overwriting each other.
1087 # It is strongly suggested that systems make use of the `etag` in the
1088 # read-modify-write cycle to perform policy updates in order to avoid race
1089 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
1090 # systems are expected to put that etag in the request to `setIamPolicy` to
1091 # ensure that their change will be applied to the same version of the policy.
1092 #
1093 # **Important:** If you use IAM Conditions, you must include the `etag` field
1094 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
1095 # you to overwrite a version `3` policy with a version `1` policy, and all of
1096 # the conditions in the version `3` policy are lost.
1097 &quot;version&quot;: 42, # Specifies the format of the policy.
1098 #
1099 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
1100 # are rejected.
1101 #
1102 # Any operation that affects conditional role bindings must specify version
1103 # `3`. This requirement applies to the following operations:
1104 #
1105 # * Getting a policy that includes a conditional role binding
1106 # * Adding a conditional role binding to a policy
1107 # * Changing a conditional role binding in a policy
1108 # * Removing any role binding, with or without a condition, from a policy
1109 # that includes conditions
1110 #
1111 # **Important:** If you use IAM Conditions, you must include the `etag` field
1112 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
1113 # you to overwrite a version `3` policy with a version `1` policy, and all of
1114 # the conditions in the version `3` policy are lost.
1115 #
1116 # If a policy does not include any conditions, operations on that policy may
1117 # specify any valid version or leave the field unset.
1118 #
1119 # To learn which resources support conditions in their IAM policies, see the
1120 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
1121 }</pre>
1122 </div>
1123
1124 <div class="method">
1125 <code class="details" id="insert">insert(project, body=None, requestId=None, x__xgafv=None)</code>
1126 <pre>Creates a snapshot in the specified project using the data included
1127 in the request. For regular snapshot creation, consider using this method
1128 instead of disks.createSnapshot,
1129 as this method supports more features, such as creating snapshots in a
1130 project different from the source disk project.
1131
1132 Args:
1133 project: string, Project ID for this request. (required)
1134 body: object, The request body.
1135 The object takes the form of:
1136
1137 { # Represents a Persistent Disk Snapshot resource.
1138 #
1139 # You can use snapshots to back up data on a regular interval. For more
1140 # information, read Creating
1141 # persistent disk snapshots.
1142 &quot;architecture&quot;: &quot;A String&quot;, # Output only. [Output Only] The architecture of the snapshot. Valid values are
1143 # ARM64 or X86_64.
1144 &quot;autoCreated&quot;: True or False, # Output only. [Output Only] Set to true if snapshots are automatically created by
1145 # applying resource policy on the target disk.
1146 &quot;chainName&quot;: &quot;A String&quot;, # Creates the new snapshot in the snapshot chain labeled with the
1147 # specified name. The chain name must be 1-63 characters long and comply
1148 # with RFC1035. This is an uncommon option only for advanced service
1149 # owners who needs to create separate snapshot chains, for example,
1150 # for chargeback tracking. When you describe your snapshot resource, this
1151 # field is visible only if it has a non-empty value.
1152 &quot;creationSizeBytes&quot;: &quot;A String&quot;, # Output only. [Output Only] Size in bytes of the snapshot at creation time.
1153 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
1154 # text format.
1155 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
1156 # create the resource.
1157 &quot;diskSizeGb&quot;: &quot;A String&quot;, # Output only. [Output Only] Size of the source disk, specified in GB.
1158 &quot;downloadBytes&quot;: &quot;A String&quot;, # Output only. [Output Only] Number of bytes downloaded to restore a snapshot to a disk.
1159 &quot;enableConfidentialCompute&quot;: True or False, # Output only. Whether this snapshot is created from a confidential compute mode disk.
1160 # [Output Only]: This field is not set by user, but from source disk.
1161 &quot;guestFlush&quot;: True or False, # [Input Only] Whether to attempt an application consistent snapshot by
1162 # informing the OS to prepare for the snapshot process.
1163 &quot;guestOsFeatures&quot;: [ # Output only. [Output Only] A list of features to enable on the guest operating system.
1164 # Applicable only for bootable images. Read
1165 # Enabling guest operating system features to see a list of available
1166 # options.
1167 { # Guest OS features.
1168 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
1169 # separate values. Set to one or more of the following values:
1170 #
1171 # - VIRTIO_SCSI_MULTIQUEUE
1172 # - WINDOWS
1173 # - MULTI_IP_SUBNET
1174 # - UEFI_COMPATIBLE
1175 # - GVNIC
1176 # - SEV_CAPABLE
1177 # - SUSPEND_RESUME_COMPATIBLE
1178 # - SEV_LIVE_MIGRATABLE_V2
1179 # - SEV_SNP_CAPABLE
1180 # - TDX_CAPABLE
1181 # - IDPF
1182 # - SNP_SVSM_CAPABLE
1183 # - CCA_CAPABLE
1184 #
1185 #
1186 # For more information, see
1187 # Enabling guest operating system features.
1188 },
1189 ],
1190 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
1191 # defined by the server.
1192 &quot;kind&quot;: &quot;compute#snapshot&quot;, # Output only. [Output Only] Type of the resource. Always compute#snapshot
1193 # for Snapshot resources.
1194 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for the labels being applied to this snapshot, which is
1195 # essentially a hash of the labels set used for optimistic locking. The
1196 # fingerprint is initially generated by Compute Engine and changes after
1197 # every request to modify or update labels. You must always provide an
1198 # up-to-date fingerprint hash in order to update or change labels,
1199 # otherwise the request will fail with error412 conditionNotMet.
1200 #
1201 # To see the latest fingerprint, make a get() request to
1202 # retrieve a snapshot.
1203 &quot;labels&quot;: { # Labels to apply to this snapshot. These can be later modified by
1204 # the setLabels method.
1205 # Label values may be empty.
1206 &quot;a_key&quot;: &quot;A String&quot;,
1207 },
1208 &quot;licenseCodes&quot;: [ # Output only. [Output Only] Integer license codes indicating which licenses are attached
1209 # to this snapshot.
1210 &quot;A String&quot;,
1211 ],
1212 &quot;licenses&quot;: [ # Output only. [Output Only] A list of public visible licenses that apply to this
1213 # snapshot. This can be because the original image had licenses attached
1214 # (such as a Windows image).
1215 &quot;A String&quot;,
1216 ],
1217 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the snapshot close to other
1218 # resources.
1219 # This field is for use by internal tools that use the public API.
1220 &quot;name&quot;: &quot;A String&quot;, # Name of the resource; provided by the client when the resource is created.
1221 # The name must be 1-63 characters long, and comply withRFC1035.
1222 # Specifically, the name must be 1-63 characters long and match the regular
1223 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
1224 # character must be a lowercase letter, and all following characters must be
1225 # a dash, lowercase letter, or digit, except the last character, which cannot
1226 # be a dash.
1227 &quot;params&quot;: { # Additional snapshot params. # Input only. [Input Only] Additional params passed with the request, but not persisted
1228 # as part of resource payload.
1229 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the snapshot. Tag keys and values have
1230 # the same definition as resource
1231 # manager tags. Keys and values can be either in numeric format,
1232 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
1233 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
1234 # `{tag_value_short_name}`. The field is ignored (both PUT &amp;
1235 # PATCH) when empty.
1236 &quot;a_key&quot;: &quot;A String&quot;,
1237 },
1238 },
1239 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the snapshot resides. Only applicable
1240 # for regional snapshots.
1241 &quot;satisfiesPzi&quot;: True or False, # Output only. Reserved for future use.
1242 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
1243 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
1244 &quot;snapshotEncryptionKey&quot;: { # Encrypts the snapshot using acustomer-supplied
1245 # encryption key.
1246 #
1247 # After you encrypt a snapshot using a customer-supplied key, you must
1248 # provide the same key if you use the snapshot later. For example, you must
1249 # provide the encryption key when you create a disk from the encrypted
1250 # snapshot in a future request.
1251 #
1252 # Customer-supplied encryption keys do not protect access to metadata
1253 # of the snapshot.
1254 #
1255 # If you do not provide an encryption key when creating the snapshot, then
1256 # the snapshot will be encrypted using an automatically generated key and you
1257 # do not need to provide a key to use the snapshot later.
1258 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
1259 # For example:
1260 #
1261 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
1262 # key_region/cryptoKeys/key
1263 #
1264 # The fully-qualifed key name may be returned for resource GET requests. For
1265 # example:
1266 #
1267 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
1268 # key_region/cryptoKeys/key
1269 # /cryptoKeyVersions/1
1270 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
1271 # key. If absent, the Compute Engine default service account is used.
1272 # For example:
1273 #
1274 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
1275 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
1276 # encryption key, encoded in RFC
1277 # 4648 base64 to either encrypt or decrypt this resource. You can
1278 # provide either the rawKey or thersaEncryptedKey.
1279 # For example:
1280 #
1281 # &quot;rawKey&quot;:
1282 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
1283 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
1284 # customer-supplied encryption key to either encrypt or decrypt this
1285 # resource. You can provide either the rawKey or thersaEncryptedKey.
1286 # For example:
1287 #
1288 # &quot;rsaEncryptedKey&quot;:
1289 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
1290 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
1291 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
1292 #
1293 # The key must meet the following requirements before you can provide it to
1294 # Compute Engine:
1295 #
1296 # 1. The key is wrapped using a RSA public key certificate provided by
1297 # Google.
1298 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
1299 # encoding.
1300 #
1301 # Gets the RSA public key certificate provided by Google at:
1302 #
1303 #
1304 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
1305 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
1306 # 4648 base64 encoded SHA-256 hash of the customer-supplied
1307 # encryption key that protects this resource.
1308 },
1309 &quot;snapshotGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the snapshot group that this snapshot
1310 # belongs to. The usage of snapshot group feature is restricted.
1311 &quot;snapshotGroupName&quot;: &quot;A String&quot;, # Output only. [Output only] The snapshot group that this snapshot belongs to. The usage
1312 # of snapshot group feature is restricted.
1313 &quot;snapshotType&quot;: &quot;A String&quot;, # Indicates the type of the snapshot.
1314 &quot;sourceDisk&quot;: &quot;A String&quot;, # The source disk used to create this snapshot.
1315 &quot;sourceDiskEncryptionKey&quot;: { # The customer-supplied
1316 # encryption key of the source disk. Required if the source disk is
1317 # protected by a customer-supplied encryption key.
1318 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
1319 # For example:
1320 #
1321 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
1322 # key_region/cryptoKeys/key
1323 #
1324 # The fully-qualifed key name may be returned for resource GET requests. For
1325 # example:
1326 #
1327 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
1328 # key_region/cryptoKeys/key
1329 # /cryptoKeyVersions/1
1330 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
1331 # key. If absent, the Compute Engine default service account is used.
1332 # For example:
1333 #
1334 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
1335 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
1336 # encryption key, encoded in RFC
1337 # 4648 base64 to either encrypt or decrypt this resource. You can
1338 # provide either the rawKey or thersaEncryptedKey.
1339 # For example:
1340 #
1341 # &quot;rawKey&quot;:
1342 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
1343 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
1344 # customer-supplied encryption key to either encrypt or decrypt this
1345 # resource. You can provide either the rawKey or thersaEncryptedKey.
1346 # For example:
1347 #
1348 # &quot;rsaEncryptedKey&quot;:
1349 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
1350 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
1351 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
1352 #
1353 # The key must meet the following requirements before you can provide it to
1354 # Compute Engine:
1355 #
1356 # 1. The key is wrapped using a RSA public key certificate provided by
1357 # Google.
1358 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
1359 # encoding.
1360 #
1361 # Gets the RSA public key certificate provided by Google at:
1362 #
1363 #
1364 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
1365 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
1366 # 4648 base64 encoded SHA-256 hash of the customer-supplied
1367 # encryption key that protects this resource.
1368 },
1369 &quot;sourceDiskForRecoveryCheckpoint&quot;: &quot;A String&quot;, # The source disk whose recovery checkpoint will be used to create this
1370 # snapshot.
1371 &quot;sourceDiskId&quot;: &quot;A String&quot;, # Output only. [Output Only] The ID value of the disk used to create this snapshot. This
1372 # value may be used to determine whether the snapshot was taken from the
1373 # current or a previous instance of a given disk name.
1374 &quot;sourceInstantSnapshot&quot;: &quot;A String&quot;, # The source instant snapshot used to create this snapshot. You can provide
1375 # this as a partial or full URL to the resource. For example, the following
1376 # are valid values:
1377 #
1378 #
1379 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instantSnapshots/instantSnapshot
1380 # - projects/project/zones/zone/instantSnapshots/instantSnapshot
1381 # - zones/zone/instantSnapshots/instantSnapshot
1382 &quot;sourceInstantSnapshotEncryptionKey&quot;: { # Customer provided encryption key when creating Snapshot from Instant
1383 # Snapshot.
1384 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
1385 # For example:
1386 #
1387 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
1388 # key_region/cryptoKeys/key
1389 #
1390 # The fully-qualifed key name may be returned for resource GET requests. For
1391 # example:
1392 #
1393 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
1394 # key_region/cryptoKeys/key
1395 # /cryptoKeyVersions/1
1396 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
1397 # key. If absent, the Compute Engine default service account is used.
1398 # For example:
1399 #
1400 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
1401 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
1402 # encryption key, encoded in RFC
1403 # 4648 base64 to either encrypt or decrypt this resource. You can
1404 # provide either the rawKey or thersaEncryptedKey.
1405 # For example:
1406 #
1407 # &quot;rawKey&quot;:
1408 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
1409 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
1410 # customer-supplied encryption key to either encrypt or decrypt this
1411 # resource. You can provide either the rawKey or thersaEncryptedKey.
1412 # For example:
1413 #
1414 # &quot;rsaEncryptedKey&quot;:
1415 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
1416 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
1417 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
1418 #
1419 # The key must meet the following requirements before you can provide it to
1420 # Compute Engine:
1421 #
1422 # 1. The key is wrapped using a RSA public key certificate provided by
1423 # Google.
1424 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
1425 # encoding.
1426 #
1427 # Gets the RSA public key certificate provided by Google at:
1428 #
1429 #
1430 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
1431 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
1432 # 4648 base64 encoded SHA-256 hash of the customer-supplied
1433 # encryption key that protects this resource.
1434 },
1435 &quot;sourceInstantSnapshotId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the instant snapshot used to create this
1436 # snapshot. This value identifies the exact instant snapshot that was used to
1437 # create this snapshot. For example, if you created the snapshot from an
1438 # instant snapshot that was later deleted and recreated under the same name,
1439 # the source instant snapshot ID would identify the exact instant snapshot
1440 # that was used.
1441 &quot;sourceSnapshotSchedulePolicy&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the resource policy which created this
1442 # scheduled snapshot.
1443 &quot;sourceSnapshotSchedulePolicyId&quot;: &quot;A String&quot;, # Output only. [Output Only] ID of the resource policy which created this
1444 # scheduled snapshot.
1445 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only] The status of the snapshot. This can beCREATING, DELETING, FAILED,READY, or UPLOADING.
1446 &quot;storageBytes&quot;: &quot;A String&quot;, # Output only. [Output Only] A size of the storage used by the snapshot. As snapshots
1447 # share storage, this number is expected to change with snapshot
1448 # creation/deletion.
1449 &quot;storageBytesStatus&quot;: &quot;A String&quot;, # Output only. [Deprecated] Instead, check the storageBytes field. After
1450 # snapshot creation, the storageBytesStatus field is alwaysUP_TO_DATE.
1451 # [Output Only] An indicator whether storageBytes is in a
1452 # stable state or it is being adjusted as a result of shared storage
1453 # reallocation. This status can either be unset, meaning the snapshot is
1454 # being created, or UP_TO_DATE, meaning the size of the snapshot
1455 # is up-to-date.
1456 &quot;storageLocations&quot;: [ # Cloud Storage bucket storage location of the snapshot (regional or
1457 # multi-regional).
1458 &quot;A String&quot;,
1459 ],
1460 }
1461
1462 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
1463 that if you must retry your request, the server will know to ignore the
1464 request if it has already been completed.
1465
1466 For example, consider a situation where you make an initial request and
1467 the request times out. If you make the request again with the same
1468 request ID, the server can check if original operation with the same
1469 request ID was received, and if so, will ignore the second request. This
1470 prevents clients from accidentally creating duplicate commitments.
1471
1472 The request ID must be
1473 a valid UUID with the exception that zero UUID is not supported
1474 (00000000-0000-0000-0000-000000000000).
1475 x__xgafv: string, V1 error format.
1476 Allowed values
1477 1 - v1 error format
1478 2 - v2 error format
1479
1480 Returns:
1481 An object of the form:
1482
1483 { # Represents an Operation resource.
1484 #
1485 # Google Compute Engine has three Operation resources:
1486 #
1487 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
1488 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
1489 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
1490 #
1491 # You can use an operation resource to manage asynchronous API requests.
1492 # For more information, readHandling
1493 # API responses.
1494 #
1495 # Operations can be global, regional or zonal.
1496 #
1497 # - For global operations, use the `globalOperations`
1498 # resource.
1499 # - For regional operations, use the
1500 # `regionOperations` resource.
1501 # - For zonal operations, use
1502 # the `zoneOperations` resource.
1503 #
1504 #
1505 #
1506 # For more information, read
1507 # Global, Regional, and Zonal Resources.
1508 #
1509 # Note that completed Operation resources have a limited
1510 # retention period.
1511 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
1512 # Not present otherwise.
1513 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1514 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
1515 # set when the operation is created.
1516 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
1517 # text format.
1518 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
1519 # this field will be populated.
1520 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
1521 # operation.
1522 {
1523 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1524 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
1525 # details. There is a set of defined message types to use for providing
1526 # details.The syntax depends on the error code. For example,
1527 # QuotaExceededInfo will have details when the error code is
1528 # QUOTA_EXCEEDED.
1529 {
1530 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
1531 #
1532 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
1533 # is not enabled:
1534 #
1535 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
1536 # &quot;domain&quot;: &quot;googleapis.com&quot;
1537 # &quot;metadata&quot;: {
1538 # &quot;resource&quot;: &quot;projects/123&quot;,
1539 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
1540 # }
1541 # }
1542 #
1543 # This response indicates that the pubsub.googleapis.com API is not enabled.
1544 #
1545 # Example of an error that is returned when attempting to create a Spanner
1546 # instance in a region that is out of stock:
1547 #
1548 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
1549 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
1550 # &quot;metadata&quot;: {
1551 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
1552 # }
1553 # }
1554 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
1555 # is typically the registered service name of the tool or product that
1556 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
1557 # generated by some common infrastructure, the error domain must be a
1558 # globally unique value that identifies the infrastructure. For Google API
1559 # infrastructure, the error domain is &quot;googleapis.com&quot;.
1560 &quot;metadatas&quot;: { # Additional structured details about this error.
1561 #
1562 # Keys must match a regular expression of `a-z+` but should
1563 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
1564 # length. When identifying the current value of an exceeded limit, the units
1565 # should be contained in the key, not the value. For example, rather than
1566 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1567 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1568 # instances that can be created in a single (batch) request.
1569 &quot;a_key&quot;: &quot;A String&quot;,
1570 },
1571 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1572 # proximate cause of the error. Error reasons are unique within a particular
1573 # domain of errors. This should be at most 63 characters and match a
1574 # regular expression of `A-Z+[A-Z0-9]`, which represents
1575 # UPPER_SNAKE_CASE.
1576 },
1577 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1578 #
1579 # For example, if a quota check failed with an error indicating the calling
1580 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1581 # directly to the right place in the developer console to flip the bit.
1582 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1583 { # Describes a URL link.
1584 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1585 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1586 },
1587 ],
1588 },
1589 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1590 # which can be attached to an RPC error.
1591 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1592 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1593 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1594 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1595 },
1596 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1597 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1598 &quot;a_key&quot;: &quot;A String&quot;,
1599 },
1600 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1601 # type or metric.
1602 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1603 # or metric.
1604 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1605 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1606 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1607 },
1608 },
1609 ],
1610 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1611 # This property is optional.
1612 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1613 },
1614 ],
1615 },
1616 &quot;getVersionOperationMetadata&quot;: {
1617 &quot;inlineSbomInfo&quot;: {
1618 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1619 # appropriate identifiers.
1620 &quot;a_key&quot;: &quot;A String&quot;,
1621 },
1622 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
1623 # identifiers.
1624 &quot;a_key&quot;: &quot;A String&quot;,
1625 },
1626 },
1627 },
1628 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1629 # message that was returned, such as `NOT FOUND`.
1630 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1631 # status code that was returned. For example, a `404` means the
1632 # resource was not found.
1633 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1634 # defined by the server.
1635 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1636 # This value is inRFC3339
1637 # text format.
1638 &quot;instancesBulkInsertOperationMetadata&quot;: {
1639 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1640 # Example key: zones/us-central1-a
1641 &quot;a_key&quot;: {
1642 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1643 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1644 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1645 # error.
1646 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1647 # if the flow is rolling forward or rolling back.
1648 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1649 },
1650 },
1651 },
1652 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1653 # Operation resources.
1654 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1655 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1656 # group of operations results from a `bulkInsert` API request.
1657 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1658 # `update`, or `delete`, and so on.
1659 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1660 # There is no requirement that this be linear or support any granularity of
1661 # operations. This should not be used to guess when the operation will be
1662 # complete. This number should monotonically increase as the operation
1663 # progresses.
1664 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1665 # applicable when performing regional operations.
1666 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1667 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1668 # this field will contain information on all underlying zonal actions and
1669 # their state.
1670 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1671 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1672 # Example key: zones/us-central1-a
1673 &quot;a_key&quot;: {
1674 &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
1675 # populated.
1676 # different programming environments, including REST APIs and RPC APIs. It is
1677 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1678 # three pieces of data: error code, error message, and error details.
1679 #
1680 # You can find out more about this error model and how to work with it in the
1681 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1682 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1683 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1684 # message types for APIs to use.
1685 {
1686 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1687 },
1688 ],
1689 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1690 # user-facing error message should be localized and sent in the
1691 # google.rpc.Status.details field, or localized by the client.
1692 },
1693 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1694 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1695 },
1696 },
1697 },
1698 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1699 # This value is inRFC3339
1700 # text format.
1701 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1702 # following:
1703 # `PENDING`, `RUNNING`, or `DONE`.
1704 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1705 # operation.
1706 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1707 # of the target resource.
1708 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1709 # operations related to creating a snapshot, this points to the disk
1710 # that the snapshot was created from.
1711 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1712 # `[email protected]` or
1713 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1714 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1715 # operation, this field will be populated.
1716 {
1717 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1718 # Engine returns NO_RESULTS_ON_PAGE if there
1719 # are no results in the response.
1720 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1721 # value format. For example:
1722 #
1723 # &quot;data&quot;: [
1724 # {
1725 # &quot;key&quot;: &quot;scope&quot;,
1726 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1727 # }
1728 {
1729 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1730 # returned. For example, for warnings where there are no results in a list
1731 # request for a particular zone, this key might be scope and
1732 # the key value might be the zone name. Other examples might be a key
1733 # indicating a deprecated resource and a suggested replacement, or a
1734 # warning about invalid network settings (for example, if an instance
1735 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1736 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1737 },
1738 ],
1739 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1740 },
1741 ],
1742 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1743 # applicable when performing per-zone operations.
1744 }</pre>
1745 </div>
1746
1747 <div class="method">
1748 <code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
1749 <pre>Retrieves the list of Snapshot resources contained within
1750 the specified project.
1751
1752 Args:
1753 project: string, Project ID for this request. (required)
1754 filter: string, A filter expression that filters resources listed in the response. Most
1755 Compute resources support two types of filter expressions:
1756 expressions that support regular expressions and expressions that follow
1757 API improvement proposal AIP-160.
1758 These two types of filter expressions cannot be mixed in one request.
1759
1760 If you want to use AIP-160, your expression must specify the field name, an
1761 operator, and the value that you want to use for filtering. The value
1762 must be a string, a number, or a boolean. The operator
1763 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
1764
1765 For example, if you are filtering Compute Engine instances, you can
1766 exclude instances named `example-instance` by specifying
1767 `name != example-instance`.
1768
1769 The `:*` comparison can be used to test whether a key has been defined.
1770 For example, to find all objects with `owner` label use:
1771 ```
1772 labels.owner:*
1773 ```
1774
1775 You can also filter nested fields. For example, you could specify
1776 `scheduling.automaticRestart = false` to include instances only
1777 if they are not scheduled for automatic restarts. You can use filtering
1778 on nested fields to filter based onresource labels.
1779
1780 To filter on multiple expressions, provide each separate expression within
1781 parentheses. For example:
1782 ```
1783 (scheduling.automaticRestart = true)
1784 (cpuPlatform = &quot;Intel Skylake&quot;)
1785 ```
1786 By default, each expression is an `AND` expression. However, you
1787 can include `AND` and `OR` expressions explicitly.
1788 For example:
1789 ```
1790 (cpuPlatform = &quot;Intel Skylake&quot;) OR
1791 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
1792 (scheduling.automaticRestart = true)
1793 ```
1794
1795 If you want to use a regular expression, use the `eq` (equal) or `ne`
1796 (not equal) operator against a single un-parenthesized expression with or
1797 without quotes or against multiple parenthesized expressions. Examples:
1798
1799 `fieldname eq unquoted literal`
1800 `fieldname eq &#x27;single quoted literal&#x27;`
1801 `fieldname eq &quot;double quoted literal&quot;`
1802 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
1803
1804 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
1805 The literal value must match the entire field.
1806
1807 For example, to filter for instances that do not end with name &quot;instance&quot;,
1808 you would use `name ne .*instance`.
1809
1810 You cannot combine constraints on multiple fields using regular
1811 expressions.
1812 maxResults: integer, The maximum number of results per page that should be returned.
1813 If the number of available results is larger than `maxResults`,
1814 Compute Engine returns a `nextPageToken` that can be used to get
1815 the next page of results in subsequent list requests. Acceptable values are
1816 `0` to `500`, inclusive. (Default: `500`)
1817 orderBy: string, Sorts list results by a certain order. By default, results
1818 are returned in alphanumerical order based on the resource name.
1819
1820 You can also sort results in descending order based on the creation
1821 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
1822 results based on the `creationTimestamp` field in
1823 reverse chronological order (newest result first). Use this to sort
1824 resources like operations so that the newest operation is returned first.
1825
1826 Currently, only sorting by `name` or
1827 `creationTimestamp desc` is supported.
1828 pageToken: string, Specifies a page token to use. Set `pageToken` to the
1829 `nextPageToken` returned by a previous list request to get
1830 the next page of results.
1831 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
1832 of failure. The default value is false.
1833
1834 For example, when partial success behavior is enabled, aggregatedList for a
1835 single zone scope either returns all resources in the zone or no resources,
1836 with an error code.
1837 x__xgafv: string, V1 error format.
1838 Allowed values
1839 1 - v1 error format
1840 2 - v2 error format
1841
1842 Returns:
1843 An object of the form:
1844
1845 { # Contains a list of Snapshot resources.
1846 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
1847 &quot;items&quot;: [ # A list of Snapshot resources.
1848 { # Represents a Persistent Disk Snapshot resource.
1849 #
1850 # You can use snapshots to back up data on a regular interval. For more
1851 # information, read Creating
1852 # persistent disk snapshots.
1853 &quot;architecture&quot;: &quot;A String&quot;, # Output only. [Output Only] The architecture of the snapshot. Valid values are
1854 # ARM64 or X86_64.
1855 &quot;autoCreated&quot;: True or False, # Output only. [Output Only] Set to true if snapshots are automatically created by
1856 # applying resource policy on the target disk.
1857 &quot;chainName&quot;: &quot;A String&quot;, # Creates the new snapshot in the snapshot chain labeled with the
1858 # specified name. The chain name must be 1-63 characters long and comply
1859 # with RFC1035. This is an uncommon option only for advanced service
1860 # owners who needs to create separate snapshot chains, for example,
1861 # for chargeback tracking. When you describe your snapshot resource, this
1862 # field is visible only if it has a non-empty value.
1863 &quot;creationSizeBytes&quot;: &quot;A String&quot;, # Output only. [Output Only] Size in bytes of the snapshot at creation time.
1864 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
1865 # text format.
1866 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
1867 # create the resource.
1868 &quot;diskSizeGb&quot;: &quot;A String&quot;, # Output only. [Output Only] Size of the source disk, specified in GB.
1869 &quot;downloadBytes&quot;: &quot;A String&quot;, # Output only. [Output Only] Number of bytes downloaded to restore a snapshot to a disk.
1870 &quot;enableConfidentialCompute&quot;: True or False, # Output only. Whether this snapshot is created from a confidential compute mode disk.
1871 # [Output Only]: This field is not set by user, but from source disk.
1872 &quot;guestFlush&quot;: True or False, # [Input Only] Whether to attempt an application consistent snapshot by
1873 # informing the OS to prepare for the snapshot process.
1874 &quot;guestOsFeatures&quot;: [ # Output only. [Output Only] A list of features to enable on the guest operating system.
1875 # Applicable only for bootable images. Read
1876 # Enabling guest operating system features to see a list of available
1877 # options.
1878 { # Guest OS features.
1879 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
1880 # separate values. Set to one or more of the following values:
1881 #
1882 # - VIRTIO_SCSI_MULTIQUEUE
1883 # - WINDOWS
1884 # - MULTI_IP_SUBNET
1885 # - UEFI_COMPATIBLE
1886 # - GVNIC
1887 # - SEV_CAPABLE
1888 # - SUSPEND_RESUME_COMPATIBLE
1889 # - SEV_LIVE_MIGRATABLE_V2
1890 # - SEV_SNP_CAPABLE
1891 # - TDX_CAPABLE
1892 # - IDPF
1893 # - SNP_SVSM_CAPABLE
1894 # - CCA_CAPABLE
1895 #
1896 #
1897 # For more information, see
1898 # Enabling guest operating system features.
1899 },
1900 ],
1901 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
1902 # defined by the server.
1903 &quot;kind&quot;: &quot;compute#snapshot&quot;, # Output only. [Output Only] Type of the resource. Always compute#snapshot
1904 # for Snapshot resources.
1905 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for the labels being applied to this snapshot, which is
1906 # essentially a hash of the labels set used for optimistic locking. The
1907 # fingerprint is initially generated by Compute Engine and changes after
1908 # every request to modify or update labels. You must always provide an
1909 # up-to-date fingerprint hash in order to update or change labels,
1910 # otherwise the request will fail with error412 conditionNotMet.
1911 #
1912 # To see the latest fingerprint, make a get() request to
1913 # retrieve a snapshot.
1914 &quot;labels&quot;: { # Labels to apply to this snapshot. These can be later modified by
1915 # the setLabels method.
1916 # Label values may be empty.
1917 &quot;a_key&quot;: &quot;A String&quot;,
1918 },
1919 &quot;licenseCodes&quot;: [ # Output only. [Output Only] Integer license codes indicating which licenses are attached
1920 # to this snapshot.
1921 &quot;A String&quot;,
1922 ],
1923 &quot;licenses&quot;: [ # Output only. [Output Only] A list of public visible licenses that apply to this
1924 # snapshot. This can be because the original image had licenses attached
1925 # (such as a Windows image).
1926 &quot;A String&quot;,
1927 ],
1928 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the snapshot close to other
1929 # resources.
1930 # This field is for use by internal tools that use the public API.
1931 &quot;name&quot;: &quot;A String&quot;, # Name of the resource; provided by the client when the resource is created.
1932 # The name must be 1-63 characters long, and comply withRFC1035.
1933 # Specifically, the name must be 1-63 characters long and match the regular
1934 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
1935 # character must be a lowercase letter, and all following characters must be
1936 # a dash, lowercase letter, or digit, except the last character, which cannot
1937 # be a dash.
1938 &quot;params&quot;: { # Additional snapshot params. # Input only. [Input Only] Additional params passed with the request, but not persisted
1939 # as part of resource payload.
1940 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the snapshot. Tag keys and values have
1941 # the same definition as resource
1942 # manager tags. Keys and values can be either in numeric format,
1943 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
1944 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
1945 # `{tag_value_short_name}`. The field is ignored (both PUT &amp;
1946 # PATCH) when empty.
1947 &quot;a_key&quot;: &quot;A String&quot;,
1948 },
1949 },
1950 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the snapshot resides. Only applicable
1951 # for regional snapshots.
1952 &quot;satisfiesPzi&quot;: True or False, # Output only. Reserved for future use.
1953 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
1954 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
1955 &quot;snapshotEncryptionKey&quot;: { # Encrypts the snapshot using acustomer-supplied
1956 # encryption key.
1957 #
1958 # After you encrypt a snapshot using a customer-supplied key, you must
1959 # provide the same key if you use the snapshot later. For example, you must
1960 # provide the encryption key when you create a disk from the encrypted
1961 # snapshot in a future request.
1962 #
1963 # Customer-supplied encryption keys do not protect access to metadata
1964 # of the snapshot.
1965 #
1966 # If you do not provide an encryption key when creating the snapshot, then
1967 # the snapshot will be encrypted using an automatically generated key and you
1968 # do not need to provide a key to use the snapshot later.
1969 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
1970 # For example:
1971 #
1972 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
1973 # key_region/cryptoKeys/key
1974 #
1975 # The fully-qualifed key name may be returned for resource GET requests. For
1976 # example:
1977 #
1978 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
1979 # key_region/cryptoKeys/key
1980 # /cryptoKeyVersions/1
1981 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
1982 # key. If absent, the Compute Engine default service account is used.
1983 # For example:
1984 #
1985 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
1986 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
1987 # encryption key, encoded in RFC
1988 # 4648 base64 to either encrypt or decrypt this resource. You can
1989 # provide either the rawKey or thersaEncryptedKey.
1990 # For example:
1991 #
1992 # &quot;rawKey&quot;:
1993 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
1994 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
1995 # customer-supplied encryption key to either encrypt or decrypt this
1996 # resource. You can provide either the rawKey or thersaEncryptedKey.
1997 # For example:
1998 #
1999 # &quot;rsaEncryptedKey&quot;:
2000 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
2001 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
2002 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
2003 #
2004 # The key must meet the following requirements before you can provide it to
2005 # Compute Engine:
2006 #
2007 # 1. The key is wrapped using a RSA public key certificate provided by
2008 # Google.
2009 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
2010 # encoding.
2011 #
2012 # Gets the RSA public key certificate provided by Google at:
2013 #
2014 #
2015 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
2016 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
2017 # 4648 base64 encoded SHA-256 hash of the customer-supplied
2018 # encryption key that protects this resource.
2019 },
2020 &quot;snapshotGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the snapshot group that this snapshot
2021 # belongs to. The usage of snapshot group feature is restricted.
2022 &quot;snapshotGroupName&quot;: &quot;A String&quot;, # Output only. [Output only] The snapshot group that this snapshot belongs to. The usage
2023 # of snapshot group feature is restricted.
2024 &quot;snapshotType&quot;: &quot;A String&quot;, # Indicates the type of the snapshot.
2025 &quot;sourceDisk&quot;: &quot;A String&quot;, # The source disk used to create this snapshot.
2026 &quot;sourceDiskEncryptionKey&quot;: { # The customer-supplied
2027 # encryption key of the source disk. Required if the source disk is
2028 # protected by a customer-supplied encryption key.
2029 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
2030 # For example:
2031 #
2032 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
2033 # key_region/cryptoKeys/key
2034 #
2035 # The fully-qualifed key name may be returned for resource GET requests. For
2036 # example:
2037 #
2038 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
2039 # key_region/cryptoKeys/key
2040 # /cryptoKeyVersions/1
2041 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
2042 # key. If absent, the Compute Engine default service account is used.
2043 # For example:
2044 #
2045 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
2046 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
2047 # encryption key, encoded in RFC
2048 # 4648 base64 to either encrypt or decrypt this resource. You can
2049 # provide either the rawKey or thersaEncryptedKey.
2050 # For example:
2051 #
2052 # &quot;rawKey&quot;:
2053 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
2054 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
2055 # customer-supplied encryption key to either encrypt or decrypt this
2056 # resource. You can provide either the rawKey or thersaEncryptedKey.
2057 # For example:
2058 #
2059 # &quot;rsaEncryptedKey&quot;:
2060 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
2061 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
2062 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
2063 #
2064 # The key must meet the following requirements before you can provide it to
2065 # Compute Engine:
2066 #
2067 # 1. The key is wrapped using a RSA public key certificate provided by
2068 # Google.
2069 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
2070 # encoding.
2071 #
2072 # Gets the RSA public key certificate provided by Google at:
2073 #
2074 #
2075 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
2076 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
2077 # 4648 base64 encoded SHA-256 hash of the customer-supplied
2078 # encryption key that protects this resource.
2079 },
2080 &quot;sourceDiskForRecoveryCheckpoint&quot;: &quot;A String&quot;, # The source disk whose recovery checkpoint will be used to create this
2081 # snapshot.
2082 &quot;sourceDiskId&quot;: &quot;A String&quot;, # Output only. [Output Only] The ID value of the disk used to create this snapshot. This
2083 # value may be used to determine whether the snapshot was taken from the
2084 # current or a previous instance of a given disk name.
2085 &quot;sourceInstantSnapshot&quot;: &quot;A String&quot;, # The source instant snapshot used to create this snapshot. You can provide
2086 # this as a partial or full URL to the resource. For example, the following
2087 # are valid values:
2088 #
2089 #
2090 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instantSnapshots/instantSnapshot
2091 # - projects/project/zones/zone/instantSnapshots/instantSnapshot
2092 # - zones/zone/instantSnapshots/instantSnapshot
2093 &quot;sourceInstantSnapshotEncryptionKey&quot;: { # Customer provided encryption key when creating Snapshot from Instant
2094 # Snapshot.
2095 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
2096 # For example:
2097 #
2098 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
2099 # key_region/cryptoKeys/key
2100 #
2101 # The fully-qualifed key name may be returned for resource GET requests. For
2102 # example:
2103 #
2104 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
2105 # key_region/cryptoKeys/key
2106 # /cryptoKeyVersions/1
2107 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
2108 # key. If absent, the Compute Engine default service account is used.
2109 # For example:
2110 #
2111 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
2112 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
2113 # encryption key, encoded in RFC
2114 # 4648 base64 to either encrypt or decrypt this resource. You can
2115 # provide either the rawKey or thersaEncryptedKey.
2116 # For example:
2117 #
2118 # &quot;rawKey&quot;:
2119 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
2120 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
2121 # customer-supplied encryption key to either encrypt or decrypt this
2122 # resource. You can provide either the rawKey or thersaEncryptedKey.
2123 # For example:
2124 #
2125 # &quot;rsaEncryptedKey&quot;:
2126 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
2127 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
2128 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
2129 #
2130 # The key must meet the following requirements before you can provide it to
2131 # Compute Engine:
2132 #
2133 # 1. The key is wrapped using a RSA public key certificate provided by
2134 # Google.
2135 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
2136 # encoding.
2137 #
2138 # Gets the RSA public key certificate provided by Google at:
2139 #
2140 #
2141 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
2142 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
2143 # 4648 base64 encoded SHA-256 hash of the customer-supplied
2144 # encryption key that protects this resource.
2145 },
2146 &quot;sourceInstantSnapshotId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the instant snapshot used to create this
2147 # snapshot. This value identifies the exact instant snapshot that was used to
2148 # create this snapshot. For example, if you created the snapshot from an
2149 # instant snapshot that was later deleted and recreated under the same name,
2150 # the source instant snapshot ID would identify the exact instant snapshot
2151 # that was used.
2152 &quot;sourceSnapshotSchedulePolicy&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the resource policy which created this
2153 # scheduled snapshot.
2154 &quot;sourceSnapshotSchedulePolicyId&quot;: &quot;A String&quot;, # Output only. [Output Only] ID of the resource policy which created this
2155 # scheduled snapshot.
2156 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only] The status of the snapshot. This can beCREATING, DELETING, FAILED,READY, or UPLOADING.
2157 &quot;storageBytes&quot;: &quot;A String&quot;, # Output only. [Output Only] A size of the storage used by the snapshot. As snapshots
2158 # share storage, this number is expected to change with snapshot
2159 # creation/deletion.
2160 &quot;storageBytesStatus&quot;: &quot;A String&quot;, # Output only. [Deprecated] Instead, check the storageBytes field. After
2161 # snapshot creation, the storageBytesStatus field is alwaysUP_TO_DATE.
2162 # [Output Only] An indicator whether storageBytes is in a
2163 # stable state or it is being adjusted as a result of shared storage
2164 # reallocation. This status can either be unset, meaning the snapshot is
2165 # being created, or UP_TO_DATE, meaning the size of the snapshot
2166 # is up-to-date.
2167 &quot;storageLocations&quot;: [ # Cloud Storage bucket storage location of the snapshot (regional or
2168 # multi-regional).
2169 &quot;A String&quot;,
2170 ],
2171 },
2172 ],
2173 &quot;kind&quot;: &quot;compute#snapshotList&quot;, # Output only. Type of resource.
2174 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
2175 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
2176 # the query parameter pageToken in the next list request.
2177 # Subsequent list requests will have their own nextPageToken to
2178 # continue paging through the results.
2179 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
2180 &quot;warning&quot;: { # [Output Only] Informational warning message.
2181 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2182 # Engine returns NO_RESULTS_ON_PAGE if there
2183 # are no results in the response.
2184 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2185 # value format. For example:
2186 #
2187 # &quot;data&quot;: [
2188 # {
2189 # &quot;key&quot;: &quot;scope&quot;,
2190 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2191 # }
2192 {
2193 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2194 # returned. For example, for warnings where there are no results in a list
2195 # request for a particular zone, this key might be scope and
2196 # the key value might be the zone name. Other examples might be a key
2197 # indicating a deprecated resource and a suggested replacement, or a
2198 # warning about invalid network settings (for example, if an instance
2199 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2200 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2201 },
2202 ],
2203 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2204 },
2205 }</pre>
2206 </div>
2207
2208 <div class="method">
2209 <code class="details" id="list_next">list_next()</code>
2210 <pre>Retrieves the next page of results.
2211
2212 Args:
2213 previous_request: The request for the previous page. (required)
2214 previous_response: The response from the request for the previous page. (required)
2215
2216 Returns:
2217 A request object that you can call &#x27;execute()&#x27; on to request the next
2218 page. Returns None if there are no more items in the collection.
2219 </pre>
2220 </div>
2221
2222 <div class="method">
2223 <code class="details" id="setIamPolicy">setIamPolicy(project, resource, body=None, x__xgafv=None)</code>
2224 <pre>Sets the access control policy on the specified resource.
2225 Replaces any existing policy.
2226
2227 Args:
2228 project: string, Project ID for this request. (required)
2229 resource: string, Name or id of the resource for this request. (required)
2230 body: object, The request body.
2231 The object takes the form of:
2232
2233 {
2234 &quot;bindings&quot;: [ # Flatten Policy to create a backward compatible wire-format.
2235 # Deprecated. Use &#x27;policy&#x27; to specify bindings.
2236 { # Associates `members`, or principals, with a `role`.
2237 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
2238 #
2239 # If the condition evaluates to `true`, then this binding applies to the
2240 # current request.
2241 #
2242 # If the condition evaluates to `false`, then this binding does not apply to
2243 # the current request. However, a different role binding might grant the same
2244 # role to one or more of the principals in this binding.
2245 #
2246 # To learn which resources support conditions in their IAM policies, see the
2247 # [IAM
2248 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
2249 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
2250 # are documented at https://github.com/google/cel-spec.
2251 #
2252 # Example (Comparison):
2253 #
2254 # title: &quot;Summary size limit&quot;
2255 # description: &quot;Determines if a summary is less than 100 chars&quot;
2256 # expression: &quot;document.summary.size() &lt; 100&quot;
2257 #
2258 # Example (Equality):
2259 #
2260 # title: &quot;Requestor is owner&quot;
2261 # description: &quot;Determines if requestor is the document owner&quot;
2262 # expression: &quot;document.owner == request.auth.claims.email&quot;
2263 #
2264 # Example (Logic):
2265 #
2266 # title: &quot;Public documents&quot;
2267 # description: &quot;Determine whether the document should be publicly visible&quot;
2268 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
2269 #
2270 # Example (Data Manipulation):
2271 #
2272 # title: &quot;Notification string&quot;
2273 # description: &quot;Create a notification string with a timestamp.&quot;
2274 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
2275 #
2276 # The exact variables and functions that may be referenced within an expression
2277 # are determined by the service that evaluates it. See the service
2278 # documentation for additional information.
2279 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
2280 # describes the expression, e.g. when hovered over it in a UI.
2281 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
2282 # syntax.
2283 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
2284 # reporting, e.g. a file name and a position in the file.
2285 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
2286 # its purpose. This can be used e.g. in UIs which allow to enter the
2287 # expression.
2288 },
2289 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
2290 # `members` can have the following values:
2291 #
2292 # * `allUsers`: A special identifier that represents anyone who is
2293 # on the internet; with or without a Google account.
2294 #
2295 # * `allAuthenticatedUsers`: A special identifier that represents anyone
2296 # who is authenticated with a Google account or a service account.
2297 # Does not include identities that come from external identity providers
2298 # (IdPs) through identity federation.
2299 #
2300 # * `user:{emailid}`: An email address that represents a specific Google
2301 # account. For example, `[email protected]` .
2302 #
2303 #
2304 # * `serviceAccount:{emailid}`: An email address that represents a Google
2305 # service account. For example,
2306 # `[email protected]`.
2307 #
2308 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
2309 # identifier for a
2310 # [Kubernetes service
2311 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
2312 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
2313 #
2314 # * `group:{emailid}`: An email address that represents a Google group.
2315 # For example, `[email protected]`.
2316 #
2317 #
2318 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
2319 # users of that domain. For example, `google.com` or `example.com`.
2320 #
2321 #
2322 #
2323 #
2324 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
2325 # A single identity in a workforce identity pool.
2326 #
2327 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
2328 # All workforce identities in a group.
2329 #
2330 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
2331 # All workforce identities with a specific attribute value.
2332 #
2333 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
2334 # All identities in a workforce identity pool.
2335 #
2336 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
2337 # A single identity in a workload identity pool.
2338 #
2339 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
2340 # A workload identity pool group.
2341 #
2342 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
2343 # All identities in a workload identity pool with a certain attribute.
2344 #
2345 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
2346 # All identities in a workload identity pool.
2347 #
2348 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
2349 # identifier) representing a user that has been recently deleted. For
2350 # example, `[email protected]?uid=123456789012345678901`. If the user is
2351 # recovered, this value reverts to `user:{emailid}` and the recovered user
2352 # retains the role in the binding.
2353 #
2354 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
2355 # unique identifier) representing a service account that has been recently
2356 # deleted. For example,
2357 # `[email protected]?uid=123456789012345678901`.
2358 # If the service account is undeleted, this value reverts to
2359 # `serviceAccount:{emailid}` and the undeleted service account retains the
2360 # role in the binding.
2361 #
2362 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
2363 # identifier) representing a Google group that has been recently
2364 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
2365 # the group is recovered, this value reverts to `group:{emailid}` and the
2366 # recovered group retains the role in the binding.
2367 #
2368 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
2369 # Deleted single identity in a workforce identity pool. For example,
2370 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
2371 &quot;A String&quot;,
2372 ],
2373 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
2374 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
2375 #
2376 # For an overview of the IAM roles and permissions, see the
2377 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
2378 # a list of the available pre-defined roles, see
2379 # [here](https://cloud.google.com/iam/docs/understanding-roles).
2380 },
2381 ],
2382 &quot;etag&quot;: &quot;A String&quot;, # Flatten Policy to create a backward compatible wire-format.
2383 # Deprecated. Use &#x27;policy&#x27; to specify the etag.
2384 &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
2385 # the policy is limited to a few 10s of KB. An empty policy is in general a
2386 # valid policy but certain services (like Projects) might reject them.
2387 # controls for Google Cloud resources.
2388 #
2389 #
2390 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
2391 # `members`, or principals, to a single `role`. Principals can be user
2392 # accounts, service accounts, Google groups, and domains (such as G Suite). A
2393 # `role` is a named list of permissions; each `role` can be an IAM predefined
2394 # role or a user-created custom role.
2395 #
2396 # For some types of Google Cloud resources, a `binding` can also specify a
2397 # `condition`, which is a logical expression that allows access to a resource
2398 # only if the expression evaluates to `true`. A condition can add constraints
2399 # based on attributes of the request, the resource, or both. To learn which
2400 # resources support conditions in their IAM policies, see the
2401 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
2402 #
2403 # **JSON example:**
2404 #
2405 # ```
2406 # {
2407 # &quot;bindings&quot;: [
2408 # {
2409 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
2410 # &quot;members&quot;: [
2411 # &quot;user:[email protected]&quot;,
2412 # &quot;group:[email protected]&quot;,
2413 # &quot;domain:google.com&quot;,
2414 # &quot;serviceAccount:[email protected]&quot;
2415 # ]
2416 # },
2417 # {
2418 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
2419 # &quot;members&quot;: [
2420 # &quot;user:[email protected]&quot;
2421 # ],
2422 # &quot;condition&quot;: {
2423 # &quot;title&quot;: &quot;expirable access&quot;,
2424 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
2425 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
2426 # }
2427 # }
2428 # ],
2429 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
2430 # &quot;version&quot;: 3
2431 # }
2432 # ```
2433 #
2434 # **YAML example:**
2435 #
2436 # ```
2437 # bindings:
2438 # - members:
2439 # - user:[email protected]
2440 # - group:[email protected]
2441 # - domain:google.com
2442 # - serviceAccount:[email protected]
2443 # role: roles/resourcemanager.organizationAdmin
2444 # - members:
2445 # - user:[email protected]
2446 # role: roles/resourcemanager.organizationViewer
2447 # condition:
2448 # title: expirable access
2449 # description: Does not grant access after Sep 2020
2450 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
2451 # etag: BwWWja0YfJA=
2452 # version: 3
2453 # ```
2454 #
2455 # For a description of IAM and its features, see the
2456 # [IAM documentation](https://cloud.google.com/iam/docs/).
2457 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
2458 { # Specifies the audit configuration for a service.
2459 # The configuration determines which permission types are logged, and what
2460 # identities, if any, are exempted from logging.
2461 # An AuditConfig must have one or more AuditLogConfigs.
2462 #
2463 # If there are AuditConfigs for both `allServices` and a specific service,
2464 # the union of the two AuditConfigs is used for that service: the log_types
2465 # specified in each AuditConfig are enabled, and the exempted_members in each
2466 # AuditLogConfig are exempted.
2467 #
2468 # Example Policy with multiple AuditConfigs:
2469 #
2470 # {
2471 # &quot;audit_configs&quot;: [
2472 # {
2473 # &quot;service&quot;: &quot;allServices&quot;,
2474 # &quot;audit_log_configs&quot;: [
2475 # {
2476 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
2477 # &quot;exempted_members&quot;: [
2478 # &quot;user:[email protected]&quot;
2479 # ]
2480 # },
2481 # {
2482 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
2483 # },
2484 # {
2485 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
2486 # }
2487 # ]
2488 # },
2489 # {
2490 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
2491 # &quot;audit_log_configs&quot;: [
2492 # {
2493 # &quot;log_type&quot;: &quot;DATA_READ&quot;
2494 # },
2495 # {
2496 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
2497 # &quot;exempted_members&quot;: [
2498 # &quot;user:[email protected]&quot;
2499 # ]
2500 # }
2501 # ]
2502 # }
2503 # ]
2504 # }
2505 #
2506 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
2507 # logging. It also exempts `[email protected]` from DATA_READ logging, and
2508 # `[email protected]` from DATA_WRITE logging.
2509 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
2510 { # Provides the configuration for logging a type of permissions.
2511 # Example:
2512 #
2513 # {
2514 # &quot;audit_log_configs&quot;: [
2515 # {
2516 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
2517 # &quot;exempted_members&quot;: [
2518 # &quot;user:[email protected]&quot;
2519 # ]
2520 # },
2521 # {
2522 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
2523 # }
2524 # ]
2525 # }
2526 #
2527 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
2528 # [email protected] from DATA_READ logging.
2529 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
2530 # permission.
2531 # Follows the same format of Binding.members.
2532 &quot;A String&quot;,
2533 ],
2534 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
2535 },
2536 ],
2537 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
2538 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
2539 # `allServices` is a special value that covers all services.
2540 },
2541 ],
2542 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
2543 # may specify a `condition` that determines how and when the `bindings` are
2544 # applied. Each of the `bindings` must contain at least one principal.
2545 #
2546 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
2547 # of these principals can be Google groups. Each occurrence of a principal
2548 # counts towards these limits. For example, if the `bindings` grant 50
2549 # different roles to `user:[email protected]`, and not to any other
2550 # principal, then you can add another 1,450 principals to the `bindings` in
2551 # the `Policy`.
2552 { # Associates `members`, or principals, with a `role`.
2553 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
2554 #
2555 # If the condition evaluates to `true`, then this binding applies to the
2556 # current request.
2557 #
2558 # If the condition evaluates to `false`, then this binding does not apply to
2559 # the current request. However, a different role binding might grant the same
2560 # role to one or more of the principals in this binding.
2561 #
2562 # To learn which resources support conditions in their IAM policies, see the
2563 # [IAM
2564 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
2565 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
2566 # are documented at https://github.com/google/cel-spec.
2567 #
2568 # Example (Comparison):
2569 #
2570 # title: &quot;Summary size limit&quot;
2571 # description: &quot;Determines if a summary is less than 100 chars&quot;
2572 # expression: &quot;document.summary.size() &lt; 100&quot;
2573 #
2574 # Example (Equality):
2575 #
2576 # title: &quot;Requestor is owner&quot;
2577 # description: &quot;Determines if requestor is the document owner&quot;
2578 # expression: &quot;document.owner == request.auth.claims.email&quot;
2579 #
2580 # Example (Logic):
2581 #
2582 # title: &quot;Public documents&quot;
2583 # description: &quot;Determine whether the document should be publicly visible&quot;
2584 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
2585 #
2586 # Example (Data Manipulation):
2587 #
2588 # title: &quot;Notification string&quot;
2589 # description: &quot;Create a notification string with a timestamp.&quot;
2590 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
2591 #
2592 # The exact variables and functions that may be referenced within an expression
2593 # are determined by the service that evaluates it. See the service
2594 # documentation for additional information.
2595 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
2596 # describes the expression, e.g. when hovered over it in a UI.
2597 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
2598 # syntax.
2599 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
2600 # reporting, e.g. a file name and a position in the file.
2601 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
2602 # its purpose. This can be used e.g. in UIs which allow to enter the
2603 # expression.
2604 },
2605 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
2606 # `members` can have the following values:
2607 #
2608 # * `allUsers`: A special identifier that represents anyone who is
2609 # on the internet; with or without a Google account.
2610 #
2611 # * `allAuthenticatedUsers`: A special identifier that represents anyone
2612 # who is authenticated with a Google account or a service account.
2613 # Does not include identities that come from external identity providers
2614 # (IdPs) through identity federation.
2615 #
2616 # * `user:{emailid}`: An email address that represents a specific Google
2617 # account. For example, `[email protected]` .
2618 #
2619 #
2620 # * `serviceAccount:{emailid}`: An email address that represents a Google
2621 # service account. For example,
2622 # `[email protected]`.
2623 #
2624 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
2625 # identifier for a
2626 # [Kubernetes service
2627 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
2628 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
2629 #
2630 # * `group:{emailid}`: An email address that represents a Google group.
2631 # For example, `[email protected]`.
2632 #
2633 #
2634 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
2635 # users of that domain. For example, `google.com` or `example.com`.
2636 #
2637 #
2638 #
2639 #
2640 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
2641 # A single identity in a workforce identity pool.
2642 #
2643 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
2644 # All workforce identities in a group.
2645 #
2646 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
2647 # All workforce identities with a specific attribute value.
2648 #
2649 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
2650 # All identities in a workforce identity pool.
2651 #
2652 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
2653 # A single identity in a workload identity pool.
2654 #
2655 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
2656 # A workload identity pool group.
2657 #
2658 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
2659 # All identities in a workload identity pool with a certain attribute.
2660 #
2661 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
2662 # All identities in a workload identity pool.
2663 #
2664 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
2665 # identifier) representing a user that has been recently deleted. For
2666 # example, `[email protected]?uid=123456789012345678901`. If the user is
2667 # recovered, this value reverts to `user:{emailid}` and the recovered user
2668 # retains the role in the binding.
2669 #
2670 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
2671 # unique identifier) representing a service account that has been recently
2672 # deleted. For example,
2673 # `[email protected]?uid=123456789012345678901`.
2674 # If the service account is undeleted, this value reverts to
2675 # `serviceAccount:{emailid}` and the undeleted service account retains the
2676 # role in the binding.
2677 #
2678 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
2679 # identifier) representing a Google group that has been recently
2680 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
2681 # the group is recovered, this value reverts to `group:{emailid}` and the
2682 # recovered group retains the role in the binding.
2683 #
2684 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
2685 # Deleted single identity in a workforce identity pool. For example,
2686 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
2687 &quot;A String&quot;,
2688 ],
2689 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
2690 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
2691 #
2692 # For an overview of the IAM roles and permissions, see the
2693 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
2694 # a list of the available pre-defined roles, see
2695 # [here](https://cloud.google.com/iam/docs/understanding-roles).
2696 },
2697 ],
2698 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
2699 # prevent simultaneous updates of a policy from overwriting each other.
2700 # It is strongly suggested that systems make use of the `etag` in the
2701 # read-modify-write cycle to perform policy updates in order to avoid race
2702 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
2703 # systems are expected to put that etag in the request to `setIamPolicy` to
2704 # ensure that their change will be applied to the same version of the policy.
2705 #
2706 # **Important:** If you use IAM Conditions, you must include the `etag` field
2707 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
2708 # you to overwrite a version `3` policy with a version `1` policy, and all of
2709 # the conditions in the version `3` policy are lost.
2710 &quot;version&quot;: 42, # Specifies the format of the policy.
2711 #
2712 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
2713 # are rejected.
2714 #
2715 # Any operation that affects conditional role bindings must specify version
2716 # `3`. This requirement applies to the following operations:
2717 #
2718 # * Getting a policy that includes a conditional role binding
2719 # * Adding a conditional role binding to a policy
2720 # * Changing a conditional role binding in a policy
2721 # * Removing any role binding, with or without a condition, from a policy
2722 # that includes conditions
2723 #
2724 # **Important:** If you use IAM Conditions, you must include the `etag` field
2725 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
2726 # you to overwrite a version `3` policy with a version `1` policy, and all of
2727 # the conditions in the version `3` policy are lost.
2728 #
2729 # If a policy does not include any conditions, operations on that policy may
2730 # specify any valid version or leave the field unset.
2731 #
2732 # To learn which resources support conditions in their IAM policies, see the
2733 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
2734 },
2735 }
2736
2737 x__xgafv: string, V1 error format.
2738 Allowed values
2739 1 - v1 error format
2740 2 - v2 error format
2741
2742 Returns:
2743 An object of the form:
2744
2745 { # An Identity and Access Management (IAM) policy, which specifies access
2746 # controls for Google Cloud resources.
2747 #
2748 #
2749 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
2750 # `members`, or principals, to a single `role`. Principals can be user
2751 # accounts, service accounts, Google groups, and domains (such as G Suite). A
2752 # `role` is a named list of permissions; each `role` can be an IAM predefined
2753 # role or a user-created custom role.
2754 #
2755 # For some types of Google Cloud resources, a `binding` can also specify a
2756 # `condition`, which is a logical expression that allows access to a resource
2757 # only if the expression evaluates to `true`. A condition can add constraints
2758 # based on attributes of the request, the resource, or both. To learn which
2759 # resources support conditions in their IAM policies, see the
2760 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
2761 #
2762 # **JSON example:**
2763 #
2764 # ```
2765 # {
2766 # &quot;bindings&quot;: [
2767 # {
2768 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
2769 # &quot;members&quot;: [
2770 # &quot;user:[email protected]&quot;,
2771 # &quot;group:[email protected]&quot;,
2772 # &quot;domain:google.com&quot;,
2773 # &quot;serviceAccount:[email protected]&quot;
2774 # ]
2775 # },
2776 # {
2777 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
2778 # &quot;members&quot;: [
2779 # &quot;user:[email protected]&quot;
2780 # ],
2781 # &quot;condition&quot;: {
2782 # &quot;title&quot;: &quot;expirable access&quot;,
2783 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
2784 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
2785 # }
2786 # }
2787 # ],
2788 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
2789 # &quot;version&quot;: 3
2790 # }
2791 # ```
2792 #
2793 # **YAML example:**
2794 #
2795 # ```
2796 # bindings:
2797 # - members:
2798 # - user:[email protected]
2799 # - group:[email protected]
2800 # - domain:google.com
2801 # - serviceAccount:[email protected]
2802 # role: roles/resourcemanager.organizationAdmin
2803 # - members:
2804 # - user:[email protected]
2805 # role: roles/resourcemanager.organizationViewer
2806 # condition:
2807 # title: expirable access
2808 # description: Does not grant access after Sep 2020
2809 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
2810 # etag: BwWWja0YfJA=
2811 # version: 3
2812 # ```
2813 #
2814 # For a description of IAM and its features, see the
2815 # [IAM documentation](https://cloud.google.com/iam/docs/).
2816 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
2817 { # Specifies the audit configuration for a service.
2818 # The configuration determines which permission types are logged, and what
2819 # identities, if any, are exempted from logging.
2820 # An AuditConfig must have one or more AuditLogConfigs.
2821 #
2822 # If there are AuditConfigs for both `allServices` and a specific service,
2823 # the union of the two AuditConfigs is used for that service: the log_types
2824 # specified in each AuditConfig are enabled, and the exempted_members in each
2825 # AuditLogConfig are exempted.
2826 #
2827 # Example Policy with multiple AuditConfigs:
2828 #
2829 # {
2830 # &quot;audit_configs&quot;: [
2831 # {
2832 # &quot;service&quot;: &quot;allServices&quot;,
2833 # &quot;audit_log_configs&quot;: [
2834 # {
2835 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
2836 # &quot;exempted_members&quot;: [
2837 # &quot;user:[email protected]&quot;
2838 # ]
2839 # },
2840 # {
2841 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
2842 # },
2843 # {
2844 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
2845 # }
2846 # ]
2847 # },
2848 # {
2849 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
2850 # &quot;audit_log_configs&quot;: [
2851 # {
2852 # &quot;log_type&quot;: &quot;DATA_READ&quot;
2853 # },
2854 # {
2855 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
2856 # &quot;exempted_members&quot;: [
2857 # &quot;user:[email protected]&quot;
2858 # ]
2859 # }
2860 # ]
2861 # }
2862 # ]
2863 # }
2864 #
2865 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
2866 # logging. It also exempts `[email protected]` from DATA_READ logging, and
2867 # `[email protected]` from DATA_WRITE logging.
2868 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
2869 { # Provides the configuration for logging a type of permissions.
2870 # Example:
2871 #
2872 # {
2873 # &quot;audit_log_configs&quot;: [
2874 # {
2875 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
2876 # &quot;exempted_members&quot;: [
2877 # &quot;user:[email protected]&quot;
2878 # ]
2879 # },
2880 # {
2881 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
2882 # }
2883 # ]
2884 # }
2885 #
2886 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
2887 # [email protected] from DATA_READ logging.
2888 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
2889 # permission.
2890 # Follows the same format of Binding.members.
2891 &quot;A String&quot;,
2892 ],
2893 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
2894 },
2895 ],
2896 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
2897 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
2898 # `allServices` is a special value that covers all services.
2899 },
2900 ],
2901 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
2902 # may specify a `condition` that determines how and when the `bindings` are
2903 # applied. Each of the `bindings` must contain at least one principal.
2904 #
2905 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
2906 # of these principals can be Google groups. Each occurrence of a principal
2907 # counts towards these limits. For example, if the `bindings` grant 50
2908 # different roles to `user:[email protected]`, and not to any other
2909 # principal, then you can add another 1,450 principals to the `bindings` in
2910 # the `Policy`.
2911 { # Associates `members`, or principals, with a `role`.
2912 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
2913 #
2914 # If the condition evaluates to `true`, then this binding applies to the
2915 # current request.
2916 #
2917 # If the condition evaluates to `false`, then this binding does not apply to
2918 # the current request. However, a different role binding might grant the same
2919 # role to one or more of the principals in this binding.
2920 #
2921 # To learn which resources support conditions in their IAM policies, see the
2922 # [IAM
2923 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
2924 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
2925 # are documented at https://github.com/google/cel-spec.
2926 #
2927 # Example (Comparison):
2928 #
2929 # title: &quot;Summary size limit&quot;
2930 # description: &quot;Determines if a summary is less than 100 chars&quot;
2931 # expression: &quot;document.summary.size() &lt; 100&quot;
2932 #
2933 # Example (Equality):
2934 #
2935 # title: &quot;Requestor is owner&quot;
2936 # description: &quot;Determines if requestor is the document owner&quot;
2937 # expression: &quot;document.owner == request.auth.claims.email&quot;
2938 #
2939 # Example (Logic):
2940 #
2941 # title: &quot;Public documents&quot;
2942 # description: &quot;Determine whether the document should be publicly visible&quot;
2943 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
2944 #
2945 # Example (Data Manipulation):
2946 #
2947 # title: &quot;Notification string&quot;
2948 # description: &quot;Create a notification string with a timestamp.&quot;
2949 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
2950 #
2951 # The exact variables and functions that may be referenced within an expression
2952 # are determined by the service that evaluates it. See the service
2953 # documentation for additional information.
2954 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
2955 # describes the expression, e.g. when hovered over it in a UI.
2956 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
2957 # syntax.
2958 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
2959 # reporting, e.g. a file name and a position in the file.
2960 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
2961 # its purpose. This can be used e.g. in UIs which allow to enter the
2962 # expression.
2963 },
2964 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
2965 # `members` can have the following values:
2966 #
2967 # * `allUsers`: A special identifier that represents anyone who is
2968 # on the internet; with or without a Google account.
2969 #
2970 # * `allAuthenticatedUsers`: A special identifier that represents anyone
2971 # who is authenticated with a Google account or a service account.
2972 # Does not include identities that come from external identity providers
2973 # (IdPs) through identity federation.
2974 #
2975 # * `user:{emailid}`: An email address that represents a specific Google
2976 # account. For example, `[email protected]` .
2977 #
2978 #
2979 # * `serviceAccount:{emailid}`: An email address that represents a Google
2980 # service account. For example,
2981 # `[email protected]`.
2982 #
2983 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
2984 # identifier for a
2985 # [Kubernetes service
2986 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
2987 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
2988 #
2989 # * `group:{emailid}`: An email address that represents a Google group.
2990 # For example, `[email protected]`.
2991 #
2992 #
2993 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
2994 # users of that domain. For example, `google.com` or `example.com`.
2995 #
2996 #
2997 #
2998 #
2999 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
3000 # A single identity in a workforce identity pool.
3001 #
3002 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
3003 # All workforce identities in a group.
3004 #
3005 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
3006 # All workforce identities with a specific attribute value.
3007 #
3008 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
3009 # All identities in a workforce identity pool.
3010 #
3011 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
3012 # A single identity in a workload identity pool.
3013 #
3014 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
3015 # A workload identity pool group.
3016 #
3017 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
3018 # All identities in a workload identity pool with a certain attribute.
3019 #
3020 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
3021 # All identities in a workload identity pool.
3022 #
3023 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
3024 # identifier) representing a user that has been recently deleted. For
3025 # example, `[email protected]?uid=123456789012345678901`. If the user is
3026 # recovered, this value reverts to `user:{emailid}` and the recovered user
3027 # retains the role in the binding.
3028 #
3029 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
3030 # unique identifier) representing a service account that has been recently
3031 # deleted. For example,
3032 # `[email protected]?uid=123456789012345678901`.
3033 # If the service account is undeleted, this value reverts to
3034 # `serviceAccount:{emailid}` and the undeleted service account retains the
3035 # role in the binding.
3036 #
3037 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
3038 # identifier) representing a Google group that has been recently
3039 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
3040 # the group is recovered, this value reverts to `group:{emailid}` and the
3041 # recovered group retains the role in the binding.
3042 #
3043 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
3044 # Deleted single identity in a workforce identity pool. For example,
3045 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
3046 &quot;A String&quot;,
3047 ],
3048 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
3049 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
3050 #
3051 # For an overview of the IAM roles and permissions, see the
3052 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
3053 # a list of the available pre-defined roles, see
3054 # [here](https://cloud.google.com/iam/docs/understanding-roles).
3055 },
3056 ],
3057 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
3058 # prevent simultaneous updates of a policy from overwriting each other.
3059 # It is strongly suggested that systems make use of the `etag` in the
3060 # read-modify-write cycle to perform policy updates in order to avoid race
3061 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
3062 # systems are expected to put that etag in the request to `setIamPolicy` to
3063 # ensure that their change will be applied to the same version of the policy.
3064 #
3065 # **Important:** If you use IAM Conditions, you must include the `etag` field
3066 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
3067 # you to overwrite a version `3` policy with a version `1` policy, and all of
3068 # the conditions in the version `3` policy are lost.
3069 &quot;version&quot;: 42, # Specifies the format of the policy.
3070 #
3071 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
3072 # are rejected.
3073 #
3074 # Any operation that affects conditional role bindings must specify version
3075 # `3`. This requirement applies to the following operations:
3076 #
3077 # * Getting a policy that includes a conditional role binding
3078 # * Adding a conditional role binding to a policy
3079 # * Changing a conditional role binding in a policy
3080 # * Removing any role binding, with or without a condition, from a policy
3081 # that includes conditions
3082 #
3083 # **Important:** If you use IAM Conditions, you must include the `etag` field
3084 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
3085 # you to overwrite a version `3` policy with a version `1` policy, and all of
3086 # the conditions in the version `3` policy are lost.
3087 #
3088 # If a policy does not include any conditions, operations on that policy may
3089 # specify any valid version or leave the field unset.
3090 #
3091 # To learn which resources support conditions in their IAM policies, see the
3092 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
3093 }</pre>
3094 </div>
3095
3096 <div class="method">
3097 <code class="details" id="setLabels">setLabels(project, resource, body=None, x__xgafv=None)</code>
3098 <pre>Sets the labels on a snapshot. To learn more about labels, read theLabeling
3099 Resources documentation.
3100
3101 Args:
3102 project: string, Project ID for this request. (required)
3103 resource: string, Name or id of the resource for this request. (required)
3104 body: object, The request body.
3105 The object takes the form of:
3106
3107 {
3108 &quot;labelFingerprint&quot;: &quot;A String&quot;, # The fingerprint of the previous set of labels for this resource,
3109 # used to detect conflicts. The fingerprint is initially generated by Compute
3110 # Engine and changes after every request to modify or update labels. You must
3111 # always provide an up-to-date fingerprint hash when updating or changing
3112 # labels, otherwise the request will fail with error412 conditionNotMet. Make a get() request to the
3113 # resource to get the latest fingerprint.
3114 &quot;labels&quot;: { # A list of labels to apply for this resource. Each label must comply with
3115 # the
3116 # requirements for labels. For example,&quot;webserver-frontend&quot;: &quot;images&quot;. A label value can also be
3117 # empty (e.g. &quot;my-label&quot;: &quot;&quot;).
3118 &quot;a_key&quot;: &quot;A String&quot;,
3119 },
3120 }
3121
3122 x__xgafv: string, V1 error format.
3123 Allowed values
3124 1 - v1 error format
3125 2 - v2 error format
3126
3127 Returns:
3128 An object of the form:
3129
3130 { # Represents an Operation resource.
3131 #
3132 # Google Compute Engine has three Operation resources:
3133 #
3134 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
3135 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
3136 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
3137 #
3138 # You can use an operation resource to manage asynchronous API requests.
3139 # For more information, readHandling
3140 # API responses.
3141 #
3142 # Operations can be global, regional or zonal.
3143 #
3144 # - For global operations, use the `globalOperations`
3145 # resource.
3146 # - For regional operations, use the
3147 # `regionOperations` resource.
3148 # - For zonal operations, use
3149 # the `zoneOperations` resource.
3150 #
3151 #
3152 #
3153 # For more information, read
3154 # Global, Regional, and Zonal Resources.
3155 #
3156 # Note that completed Operation resources have a limited
3157 # retention period.
3158 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
3159 # Not present otherwise.
3160 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
3161 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
3162 # set when the operation is created.
3163 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
3164 # text format.
3165 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
3166 # this field will be populated.
3167 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
3168 # operation.
3169 {
3170 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
3171 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
3172 # details. There is a set of defined message types to use for providing
3173 # details.The syntax depends on the error code. For example,
3174 # QuotaExceededInfo will have details when the error code is
3175 # QUOTA_EXCEEDED.
3176 {
3177 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
3178 #
3179 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
3180 # is not enabled:
3181 #
3182 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
3183 # &quot;domain&quot;: &quot;googleapis.com&quot;
3184 # &quot;metadata&quot;: {
3185 # &quot;resource&quot;: &quot;projects/123&quot;,
3186 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
3187 # }
3188 # }
3189 #
3190 # This response indicates that the pubsub.googleapis.com API is not enabled.
3191 #
3192 # Example of an error that is returned when attempting to create a Spanner
3193 # instance in a region that is out of stock:
3194 #
3195 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
3196 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
3197 # &quot;metadata&quot;: {
3198 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
3199 # }
3200 # }
3201 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
3202 # is typically the registered service name of the tool or product that
3203 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
3204 # generated by some common infrastructure, the error domain must be a
3205 # globally unique value that identifies the infrastructure. For Google API
3206 # infrastructure, the error domain is &quot;googleapis.com&quot;.
3207 &quot;metadatas&quot;: { # Additional structured details about this error.
3208 #
3209 # Keys must match a regular expression of `a-z+` but should
3210 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
3211 # length. When identifying the current value of an exceeded limit, the units
3212 # should be contained in the key, not the value. For example, rather than
3213 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
3214 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
3215 # instances that can be created in a single (batch) request.
3216 &quot;a_key&quot;: &quot;A String&quot;,
3217 },
3218 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
3219 # proximate cause of the error. Error reasons are unique within a particular
3220 # domain of errors. This should be at most 63 characters and match a
3221 # regular expression of `A-Z+[A-Z0-9]`, which represents
3222 # UPPER_SNAKE_CASE.
3223 },
3224 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
3225 #
3226 # For example, if a quota check failed with an error indicating the calling
3227 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
3228 # directly to the right place in the developer console to flip the bit.
3229 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
3230 { # Describes a URL link.
3231 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
3232 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
3233 },
3234 ],
3235 },
3236 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
3237 # which can be attached to an RPC error.
3238 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
3239 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
3240 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
3241 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
3242 },
3243 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
3244 &quot;dimensions&quot;: { # The map holding related quota dimensions.
3245 &quot;a_key&quot;: &quot;A String&quot;,
3246 },
3247 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
3248 # type or metric.
3249 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
3250 # or metric.
3251 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
3252 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
3253 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
3254 },
3255 },
3256 ],
3257 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
3258 # This property is optional.
3259 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
3260 },
3261 ],
3262 },
3263 &quot;getVersionOperationMetadata&quot;: {
3264 &quot;inlineSbomInfo&quot;: {
3265 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
3266 # appropriate identifiers.
3267 &quot;a_key&quot;: &quot;A String&quot;,
3268 },
3269 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
3270 # identifiers.
3271 &quot;a_key&quot;: &quot;A String&quot;,
3272 },
3273 },
3274 },
3275 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
3276 # message that was returned, such as `NOT FOUND`.
3277 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
3278 # status code that was returned. For example, a `404` means the
3279 # resource was not found.
3280 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
3281 # defined by the server.
3282 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
3283 # This value is inRFC3339
3284 # text format.
3285 &quot;instancesBulkInsertOperationMetadata&quot;: {
3286 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
3287 # Example key: zones/us-central1-a
3288 &quot;a_key&quot;: {
3289 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
3290 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
3291 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
3292 # error.
3293 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
3294 # if the flow is rolling forward or rolling back.
3295 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
3296 },
3297 },
3298 },
3299 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
3300 # Operation resources.
3301 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
3302 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
3303 # group of operations results from a `bulkInsert` API request.
3304 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
3305 # `update`, or `delete`, and so on.
3306 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
3307 # There is no requirement that this be linear or support any granularity of
3308 # operations. This should not be used to guess when the operation will be
3309 # complete. This number should monotonically increase as the operation
3310 # progresses.
3311 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
3312 # applicable when performing regional operations.
3313 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
3314 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
3315 # this field will contain information on all underlying zonal actions and
3316 # their state.
3317 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
3318 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
3319 # Example key: zones/us-central1-a
3320 &quot;a_key&quot;: {
3321 &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
3322 # populated.
3323 # different programming environments, including REST APIs and RPC APIs. It is
3324 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
3325 # three pieces of data: error code, error message, and error details.
3326 #
3327 # You can find out more about this error model and how to work with it in the
3328 # [API Design Guide](https://cloud.google.com/apis/design/errors).
3329 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
3330 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
3331 # message types for APIs to use.
3332 {
3333 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
3334 },
3335 ],
3336 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
3337 # user-facing error message should be localized and sent in the
3338 # google.rpc.Status.details field, or localized by the client.
3339 },
3340 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
3341 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
3342 },
3343 },
3344 },
3345 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
3346 # This value is inRFC3339
3347 # text format.
3348 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
3349 # following:
3350 # `PENDING`, `RUNNING`, or `DONE`.
3351 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
3352 # operation.
3353 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
3354 # of the target resource.
3355 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
3356 # operations related to creating a snapshot, this points to the disk
3357 # that the snapshot was created from.
3358 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
3359 # `[email protected]` or
3360 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
3361 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
3362 # operation, this field will be populated.
3363 {
3364 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
3365 # Engine returns NO_RESULTS_ON_PAGE if there
3366 # are no results in the response.
3367 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
3368 # value format. For example:
3369 #
3370 # &quot;data&quot;: [
3371 # {
3372 # &quot;key&quot;: &quot;scope&quot;,
3373 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
3374 # }
3375 {
3376 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
3377 # returned. For example, for warnings where there are no results in a list
3378 # request for a particular zone, this key might be scope and
3379 # the key value might be the zone name. Other examples might be a key
3380 # indicating a deprecated resource and a suggested replacement, or a
3381 # warning about invalid network settings (for example, if an instance
3382 # attempts to perform IP forwarding but is not enabled for IP forwarding).
3383 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
3384 },
3385 ],
3386 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
3387 },
3388 ],
3389 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
3390 # applicable when performing per-zone operations.
3391 }</pre>
3392 </div>
3393
3394 <div class="method">
3395 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</code>
3396 <pre>Returns permissions that a caller has on the specified resource.
3397
3398 Args:
3399 project: string, Project ID for this request. (required)
3400 resource: string, Name or id of the resource for this request. (required)
3401 body: object, The request body.
3402 The object takes the form of:
3403
3404 {
3405 &quot;permissions&quot;: [ # The set of permissions to check for the &#x27;resource&#x27;. Permissions with
3406 # wildcards (such as &#x27;*&#x27; or &#x27;storage.*&#x27;) are not allowed.
3407 &quot;A String&quot;,
3408 ],
3409 }
3410
3411 x__xgafv: string, V1 error format.
3412 Allowed values
3413 1 - v1 error format
3414 2 - v2 error format
3415
3416 Returns:
3417 An object of the form:
3418
3419 {
3420 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is
3421 # allowed.
3422 &quot;A String&quot;,
3423 ],
3424 }</pre>
3425 </div>
3426
3427 <div class="method">
3428 <code class="details" id="updateKmsKey">updateKmsKey(project, snapshot, body=None, requestId=None, x__xgafv=None)</code>
3429 <pre>Rotates the customer-managed
3430 encryption key to the latest version for the specified snapshot.
3431
3432 Args:
3433 project: string, Project ID for this request. (required)
3434 snapshot: string, Name of the snapshot resource to update. Should conform to RFC1035. (required)
3435 body: object, The request body.
3436 The object takes the form of:
3437
3438 {
3439 &quot;kmsKeyName&quot;: &quot;A String&quot;, # Optional. The new KMS key to replace the current one on the snapshot. If empty, the
3440 # snapshot will be re-encrypted using the primary version of the snapshot&#x27;s
3441 # current KMS key.
3442 #
3443 # The KMS key can be provided in the following formats:
3444 #
3445 #
3446 # - projects/project_id/locations/region/keyRings/key_ring/cryptoKeys/key
3447 }
3448
3449 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
3450 that if you must retry your request, the server will know to ignore the
3451 request if it has already been completed.
3452
3453 For example, consider a situation where you make an initial request and
3454 the request times out. If you make the request again with the same
3455 request ID, the server can check if original operation with the same
3456 request ID was received, and if so, will ignore the second request. This
3457 prevents clients from accidentally creating duplicate commitments.
3458
3459 The request ID must be
3460 a valid UUID with the exception that zero UUID is not supported
3461 (00000000-0000-0000-0000-000000000000).
3462 x__xgafv: string, V1 error format.
3463 Allowed values
3464 1 - v1 error format
3465 2 - v2 error format
3466
3467 Returns:
3468 An object of the form:
3469
3470 { # Represents an Operation resource.
3471 #
3472 # Google Compute Engine has three Operation resources:
3473 #
3474 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
3475 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
3476 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
3477 #
3478 # You can use an operation resource to manage asynchronous API requests.
3479 # For more information, readHandling
3480 # API responses.
3481 #
3482 # Operations can be global, regional or zonal.
3483 #
3484 # - For global operations, use the `globalOperations`
3485 # resource.
3486 # - For regional operations, use the
3487 # `regionOperations` resource.
3488 # - For zonal operations, use
3489 # the `zoneOperations` resource.
3490 #
3491 #
3492 #
3493 # For more information, read
3494 # Global, Regional, and Zonal Resources.
3495 #
3496 # Note that completed Operation resources have a limited
3497 # retention period.
3498 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
3499 # Not present otherwise.
3500 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
3501 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
3502 # set when the operation is created.
3503 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
3504 # text format.
3505 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
3506 # this field will be populated.
3507 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
3508 # operation.
3509 {
3510 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
3511 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
3512 # details. There is a set of defined message types to use for providing
3513 # details.The syntax depends on the error code. For example,
3514 # QuotaExceededInfo will have details when the error code is
3515 # QUOTA_EXCEEDED.
3516 {
3517 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
3518 #
3519 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
3520 # is not enabled:
3521 #
3522 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
3523 # &quot;domain&quot;: &quot;googleapis.com&quot;
3524 # &quot;metadata&quot;: {
3525 # &quot;resource&quot;: &quot;projects/123&quot;,
3526 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
3527 # }
3528 # }
3529 #
3530 # This response indicates that the pubsub.googleapis.com API is not enabled.
3531 #
3532 # Example of an error that is returned when attempting to create a Spanner
3533 # instance in a region that is out of stock:
3534 #
3535 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
3536 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
3537 # &quot;metadata&quot;: {
3538 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
3539 # }
3540 # }
3541 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
3542 # is typically the registered service name of the tool or product that
3543 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
3544 # generated by some common infrastructure, the error domain must be a
3545 # globally unique value that identifies the infrastructure. For Google API
3546 # infrastructure, the error domain is &quot;googleapis.com&quot;.
3547 &quot;metadatas&quot;: { # Additional structured details about this error.
3548 #
3549 # Keys must match a regular expression of `a-z+` but should
3550 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
3551 # length. When identifying the current value of an exceeded limit, the units
3552 # should be contained in the key, not the value. For example, rather than
3553 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
3554 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
3555 # instances that can be created in a single (batch) request.
3556 &quot;a_key&quot;: &quot;A String&quot;,
3557 },
3558 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
3559 # proximate cause of the error. Error reasons are unique within a particular
3560 # domain of errors. This should be at most 63 characters and match a
3561 # regular expression of `A-Z+[A-Z0-9]`, which represents
3562 # UPPER_SNAKE_CASE.
3563 },
3564 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
3565 #
3566 # For example, if a quota check failed with an error indicating the calling
3567 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
3568 # directly to the right place in the developer console to flip the bit.
3569 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
3570 { # Describes a URL link.
3571 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
3572 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
3573 },
3574 ],
3575 },
3576 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
3577 # which can be attached to an RPC error.
3578 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
3579 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
3580 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
3581 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
3582 },
3583 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
3584 &quot;dimensions&quot;: { # The map holding related quota dimensions.
3585 &quot;a_key&quot;: &quot;A String&quot;,
3586 },
3587 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
3588 # type or metric.
3589 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
3590 # or metric.
3591 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
3592 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
3593 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
3594 },
3595 },
3596 ],
3597 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
3598 # This property is optional.
3599 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
3600 },
3601 ],
3602 },
3603 &quot;getVersionOperationMetadata&quot;: {
3604 &quot;inlineSbomInfo&quot;: {
3605 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
3606 # appropriate identifiers.
3607 &quot;a_key&quot;: &quot;A String&quot;,
3608 },
3609 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
3610 # identifiers.
3611 &quot;a_key&quot;: &quot;A String&quot;,
3612 },
3613 },
3614 },
3615 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
3616 # message that was returned, such as `NOT FOUND`.
3617 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
3618 # status code that was returned. For example, a `404` means the
3619 # resource was not found.
3620 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
3621 # defined by the server.
3622 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
3623 # This value is inRFC3339
3624 # text format.
3625 &quot;instancesBulkInsertOperationMetadata&quot;: {
3626 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
3627 # Example key: zones/us-central1-a
3628 &quot;a_key&quot;: {
3629 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
3630 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
3631 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
3632 # error.
3633 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
3634 # if the flow is rolling forward or rolling back.
3635 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
3636 },
3637 },
3638 },
3639 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
3640 # Operation resources.
3641 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
3642 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
3643 # group of operations results from a `bulkInsert` API request.
3644 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
3645 # `update`, or `delete`, and so on.
3646 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
3647 # There is no requirement that this be linear or support any granularity of
3648 # operations. This should not be used to guess when the operation will be
3649 # complete. This number should monotonically increase as the operation
3650 # progresses.
3651 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
3652 # applicable when performing regional operations.
3653 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
3654 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
3655 # this field will contain information on all underlying zonal actions and
3656 # their state.
3657 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
3658 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
3659 # Example key: zones/us-central1-a
3660 &quot;a_key&quot;: {
3661 &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
3662 # populated.
3663 # different programming environments, including REST APIs and RPC APIs. It is
3664 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
3665 # three pieces of data: error code, error message, and error details.
3666 #
3667 # You can find out more about this error model and how to work with it in the
3668 # [API Design Guide](https://cloud.google.com/apis/design/errors).
3669 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
3670 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
3671 # message types for APIs to use.
3672 {
3673 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
3674 },
3675 ],
3676 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
3677 # user-facing error message should be localized and sent in the
3678 # google.rpc.Status.details field, or localized by the client.
3679 },
3680 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
3681 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
3682 },
3683 },
3684 },
3685 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
3686 # This value is inRFC3339
3687 # text format.
3688 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
3689 # following:
3690 # `PENDING`, `RUNNING`, or `DONE`.
3691 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
3692 # operation.
3693 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
3694 # of the target resource.
3695 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
3696 # operations related to creating a snapshot, this points to the disk
3697 # that the snapshot was created from.
3698 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
3699 # `[email protected]` or
3700 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
3701 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
3702 # operation, this field will be populated.
3703 {
3704 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
3705 # Engine returns NO_RESULTS_ON_PAGE if there
3706 # are no results in the response.
3707 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
3708 # value format. For example:
3709 #
3710 # &quot;data&quot;: [
3711 # {
3712 # &quot;key&quot;: &quot;scope&quot;,
3713 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
3714 # }
3715 {
3716 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
3717 # returned. For example, for warnings where there are no results in a list
3718 # request for a particular zone, this key might be scope and
3719 # the key value might be the zone name. Other examples might be a key
3720 # indicating a deprecated resource and a suggested replacement, or a
3721 # warning about invalid network settings (for example, if an instance
3722 # attempts to perform IP forwarding but is not enabled for IP forwarding).
3723 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
3724 },
3725 ],
3726 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
3727 },
3728 ],
3729 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
3730 # applicable when performing per-zone operations.
3731 }</pre>
3732 </div>
3733
3734 </body></html>