Debian Codegraph @

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