Debian Codegraph @

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