Debian Codegraph @

docs/dyn/compute_alpha.regionRecoverableSnapshots.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.regionRecoverableSnapshots.html">regionRecoverableSnapshots</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, recoverableSnapshot, requestId=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Deletes the specified RecoverableSnapshot. Deleting a recoverable snapshot</p>
83 <p class="toc_element">
84 <code><a href="#get">get(project, region, recoverableSnapshot, x__xgafv=None)</a></code></p>
85 <p class="firstline">Returns the specified RecoverableSnapshot 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="#list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
91 <p class="firstline">Retrieves the list of RecoverableSnapshot resources contained within</p>
92 <p class="toc_element">
93 <code><a href="#list_next">list_next()</a></code></p>
94 <p class="firstline">Retrieves the next page of results.</p>
95 <p class="toc_element">
96 <code><a href="#recover">recover(project, region, recoverableSnapshot, requestId=None, snapshotName=None, x__xgafv=None)</a></code></p>
97 <p class="firstline">Recovers the specified RecoverableSnapshot.</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="#testIamPermissions">testIamPermissions(project, region, resource, body=None, x__xgafv=None)</a></code></p>
103 <p class="firstline">Returns permissions that a caller has on the specified resource.</p>
104 <h3>Method Details</h3>
105 <div class="method">
106 <code class="details" id="close">close()</code>
107 <pre>Close httplib2 connections.</pre>
108 </div>
109
110 <div class="method">
111 <code class="details" id="delete">delete(project, region, recoverableSnapshot, requestId=None, x__xgafv=None)</code>
112 <pre>Deletes the specified RecoverableSnapshot. Deleting a recoverable snapshot
113 will delete the underlying PD snapshot and is irreversible.
114
115 Args:
116 project: string, Project ID for this request. (required)
117 region: string, Name of the region for this request. (required)
118 recoverableSnapshot: string, Name of the recoverable Snapshot resource to delete. (required)
119 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
120 that if you must retry your request, the server will know to ignore the
121 request if it has already been completed.
122
123 For example, consider a situation where you make an initial request and
124 the request times out. If you make the request again with the same
125 request ID, the server can check if original operation with the same
126 request ID was received, and if so, will ignore the second request. This
127 prevents clients from accidentally creating duplicate commitments.
128
129 The request ID must be
130 a valid UUID with the exception that zero UUID is not supported
131 (00000000-0000-0000-0000-000000000000).
132 x__xgafv: string, V1 error format.
133 Allowed values
134 1 - v1 error format
135 2 - v2 error format
136
137 Returns:
138 An object of the form:
139
140 { # Represents an Operation resource.
141 #
142 # Google Compute Engine has three Operation resources:
143 #
144 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
145 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
146 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
147 #
148 # You can use an operation resource to manage asynchronous API requests.
149 # For more information, readHandling
150 # API responses.
151 #
152 # Operations can be global, regional or zonal.
153 #
154 # - For global operations, use the `globalOperations`
155 # resource.
156 # - For regional operations, use the
157 # `regionOperations` resource.
158 # - For zonal operations, use
159 # the `zoneOperations` resource.
160 #
161 #
162 #
163 # For more information, read
164 # Global, Regional, and Zonal Resources.
165 #
166 # Note that completed Operation resources have a limited
167 # retention period.
168 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
169 # Not present otherwise.
170 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
171 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
172 # set when the operation is created.
173 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
174 # text format.
175 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
176 # this field will be populated.
177 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
178 # operation.
179 {
180 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
181 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
182 # details. There is a set of defined message types to use for providing
183 # details.The syntax depends on the error code. For example,
184 # QuotaExceededInfo will have details when the error code is
185 # QUOTA_EXCEEDED.
186 {
187 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
188 #
189 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
190 # is not enabled:
191 #
192 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
193 # &quot;domain&quot;: &quot;googleapis.com&quot;
194 # &quot;metadata&quot;: {
195 # &quot;resource&quot;: &quot;projects/123&quot;,
196 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
197 # }
198 # }
199 #
200 # This response indicates that the pubsub.googleapis.com API is not enabled.
201 #
202 # Example of an error that is returned when attempting to create a Spanner
203 # instance in a region that is out of stock:
204 #
205 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
206 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
207 # &quot;metadata&quot;: {
208 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
209 # }
210 # }
211 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
212 # is typically the registered service name of the tool or product that
213 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
214 # generated by some common infrastructure, the error domain must be a
215 # globally unique value that identifies the infrastructure. For Google API
216 # infrastructure, the error domain is &quot;googleapis.com&quot;.
217 &quot;metadatas&quot;: { # Additional structured details about this error.
218 #
219 # Keys must match a regular expression of `a-z+` but should
220 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
221 # length. When identifying the current value of an exceeded limit, the units
222 # should be contained in the key, not the value. For example, rather than
223 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
224 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
225 # instances that can be created in a single (batch) request.
226 &quot;a_key&quot;: &quot;A String&quot;,
227 },
228 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
229 # proximate cause of the error. Error reasons are unique within a particular
230 # domain of errors. This should be at most 63 characters and match a
231 # regular expression of `A-Z+[A-Z0-9]`, which represents
232 # UPPER_SNAKE_CASE.
233 },
234 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
235 #
236 # For example, if a quota check failed with an error indicating the calling
237 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
238 # directly to the right place in the developer console to flip the bit.
239 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
240 { # Describes a URL link.
241 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
242 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
243 },
244 ],
245 },
246 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
247 # which can be attached to an RPC error.
248 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
249 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
250 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
251 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
252 },
253 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
254 &quot;dimensions&quot;: { # The map holding related quota dimensions.
255 &quot;a_key&quot;: &quot;A String&quot;,
256 },
257 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
258 # type or metric.
259 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
260 # or metric.
261 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
262 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
263 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
264 },
265 },
266 ],
267 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
268 # This property is optional.
269 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
270 },
271 ],
272 },
273 &quot;getVersionOperationMetadata&quot;: {
274 &quot;inlineSbomInfo&quot;: {
275 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
276 # appropriate identifiers.
277 &quot;a_key&quot;: &quot;A String&quot;,
278 },
279 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
280 # identifiers.
281 &quot;a_key&quot;: &quot;A String&quot;,
282 },
283 },
284 },
285 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
286 # message that was returned, such as `NOT FOUND`.
287 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
288 # status code that was returned. For example, a `404` means the
289 # resource was not found.
290 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
291 # defined by the server.
292 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
293 # This value is inRFC3339
294 # text format.
295 &quot;instancesBulkInsertOperationMetadata&quot;: {
296 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
297 # Example key: zones/us-central1-a
298 &quot;a_key&quot;: {
299 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
300 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
301 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
302 # error.
303 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
304 # if the flow is rolling forward or rolling back.
305 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
306 },
307 },
308 },
309 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
310 # Operation resources.
311 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
312 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
313 # group of operations results from a `bulkInsert` API request.
314 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
315 # `update`, or `delete`, and so on.
316 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
317 # There is no requirement that this be linear or support any granularity of
318 # operations. This should not be used to guess when the operation will be
319 # complete. This number should monotonically increase as the operation
320 # progresses.
321 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
322 # applicable when performing regional operations.
323 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
324 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
325 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
326 # this field will contain information on all underlying zonal actions and
327 # their state.
328 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
329 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
330 # Example key: zones/us-central1-a
331 &quot;a_key&quot;: {
332 &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
333 # populated.
334 # different programming environments, including REST APIs and RPC APIs. It is
335 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
336 # three pieces of data: error code, error message, and error details.
337 #
338 # You can find out more about this error model and how to work with it in the
339 # [API Design Guide](https://cloud.google.com/apis/design/errors).
340 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
341 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
342 # message types for APIs to use.
343 {
344 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
345 },
346 ],
347 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
348 # user-facing error message should be localized and sent in the
349 # google.rpc.Status.details field, or localized by the client.
350 },
351 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
352 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
353 },
354 },
355 },
356 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
357 # This value is inRFC3339
358 # text format.
359 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
360 # following:
361 # `PENDING`, `RUNNING`, or `DONE`.
362 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
363 # operation.
364 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
365 # of the target resource.
366 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
367 # operations related to creating a snapshot, this points to the disk
368 # that the snapshot was created from.
369 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
370 # `[email protected]` or
371 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
372 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
373 # operation, this field will be populated.
374 {
375 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
376 # Engine returns NO_RESULTS_ON_PAGE if there
377 # are no results in the response.
378 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
379 # value format. For example:
380 #
381 # &quot;data&quot;: [
382 # {
383 # &quot;key&quot;: &quot;scope&quot;,
384 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
385 # }
386 {
387 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
388 # returned. For example, for warnings where there are no results in a list
389 # request for a particular zone, this key might be scope and
390 # the key value might be the zone name. Other examples might be a key
391 # indicating a deprecated resource and a suggested replacement, or a
392 # warning about invalid network settings (for example, if an instance
393 # attempts to perform IP forwarding but is not enabled for IP forwarding).
394 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
395 },
396 ],
397 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
398 },
399 ],
400 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
401 # applicable when performing per-zone operations.
402 }</pre>
403 </div>
404
405 <div class="method">
406 <code class="details" id="get">get(project, region, recoverableSnapshot, x__xgafv=None)</code>
407 <pre>Returns the specified RecoverableSnapshot resource.
408
409 Args:
410 project: string, Project ID for this request. (required)
411 region: string, Name of the region for this request. (required)
412 recoverableSnapshot: string, Name of the Snapshot resource to return. (required)
413 x__xgafv: string, V1 error format.
414 Allowed values
415 1 - v1 error format
416 2 - v2 error format
417
418 Returns:
419 An object of the form:
420
421 { # Represents a RecoverableSnapshot resource.
422 #
423 # A RecoverableSnapshot represents a snapshot in recycle bin.
424 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
425 # text format.
426 &quot;description&quot;: &quot;A String&quot;, # Optional. An optional description of this resource.
427 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
428 # defined by the server.
429 &quot;kind&quot;: &quot;compute#recoverableSnapshot&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#recoverableSnapshot for RecoverableSnapshot
430 # resources.
431 &quot;name&quot;: &quot;A String&quot;, # Output only. Identifier. Name of the recoverable snapshot generated on the deletion of the snapshot.
432 # The name will be 1-63 characters long, and comply withRFC1035.
433 # Specifically, the name will be 1-63 characters long and match the regular
434 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
435 # character will be a lowercase letter, and all following characters can be
436 # a dash, lowercase letter, or digit, except the last character, which cannot
437 # be a dash.
438 &quot;originalResource&quot;: { # Output only. Output Only] The original snapshot resource.
439 &quot;architecture&quot;: &quot;A String&quot;, # Output only. [Output Only] The architecture of the snapshot. Valid values are
440 # ARM64 or X86_64.
441 &quot;autoCreated&quot;: True or False, # Output only. [Output Only] Set to true if snapshots are automatically created by
442 # applying resource policy on the target disk.
443 &quot;chainName&quot;: &quot;A String&quot;, # Creates the new snapshot in the snapshot chain labeled with the
444 # specified name. The chain name must be 1-63 characters long and comply
445 # with RFC1035. This is an uncommon option only for advanced service
446 # owners who needs to create separate snapshot chains, for example,
447 # for chargeback tracking. When you describe your snapshot resource, this
448 # field is visible only if it has a non-empty value.
449 &quot;creationSizeBytes&quot;: &quot;A String&quot;, # Output only. [Output Only] Size in bytes of the snapshot at creation time.
450 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339 text format.
451 &quot;deletionTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Purge timestamp of recoverable snapshot inRFC3339 text format.
452 &quot;description&quot;: &quot;A String&quot;, # An optional description of this 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;guestOsFeatures&quot;: [ # Output only. [Output Only] A list of features to enable on the guest operating system.
458 # Applicable only for bootable images. Read
459 # Enabling guest operating system features to see a list of available
460 # options.
461 { # Guest OS features.
462 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
463 # separate values. Set to one or more of the following values:
464 #
465 # - VIRTIO_SCSI_MULTIQUEUE
466 # - WINDOWS
467 # - MULTI_IP_SUBNET
468 # - UEFI_COMPATIBLE
469 # - GVNIC
470 # - SEV_CAPABLE
471 # - SUSPEND_RESUME_COMPATIBLE
472 # - SEV_LIVE_MIGRATABLE_V2
473 # - SEV_SNP_CAPABLE
474 # - TDX_CAPABLE
475 # - IDPF
476 # - SNP_SVSM_CAPABLE
477 # - CCA_CAPABLE
478 #
479 #
480 # For more information, see
481 # Enabling guest operating system features.
482 },
483 ],
484 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the original snapshot. This
485 # identifier is defined by the server.
486 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for the labels being applied to this snapshot, which is
487 # essentially a hash of the labels set used for optimistic locking. The
488 # fingerprint is initially generated by Compute Engine and changes after
489 # every request to modify or update labels. You must always provide an
490 # up-to-date fingerprint hash in order to update or change labels,
491 # otherwise the request will fail with error412 conditionNotMet.
492 #
493 # To see the latest fingerprint, make a get() request to
494 # retrieve a snapshot.
495 &quot;labels&quot;: { # Labels to apply to this snapshot. These can be later modified by
496 # the setLabels method.
497 # Label values may be empty.
498 &quot;a_key&quot;: &quot;A String&quot;,
499 },
500 &quot;licenseCodes&quot;: [ # Output only. [Output Only] Integer license codes indicating which licenses are
501 # attached to this snapshot.
502 &quot;A String&quot;,
503 ],
504 &quot;licenses&quot;: [ # Output only. [Output Only] A list of public visible licenses that apply to this
505 # snapshot.
506 &quot;A String&quot;,
507 ],
508 &quot;maxRetentionDays&quot;: 42, # Number of days the snapshot should be retained before being deleted
509 # automatically.
510 &quot;name&quot;: &quot;A String&quot;, # Name of the original snapshot provided by the client. The name must be
511 # 1-63 characters long, and comply with RFC1035.
512 # Specifically, the name must be 1-63 characters long and match the regular
513 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
514 # character must be a lowercase letter, and all following characters must
515 # be a dash, lowercase letter, or digit, except the last character, which
516 # cannot be a dash.
517 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the snapshot resides. Only
518 # applicable for regional snapshots.
519 &quot;satisfiesPzi&quot;: True or False, # Output only. Reserved for future use.
520 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
521 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
522 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource&#x27;s resource id.
523 &quot;snapshotEncryptionKey&quot;: { # Encrypts the snapshot using acustomer-supplied
524 # encryption key.
525 #
526 # After you encrypt a snapshot using a customer-supplied key, you must
527 # provide the same key if you use the snapshot later. For example, you must
528 # provide the encryption key when you create a disk from the encrypted
529 # snapshot in a future request.
530 #
531 # Customer-supplied encryption keys do not protect access to metadata
532 # of the snapshot.
533 #
534 # If you do not provide an encryption key when creating the snapshot, then
535 # the snapshot will be encrypted using an automatically generated key and
536 # you do not need to provide a key to use the snapshot later.
537 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
538 # For example:
539 #
540 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
541 # key_region/cryptoKeys/key
542 #
543 # The fully-qualifed key name may be returned for resource GET requests. For
544 # example:
545 #
546 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
547 # key_region/cryptoKeys/key
548 # /cryptoKeyVersions/1
549 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
550 # key. If absent, the Compute Engine default service account is used.
551 # For example:
552 #
553 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
554 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
555 # encryption key, encoded in RFC
556 # 4648 base64 to either encrypt or decrypt this resource. You can
557 # provide either the rawKey or thersaEncryptedKey.
558 # For example:
559 #
560 # &quot;rawKey&quot;:
561 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
562 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
563 # customer-supplied encryption key to either encrypt or decrypt this
564 # resource. You can provide either the rawKey or thersaEncryptedKey.
565 # For example:
566 #
567 # &quot;rsaEncryptedKey&quot;:
568 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
569 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
570 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
571 #
572 # The key must meet the following requirements before you can provide it to
573 # Compute Engine:
574 #
575 # 1. The key is wrapped using a RSA public key certificate provided by
576 # Google.
577 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
578 # encoding.
579 #
580 # Gets the RSA public key certificate provided by Google at:
581 #
582 #
583 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
584 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
585 # 4648 base64 encoded SHA-256 hash of the customer-supplied
586 # encryption key that protects this resource.
587 },
588 &quot;snapshotGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the snapshot group that this snapshot
589 # belongs to. The usage of snapshot group feature is restricted.
590 &quot;snapshotGroupName&quot;: &quot;A String&quot;, # Output only. [Output only] The snapshot group that this snapshot belongs to. The usage
591 # of snapshot group feature is restricted.
592 &quot;snapshotType&quot;: &quot;A String&quot;, # Indicates the type of the snapshot.
593 &quot;sourceDisk&quot;: &quot;A String&quot;, # The source disk used to create this snapshot.
594 &quot;sourceDiskEncryptionKey&quot;: { # The customer-supplied
595 # encryption key of the source disk. Required if the source disk is
596 # protected by a customer-supplied encryption key.
597 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
598 # For example:
599 #
600 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
601 # key_region/cryptoKeys/key
602 #
603 # The fully-qualifed key name may be returned for resource GET requests. For
604 # example:
605 #
606 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
607 # key_region/cryptoKeys/key
608 # /cryptoKeyVersions/1
609 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
610 # key. If absent, the Compute Engine default service account is used.
611 # For example:
612 #
613 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
614 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
615 # encryption key, encoded in RFC
616 # 4648 base64 to either encrypt or decrypt this resource. You can
617 # provide either the rawKey or thersaEncryptedKey.
618 # For example:
619 #
620 # &quot;rawKey&quot;:
621 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
622 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
623 # customer-supplied encryption key to either encrypt or decrypt this
624 # resource. You can provide either the rawKey or thersaEncryptedKey.
625 # For example:
626 #
627 # &quot;rsaEncryptedKey&quot;:
628 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
629 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
630 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
631 #
632 # The key must meet the following requirements before you can provide it to
633 # Compute Engine:
634 #
635 # 1. The key is wrapped using a RSA public key certificate provided by
636 # Google.
637 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
638 # encoding.
639 #
640 # Gets the RSA public key certificate provided by Google at:
641 #
642 #
643 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
644 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
645 # 4648 base64 encoded SHA-256 hash of the customer-supplied
646 # encryption key that protects this resource.
647 },
648 &quot;sourceDiskForRecoveryCheckpoint&quot;: &quot;A String&quot;, # The source disk whose recovery checkpoint will be used to create this
649 # snapshot.
650 &quot;sourceDiskId&quot;: &quot;A String&quot;, # Output only. [Output Only] The ID value of the disk used to create this snapshot
651 &quot;sourceInstantSnapshot&quot;: &quot;A String&quot;, # The source instant snapshot used to create this snapshot.
652 &quot;sourceInstantSnapshotEncryptionKey&quot;: { # Customer provided encryption key when creating Snapshot from Instant
653 # Snapshot.
654 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
655 # For example:
656 #
657 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
658 # key_region/cryptoKeys/key
659 #
660 # The fully-qualifed key name may be returned for resource GET requests. For
661 # example:
662 #
663 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
664 # key_region/cryptoKeys/key
665 # /cryptoKeyVersions/1
666 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
667 # key. If absent, the Compute Engine default service account is used.
668 # For example:
669 #
670 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
671 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
672 # encryption key, encoded in RFC
673 # 4648 base64 to either encrypt or decrypt this resource. You can
674 # provide either the rawKey or thersaEncryptedKey.
675 # For example:
676 #
677 # &quot;rawKey&quot;:
678 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
679 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
680 # customer-supplied encryption key to either encrypt or decrypt this
681 # resource. You can provide either the rawKey or thersaEncryptedKey.
682 # For example:
683 #
684 # &quot;rsaEncryptedKey&quot;:
685 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
686 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
687 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
688 #
689 # The key must meet the following requirements before you can provide it to
690 # Compute Engine:
691 #
692 # 1. The key is wrapped using a RSA public key certificate provided by
693 # Google.
694 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
695 # encoding.
696 #
697 # Gets the RSA public key certificate provided by Google at:
698 #
699 #
700 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
701 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
702 # 4648 base64 encoded SHA-256 hash of the customer-supplied
703 # encryption key that protects this resource.
704 },
705 &quot;sourceInstantSnapshotId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the instant snapshot used to create this
706 # snapshot. This value identifies the exact instant snapshot that was used
707 # to create this persistent disk. For example, if you created the
708 # persistent disk from an instant snapshot that was later deleted and
709 # recreated under the same name, the source instant snapshot ID would
710 # identify the exact instant snapshot that was used.
711 &quot;sourceSnapshotSchedulePolicy&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the resource policy which created this
712 # scheduled snapshot.
713 &quot;sourceSnapshotSchedulePolicyId&quot;: &quot;A String&quot;, # Output only. [Output Only] ID of the resource policy which created this
714 # scheduled snapshot.
715 &quot;storageBytes&quot;: &quot;A String&quot;, # Output only. [Output Only] A size of the storage used by the snapshot.
716 &quot;storageBytesStatus&quot;: &quot;A String&quot;, # Output only. [Deprecated] Instead, check the storageBytes field. After
717 # snapshot creation, the storageBytesStatus field is alwaysUP_TO_DATE.
718 # [Output Only] An indicator whether storageBytes is in a
719 # stable state or it is being adjusted as a result of shared storage
720 # reallocation. This status can either be unset, meaning the snapshot is
721 # being created, or UP_TO_DATE, meaning the size of the
722 # snapshot is up-to-date.
723 &quot;storageLocations&quot;: [ # Cloud Storage bucket storage location of the snapshot (regional or
724 # multi-regional).
725 &quot;A String&quot;,
726 ],
727 },
728 &quot;purgeTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Purge timestamp of recoverable snapshot inRFC3339
729 # text format.
730 &quot;satisfiesPzi&quot;: True or False, # Output only. [Output Only] Reserved for future use.
731 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
732 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
733 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource&#x27;s resource id.
734 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only] Status of the recoverable snapshot.
735 }</pre>
736 </div>
737
738 <div class="method">
739 <code class="details" id="getIamPolicy">getIamPolicy(project, region, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</code>
740 <pre>Gets the access control policy for a resource. May be empty if no such
741 policy or resource exists.
742
743 Args:
744 project: string, Project ID for this request. (required)
745 region: string, The name of the region for this request. (required)
746 resource: string, Name or id of the resource for this request. (required)
747 optionsRequestedPolicyVersion: integer, Requested IAM Policy version.
748 x__xgafv: string, V1 error format.
749 Allowed values
750 1 - v1 error format
751 2 - v2 error format
752
753 Returns:
754 An object of the form:
755
756 { # An Identity and Access Management (IAM) policy, which specifies access
757 # controls for Google Cloud resources.
758 #
759 #
760 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
761 # `members`, or principals, to a single `role`. Principals can be user
762 # accounts, service accounts, Google groups, and domains (such as G Suite). A
763 # `role` is a named list of permissions; each `role` can be an IAM predefined
764 # role or a user-created custom role.
765 #
766 # For some types of Google Cloud resources, a `binding` can also specify a
767 # `condition`, which is a logical expression that allows access to a resource
768 # only if the expression evaluates to `true`. A condition can add constraints
769 # based on attributes of the request, the resource, or both. To learn which
770 # resources support conditions in their IAM policies, see the
771 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
772 #
773 # **JSON example:**
774 #
775 # ```
776 # {
777 # &quot;bindings&quot;: [
778 # {
779 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
780 # &quot;members&quot;: [
781 # &quot;user:[email protected]&quot;,
782 # &quot;group:[email protected]&quot;,
783 # &quot;domain:google.com&quot;,
784 # &quot;serviceAccount:[email protected]&quot;
785 # ]
786 # },
787 # {
788 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
789 # &quot;members&quot;: [
790 # &quot;user:[email protected]&quot;
791 # ],
792 # &quot;condition&quot;: {
793 # &quot;title&quot;: &quot;expirable access&quot;,
794 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
795 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
796 # }
797 # }
798 # ],
799 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
800 # &quot;version&quot;: 3
801 # }
802 # ```
803 #
804 # **YAML example:**
805 #
806 # ```
807 # bindings:
808 # - members:
809 # - user:[email protected]
810 # - group:[email protected]
811 # - domain:google.com
812 # - serviceAccount:[email protected]
813 # role: roles/resourcemanager.organizationAdmin
814 # - members:
815 # - user:[email protected]
816 # role: roles/resourcemanager.organizationViewer
817 # condition:
818 # title: expirable access
819 # description: Does not grant access after Sep 2020
820 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
821 # etag: BwWWja0YfJA=
822 # version: 3
823 # ```
824 #
825 # For a description of IAM and its features, see the
826 # [IAM documentation](https://cloud.google.com/iam/docs/).
827 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
828 { # Specifies the audit configuration for a service.
829 # The configuration determines which permission types are logged, and what
830 # identities, if any, are exempted from logging.
831 # An AuditConfig must have one or more AuditLogConfigs.
832 #
833 # If there are AuditConfigs for both `allServices` and a specific service,
834 # the union of the two AuditConfigs is used for that service: the log_types
835 # specified in each AuditConfig are enabled, and the exempted_members in each
836 # AuditLogConfig are exempted.
837 #
838 # Example Policy with multiple AuditConfigs:
839 #
840 # {
841 # &quot;audit_configs&quot;: [
842 # {
843 # &quot;service&quot;: &quot;allServices&quot;,
844 # &quot;audit_log_configs&quot;: [
845 # {
846 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
847 # &quot;exempted_members&quot;: [
848 # &quot;user:[email protected]&quot;
849 # ]
850 # },
851 # {
852 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
853 # },
854 # {
855 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
856 # }
857 # ]
858 # },
859 # {
860 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
861 # &quot;audit_log_configs&quot;: [
862 # {
863 # &quot;log_type&quot;: &quot;DATA_READ&quot;
864 # },
865 # {
866 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
867 # &quot;exempted_members&quot;: [
868 # &quot;user:[email protected]&quot;
869 # ]
870 # }
871 # ]
872 # }
873 # ]
874 # }
875 #
876 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
877 # logging. It also exempts `[email protected]` from DATA_READ logging, and
878 # `[email protected]` from DATA_WRITE logging.
879 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
880 { # Provides the configuration for logging a type of permissions.
881 # Example:
882 #
883 # {
884 # &quot;audit_log_configs&quot;: [
885 # {
886 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
887 # &quot;exempted_members&quot;: [
888 # &quot;user:[email protected]&quot;
889 # ]
890 # },
891 # {
892 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
893 # }
894 # ]
895 # }
896 #
897 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
898 # [email protected] from DATA_READ logging.
899 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
900 # permission.
901 # Follows the same format of Binding.members.
902 &quot;A String&quot;,
903 ],
904 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
905 },
906 ],
907 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
908 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
909 # `allServices` is a special value that covers all services.
910 },
911 ],
912 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
913 # may specify a `condition` that determines how and when the `bindings` are
914 # applied. Each of the `bindings` must contain at least one principal.
915 #
916 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
917 # of these principals can be Google groups. Each occurrence of a principal
918 # counts towards these limits. For example, if the `bindings` grant 50
919 # different roles to `user:[email protected]`, and not to any other
920 # principal, then you can add another 1,450 principals to the `bindings` in
921 # the `Policy`.
922 { # Associates `members`, or principals, with a `role`.
923 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
924 #
925 # If the condition evaluates to `true`, then this binding applies to the
926 # current request.
927 #
928 # If the condition evaluates to `false`, then this binding does not apply to
929 # the current request. However, a different role binding might grant the same
930 # role to one or more of the principals in this binding.
931 #
932 # To learn which resources support conditions in their IAM policies, see the
933 # [IAM
934 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
935 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
936 # are documented at https://github.com/google/cel-spec.
937 #
938 # Example (Comparison):
939 #
940 # title: &quot;Summary size limit&quot;
941 # description: &quot;Determines if a summary is less than 100 chars&quot;
942 # expression: &quot;document.summary.size() &lt; 100&quot;
943 #
944 # Example (Equality):
945 #
946 # title: &quot;Requestor is owner&quot;
947 # description: &quot;Determines if requestor is the document owner&quot;
948 # expression: &quot;document.owner == request.auth.claims.email&quot;
949 #
950 # Example (Logic):
951 #
952 # title: &quot;Public documents&quot;
953 # description: &quot;Determine whether the document should be publicly visible&quot;
954 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
955 #
956 # Example (Data Manipulation):
957 #
958 # title: &quot;Notification string&quot;
959 # description: &quot;Create a notification string with a timestamp.&quot;
960 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
961 #
962 # The exact variables and functions that may be referenced within an expression
963 # are determined by the service that evaluates it. See the service
964 # documentation for additional information.
965 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
966 # describes the expression, e.g. when hovered over it in a UI.
967 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
968 # syntax.
969 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
970 # reporting, e.g. a file name and a position in the file.
971 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
972 # its purpose. This can be used e.g. in UIs which allow to enter the
973 # expression.
974 },
975 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
976 # `members` can have the following values:
977 #
978 # * `allUsers`: A special identifier that represents anyone who is
979 # on the internet; with or without a Google account.
980 #
981 # * `allAuthenticatedUsers`: A special identifier that represents anyone
982 # who is authenticated with a Google account or a service account.
983 # Does not include identities that come from external identity providers
984 # (IdPs) through identity federation.
985 #
986 # * `user:{emailid}`: An email address that represents a specific Google
987 # account. For example, `[email protected]` .
988 #
989 #
990 # * `serviceAccount:{emailid}`: An email address that represents a Google
991 # service account. For example,
992 # `[email protected]`.
993 #
994 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
995 # identifier for a
996 # [Kubernetes service
997 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
998 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
999 #
1000 # * `group:{emailid}`: An email address that represents a Google group.
1001 # For example, `[email protected]`.
1002 #
1003 #
1004 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
1005 # users of that domain. For example, `google.com` or `example.com`.
1006 #
1007 #
1008 #
1009 #
1010 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
1011 # A single identity in a workforce identity pool.
1012 #
1013 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
1014 # All workforce identities in a group.
1015 #
1016 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
1017 # All workforce identities with a specific attribute value.
1018 #
1019 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
1020 # All identities in a workforce identity pool.
1021 #
1022 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
1023 # A single identity in a workload identity pool.
1024 #
1025 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
1026 # A workload identity pool group.
1027 #
1028 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
1029 # All identities in a workload identity pool with a certain attribute.
1030 #
1031 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
1032 # All identities in a workload identity pool.
1033 #
1034 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
1035 # identifier) representing a user that has been recently deleted. For
1036 # example, `[email protected]?uid=123456789012345678901`. If the user is
1037 # recovered, this value reverts to `user:{emailid}` and the recovered user
1038 # retains the role in the binding.
1039 #
1040 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
1041 # unique identifier) representing a service account that has been recently
1042 # deleted. For example,
1043 # `[email protected]?uid=123456789012345678901`.
1044 # If the service account is undeleted, this value reverts to
1045 # `serviceAccount:{emailid}` and the undeleted service account retains the
1046 # role in the binding.
1047 #
1048 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
1049 # identifier) representing a Google group that has been recently
1050 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
1051 # the group is recovered, this value reverts to `group:{emailid}` and the
1052 # recovered group retains the role in the binding.
1053 #
1054 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
1055 # Deleted single identity in a workforce identity pool. For example,
1056 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
1057 &quot;A String&quot;,
1058 ],
1059 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
1060 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
1061 #
1062 # For an overview of the IAM roles and permissions, see the
1063 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
1064 # a list of the available pre-defined roles, see
1065 # [here](https://cloud.google.com/iam/docs/understanding-roles).
1066 },
1067 ],
1068 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
1069 # prevent simultaneous updates of a policy from overwriting each other.
1070 # It is strongly suggested that systems make use of the `etag` in the
1071 # read-modify-write cycle to perform policy updates in order to avoid race
1072 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
1073 # systems are expected to put that etag in the request to `setIamPolicy` to
1074 # ensure that their change will be applied to the same version of the policy.
1075 #
1076 # **Important:** If you use IAM Conditions, you must include the `etag` field
1077 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
1078 # you to overwrite a version `3` policy with a version `1` policy, and all of
1079 # the conditions in the version `3` policy are lost.
1080 &quot;version&quot;: 42, # Specifies the format of the policy.
1081 #
1082 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
1083 # are rejected.
1084 #
1085 # Any operation that affects conditional role bindings must specify version
1086 # `3`. This requirement applies to the following operations:
1087 #
1088 # * Getting a policy that includes a conditional role binding
1089 # * Adding a conditional role binding to a policy
1090 # * Changing a conditional role binding in a policy
1091 # * Removing any role binding, with or without a condition, from a policy
1092 # that includes conditions
1093 #
1094 # **Important:** If you use IAM Conditions, you must include the `etag` field
1095 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
1096 # you to overwrite a version `3` policy with a version `1` policy, and all of
1097 # the conditions in the version `3` policy are lost.
1098 #
1099 # If a policy does not include any conditions, operations on that policy may
1100 # specify any valid version or leave the field unset.
1101 #
1102 # To learn which resources support conditions in their IAM policies, see the
1103 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
1104 }</pre>
1105 </div>
1106
1107 <div class="method">
1108 <code class="details" id="list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
1109 <pre>Retrieves the list of RecoverableSnapshot resources contained within
1110 the specified region.
1111
1112 Args:
1113 project: string, Project ID for this request. (required)
1114 region: string, Name of the region for this request. (required)
1115 filter: string, A filter expression that filters resources listed in the response. Most
1116 Compute resources support two types of filter expressions:
1117 expressions that support regular expressions and expressions that follow
1118 API improvement proposal AIP-160.
1119 These two types of filter expressions cannot be mixed in one request.
1120
1121 If you want to use AIP-160, your expression must specify the field name, an
1122 operator, and the value that you want to use for filtering. The value
1123 must be a string, a number, or a boolean. The operator
1124 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
1125
1126 For example, if you are filtering Compute Engine instances, you can
1127 exclude instances named `example-instance` by specifying
1128 `name != example-instance`.
1129
1130 The `:*` comparison can be used to test whether a key has been defined.
1131 For example, to find all objects with `owner` label use:
1132 ```
1133 labels.owner:*
1134 ```
1135
1136 You can also filter nested fields. For example, you could specify
1137 `scheduling.automaticRestart = false` to include instances only
1138 if they are not scheduled for automatic restarts. You can use filtering
1139 on nested fields to filter based onresource labels.
1140
1141 To filter on multiple expressions, provide each separate expression within
1142 parentheses. For example:
1143 ```
1144 (scheduling.automaticRestart = true)
1145 (cpuPlatform = &quot;Intel Skylake&quot;)
1146 ```
1147 By default, each expression is an `AND` expression. However, you
1148 can include `AND` and `OR` expressions explicitly.
1149 For example:
1150 ```
1151 (cpuPlatform = &quot;Intel Skylake&quot;) OR
1152 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
1153 (scheduling.automaticRestart = true)
1154 ```
1155
1156 If you want to use a regular expression, use the `eq` (equal) or `ne`
1157 (not equal) operator against a single un-parenthesized expression with or
1158 without quotes or against multiple parenthesized expressions. Examples:
1159
1160 `fieldname eq unquoted literal`
1161 `fieldname eq &#x27;single quoted literal&#x27;`
1162 `fieldname eq &quot;double quoted literal&quot;`
1163 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
1164
1165 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
1166 The literal value must match the entire field.
1167
1168 For example, to filter for instances that do not end with name &quot;instance&quot;,
1169 you would use `name ne .*instance`.
1170
1171 You cannot combine constraints on multiple fields using regular
1172 expressions.
1173 maxResults: integer, The maximum number of results per page that should be returned.
1174 If the number of available results is larger than `maxResults`,
1175 Compute Engine returns a `nextPageToken` that can be used to get
1176 the next page of results in subsequent list requests. Acceptable values are
1177 `0` to `500`, inclusive. (Default: `500`)
1178 orderBy: string, Sorts list results by a certain order. By default, results
1179 are returned in alphanumerical order based on the resource name.
1180
1181 You can also sort results in descending order based on the creation
1182 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
1183 results based on the `creationTimestamp` field in
1184 reverse chronological order (newest result first). Use this to sort
1185 resources like operations so that the newest operation is returned first.
1186
1187 Currently, only sorting by `name` or
1188 `creationTimestamp desc` is supported.
1189 pageToken: string, Specifies a page token to use. Set `pageToken` to the
1190 `nextPageToken` returned by a previous list request to get
1191 the next page of results.
1192 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
1193 of failure. The default value is false.
1194
1195 For example, when partial success behavior is enabled, aggregatedList for a
1196 single zone scope either returns all resources in the zone or no resources,
1197 with an error code.
1198 x__xgafv: string, V1 error format.
1199 Allowed values
1200 1 - v1 error format
1201 2 - v2 error format
1202
1203 Returns:
1204 An object of the form:
1205
1206 {
1207 &quot;etag&quot;: &quot;A String&quot;,
1208 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
1209 &quot;items&quot;: [ # A list of RecoverableSnapshots resources.
1210 { # Represents a RecoverableSnapshot resource.
1211 #
1212 # A RecoverableSnapshot represents a snapshot in recycle bin.
1213 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
1214 # text format.
1215 &quot;description&quot;: &quot;A String&quot;, # Optional. An optional description of this resource.
1216 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
1217 # defined by the server.
1218 &quot;kind&quot;: &quot;compute#recoverableSnapshot&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#recoverableSnapshot for RecoverableSnapshot
1219 # resources.
1220 &quot;name&quot;: &quot;A String&quot;, # Output only. Identifier. Name of the recoverable snapshot generated on the deletion of the snapshot.
1221 # The name will be 1-63 characters long, and comply withRFC1035.
1222 # Specifically, the name will be 1-63 characters long and match the regular
1223 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
1224 # character will be a lowercase letter, and all following characters can be
1225 # a dash, lowercase letter, or digit, except the last character, which cannot
1226 # be a dash.
1227 &quot;originalResource&quot;: { # Output only. Output Only] The original snapshot resource.
1228 &quot;architecture&quot;: &quot;A String&quot;, # Output only. [Output Only] The architecture of the snapshot. Valid values are
1229 # ARM64 or X86_64.
1230 &quot;autoCreated&quot;: True or False, # Output only. [Output Only] Set to true if snapshots are automatically created by
1231 # applying resource policy on the target disk.
1232 &quot;chainName&quot;: &quot;A String&quot;, # Creates the new snapshot in the snapshot chain labeled with the
1233 # specified name. The chain name must be 1-63 characters long and comply
1234 # with RFC1035. This is an uncommon option only for advanced service
1235 # owners who needs to create separate snapshot chains, for example,
1236 # for chargeback tracking. When you describe your snapshot resource, this
1237 # field is visible only if it has a non-empty value.
1238 &quot;creationSizeBytes&quot;: &quot;A String&quot;, # Output only. [Output Only] Size in bytes of the snapshot at creation time.
1239 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339 text format.
1240 &quot;deletionTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Purge timestamp of recoverable snapshot inRFC3339 text format.
1241 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource.
1242 &quot;diskSizeGb&quot;: &quot;A String&quot;, # Output only. [Output Only] Size of the source disk, specified in GB.
1243 &quot;downloadBytes&quot;: &quot;A String&quot;, # Output only. [Output Only] Number of bytes downloaded to restore a snapshot to a disk.
1244 &quot;enableConfidentialCompute&quot;: True or False, # Output only. Whether this snapshot is created from a confidential compute mode disk.
1245 # [Output Only]: This field is not set by user, but from source disk.
1246 &quot;guestOsFeatures&quot;: [ # Output only. [Output Only] A list of features to enable on the guest operating system.
1247 # Applicable only for bootable images. Read
1248 # Enabling guest operating system features to see a list of available
1249 # options.
1250 { # Guest OS features.
1251 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
1252 # separate values. Set to one or more of the following values:
1253 #
1254 # - VIRTIO_SCSI_MULTIQUEUE
1255 # - WINDOWS
1256 # - MULTI_IP_SUBNET
1257 # - UEFI_COMPATIBLE
1258 # - GVNIC
1259 # - SEV_CAPABLE
1260 # - SUSPEND_RESUME_COMPATIBLE
1261 # - SEV_LIVE_MIGRATABLE_V2
1262 # - SEV_SNP_CAPABLE
1263 # - TDX_CAPABLE
1264 # - IDPF
1265 # - SNP_SVSM_CAPABLE
1266 # - CCA_CAPABLE
1267 #
1268 #
1269 # For more information, see
1270 # Enabling guest operating system features.
1271 },
1272 ],
1273 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the original snapshot. This
1274 # identifier is defined by the server.
1275 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for the labels being applied to this snapshot, which is
1276 # essentially a hash of the labels set used for optimistic locking. The
1277 # fingerprint is initially generated by Compute Engine and changes after
1278 # every request to modify or update labels. You must always provide an
1279 # up-to-date fingerprint hash in order to update or change labels,
1280 # otherwise the request will fail with error412 conditionNotMet.
1281 #
1282 # To see the latest fingerprint, make a get() request to
1283 # retrieve a snapshot.
1284 &quot;labels&quot;: { # Labels to apply to this snapshot. These can be later modified by
1285 # the setLabels method.
1286 # Label values may be empty.
1287 &quot;a_key&quot;: &quot;A String&quot;,
1288 },
1289 &quot;licenseCodes&quot;: [ # Output only. [Output Only] Integer license codes indicating which licenses are
1290 # attached to this snapshot.
1291 &quot;A String&quot;,
1292 ],
1293 &quot;licenses&quot;: [ # Output only. [Output Only] A list of public visible licenses that apply to this
1294 # snapshot.
1295 &quot;A String&quot;,
1296 ],
1297 &quot;maxRetentionDays&quot;: 42, # Number of days the snapshot should be retained before being deleted
1298 # automatically.
1299 &quot;name&quot;: &quot;A String&quot;, # Name of the original snapshot provided by the client. The name must be
1300 # 1-63 characters long, and comply with RFC1035.
1301 # Specifically, the name must be 1-63 characters long and match the regular
1302 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
1303 # character must be a lowercase letter, and all following characters must
1304 # be a dash, lowercase letter, or digit, except the last character, which
1305 # cannot be a dash.
1306 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the snapshot resides. Only
1307 # applicable for regional snapshots.
1308 &quot;satisfiesPzi&quot;: True or False, # Output only. Reserved for future use.
1309 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
1310 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
1311 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource&#x27;s resource id.
1312 &quot;snapshotEncryptionKey&quot;: { # Encrypts the snapshot using acustomer-supplied
1313 # encryption key.
1314 #
1315 # After you encrypt a snapshot using a customer-supplied key, you must
1316 # provide the same key if you use the snapshot later. For example, you must
1317 # provide the encryption key when you create a disk from the encrypted
1318 # snapshot in a future request.
1319 #
1320 # Customer-supplied encryption keys do not protect access to metadata
1321 # of the snapshot.
1322 #
1323 # If you do not provide an encryption key when creating the snapshot, then
1324 # the snapshot will be encrypted using an automatically generated key and
1325 # you do not need to provide a key to use the snapshot later.
1326 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
1327 # For example:
1328 #
1329 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
1330 # key_region/cryptoKeys/key
1331 #
1332 # The fully-qualifed key name may be returned for resource GET requests. For
1333 # example:
1334 #
1335 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
1336 # key_region/cryptoKeys/key
1337 # /cryptoKeyVersions/1
1338 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
1339 # key. If absent, the Compute Engine default service account is used.
1340 # For example:
1341 #
1342 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
1343 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
1344 # encryption key, encoded in RFC
1345 # 4648 base64 to either encrypt or decrypt this resource. You can
1346 # provide either the rawKey or thersaEncryptedKey.
1347 # For example:
1348 #
1349 # &quot;rawKey&quot;:
1350 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
1351 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
1352 # customer-supplied encryption key to either encrypt or decrypt this
1353 # resource. You can provide either the rawKey or thersaEncryptedKey.
1354 # For example:
1355 #
1356 # &quot;rsaEncryptedKey&quot;:
1357 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
1358 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
1359 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
1360 #
1361 # The key must meet the following requirements before you can provide it to
1362 # Compute Engine:
1363 #
1364 # 1. The key is wrapped using a RSA public key certificate provided by
1365 # Google.
1366 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
1367 # encoding.
1368 #
1369 # Gets the RSA public key certificate provided by Google at:
1370 #
1371 #
1372 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
1373 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
1374 # 4648 base64 encoded SHA-256 hash of the customer-supplied
1375 # encryption key that protects this resource.
1376 },
1377 &quot;snapshotGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the snapshot group that this snapshot
1378 # belongs to. The usage of snapshot group feature is restricted.
1379 &quot;snapshotGroupName&quot;: &quot;A String&quot;, # Output only. [Output only] The snapshot group that this snapshot belongs to. The usage
1380 # of snapshot group feature is restricted.
1381 &quot;snapshotType&quot;: &quot;A String&quot;, # Indicates the type of the snapshot.
1382 &quot;sourceDisk&quot;: &quot;A String&quot;, # The source disk used to create this snapshot.
1383 &quot;sourceDiskEncryptionKey&quot;: { # The customer-supplied
1384 # encryption key of the source disk. Required if the source disk is
1385 # protected by a customer-supplied encryption key.
1386 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
1387 # For example:
1388 #
1389 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
1390 # key_region/cryptoKeys/key
1391 #
1392 # The fully-qualifed key name may be returned for resource GET requests. For
1393 # example:
1394 #
1395 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
1396 # key_region/cryptoKeys/key
1397 # /cryptoKeyVersions/1
1398 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
1399 # key. If absent, the Compute Engine default service account is used.
1400 # For example:
1401 #
1402 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
1403 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
1404 # encryption key, encoded in RFC
1405 # 4648 base64 to either encrypt or decrypt this resource. You can
1406 # provide either the rawKey or thersaEncryptedKey.
1407 # For example:
1408 #
1409 # &quot;rawKey&quot;:
1410 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
1411 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
1412 # customer-supplied encryption key to either encrypt or decrypt this
1413 # resource. You can provide either the rawKey or thersaEncryptedKey.
1414 # For example:
1415 #
1416 # &quot;rsaEncryptedKey&quot;:
1417 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
1418 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
1419 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
1420 #
1421 # The key must meet the following requirements before you can provide it to
1422 # Compute Engine:
1423 #
1424 # 1. The key is wrapped using a RSA public key certificate provided by
1425 # Google.
1426 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
1427 # encoding.
1428 #
1429 # Gets the RSA public key certificate provided by Google at:
1430 #
1431 #
1432 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
1433 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
1434 # 4648 base64 encoded SHA-256 hash of the customer-supplied
1435 # encryption key that protects this resource.
1436 },
1437 &quot;sourceDiskForRecoveryCheckpoint&quot;: &quot;A String&quot;, # The source disk whose recovery checkpoint will be used to create this
1438 # snapshot.
1439 &quot;sourceDiskId&quot;: &quot;A String&quot;, # Output only. [Output Only] The ID value of the disk used to create this snapshot
1440 &quot;sourceInstantSnapshot&quot;: &quot;A String&quot;, # The source instant snapshot used to create this snapshot.
1441 &quot;sourceInstantSnapshotEncryptionKey&quot;: { # Customer provided encryption key when creating Snapshot from Instant
1442 # Snapshot.
1443 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
1444 # For example:
1445 #
1446 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
1447 # key_region/cryptoKeys/key
1448 #
1449 # The fully-qualifed key name may be returned for resource GET requests. For
1450 # example:
1451 #
1452 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
1453 # key_region/cryptoKeys/key
1454 # /cryptoKeyVersions/1
1455 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
1456 # key. If absent, the Compute Engine default service account is used.
1457 # For example:
1458 #
1459 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
1460 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
1461 # encryption key, encoded in RFC
1462 # 4648 base64 to either encrypt or decrypt this resource. You can
1463 # provide either the rawKey or thersaEncryptedKey.
1464 # For example:
1465 #
1466 # &quot;rawKey&quot;:
1467 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
1468 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
1469 # customer-supplied encryption key to either encrypt or decrypt this
1470 # resource. You can provide either the rawKey or thersaEncryptedKey.
1471 # For example:
1472 #
1473 # &quot;rsaEncryptedKey&quot;:
1474 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
1475 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
1476 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
1477 #
1478 # The key must meet the following requirements before you can provide it to
1479 # Compute Engine:
1480 #
1481 # 1. The key is wrapped using a RSA public key certificate provided by
1482 # Google.
1483 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
1484 # encoding.
1485 #
1486 # Gets the RSA public key certificate provided by Google at:
1487 #
1488 #
1489 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
1490 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
1491 # 4648 base64 encoded SHA-256 hash of the customer-supplied
1492 # encryption key that protects this resource.
1493 },
1494 &quot;sourceInstantSnapshotId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the instant snapshot used to create this
1495 # snapshot. This value identifies the exact instant snapshot that was used
1496 # to create this persistent disk. For example, if you created the
1497 # persistent disk from an instant snapshot that was later deleted and
1498 # recreated under the same name, the source instant snapshot ID would
1499 # identify the exact instant snapshot that was used.
1500 &quot;sourceSnapshotSchedulePolicy&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the resource policy which created this
1501 # scheduled snapshot.
1502 &quot;sourceSnapshotSchedulePolicyId&quot;: &quot;A String&quot;, # Output only. [Output Only] ID of the resource policy which created this
1503 # scheduled snapshot.
1504 &quot;storageBytes&quot;: &quot;A String&quot;, # Output only. [Output Only] A size of the storage used by the snapshot.
1505 &quot;storageBytesStatus&quot;: &quot;A String&quot;, # Output only. [Deprecated] Instead, check the storageBytes field. After
1506 # snapshot creation, the storageBytesStatus field is alwaysUP_TO_DATE.
1507 # [Output Only] An indicator whether storageBytes is in a
1508 # stable state or it is being adjusted as a result of shared storage
1509 # reallocation. This status can either be unset, meaning the snapshot is
1510 # being created, or UP_TO_DATE, meaning the size of the
1511 # snapshot is up-to-date.
1512 &quot;storageLocations&quot;: [ # Cloud Storage bucket storage location of the snapshot (regional or
1513 # multi-regional).
1514 &quot;A String&quot;,
1515 ],
1516 },
1517 &quot;purgeTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Purge timestamp of recoverable snapshot inRFC3339
1518 # text format.
1519 &quot;satisfiesPzi&quot;: True or False, # Output only. [Output Only] Reserved for future use.
1520 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
1521 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
1522 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource&#x27;s resource id.
1523 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only] Status of the recoverable snapshot.
1524 },
1525 ],
1526 &quot;kind&quot;: &quot;compute#recoverableSnapshotList&quot;, # Output only. [Output Only] Type of resource. Alwayscompute#recoverableSnapshotList for lists of
1527 # recoverablesnapshots.
1528 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
1529 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
1530 # the query parameter pageToken in the next list request.
1531 # Subsequent list requests will have their own nextPageToken to
1532 # continue paging through the results.
1533 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
1534 &quot;unreachables&quot;: [ # Output only. [Output Only] Unreachable resources.
1535 # end_interface: MixerListResponseWithEtagBuilder
1536 &quot;A String&quot;,
1537 ],
1538 &quot;warning&quot;: { # [Output Only] Informational warning message.
1539 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1540 # Engine returns NO_RESULTS_ON_PAGE if there
1541 # are no results in the response.
1542 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1543 # value format. For example:
1544 #
1545 # &quot;data&quot;: [
1546 # {
1547 # &quot;key&quot;: &quot;scope&quot;,
1548 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1549 # }
1550 {
1551 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1552 # returned. For example, for warnings where there are no results in a list
1553 # request for a particular zone, this key might be scope and
1554 # the key value might be the zone name. Other examples might be a key
1555 # indicating a deprecated resource and a suggested replacement, or a
1556 # warning about invalid network settings (for example, if an instance
1557 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1558 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1559 },
1560 ],
1561 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1562 },
1563 }</pre>
1564 </div>
1565
1566 <div class="method">
1567 <code class="details" id="list_next">list_next()</code>
1568 <pre>Retrieves the next page of results.
1569
1570 Args:
1571 previous_request: The request for the previous page. (required)
1572 previous_response: The response from the request for the previous page. (required)
1573
1574 Returns:
1575 A request object that you can call &#x27;execute()&#x27; on to request the next
1576 page. Returns None if there are no more items in the collection.
1577 </pre>
1578 </div>
1579
1580 <div class="method">
1581 <code class="details" id="recover">recover(project, region, recoverableSnapshot, requestId=None, snapshotName=None, x__xgafv=None)</code>
1582 <pre>Recovers the specified RecoverableSnapshot.
1583
1584 Args:
1585 project: string, Project Id of the request (required)
1586 region: string, Name of the region for this request. (required)
1587 recoverableSnapshot: string, Name of the recoverable resource to recover (required)
1588 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
1589 that if you must retry your request, the server will know to ignore the
1590 request if it has already been completed.
1591
1592 For example, consider a situation where you make an initial request and
1593 the request times out. If you make the request again with the same
1594 request ID, the server can check if original operation with the same
1595 request ID was received, and if so, will ignore the second request. This
1596 prevents clients from accidentally creating duplicate commitments.
1597
1598 The request ID must be
1599 a valid UUID with the exception that zero UUID is not supported
1600 (00000000-0000-0000-0000-000000000000).
1601 snapshotName: string, Optional. Name of the snapshot after the recovery
1602 The name will be 1-63 characters long, and comply withRFC1035.
1603 Specifically, the name will be 1-63 characters long and match the regular
1604 expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
1605 character will be a lowercase letter, and all following characters can be
1606 a dash, lowercase letter, or digit, except the last character, which cannot
1607 be a dash.
1608 x__xgafv: string, V1 error format.
1609 Allowed values
1610 1 - v1 error format
1611 2 - v2 error format
1612
1613 Returns:
1614 An object of the form:
1615
1616 { # Represents an Operation resource.
1617 #
1618 # Google Compute Engine has three Operation resources:
1619 #
1620 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
1621 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
1622 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
1623 #
1624 # You can use an operation resource to manage asynchronous API requests.
1625 # For more information, readHandling
1626 # API responses.
1627 #
1628 # Operations can be global, regional or zonal.
1629 #
1630 # - For global operations, use the `globalOperations`
1631 # resource.
1632 # - For regional operations, use the
1633 # `regionOperations` resource.
1634 # - For zonal operations, use
1635 # the `zoneOperations` resource.
1636 #
1637 #
1638 #
1639 # For more information, read
1640 # Global, Regional, and Zonal Resources.
1641 #
1642 # Note that completed Operation resources have a limited
1643 # retention period.
1644 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
1645 # Not present otherwise.
1646 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1647 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
1648 # set when the operation is created.
1649 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
1650 # text format.
1651 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
1652 # this field will be populated.
1653 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
1654 # operation.
1655 {
1656 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1657 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
1658 # details. There is a set of defined message types to use for providing
1659 # details.The syntax depends on the error code. For example,
1660 # QuotaExceededInfo will have details when the error code is
1661 # QUOTA_EXCEEDED.
1662 {
1663 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
1664 #
1665 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
1666 # is not enabled:
1667 #
1668 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
1669 # &quot;domain&quot;: &quot;googleapis.com&quot;
1670 # &quot;metadata&quot;: {
1671 # &quot;resource&quot;: &quot;projects/123&quot;,
1672 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
1673 # }
1674 # }
1675 #
1676 # This response indicates that the pubsub.googleapis.com API is not enabled.
1677 #
1678 # Example of an error that is returned when attempting to create a Spanner
1679 # instance in a region that is out of stock:
1680 #
1681 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
1682 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
1683 # &quot;metadata&quot;: {
1684 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
1685 # }
1686 # }
1687 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
1688 # is typically the registered service name of the tool or product that
1689 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
1690 # generated by some common infrastructure, the error domain must be a
1691 # globally unique value that identifies the infrastructure. For Google API
1692 # infrastructure, the error domain is &quot;googleapis.com&quot;.
1693 &quot;metadatas&quot;: { # Additional structured details about this error.
1694 #
1695 # Keys must match a regular expression of `a-z+` but should
1696 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
1697 # length. When identifying the current value of an exceeded limit, the units
1698 # should be contained in the key, not the value. For example, rather than
1699 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1700 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1701 # instances that can be created in a single (batch) request.
1702 &quot;a_key&quot;: &quot;A String&quot;,
1703 },
1704 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1705 # proximate cause of the error. Error reasons are unique within a particular
1706 # domain of errors. This should be at most 63 characters and match a
1707 # regular expression of `A-Z+[A-Z0-9]`, which represents
1708 # UPPER_SNAKE_CASE.
1709 },
1710 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1711 #
1712 # For example, if a quota check failed with an error indicating the calling
1713 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1714 # directly to the right place in the developer console to flip the bit.
1715 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1716 { # Describes a URL link.
1717 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1718 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1719 },
1720 ],
1721 },
1722 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1723 # which can be attached to an RPC error.
1724 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1725 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1726 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1727 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1728 },
1729 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1730 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1731 &quot;a_key&quot;: &quot;A String&quot;,
1732 },
1733 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1734 # type or metric.
1735 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1736 # or metric.
1737 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1738 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1739 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1740 },
1741 },
1742 ],
1743 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1744 # This property is optional.
1745 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1746 },
1747 ],
1748 },
1749 &quot;getVersionOperationMetadata&quot;: {
1750 &quot;inlineSbomInfo&quot;: {
1751 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1752 # appropriate identifiers.
1753 &quot;a_key&quot;: &quot;A String&quot;,
1754 },
1755 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
1756 # identifiers.
1757 &quot;a_key&quot;: &quot;A String&quot;,
1758 },
1759 },
1760 },
1761 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1762 # message that was returned, such as `NOT FOUND`.
1763 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1764 # status code that was returned. For example, a `404` means the
1765 # resource was not found.
1766 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1767 # defined by the server.
1768 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1769 # This value is inRFC3339
1770 # text format.
1771 &quot;instancesBulkInsertOperationMetadata&quot;: {
1772 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1773 # Example key: zones/us-central1-a
1774 &quot;a_key&quot;: {
1775 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1776 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1777 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1778 # error.
1779 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1780 # if the flow is rolling forward or rolling back.
1781 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1782 },
1783 },
1784 },
1785 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1786 # Operation resources.
1787 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1788 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1789 # group of operations results from a `bulkInsert` API request.
1790 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1791 # `update`, or `delete`, and so on.
1792 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1793 # There is no requirement that this be linear or support any granularity of
1794 # operations. This should not be used to guess when the operation will be
1795 # complete. This number should monotonically increase as the operation
1796 # progresses.
1797 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1798 # applicable when performing regional operations.
1799 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1800 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
1801 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1802 # this field will contain information on all underlying zonal actions and
1803 # their state.
1804 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1805 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1806 # Example key: zones/us-central1-a
1807 &quot;a_key&quot;: {
1808 &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
1809 # populated.
1810 # different programming environments, including REST APIs and RPC APIs. It is
1811 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1812 # three pieces of data: error code, error message, and error details.
1813 #
1814 # You can find out more about this error model and how to work with it in the
1815 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1816 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1817 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1818 # message types for APIs to use.
1819 {
1820 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1821 },
1822 ],
1823 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1824 # user-facing error message should be localized and sent in the
1825 # google.rpc.Status.details field, or localized by the client.
1826 },
1827 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1828 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1829 },
1830 },
1831 },
1832 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1833 # This value is inRFC3339
1834 # text format.
1835 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1836 # following:
1837 # `PENDING`, `RUNNING`, or `DONE`.
1838 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1839 # operation.
1840 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1841 # of the target resource.
1842 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1843 # operations related to creating a snapshot, this points to the disk
1844 # that the snapshot was created from.
1845 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1846 # `[email protected]` or
1847 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1848 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1849 # operation, this field will be populated.
1850 {
1851 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1852 # Engine returns NO_RESULTS_ON_PAGE if there
1853 # are no results in the response.
1854 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1855 # value format. For example:
1856 #
1857 # &quot;data&quot;: [
1858 # {
1859 # &quot;key&quot;: &quot;scope&quot;,
1860 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1861 # }
1862 {
1863 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1864 # returned. For example, for warnings where there are no results in a list
1865 # request for a particular zone, this key might be scope and
1866 # the key value might be the zone name. Other examples might be a key
1867 # indicating a deprecated resource and a suggested replacement, or a
1868 # warning about invalid network settings (for example, if an instance
1869 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1870 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1871 },
1872 ],
1873 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1874 },
1875 ],
1876 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1877 # applicable when performing per-zone operations.
1878 }</pre>
1879 </div>
1880
1881 <div class="method">
1882 <code class="details" id="setIamPolicy">setIamPolicy(project, region, resource, body=None, x__xgafv=None)</code>
1883 <pre>Sets the access control policy on the specified resource.
1884 Replaces any existing policy.
1885
1886 Args:
1887 project: string, Project ID for this request. (required)
1888 region: string, The name of the region for this request. (required)
1889 resource: string, Name or id of the resource for this request. (required)
1890 body: object, The request body.
1891 The object takes the form of:
1892
1893 {
1894 &quot;bindings&quot;: [ # Flatten Policy to create a backwacd compatible wire-format.
1895 # Deprecated. Use &#x27;policy&#x27; to specify bindings.
1896 { # Associates `members`, or principals, with a `role`.
1897 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
1898 #
1899 # If the condition evaluates to `true`, then this binding applies to the
1900 # current request.
1901 #
1902 # If the condition evaluates to `false`, then this binding does not apply to
1903 # the current request. However, a different role binding might grant the same
1904 # role to one or more of the principals in this binding.
1905 #
1906 # To learn which resources support conditions in their IAM policies, see the
1907 # [IAM
1908 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
1909 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
1910 # are documented at https://github.com/google/cel-spec.
1911 #
1912 # Example (Comparison):
1913 #
1914 # title: &quot;Summary size limit&quot;
1915 # description: &quot;Determines if a summary is less than 100 chars&quot;
1916 # expression: &quot;document.summary.size() &lt; 100&quot;
1917 #
1918 # Example (Equality):
1919 #
1920 # title: &quot;Requestor is owner&quot;
1921 # description: &quot;Determines if requestor is the document owner&quot;
1922 # expression: &quot;document.owner == request.auth.claims.email&quot;
1923 #
1924 # Example (Logic):
1925 #
1926 # title: &quot;Public documents&quot;
1927 # description: &quot;Determine whether the document should be publicly visible&quot;
1928 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
1929 #
1930 # Example (Data Manipulation):
1931 #
1932 # title: &quot;Notification string&quot;
1933 # description: &quot;Create a notification string with a timestamp.&quot;
1934 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
1935 #
1936 # The exact variables and functions that may be referenced within an expression
1937 # are determined by the service that evaluates it. See the service
1938 # documentation for additional information.
1939 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
1940 # describes the expression, e.g. when hovered over it in a UI.
1941 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
1942 # syntax.
1943 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
1944 # reporting, e.g. a file name and a position in the file.
1945 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
1946 # its purpose. This can be used e.g. in UIs which allow to enter the
1947 # expression.
1948 },
1949 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
1950 # `members` can have the following values:
1951 #
1952 # * `allUsers`: A special identifier that represents anyone who is
1953 # on the internet; with or without a Google account.
1954 #
1955 # * `allAuthenticatedUsers`: A special identifier that represents anyone
1956 # who is authenticated with a Google account or a service account.
1957 # Does not include identities that come from external identity providers
1958 # (IdPs) through identity federation.
1959 #
1960 # * `user:{emailid}`: An email address that represents a specific Google
1961 # account. For example, `[email protected]` .
1962 #
1963 #
1964 # * `serviceAccount:{emailid}`: An email address that represents a Google
1965 # service account. For example,
1966 # `[email protected]`.
1967 #
1968 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
1969 # identifier for a
1970 # [Kubernetes service
1971 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
1972 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
1973 #
1974 # * `group:{emailid}`: An email address that represents a Google group.
1975 # For example, `[email protected]`.
1976 #
1977 #
1978 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
1979 # users of that domain. For example, `google.com` or `example.com`.
1980 #
1981 #
1982 #
1983 #
1984 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
1985 # A single identity in a workforce identity pool.
1986 #
1987 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
1988 # All workforce identities in a group.
1989 #
1990 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
1991 # All workforce identities with a specific attribute value.
1992 #
1993 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
1994 # All identities in a workforce identity pool.
1995 #
1996 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
1997 # A single identity in a workload identity pool.
1998 #
1999 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
2000 # A workload identity pool group.
2001 #
2002 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
2003 # All identities in a workload identity pool with a certain attribute.
2004 #
2005 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
2006 # All identities in a workload identity pool.
2007 #
2008 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
2009 # identifier) representing a user that has been recently deleted. For
2010 # example, `[email protected]?uid=123456789012345678901`. If the user is
2011 # recovered, this value reverts to `user:{emailid}` and the recovered user
2012 # retains the role in the binding.
2013 #
2014 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
2015 # unique identifier) representing a service account that has been recently
2016 # deleted. For example,
2017 # `[email protected]?uid=123456789012345678901`.
2018 # If the service account is undeleted, this value reverts to
2019 # `serviceAccount:{emailid}` and the undeleted service account retains the
2020 # role in the binding.
2021 #
2022 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
2023 # identifier) representing a Google group that has been recently
2024 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
2025 # the group is recovered, this value reverts to `group:{emailid}` and the
2026 # recovered group retains the role in the binding.
2027 #
2028 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
2029 # Deleted single identity in a workforce identity pool. For example,
2030 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
2031 &quot;A String&quot;,
2032 ],
2033 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
2034 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
2035 #
2036 # For an overview of the IAM roles and permissions, see the
2037 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
2038 # a list of the available pre-defined roles, see
2039 # [here](https://cloud.google.com/iam/docs/understanding-roles).
2040 },
2041 ],
2042 &quot;etag&quot;: &quot;A String&quot;, # Flatten Policy to create a backward compatible wire-format.
2043 # Deprecated. Use &#x27;policy&#x27; to specify the etag.
2044 &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
2045 # the policy is limited to a few 10s of KB. An empty policy is in general a
2046 # valid policy but certain services (like Projects) might reject them.
2047 # controls for Google Cloud resources.
2048 #
2049 #
2050 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
2051 # `members`, or principals, to a single `role`. Principals can be user
2052 # accounts, service accounts, Google groups, and domains (such as G Suite). A
2053 # `role` is a named list of permissions; each `role` can be an IAM predefined
2054 # role or a user-created custom role.
2055 #
2056 # For some types of Google Cloud resources, a `binding` can also specify a
2057 # `condition`, which is a logical expression that allows access to a resource
2058 # only if the expression evaluates to `true`. A condition can add constraints
2059 # based on attributes of the request, the resource, or both. To learn which
2060 # resources support conditions in their IAM policies, see the
2061 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
2062 #
2063 # **JSON example:**
2064 #
2065 # ```
2066 # {
2067 # &quot;bindings&quot;: [
2068 # {
2069 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
2070 # &quot;members&quot;: [
2071 # &quot;user:[email protected]&quot;,
2072 # &quot;group:[email protected]&quot;,
2073 # &quot;domain:google.com&quot;,
2074 # &quot;serviceAccount:[email protected]&quot;
2075 # ]
2076 # },
2077 # {
2078 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
2079 # &quot;members&quot;: [
2080 # &quot;user:[email protected]&quot;
2081 # ],
2082 # &quot;condition&quot;: {
2083 # &quot;title&quot;: &quot;expirable access&quot;,
2084 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
2085 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
2086 # }
2087 # }
2088 # ],
2089 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
2090 # &quot;version&quot;: 3
2091 # }
2092 # ```
2093 #
2094 # **YAML example:**
2095 #
2096 # ```
2097 # bindings:
2098 # - members:
2099 # - user:[email protected]
2100 # - group:[email protected]
2101 # - domain:google.com
2102 # - serviceAccount:[email protected]
2103 # role: roles/resourcemanager.organizationAdmin
2104 # - members:
2105 # - user:[email protected]
2106 # role: roles/resourcemanager.organizationViewer
2107 # condition:
2108 # title: expirable access
2109 # description: Does not grant access after Sep 2020
2110 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
2111 # etag: BwWWja0YfJA=
2112 # version: 3
2113 # ```
2114 #
2115 # For a description of IAM and its features, see the
2116 # [IAM documentation](https://cloud.google.com/iam/docs/).
2117 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
2118 { # Specifies the audit configuration for a service.
2119 # The configuration determines which permission types are logged, and what
2120 # identities, if any, are exempted from logging.
2121 # An AuditConfig must have one or more AuditLogConfigs.
2122 #
2123 # If there are AuditConfigs for both `allServices` and a specific service,
2124 # the union of the two AuditConfigs is used for that service: the log_types
2125 # specified in each AuditConfig are enabled, and the exempted_members in each
2126 # AuditLogConfig are exempted.
2127 #
2128 # Example Policy with multiple AuditConfigs:
2129 #
2130 # {
2131 # &quot;audit_configs&quot;: [
2132 # {
2133 # &quot;service&quot;: &quot;allServices&quot;,
2134 # &quot;audit_log_configs&quot;: [
2135 # {
2136 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
2137 # &quot;exempted_members&quot;: [
2138 # &quot;user:[email protected]&quot;
2139 # ]
2140 # },
2141 # {
2142 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
2143 # },
2144 # {
2145 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
2146 # }
2147 # ]
2148 # },
2149 # {
2150 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
2151 # &quot;audit_log_configs&quot;: [
2152 # {
2153 # &quot;log_type&quot;: &quot;DATA_READ&quot;
2154 # },
2155 # {
2156 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
2157 # &quot;exempted_members&quot;: [
2158 # &quot;user:[email protected]&quot;
2159 # ]
2160 # }
2161 # ]
2162 # }
2163 # ]
2164 # }
2165 #
2166 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
2167 # logging. It also exempts `[email protected]` from DATA_READ logging, and
2168 # `[email protected]` from DATA_WRITE logging.
2169 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
2170 { # Provides the configuration for logging a type of permissions.
2171 # Example:
2172 #
2173 # {
2174 # &quot;audit_log_configs&quot;: [
2175 # {
2176 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
2177 # &quot;exempted_members&quot;: [
2178 # &quot;user:[email protected]&quot;
2179 # ]
2180 # },
2181 # {
2182 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
2183 # }
2184 # ]
2185 # }
2186 #
2187 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
2188 # [email protected] from DATA_READ logging.
2189 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
2190 # permission.
2191 # Follows the same format of Binding.members.
2192 &quot;A String&quot;,
2193 ],
2194 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
2195 },
2196 ],
2197 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
2198 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
2199 # `allServices` is a special value that covers all services.
2200 },
2201 ],
2202 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
2203 # may specify a `condition` that determines how and when the `bindings` are
2204 # applied. Each of the `bindings` must contain at least one principal.
2205 #
2206 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
2207 # of these principals can be Google groups. Each occurrence of a principal
2208 # counts towards these limits. For example, if the `bindings` grant 50
2209 # different roles to `user:[email protected]`, and not to any other
2210 # principal, then you can add another 1,450 principals to the `bindings` in
2211 # the `Policy`.
2212 { # Associates `members`, or principals, with a `role`.
2213 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
2214 #
2215 # If the condition evaluates to `true`, then this binding applies to the
2216 # current request.
2217 #
2218 # If the condition evaluates to `false`, then this binding does not apply to
2219 # the current request. However, a different role binding might grant the same
2220 # role to one or more of the principals in this binding.
2221 #
2222 # To learn which resources support conditions in their IAM policies, see the
2223 # [IAM
2224 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
2225 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
2226 # are documented at https://github.com/google/cel-spec.
2227 #
2228 # Example (Comparison):
2229 #
2230 # title: &quot;Summary size limit&quot;
2231 # description: &quot;Determines if a summary is less than 100 chars&quot;
2232 # expression: &quot;document.summary.size() &lt; 100&quot;
2233 #
2234 # Example (Equality):
2235 #
2236 # title: &quot;Requestor is owner&quot;
2237 # description: &quot;Determines if requestor is the document owner&quot;
2238 # expression: &quot;document.owner == request.auth.claims.email&quot;
2239 #
2240 # Example (Logic):
2241 #
2242 # title: &quot;Public documents&quot;
2243 # description: &quot;Determine whether the document should be publicly visible&quot;
2244 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
2245 #
2246 # Example (Data Manipulation):
2247 #
2248 # title: &quot;Notification string&quot;
2249 # description: &quot;Create a notification string with a timestamp.&quot;
2250 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
2251 #
2252 # The exact variables and functions that may be referenced within an expression
2253 # are determined by the service that evaluates it. See the service
2254 # documentation for additional information.
2255 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
2256 # describes the expression, e.g. when hovered over it in a UI.
2257 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
2258 # syntax.
2259 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
2260 # reporting, e.g. a file name and a position in the file.
2261 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
2262 # its purpose. This can be used e.g. in UIs which allow to enter the
2263 # expression.
2264 },
2265 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
2266 # `members` can have the following values:
2267 #
2268 # * `allUsers`: A special identifier that represents anyone who is
2269 # on the internet; with or without a Google account.
2270 #
2271 # * `allAuthenticatedUsers`: A special identifier that represents anyone
2272 # who is authenticated with a Google account or a service account.
2273 # Does not include identities that come from external identity providers
2274 # (IdPs) through identity federation.
2275 #
2276 # * `user:{emailid}`: An email address that represents a specific Google
2277 # account. For example, `[email protected]` .
2278 #
2279 #
2280 # * `serviceAccount:{emailid}`: An email address that represents a Google
2281 # service account. For example,
2282 # `[email protected]`.
2283 #
2284 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
2285 # identifier for a
2286 # [Kubernetes service
2287 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
2288 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
2289 #
2290 # * `group:{emailid}`: An email address that represents a Google group.
2291 # For example, `[email protected]`.
2292 #
2293 #
2294 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
2295 # users of that domain. For example, `google.com` or `example.com`.
2296 #
2297 #
2298 #
2299 #
2300 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
2301 # A single identity in a workforce identity pool.
2302 #
2303 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
2304 # All workforce identities in a group.
2305 #
2306 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
2307 # All workforce identities with a specific attribute value.
2308 #
2309 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
2310 # All identities in a workforce identity pool.
2311 #
2312 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
2313 # A single identity in a workload identity pool.
2314 #
2315 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
2316 # A workload identity pool group.
2317 #
2318 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
2319 # All identities in a workload identity pool with a certain attribute.
2320 #
2321 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
2322 # All identities in a workload identity pool.
2323 #
2324 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
2325 # identifier) representing a user that has been recently deleted. For
2326 # example, `[email protected]?uid=123456789012345678901`. If the user is
2327 # recovered, this value reverts to `user:{emailid}` and the recovered user
2328 # retains the role in the binding.
2329 #
2330 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
2331 # unique identifier) representing a service account that has been recently
2332 # deleted. For example,
2333 # `[email protected]?uid=123456789012345678901`.
2334 # If the service account is undeleted, this value reverts to
2335 # `serviceAccount:{emailid}` and the undeleted service account retains the
2336 # role in the binding.
2337 #
2338 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
2339 # identifier) representing a Google group that has been recently
2340 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
2341 # the group is recovered, this value reverts to `group:{emailid}` and the
2342 # recovered group retains the role in the binding.
2343 #
2344 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
2345 # Deleted single identity in a workforce identity pool. For example,
2346 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
2347 &quot;A String&quot;,
2348 ],
2349 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
2350 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
2351 #
2352 # For an overview of the IAM roles and permissions, see the
2353 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
2354 # a list of the available pre-defined roles, see
2355 # [here](https://cloud.google.com/iam/docs/understanding-roles).
2356 },
2357 ],
2358 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
2359 # prevent simultaneous updates of a policy from overwriting each other.
2360 # It is strongly suggested that systems make use of the `etag` in the
2361 # read-modify-write cycle to perform policy updates in order to avoid race
2362 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
2363 # systems are expected to put that etag in the request to `setIamPolicy` to
2364 # ensure that their change will be applied to the same version of the policy.
2365 #
2366 # **Important:** If you use IAM Conditions, you must include the `etag` field
2367 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
2368 # you to overwrite a version `3` policy with a version `1` policy, and all of
2369 # the conditions in the version `3` policy are lost.
2370 &quot;version&quot;: 42, # Specifies the format of the policy.
2371 #
2372 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
2373 # are rejected.
2374 #
2375 # Any operation that affects conditional role bindings must specify version
2376 # `3`. This requirement applies to the following operations:
2377 #
2378 # * Getting a policy that includes a conditional role binding
2379 # * Adding a conditional role binding to a policy
2380 # * Changing a conditional role binding in a policy
2381 # * Removing any role binding, with or without a condition, from a policy
2382 # that includes conditions
2383 #
2384 # **Important:** If you use IAM Conditions, you must include the `etag` field
2385 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
2386 # you to overwrite a version `3` policy with a version `1` policy, and all of
2387 # the conditions in the version `3` policy are lost.
2388 #
2389 # If a policy does not include any conditions, operations on that policy may
2390 # specify any valid version or leave the field unset.
2391 #
2392 # To learn which resources support conditions in their IAM policies, see the
2393 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
2394 },
2395 }
2396
2397 x__xgafv: string, V1 error format.
2398 Allowed values
2399 1 - v1 error format
2400 2 - v2 error format
2401
2402 Returns:
2403 An object of the form:
2404
2405 { # An Identity and Access Management (IAM) policy, which specifies access
2406 # controls for Google Cloud resources.
2407 #
2408 #
2409 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
2410 # `members`, or principals, to a single `role`. Principals can be user
2411 # accounts, service accounts, Google groups, and domains (such as G Suite). A
2412 # `role` is a named list of permissions; each `role` can be an IAM predefined
2413 # role or a user-created custom role.
2414 #
2415 # For some types of Google Cloud resources, a `binding` can also specify a
2416 # `condition`, which is a logical expression that allows access to a resource
2417 # only if the expression evaluates to `true`. A condition can add constraints
2418 # based on attributes of the request, the resource, or both. To learn which
2419 # resources support conditions in their IAM policies, see the
2420 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
2421 #
2422 # **JSON example:**
2423 #
2424 # ```
2425 # {
2426 # &quot;bindings&quot;: [
2427 # {
2428 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
2429 # &quot;members&quot;: [
2430 # &quot;user:[email protected]&quot;,
2431 # &quot;group:[email protected]&quot;,
2432 # &quot;domain:google.com&quot;,
2433 # &quot;serviceAccount:[email protected]&quot;
2434 # ]
2435 # },
2436 # {
2437 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
2438 # &quot;members&quot;: [
2439 # &quot;user:[email protected]&quot;
2440 # ],
2441 # &quot;condition&quot;: {
2442 # &quot;title&quot;: &quot;expirable access&quot;,
2443 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
2444 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
2445 # }
2446 # }
2447 # ],
2448 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
2449 # &quot;version&quot;: 3
2450 # }
2451 # ```
2452 #
2453 # **YAML example:**
2454 #
2455 # ```
2456 # bindings:
2457 # - members:
2458 # - user:[email protected]
2459 # - group:[email protected]
2460 # - domain:google.com
2461 # - serviceAccount:[email protected]
2462 # role: roles/resourcemanager.organizationAdmin
2463 # - members:
2464 # - user:[email protected]
2465 # role: roles/resourcemanager.organizationViewer
2466 # condition:
2467 # title: expirable access
2468 # description: Does not grant access after Sep 2020
2469 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
2470 # etag: BwWWja0YfJA=
2471 # version: 3
2472 # ```
2473 #
2474 # For a description of IAM and its features, see the
2475 # [IAM documentation](https://cloud.google.com/iam/docs/).
2476 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
2477 { # Specifies the audit configuration for a service.
2478 # The configuration determines which permission types are logged, and what
2479 # identities, if any, are exempted from logging.
2480 # An AuditConfig must have one or more AuditLogConfigs.
2481 #
2482 # If there are AuditConfigs for both `allServices` and a specific service,
2483 # the union of the two AuditConfigs is used for that service: the log_types
2484 # specified in each AuditConfig are enabled, and the exempted_members in each
2485 # AuditLogConfig are exempted.
2486 #
2487 # Example Policy with multiple AuditConfigs:
2488 #
2489 # {
2490 # &quot;audit_configs&quot;: [
2491 # {
2492 # &quot;service&quot;: &quot;allServices&quot;,
2493 # &quot;audit_log_configs&quot;: [
2494 # {
2495 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
2496 # &quot;exempted_members&quot;: [
2497 # &quot;user:[email protected]&quot;
2498 # ]
2499 # },
2500 # {
2501 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
2502 # },
2503 # {
2504 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
2505 # }
2506 # ]
2507 # },
2508 # {
2509 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
2510 # &quot;audit_log_configs&quot;: [
2511 # {
2512 # &quot;log_type&quot;: &quot;DATA_READ&quot;
2513 # },
2514 # {
2515 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
2516 # &quot;exempted_members&quot;: [
2517 # &quot;user:[email protected]&quot;
2518 # ]
2519 # }
2520 # ]
2521 # }
2522 # ]
2523 # }
2524 #
2525 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
2526 # logging. It also exempts `[email protected]` from DATA_READ logging, and
2527 # `[email protected]` from DATA_WRITE logging.
2528 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
2529 { # Provides the configuration for logging a type of permissions.
2530 # Example:
2531 #
2532 # {
2533 # &quot;audit_log_configs&quot;: [
2534 # {
2535 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
2536 # &quot;exempted_members&quot;: [
2537 # &quot;user:[email protected]&quot;
2538 # ]
2539 # },
2540 # {
2541 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
2542 # }
2543 # ]
2544 # }
2545 #
2546 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
2547 # [email protected] from DATA_READ logging.
2548 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
2549 # permission.
2550 # Follows the same format of Binding.members.
2551 &quot;A String&quot;,
2552 ],
2553 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
2554 },
2555 ],
2556 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
2557 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
2558 # `allServices` is a special value that covers all services.
2559 },
2560 ],
2561 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
2562 # may specify a `condition` that determines how and when the `bindings` are
2563 # applied. Each of the `bindings` must contain at least one principal.
2564 #
2565 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
2566 # of these principals can be Google groups. Each occurrence of a principal
2567 # counts towards these limits. For example, if the `bindings` grant 50
2568 # different roles to `user:[email protected]`, and not to any other
2569 # principal, then you can add another 1,450 principals to the `bindings` in
2570 # the `Policy`.
2571 { # Associates `members`, or principals, with a `role`.
2572 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
2573 #
2574 # If the condition evaluates to `true`, then this binding applies to the
2575 # current request.
2576 #
2577 # If the condition evaluates to `false`, then this binding does not apply to
2578 # the current request. However, a different role binding might grant the same
2579 # role to one or more of the principals in this binding.
2580 #
2581 # To learn which resources support conditions in their IAM policies, see the
2582 # [IAM
2583 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
2584 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
2585 # are documented at https://github.com/google/cel-spec.
2586 #
2587 # Example (Comparison):
2588 #
2589 # title: &quot;Summary size limit&quot;
2590 # description: &quot;Determines if a summary is less than 100 chars&quot;
2591 # expression: &quot;document.summary.size() &lt; 100&quot;
2592 #
2593 # Example (Equality):
2594 #
2595 # title: &quot;Requestor is owner&quot;
2596 # description: &quot;Determines if requestor is the document owner&quot;
2597 # expression: &quot;document.owner == request.auth.claims.email&quot;
2598 #
2599 # Example (Logic):
2600 #
2601 # title: &quot;Public documents&quot;
2602 # description: &quot;Determine whether the document should be publicly visible&quot;
2603 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
2604 #
2605 # Example (Data Manipulation):
2606 #
2607 # title: &quot;Notification string&quot;
2608 # description: &quot;Create a notification string with a timestamp.&quot;
2609 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
2610 #
2611 # The exact variables and functions that may be referenced within an expression
2612 # are determined by the service that evaluates it. See the service
2613 # documentation for additional information.
2614 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
2615 # describes the expression, e.g. when hovered over it in a UI.
2616 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
2617 # syntax.
2618 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
2619 # reporting, e.g. a file name and a position in the file.
2620 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
2621 # its purpose. This can be used e.g. in UIs which allow to enter the
2622 # expression.
2623 },
2624 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
2625 # `members` can have the following values:
2626 #
2627 # * `allUsers`: A special identifier that represents anyone who is
2628 # on the internet; with or without a Google account.
2629 #
2630 # * `allAuthenticatedUsers`: A special identifier that represents anyone
2631 # who is authenticated with a Google account or a service account.
2632 # Does not include identities that come from external identity providers
2633 # (IdPs) through identity federation.
2634 #
2635 # * `user:{emailid}`: An email address that represents a specific Google
2636 # account. For example, `[email protected]` .
2637 #
2638 #
2639 # * `serviceAccount:{emailid}`: An email address that represents a Google
2640 # service account. For example,
2641 # `[email protected]`.
2642 #
2643 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
2644 # identifier for a
2645 # [Kubernetes service
2646 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
2647 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
2648 #
2649 # * `group:{emailid}`: An email address that represents a Google group.
2650 # For example, `[email protected]`.
2651 #
2652 #
2653 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
2654 # users of that domain. For example, `google.com` or `example.com`.
2655 #
2656 #
2657 #
2658 #
2659 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
2660 # A single identity in a workforce identity pool.
2661 #
2662 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
2663 # All workforce identities in a group.
2664 #
2665 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
2666 # All workforce identities with a specific attribute value.
2667 #
2668 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
2669 # All identities in a workforce identity pool.
2670 #
2671 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
2672 # A single identity in a workload identity pool.
2673 #
2674 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
2675 # A workload identity pool group.
2676 #
2677 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
2678 # All identities in a workload identity pool with a certain attribute.
2679 #
2680 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
2681 # All identities in a workload identity pool.
2682 #
2683 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
2684 # identifier) representing a user that has been recently deleted. For
2685 # example, `[email protected]?uid=123456789012345678901`. If the user is
2686 # recovered, this value reverts to `user:{emailid}` and the recovered user
2687 # retains the role in the binding.
2688 #
2689 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
2690 # unique identifier) representing a service account that has been recently
2691 # deleted. For example,
2692 # `[email protected]?uid=123456789012345678901`.
2693 # If the service account is undeleted, this value reverts to
2694 # `serviceAccount:{emailid}` and the undeleted service account retains the
2695 # role in the binding.
2696 #
2697 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
2698 # identifier) representing a Google group that has been recently
2699 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
2700 # the group is recovered, this value reverts to `group:{emailid}` and the
2701 # recovered group retains the role in the binding.
2702 #
2703 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
2704 # Deleted single identity in a workforce identity pool. For example,
2705 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
2706 &quot;A String&quot;,
2707 ],
2708 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
2709 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
2710 #
2711 # For an overview of the IAM roles and permissions, see the
2712 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
2713 # a list of the available pre-defined roles, see
2714 # [here](https://cloud.google.com/iam/docs/understanding-roles).
2715 },
2716 ],
2717 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
2718 # prevent simultaneous updates of a policy from overwriting each other.
2719 # It is strongly suggested that systems make use of the `etag` in the
2720 # read-modify-write cycle to perform policy updates in order to avoid race
2721 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
2722 # systems are expected to put that etag in the request to `setIamPolicy` to
2723 # ensure that their change will be applied to the same version of the policy.
2724 #
2725 # **Important:** If you use IAM Conditions, you must include the `etag` field
2726 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
2727 # you to overwrite a version `3` policy with a version `1` policy, and all of
2728 # the conditions in the version `3` policy are lost.
2729 &quot;version&quot;: 42, # Specifies the format of the policy.
2730 #
2731 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
2732 # are rejected.
2733 #
2734 # Any operation that affects conditional role bindings must specify version
2735 # `3`. This requirement applies to the following operations:
2736 #
2737 # * Getting a policy that includes a conditional role binding
2738 # * Adding a conditional role binding to a policy
2739 # * Changing a conditional role binding in a policy
2740 # * Removing any role binding, with or without a condition, from a policy
2741 # that includes conditions
2742 #
2743 # **Important:** If you use IAM Conditions, you must include the `etag` field
2744 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
2745 # you to overwrite a version `3` policy with a version `1` policy, and all of
2746 # the conditions in the version `3` policy are lost.
2747 #
2748 # If a policy does not include any conditions, operations on that policy may
2749 # specify any valid version or leave the field unset.
2750 #
2751 # To learn which resources support conditions in their IAM policies, see the
2752 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
2753 }</pre>
2754 </div>
2755
2756 <div class="method">
2757 <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body=None, x__xgafv=None)</code>
2758 <pre>Returns permissions that a caller has on the specified resource.
2759
2760 Args:
2761 project: string, Project ID for this request. (required)
2762 region: string, The name of the region for this request. (required)
2763 resource: string, Name or id of the resource for this request. (required)
2764 body: object, The request body.
2765 The object takes the form of:
2766
2767 {
2768 &quot;permissions&quot;: [ # The set of permissions to check for the &#x27;resource&#x27;. Permissions with
2769 # wildcards (such as &#x27;*&#x27; or &#x27;storage.*&#x27;) are not allowed.
2770 &quot;A String&quot;,
2771 ],
2772 }
2773
2774 x__xgafv: string, V1 error format.
2775 Allowed values
2776 1 - v1 error format
2777 2 - v2 error format
2778
2779 Returns:
2780 An object of the form:
2781
2782 {
2783 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is
2784 # allowed.
2785 &quot;A String&quot;,
2786 ],
2787 }</pre>
2788 </div>
2789
2790 </body></html>