Debian Codegraph @

docs/dyn/compute_beta.regionSnapshots.html

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