Debian Codegraph @

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