Debian Codegraph @

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