Debian Codegraph @

docs/dyn/compute_beta.regionInstantSnapshots.html

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