Debian Codegraph @

docs/dyn/compute_beta.reservationBlocks.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.reservationBlocks.html">reservationBlocks</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#get">get(project, zone, reservation, reservationBlock, view=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Retrieves information about the specified reservation block.</p>
83 <p class="toc_element">
84 <code><a href="#getIamPolicy">getIamPolicy(project, zone, parentResource, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</a></code></p>
85 <p class="firstline">Gets the access control policy for a resource. May be empty if no such</p>
86 <p class="toc_element">
87 <code><a href="#list">list(project, zone, reservation, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Retrieves a list of reservation blocks under a single reservation.</p>
89 <p class="toc_element">
90 <code><a href="#list_next">list_next()</a></code></p>
91 <p class="firstline">Retrieves the next page of results.</p>
92 <p class="toc_element">
93 <code><a href="#performMaintenance">performMaintenance(project, zone, reservation, reservationBlock, body=None, requestId=None, x__xgafv=None)</a></code></p>
94 <p class="firstline">Allows customers to perform maintenance on a reservation block</p>
95 <p class="toc_element">
96 <code><a href="#setIamPolicy">setIamPolicy(project, zone, parentResource, resource, body=None, x__xgafv=None)</a></code></p>
97 <p class="firstline">Sets the access control policy on the specified resource.</p>
98 <p class="toc_element">
99 <code><a href="#testIamPermissions">testIamPermissions(project, zone, parentResource, resource, body=None, x__xgafv=None)</a></code></p>
100 <p class="firstline">Returns permissions that a caller has on the specified resource.</p>
101 <h3>Method Details</h3>
102 <div class="method">
103 <code class="details" id="close">close()</code>
104 <pre>Close httplib2 connections.</pre>
105 </div>
106
107 <div class="method">
108 <code class="details" id="get">get(project, zone, reservation, reservationBlock, view=None, x__xgafv=None)</code>
109 <pre>Retrieves information about the specified reservation block.
110
111 Args:
112 project: string, Project ID for this request. (required)
113 zone: string, Name of the zone for this request. Zone name should conform to RFC1035. (required)
114 reservation: string, The name of the reservation.
115 Name should conform to RFC1035 or be a resource ID. (required)
116 reservationBlock: string, The name of the reservation block.
117 Name should conform to RFC1035 or be a resource ID. (required)
118 view: string, View of the Block.
119 Allowed values
120 BASIC - This view includes basic information about the reservation block
121 BLOCK_VIEW_UNSPECIFIED - The default / unset value. The API will default to the BASIC view.
122 FULL - Includes detailed topology view.
123 x__xgafv: string, V1 error format.
124 Allowed values
125 1 - v1 error format
126 2 - v2 error format
127
128 Returns:
129 An object of the form:
130
131 {
132 &quot;resource&quot;: { # Represents a reservation block resource.
133 &quot;blockHealthInfo&quot;: { # Health information for the reservation block. # Output only. [Output Only] Health information for the reservation block.
134 &quot;degradedSubBlockCount&quot;: 42, # The number of subBlocks that are degraded.
135 &quot;healthStatus&quot;: &quot;A String&quot;, # The health status of the reservation block.
136 &quot;healthySubBlockCount&quot;: 42, # The number of subBlocks that are healthy.
137 },
138 &quot;count&quot;: 42, # Output only. [Output Only] The number of resources that are allocated in this
139 # reservation block.
140 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339 text format.
141 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
142 # defined by the server.
143 &quot;inUseCount&quot;: 42, # Output only. [Output Only] The number of instances that are currently in use on this
144 # reservation block.
145 &quot;inUseHostCount&quot;: 42, # Output only. Number of hosts currently in use. If there is one or more Instances running
146 # on the host, it is considered in use.
147 &quot;kind&quot;: &quot;compute#reservationBlock&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#reservationBlock for reservation blocks.
148 &quot;name&quot;: &quot;A String&quot;, # Output only. [Output Only] The name of this reservation block generated by Google
149 # Compute Engine. The name must be 1-63 characters long, and comply with
150 # RFC1035 @pattern [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
151 &quot;physicalTopology&quot;: { # Output only. [Output Only] The physical topology of the reservation block.
152 &quot;block&quot;: &quot;A String&quot;, # The hash of the capacity block within the cluster.
153 &quot;cluster&quot;: &quot;A String&quot;, # The cluster name of the reservation block.
154 &quot;instances&quot;: [ # Output only. The detailed instances information for a given Block
155 { # The instances information for a given Block
156 &quot;instanceId&quot;: &quot;A String&quot;, # The InstanceId of the instance
157 &quot;physicalHostTopology&quot;: { # The PhysicalHostTopology of the instance within a Block resource. # Output only. The PhysicalHostTopology of instances within a Block resource.
158 &quot;host&quot;: &quot;A String&quot;, # Host hash for a given instance
159 &quot;subBlock&quot;: &quot;A String&quot;, # Sub block hash for a given instance
160 },
161 &quot;projectId&quot;: &quot;A String&quot;, # Project where the instance lives
162 },
163 ],
164 },
165 &quot;reservationMaintenance&quot;: { # Maintenance Info for ReservationBlocks. # Output only. [Output Only] Maintenance information for this reservation block.
166 &quot;instanceMaintenanceOngoingCount&quot;: 42, # Describes number of instances that have ongoing maintenance.
167 &quot;instanceMaintenancePendingCount&quot;: 42, # Describes number of instances that have pending maintenance.
168 &quot;maintenanceOngoingCount&quot;: 42, # Progress for ongoing maintenance for this group of VMs/hosts.
169 # Describes number of hosts in the block that have ongoing maintenance.
170 &quot;maintenancePendingCount&quot;: 42, # Progress for ongoing maintenance for this group of VMs/hosts.
171 # Describes number of hosts in the block that have pending maintenance.
172 &quot;schedulingType&quot;: &quot;A String&quot;, # The type of maintenance for the reservation.
173 &quot;subblockInfraMaintenanceOngoingCount&quot;: 42, # Describes number of subblock Infrastructure that has ongoing maintenance.
174 # Here, Subblock Infrastructure Maintenance pertains to upstream hardware
175 # contained in the Subblock that is necessary for a VM Family(e.g. NVLink
176 # Domains). Not all VM Families will support this field.
177 &quot;subblockInfraMaintenancePendingCount&quot;: 42, # Describes number of subblock Infrastructure that has pending maintenance.
178 # Here, Subblock Infrastructure Maintenance pertains to upstream hardware
179 # contained in the Subblock that is necessary for a VM Family (e.g. NVLink
180 # Domains). Not all VM Families will support this field.
181 &quot;upcomingGroupMaintenance&quot;: { # Upcoming Maintenance notification information. # Maintenance information on this group of VMs.
182 &quot;canReschedule&quot;: True or False, # Indicates if the maintenance can be customer triggered.
183 &quot;latestWindowStartTime&quot;: &quot;A String&quot;, # The latest time for the planned maintenance window to start.
184 # This timestamp value is in RFC3339 text format.
185 &quot;maintenanceOnShutdown&quot;: True or False, # Indicates whether the UpcomingMaintenance will be triggered on VM shutdown.
186 &quot;maintenanceReasons&quot;: [ # The reasons for the maintenance. Only valid for vms.
187 &quot;A String&quot;,
188 ],
189 &quot;maintenanceStatus&quot;: &quot;A String&quot;,
190 &quot;type&quot;: &quot;A String&quot;, # Defines the type of maintenance.
191 &quot;windowEndTime&quot;: &quot;A String&quot;, # The time by which the maintenance disruption will be completed.
192 # This timestamp value is in RFC3339 text format.
193 &quot;windowStartTime&quot;: &quot;A String&quot;, # The current start time of the maintenance window.
194 # This timestamp value is in RFC3339 text format.
195 },
196 },
197 &quot;reservationSubBlockCount&quot;: 42, # Output only. [Output Only] The number of reservation subBlocks associated with this
198 # reservation block.
199 &quot;reservationSubBlockInUseCount&quot;: 42, # Output only. [Output Only] The number of in-use reservation subBlocks associated with
200 # this reservation block. If at least one VM is running on a subBlock, it is
201 # considered in-use.
202 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined fully-qualified URL for this resource.
203 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
204 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only] Status of the reservation block.
205 &quot;zone&quot;: &quot;A String&quot;, # Output only. [Output Only] Zone in which the reservation block resides.
206 },
207 }</pre>
208 </div>
209
210 <div class="method">
211 <code class="details" id="getIamPolicy">getIamPolicy(project, zone, parentResource, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</code>
212 <pre>Gets the access control policy for a resource. May be empty if no such
213 policy or resource exists.
214
215 Args:
216 project: string, Project ID for this request. (required)
217 zone: string, The name of the zone for this request. (required)
218 parentResource: string, Name or id of parent resource of the resource for this request. (required)
219 resource: string, Name or id of the resource for this request. (required)
220 optionsRequestedPolicyVersion: integer, Requested IAM Policy version.
221 x__xgafv: string, V1 error format.
222 Allowed values
223 1 - v1 error format
224 2 - v2 error format
225
226 Returns:
227 An object of the form:
228
229 { # An Identity and Access Management (IAM) policy, which specifies access
230 # controls for Google Cloud resources.
231 #
232 #
233 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
234 # `members`, or principals, to a single `role`. Principals can be user
235 # accounts, service accounts, Google groups, and domains (such as G Suite). A
236 # `role` is a named list of permissions; each `role` can be an IAM predefined
237 # role or a user-created custom role.
238 #
239 # For some types of Google Cloud resources, a `binding` can also specify a
240 # `condition`, which is a logical expression that allows access to a resource
241 # only if the expression evaluates to `true`. A condition can add constraints
242 # based on attributes of the request, the resource, or both. To learn which
243 # resources support conditions in their IAM policies, see the
244 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
245 #
246 # **JSON example:**
247 #
248 # ```
249 # {
250 # &quot;bindings&quot;: [
251 # {
252 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
253 # &quot;members&quot;: [
254 # &quot;user:[email protected]&quot;,
255 # &quot;group:[email protected]&quot;,
256 # &quot;domain:google.com&quot;,
257 # &quot;serviceAccount:[email protected]&quot;
258 # ]
259 # },
260 # {
261 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
262 # &quot;members&quot;: [
263 # &quot;user:[email protected]&quot;
264 # ],
265 # &quot;condition&quot;: {
266 # &quot;title&quot;: &quot;expirable access&quot;,
267 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
268 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
269 # }
270 # }
271 # ],
272 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
273 # &quot;version&quot;: 3
274 # }
275 # ```
276 #
277 # **YAML example:**
278 #
279 # ```
280 # bindings:
281 # - members:
282 # - user:[email protected]
283 # - group:[email protected]
284 # - domain:google.com
285 # - serviceAccount:[email protected]
286 # role: roles/resourcemanager.organizationAdmin
287 # - members:
288 # - user:[email protected]
289 # role: roles/resourcemanager.organizationViewer
290 # condition:
291 # title: expirable access
292 # description: Does not grant access after Sep 2020
293 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
294 # etag: BwWWja0YfJA=
295 # version: 3
296 # ```
297 #
298 # For a description of IAM and its features, see the
299 # [IAM documentation](https://cloud.google.com/iam/docs/).
300 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
301 { # Specifies the audit configuration for a service.
302 # The configuration determines which permission types are logged, and what
303 # identities, if any, are exempted from logging.
304 # An AuditConfig must have one or more AuditLogConfigs.
305 #
306 # If there are AuditConfigs for both `allServices` and a specific service,
307 # the union of the two AuditConfigs is used for that service: the log_types
308 # specified in each AuditConfig are enabled, and the exempted_members in each
309 # AuditLogConfig are exempted.
310 #
311 # Example Policy with multiple AuditConfigs:
312 #
313 # {
314 # &quot;audit_configs&quot;: [
315 # {
316 # &quot;service&quot;: &quot;allServices&quot;,
317 # &quot;audit_log_configs&quot;: [
318 # {
319 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
320 # &quot;exempted_members&quot;: [
321 # &quot;user:[email protected]&quot;
322 # ]
323 # },
324 # {
325 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
326 # },
327 # {
328 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
329 # }
330 # ]
331 # },
332 # {
333 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
334 # &quot;audit_log_configs&quot;: [
335 # {
336 # &quot;log_type&quot;: &quot;DATA_READ&quot;
337 # },
338 # {
339 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
340 # &quot;exempted_members&quot;: [
341 # &quot;user:[email protected]&quot;
342 # ]
343 # }
344 # ]
345 # }
346 # ]
347 # }
348 #
349 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
350 # logging. It also exempts `[email protected]` from DATA_READ logging, and
351 # `[email protected]` from DATA_WRITE logging.
352 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
353 { # Provides the configuration for logging a type of permissions.
354 # Example:
355 #
356 # {
357 # &quot;audit_log_configs&quot;: [
358 # {
359 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
360 # &quot;exempted_members&quot;: [
361 # &quot;user:[email protected]&quot;
362 # ]
363 # },
364 # {
365 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
366 # }
367 # ]
368 # }
369 #
370 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
371 # [email protected] from DATA_READ logging.
372 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
373 # permission.
374 # Follows the same format of Binding.members.
375 &quot;A String&quot;,
376 ],
377 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
378 },
379 ],
380 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
381 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
382 # `allServices` is a special value that covers all services.
383 },
384 ],
385 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
386 # may specify a `condition` that determines how and when the `bindings` are
387 # applied. Each of the `bindings` must contain at least one principal.
388 #
389 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
390 # of these principals can be Google groups. Each occurrence of a principal
391 # counts towards these limits. For example, if the `bindings` grant 50
392 # different roles to `user:[email protected]`, and not to any other
393 # principal, then you can add another 1,450 principals to the `bindings` in
394 # the `Policy`.
395 { # Associates `members`, or principals, with a `role`.
396 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
397 #
398 # If the condition evaluates to `true`, then this binding applies to the
399 # current request.
400 #
401 # If the condition evaluates to `false`, then this binding does not apply to
402 # the current request. However, a different role binding might grant the same
403 # role to one or more of the principals in this binding.
404 #
405 # To learn which resources support conditions in their IAM policies, see the
406 # [IAM
407 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
408 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
409 # are documented at https://github.com/google/cel-spec.
410 #
411 # Example (Comparison):
412 #
413 # title: &quot;Summary size limit&quot;
414 # description: &quot;Determines if a summary is less than 100 chars&quot;
415 # expression: &quot;document.summary.size() &lt; 100&quot;
416 #
417 # Example (Equality):
418 #
419 # title: &quot;Requestor is owner&quot;
420 # description: &quot;Determines if requestor is the document owner&quot;
421 # expression: &quot;document.owner == request.auth.claims.email&quot;
422 #
423 # Example (Logic):
424 #
425 # title: &quot;Public documents&quot;
426 # description: &quot;Determine whether the document should be publicly visible&quot;
427 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
428 #
429 # Example (Data Manipulation):
430 #
431 # title: &quot;Notification string&quot;
432 # description: &quot;Create a notification string with a timestamp.&quot;
433 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
434 #
435 # The exact variables and functions that may be referenced within an expression
436 # are determined by the service that evaluates it. See the service
437 # documentation for additional information.
438 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
439 # describes the expression, e.g. when hovered over it in a UI.
440 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
441 # syntax.
442 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
443 # reporting, e.g. a file name and a position in the file.
444 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
445 # its purpose. This can be used e.g. in UIs which allow to enter the
446 # expression.
447 },
448 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
449 # `members` can have the following values:
450 #
451 # * `allUsers`: A special identifier that represents anyone who is
452 # on the internet; with or without a Google account.
453 #
454 # * `allAuthenticatedUsers`: A special identifier that represents anyone
455 # who is authenticated with a Google account or a service account.
456 # Does not include identities that come from external identity providers
457 # (IdPs) through identity federation.
458 #
459 # * `user:{emailid}`: An email address that represents a specific Google
460 # account. For example, `[email protected]` .
461 #
462 #
463 # * `serviceAccount:{emailid}`: An email address that represents a Google
464 # service account. For example,
465 # `[email protected]`.
466 #
467 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
468 # identifier for a
469 # [Kubernetes service
470 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
471 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
472 #
473 # * `group:{emailid}`: An email address that represents a Google group.
474 # For example, `[email protected]`.
475 #
476 #
477 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
478 # users of that domain. For example, `google.com` or `example.com`.
479 #
480 #
481 #
482 #
483 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
484 # A single identity in a workforce identity pool.
485 #
486 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
487 # All workforce identities in a group.
488 #
489 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
490 # All workforce identities with a specific attribute value.
491 #
492 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
493 # All identities in a workforce identity pool.
494 #
495 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
496 # A single identity in a workload identity pool.
497 #
498 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
499 # A workload identity pool group.
500 #
501 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
502 # All identities in a workload identity pool with a certain attribute.
503 #
504 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
505 # All identities in a workload identity pool.
506 #
507 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
508 # identifier) representing a user that has been recently deleted. For
509 # example, `[email protected]?uid=123456789012345678901`. If the user is
510 # recovered, this value reverts to `user:{emailid}` and the recovered user
511 # retains the role in the binding.
512 #
513 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
514 # unique identifier) representing a service account that has been recently
515 # deleted. For example,
516 # `[email protected]?uid=123456789012345678901`.
517 # If the service account is undeleted, this value reverts to
518 # `serviceAccount:{emailid}` and the undeleted service account retains the
519 # role in the binding.
520 #
521 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
522 # identifier) representing a Google group that has been recently
523 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
524 # the group is recovered, this value reverts to `group:{emailid}` and the
525 # recovered group retains the role in the binding.
526 #
527 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
528 # Deleted single identity in a workforce identity pool. For example,
529 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
530 &quot;A String&quot;,
531 ],
532 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
533 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
534 #
535 # For an overview of the IAM roles and permissions, see the
536 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
537 # a list of the available pre-defined roles, see
538 # [here](https://cloud.google.com/iam/docs/understanding-roles).
539 },
540 ],
541 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
542 # prevent simultaneous updates of a policy from overwriting each other.
543 # It is strongly suggested that systems make use of the `etag` in the
544 # read-modify-write cycle to perform policy updates in order to avoid race
545 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
546 # systems are expected to put that etag in the request to `setIamPolicy` to
547 # ensure that their change will be applied to the same version of the policy.
548 #
549 # **Important:** If you use IAM Conditions, you must include the `etag` field
550 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
551 # you to overwrite a version `3` policy with a version `1` policy, and all of
552 # the conditions in the version `3` policy are lost.
553 &quot;version&quot;: 42, # Specifies the format of the policy.
554 #
555 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
556 # are rejected.
557 #
558 # Any operation that affects conditional role bindings must specify version
559 # `3`. This requirement applies to the following operations:
560 #
561 # * Getting a policy that includes a conditional role binding
562 # * Adding a conditional role binding to a policy
563 # * Changing a conditional role binding in a policy
564 # * Removing any role binding, with or without a condition, from a policy
565 # that includes conditions
566 #
567 # **Important:** If you use IAM Conditions, you must include the `etag` field
568 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
569 # you to overwrite a version `3` policy with a version `1` policy, and all of
570 # the conditions in the version `3` policy are lost.
571 #
572 # If a policy does not include any conditions, operations on that policy may
573 # specify any valid version or leave the field unset.
574 #
575 # To learn which resources support conditions in their IAM policies, see the
576 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
577 }</pre>
578 </div>
579
580 <div class="method">
581 <code class="details" id="list">list(project, zone, reservation, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
582 <pre>Retrieves a list of reservation blocks under a single reservation.
583
584 Args:
585 project: string, Project ID for this request. (required)
586 zone: string, Name of the zone for this request. Zone name should conform to RFC1035. (required)
587 reservation: string, The name of the reservation.
588 Name should conform to RFC1035 or be a resource ID. (required)
589 filter: string, A filter expression that filters resources listed in the response. Most
590 Compute resources support two types of filter expressions:
591 expressions that support regular expressions and expressions that follow
592 API improvement proposal AIP-160.
593 These two types of filter expressions cannot be mixed in one request.
594
595 If you want to use AIP-160, your expression must specify the field name, an
596 operator, and the value that you want to use for filtering. The value
597 must be a string, a number, or a boolean. The operator
598 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
599
600 For example, if you are filtering Compute Engine instances, you can
601 exclude instances named `example-instance` by specifying
602 `name != example-instance`.
603
604 The `:*` comparison can be used to test whether a key has been defined.
605 For example, to find all objects with `owner` label use:
606 ```
607 labels.owner:*
608 ```
609
610 You can also filter nested fields. For example, you could specify
611 `scheduling.automaticRestart = false` to include instances only
612 if they are not scheduled for automatic restarts. You can use filtering
613 on nested fields to filter based onresource labels.
614
615 To filter on multiple expressions, provide each separate expression within
616 parentheses. For example:
617 ```
618 (scheduling.automaticRestart = true)
619 (cpuPlatform = &quot;Intel Skylake&quot;)
620 ```
621 By default, each expression is an `AND` expression. However, you
622 can include `AND` and `OR` expressions explicitly.
623 For example:
624 ```
625 (cpuPlatform = &quot;Intel Skylake&quot;) OR
626 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
627 (scheduling.automaticRestart = true)
628 ```
629
630 If you want to use a regular expression, use the `eq` (equal) or `ne`
631 (not equal) operator against a single un-parenthesized expression with or
632 without quotes or against multiple parenthesized expressions. Examples:
633
634 `fieldname eq unquoted literal`
635 `fieldname eq &#x27;single quoted literal&#x27;`
636 `fieldname eq &quot;double quoted literal&quot;`
637 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
638
639 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
640 The literal value must match the entire field.
641
642 For example, to filter for instances that do not end with name &quot;instance&quot;,
643 you would use `name ne .*instance`.
644
645 You cannot combine constraints on multiple fields using regular
646 expressions.
647 maxResults: integer, The maximum number of results per page that should be returned.
648 If the number of available results is larger than `maxResults`,
649 Compute Engine returns a `nextPageToken` that can be used to get
650 the next page of results in subsequent list requests. Acceptable values are
651 `0` to `500`, inclusive. (Default: `500`)
652 orderBy: string, Sorts list results by a certain order. By default, results
653 are returned in alphanumerical order based on the resource name.
654
655 You can also sort results in descending order based on the creation
656 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
657 results based on the `creationTimestamp` field in
658 reverse chronological order (newest result first). Use this to sort
659 resources like operations so that the newest operation is returned first.
660
661 Currently, only sorting by `name` or
662 `creationTimestamp desc` is supported.
663 pageToken: string, Specifies a page token to use. Set `pageToken` to the
664 `nextPageToken` returned by a previous list request to get
665 the next page of results.
666 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
667 of failure. The default value is false.
668
669 For example, when partial success behavior is enabled, aggregatedList for a
670 single zone scope either returns all resources in the zone or no resources,
671 with an error code.
672 x__xgafv: string, V1 error format.
673 Allowed values
674 1 - v1 error format
675 2 - v2 error format
676
677 Returns:
678 An object of the form:
679
680 { # A list of reservation blocks under a single reservation.
681 &quot;id&quot;: &quot;A String&quot;, # Unique identifier for the resource; defined by the server.
682 &quot;items&quot;: [ # A list of reservation block resources.
683 { # Represents a reservation block resource.
684 &quot;blockHealthInfo&quot;: { # Health information for the reservation block. # Output only. [Output Only] Health information for the reservation block.
685 &quot;degradedSubBlockCount&quot;: 42, # The number of subBlocks that are degraded.
686 &quot;healthStatus&quot;: &quot;A String&quot;, # The health status of the reservation block.
687 &quot;healthySubBlockCount&quot;: 42, # The number of subBlocks that are healthy.
688 },
689 &quot;count&quot;: 42, # Output only. [Output Only] The number of resources that are allocated in this
690 # reservation block.
691 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339 text format.
692 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
693 # defined by the server.
694 &quot;inUseCount&quot;: 42, # Output only. [Output Only] The number of instances that are currently in use on this
695 # reservation block.
696 &quot;inUseHostCount&quot;: 42, # Output only. Number of hosts currently in use. If there is one or more Instances running
697 # on the host, it is considered in use.
698 &quot;kind&quot;: &quot;compute#reservationBlock&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#reservationBlock for reservation blocks.
699 &quot;name&quot;: &quot;A String&quot;, # Output only. [Output Only] The name of this reservation block generated by Google
700 # Compute Engine. The name must be 1-63 characters long, and comply with
701 # RFC1035 @pattern [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
702 &quot;physicalTopology&quot;: { # Output only. [Output Only] The physical topology of the reservation block.
703 &quot;block&quot;: &quot;A String&quot;, # The hash of the capacity block within the cluster.
704 &quot;cluster&quot;: &quot;A String&quot;, # The cluster name of the reservation block.
705 &quot;instances&quot;: [ # Output only. The detailed instances information for a given Block
706 { # The instances information for a given Block
707 &quot;instanceId&quot;: &quot;A String&quot;, # The InstanceId of the instance
708 &quot;physicalHostTopology&quot;: { # The PhysicalHostTopology of the instance within a Block resource. # Output only. The PhysicalHostTopology of instances within a Block resource.
709 &quot;host&quot;: &quot;A String&quot;, # Host hash for a given instance
710 &quot;subBlock&quot;: &quot;A String&quot;, # Sub block hash for a given instance
711 },
712 &quot;projectId&quot;: &quot;A String&quot;, # Project where the instance lives
713 },
714 ],
715 },
716 &quot;reservationMaintenance&quot;: { # Maintenance Info for ReservationBlocks. # Output only. [Output Only] Maintenance information for this reservation block.
717 &quot;instanceMaintenanceOngoingCount&quot;: 42, # Describes number of instances that have ongoing maintenance.
718 &quot;instanceMaintenancePendingCount&quot;: 42, # Describes number of instances that have pending maintenance.
719 &quot;maintenanceOngoingCount&quot;: 42, # Progress for ongoing maintenance for this group of VMs/hosts.
720 # Describes number of hosts in the block that have ongoing maintenance.
721 &quot;maintenancePendingCount&quot;: 42, # Progress for ongoing maintenance for this group of VMs/hosts.
722 # Describes number of hosts in the block that have pending maintenance.
723 &quot;schedulingType&quot;: &quot;A String&quot;, # The type of maintenance for the reservation.
724 &quot;subblockInfraMaintenanceOngoingCount&quot;: 42, # Describes number of subblock Infrastructure that has ongoing maintenance.
725 # Here, Subblock Infrastructure Maintenance pertains to upstream hardware
726 # contained in the Subblock that is necessary for a VM Family(e.g. NVLink
727 # Domains). Not all VM Families will support this field.
728 &quot;subblockInfraMaintenancePendingCount&quot;: 42, # Describes number of subblock Infrastructure that has pending maintenance.
729 # Here, Subblock Infrastructure Maintenance pertains to upstream hardware
730 # contained in the Subblock that is necessary for a VM Family (e.g. NVLink
731 # Domains). Not all VM Families will support this field.
732 &quot;upcomingGroupMaintenance&quot;: { # Upcoming Maintenance notification information. # Maintenance information on this group of VMs.
733 &quot;canReschedule&quot;: True or False, # Indicates if the maintenance can be customer triggered.
734 &quot;latestWindowStartTime&quot;: &quot;A String&quot;, # The latest time for the planned maintenance window to start.
735 # This timestamp value is in RFC3339 text format.
736 &quot;maintenanceOnShutdown&quot;: True or False, # Indicates whether the UpcomingMaintenance will be triggered on VM shutdown.
737 &quot;maintenanceReasons&quot;: [ # The reasons for the maintenance. Only valid for vms.
738 &quot;A String&quot;,
739 ],
740 &quot;maintenanceStatus&quot;: &quot;A String&quot;,
741 &quot;type&quot;: &quot;A String&quot;, # Defines the type of maintenance.
742 &quot;windowEndTime&quot;: &quot;A String&quot;, # The time by which the maintenance disruption will be completed.
743 # This timestamp value is in RFC3339 text format.
744 &quot;windowStartTime&quot;: &quot;A String&quot;, # The current start time of the maintenance window.
745 # This timestamp value is in RFC3339 text format.
746 },
747 },
748 &quot;reservationSubBlockCount&quot;: 42, # Output only. [Output Only] The number of reservation subBlocks associated with this
749 # reservation block.
750 &quot;reservationSubBlockInUseCount&quot;: 42, # Output only. [Output Only] The number of in-use reservation subBlocks associated with
751 # this reservation block. If at least one VM is running on a subBlock, it is
752 # considered in-use.
753 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined fully-qualified URL for this resource.
754 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
755 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only] Status of the reservation block.
756 &quot;zone&quot;: &quot;A String&quot;, # Output only. [Output Only] Zone in which the reservation block resides.
757 },
758 ],
759 &quot;kind&quot;: &quot;compute#reservationBlock&quot;, # Type of the resource. Alwayscompute#reservationBlock for a list of reservation blocks.
760 &quot;nextPageToken&quot;: &quot;A String&quot;, # This token allows you to get the next page of results for
761 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
762 # the query parameter pageToken in the next list request.
763 # Subsequent list requests will have their own nextPageToken to
764 # continue paging through the results.
765 &quot;selfLink&quot;: &quot;A String&quot;, # Server-defined URL for this resource.
766 &quot;warning&quot;: { # Informational warning message.
767 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
768 # Engine returns NO_RESULTS_ON_PAGE if there
769 # are no results in the response.
770 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
771 # value format. For example:
772 #
773 # &quot;data&quot;: [
774 # {
775 # &quot;key&quot;: &quot;scope&quot;,
776 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
777 # }
778 {
779 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
780 # returned. For example, for warnings where there are no results in a list
781 # request for a particular zone, this key might be scope and
782 # the key value might be the zone name. Other examples might be a key
783 # indicating a deprecated resource and a suggested replacement, or a
784 # warning about invalid network settings (for example, if an instance
785 # attempts to perform IP forwarding but is not enabled for IP forwarding).
786 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
787 },
788 ],
789 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
790 },
791 }</pre>
792 </div>
793
794 <div class="method">
795 <code class="details" id="list_next">list_next()</code>
796 <pre>Retrieves the next page of results.
797
798 Args:
799 previous_request: The request for the previous page. (required)
800 previous_response: The response from the request for the previous page. (required)
801
802 Returns:
803 A request object that you can call &#x27;execute()&#x27; on to request the next
804 page. Returns None if there are no more items in the collection.
805 </pre>
806 </div>
807
808 <div class="method">
809 <code class="details" id="performMaintenance">performMaintenance(project, zone, reservation, reservationBlock, body=None, requestId=None, x__xgafv=None)</code>
810 <pre>Allows customers to perform maintenance on a reservation block
811
812 Args:
813 project: string, Project ID for this request. (required)
814 zone: string, Name of the zone for this request. Zone name should conform to RFC1035. (required)
815 reservation: string, The name of the reservation.
816 Name should conform to RFC1035 or be a resource ID. (required)
817 reservationBlock: string, The name of the reservation block.
818 Name should conform to RFC1035 or be a resource ID. (required)
819 body: object, The request body.
820 The object takes the form of:
821
822 {
823 &quot;maintenanceScope&quot;: &quot;A String&quot;, # Specifies if all, running or unused hosts are in scope for this request.
824 }
825
826 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
827 that if you must retry your request, the server will know to ignore the
828 request if it has already been completed.
829
830 For example, consider a situation where you make an initial request and
831 the request times out. If you make the request again with the same
832 request ID, the server can check if original operation with the same
833 request ID was received, and if so, will ignore the second request. This
834 prevents clients from accidentally creating duplicate commitments.
835
836 The request ID must be
837 a valid UUID with the exception that zero UUID is not supported
838 (00000000-0000-0000-0000-000000000000).
839 x__xgafv: string, V1 error format.
840 Allowed values
841 1 - v1 error format
842 2 - v2 error format
843
844 Returns:
845 An object of the form:
846
847 { # Represents an Operation resource.
848 #
849 # Google Compute Engine has three Operation resources:
850 #
851 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
852 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
853 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
854 #
855 # You can use an operation resource to manage asynchronous API requests.
856 # For more information, readHandling
857 # API responses.
858 #
859 # Operations can be global, regional or zonal.
860 #
861 # - For global operations, use the `globalOperations`
862 # resource.
863 # - For regional operations, use the
864 # `regionOperations` resource.
865 # - For zonal operations, use
866 # the `zoneOperations` resource.
867 #
868 #
869 #
870 # For more information, read
871 # Global, Regional, and Zonal Resources.
872 #
873 # Note that completed Operation resources have a limited
874 # retention period.
875 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
876 # Not present otherwise.
877 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
878 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
879 # set when the operation is created.
880 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
881 # text format.
882 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
883 # this field will be populated.
884 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
885 # operation.
886 {
887 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
888 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
889 # details. There is a set of defined message types to use for providing
890 # details.The syntax depends on the error code. For example,
891 # QuotaExceededInfo will have details when the error code is
892 # QUOTA_EXCEEDED.
893 {
894 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
895 #
896 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
897 # is not enabled:
898 #
899 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
900 # &quot;domain&quot;: &quot;googleapis.com&quot;
901 # &quot;metadata&quot;: {
902 # &quot;resource&quot;: &quot;projects/123&quot;,
903 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
904 # }
905 # }
906 #
907 # This response indicates that the pubsub.googleapis.com API is not enabled.
908 #
909 # Example of an error that is returned when attempting to create a Spanner
910 # instance in a region that is out of stock:
911 #
912 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
913 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
914 # &quot;metadata&quot;: {
915 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
916 # }
917 # }
918 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
919 # is typically the registered service name of the tool or product that
920 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
921 # generated by some common infrastructure, the error domain must be a
922 # globally unique value that identifies the infrastructure. For Google API
923 # infrastructure, the error domain is &quot;googleapis.com&quot;.
924 &quot;metadatas&quot;: { # Additional structured details about this error.
925 #
926 # Keys must match a regular expression of `a-z+` but should
927 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
928 # length. When identifying the current value of an exceeded limit, the units
929 # should be contained in the key, not the value. For example, rather than
930 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
931 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
932 # instances that can be created in a single (batch) request.
933 &quot;a_key&quot;: &quot;A String&quot;,
934 },
935 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
936 # proximate cause of the error. Error reasons are unique within a particular
937 # domain of errors. This should be at most 63 characters and match a
938 # regular expression of `A-Z+[A-Z0-9]`, which represents
939 # UPPER_SNAKE_CASE.
940 },
941 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
942 #
943 # For example, if a quota check failed with an error indicating the calling
944 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
945 # directly to the right place in the developer console to flip the bit.
946 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
947 { # Describes a URL link.
948 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
949 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
950 },
951 ],
952 },
953 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
954 # which can be attached to an RPC error.
955 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
956 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
957 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
958 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
959 },
960 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
961 &quot;dimensions&quot;: { # The map holding related quota dimensions.
962 &quot;a_key&quot;: &quot;A String&quot;,
963 },
964 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
965 # type or metric.
966 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
967 # or metric.
968 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
969 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
970 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
971 },
972 },
973 ],
974 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
975 # This property is optional.
976 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
977 },
978 ],
979 },
980 &quot;getVersionOperationMetadata&quot;: {
981 &quot;inlineSbomInfo&quot;: {
982 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
983 # appropriate identifiers.
984 &quot;a_key&quot;: &quot;A String&quot;,
985 },
986 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
987 # identifiers.
988 &quot;a_key&quot;: &quot;A String&quot;,
989 },
990 },
991 },
992 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
993 # message that was returned, such as `NOT FOUND`.
994 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
995 # status code that was returned. For example, a `404` means the
996 # resource was not found.
997 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
998 # defined by the server.
999 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1000 # This value is inRFC3339
1001 # text format.
1002 &quot;instancesBulkInsertOperationMetadata&quot;: {
1003 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1004 # Example key: zones/us-central1-a
1005 &quot;a_key&quot;: {
1006 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1007 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1008 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1009 # error.
1010 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1011 # if the flow is rolling forward or rolling back.
1012 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1013 },
1014 },
1015 },
1016 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1017 # Operation resources.
1018 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1019 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1020 # group of operations results from a `bulkInsert` API request.
1021 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1022 # `update`, or `delete`, and so on.
1023 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1024 # There is no requirement that this be linear or support any granularity of
1025 # operations. This should not be used to guess when the operation will be
1026 # complete. This number should monotonically increase as the operation
1027 # progresses.
1028 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1029 # applicable when performing regional operations.
1030 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1031 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1032 # this field will contain information on all underlying zonal actions and
1033 # their state.
1034 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1035 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1036 # Example key: zones/us-central1-a
1037 &quot;a_key&quot;: {
1038 &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
1039 # populated.
1040 # different programming environments, including REST APIs and RPC APIs. It is
1041 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1042 # three pieces of data: error code, error message, and error details.
1043 #
1044 # You can find out more about this error model and how to work with it in the
1045 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1046 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1047 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1048 # message types for APIs to use.
1049 {
1050 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1051 },
1052 ],
1053 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1054 # user-facing error message should be localized and sent in the
1055 # google.rpc.Status.details field, or localized by the client.
1056 },
1057 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1058 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1059 },
1060 },
1061 },
1062 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1063 # This value is inRFC3339
1064 # text format.
1065 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1066 # following:
1067 # `PENDING`, `RUNNING`, or `DONE`.
1068 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1069 # operation.
1070 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1071 # of the target resource.
1072 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1073 # operations related to creating a snapshot, this points to the disk
1074 # that the snapshot was created from.
1075 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1076 # `[email protected]` or
1077 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1078 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1079 # operation, this field will be populated.
1080 {
1081 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1082 # Engine returns NO_RESULTS_ON_PAGE if there
1083 # are no results in the response.
1084 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1085 # value format. For example:
1086 #
1087 # &quot;data&quot;: [
1088 # {
1089 # &quot;key&quot;: &quot;scope&quot;,
1090 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1091 # }
1092 {
1093 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1094 # returned. For example, for warnings where there are no results in a list
1095 # request for a particular zone, this key might be scope and
1096 # the key value might be the zone name. Other examples might be a key
1097 # indicating a deprecated resource and a suggested replacement, or a
1098 # warning about invalid network settings (for example, if an instance
1099 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1100 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1101 },
1102 ],
1103 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1104 },
1105 ],
1106 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1107 # applicable when performing per-zone operations.
1108 }</pre>
1109 </div>
1110
1111 <div class="method">
1112 <code class="details" id="setIamPolicy">setIamPolicy(project, zone, parentResource, resource, body=None, x__xgafv=None)</code>
1113 <pre>Sets the access control policy on the specified resource.
1114 Replaces any existing policy.
1115
1116 Args:
1117 project: string, Project ID for this request. (required)
1118 zone: string, The name of the zone for this request. (required)
1119 parentResource: string, Name or id of parent resource of the resource for this request. (required)
1120 resource: string, Name or id of the resource for this request. (required)
1121 body: object, The request body.
1122 The object takes the form of:
1123
1124 {
1125 &quot;bindings&quot;: [ # Flatten Policy to create a backwacd compatible wire-format.
1126 # Deprecated. Use &#x27;policy&#x27; to specify bindings.
1127 { # Associates `members`, or principals, with a `role`.
1128 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
1129 #
1130 # If the condition evaluates to `true`, then this binding applies to the
1131 # current request.
1132 #
1133 # If the condition evaluates to `false`, then this binding does not apply to
1134 # the current request. However, a different role binding might grant the same
1135 # role to one or more of the principals in this binding.
1136 #
1137 # To learn which resources support conditions in their IAM policies, see the
1138 # [IAM
1139 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
1140 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
1141 # are documented at https://github.com/google/cel-spec.
1142 #
1143 # Example (Comparison):
1144 #
1145 # title: &quot;Summary size limit&quot;
1146 # description: &quot;Determines if a summary is less than 100 chars&quot;
1147 # expression: &quot;document.summary.size() &lt; 100&quot;
1148 #
1149 # Example (Equality):
1150 #
1151 # title: &quot;Requestor is owner&quot;
1152 # description: &quot;Determines if requestor is the document owner&quot;
1153 # expression: &quot;document.owner == request.auth.claims.email&quot;
1154 #
1155 # Example (Logic):
1156 #
1157 # title: &quot;Public documents&quot;
1158 # description: &quot;Determine whether the document should be publicly visible&quot;
1159 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
1160 #
1161 # Example (Data Manipulation):
1162 #
1163 # title: &quot;Notification string&quot;
1164 # description: &quot;Create a notification string with a timestamp.&quot;
1165 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
1166 #
1167 # The exact variables and functions that may be referenced within an expression
1168 # are determined by the service that evaluates it. See the service
1169 # documentation for additional information.
1170 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
1171 # describes the expression, e.g. when hovered over it in a UI.
1172 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
1173 # syntax.
1174 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
1175 # reporting, e.g. a file name and a position in the file.
1176 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
1177 # its purpose. This can be used e.g. in UIs which allow to enter the
1178 # expression.
1179 },
1180 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
1181 # `members` can have the following values:
1182 #
1183 # * `allUsers`: A special identifier that represents anyone who is
1184 # on the internet; with or without a Google account.
1185 #
1186 # * `allAuthenticatedUsers`: A special identifier that represents anyone
1187 # who is authenticated with a Google account or a service account.
1188 # Does not include identities that come from external identity providers
1189 # (IdPs) through identity federation.
1190 #
1191 # * `user:{emailid}`: An email address that represents a specific Google
1192 # account. For example, `[email protected]` .
1193 #
1194 #
1195 # * `serviceAccount:{emailid}`: An email address that represents a Google
1196 # service account. For example,
1197 # `[email protected]`.
1198 #
1199 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
1200 # identifier for a
1201 # [Kubernetes service
1202 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
1203 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
1204 #
1205 # * `group:{emailid}`: An email address that represents a Google group.
1206 # For example, `[email protected]`.
1207 #
1208 #
1209 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
1210 # users of that domain. For example, `google.com` or `example.com`.
1211 #
1212 #
1213 #
1214 #
1215 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
1216 # A single identity in a workforce identity pool.
1217 #
1218 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
1219 # All workforce identities in a group.
1220 #
1221 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
1222 # All workforce identities with a specific attribute value.
1223 #
1224 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
1225 # All identities in a workforce identity pool.
1226 #
1227 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
1228 # A single identity in a workload identity pool.
1229 #
1230 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
1231 # A workload identity pool group.
1232 #
1233 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
1234 # All identities in a workload identity pool with a certain attribute.
1235 #
1236 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
1237 # All identities in a workload identity pool.
1238 #
1239 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
1240 # identifier) representing a user that has been recently deleted. For
1241 # example, `[email protected]?uid=123456789012345678901`. If the user is
1242 # recovered, this value reverts to `user:{emailid}` and the recovered user
1243 # retains the role in the binding.
1244 #
1245 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
1246 # unique identifier) representing a service account that has been recently
1247 # deleted. For example,
1248 # `[email protected]?uid=123456789012345678901`.
1249 # If the service account is undeleted, this value reverts to
1250 # `serviceAccount:{emailid}` and the undeleted service account retains the
1251 # role in the binding.
1252 #
1253 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
1254 # identifier) representing a Google group that has been recently
1255 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
1256 # the group is recovered, this value reverts to `group:{emailid}` and the
1257 # recovered group retains the role in the binding.
1258 #
1259 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
1260 # Deleted single identity in a workforce identity pool. For example,
1261 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
1262 &quot;A String&quot;,
1263 ],
1264 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
1265 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
1266 #
1267 # For an overview of the IAM roles and permissions, see the
1268 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
1269 # a list of the available pre-defined roles, see
1270 # [here](https://cloud.google.com/iam/docs/understanding-roles).
1271 },
1272 ],
1273 &quot;etag&quot;: &quot;A String&quot;, # Flatten Policy to create a backward compatible wire-format.
1274 # Deprecated. Use &#x27;policy&#x27; to specify the etag.
1275 &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
1276 # the policy is limited to a few 10s of KB. An empty policy is in general a
1277 # valid policy but certain services (like Projects) might reject them.
1278 # controls for Google Cloud resources.
1279 #
1280 #
1281 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
1282 # `members`, or principals, to a single `role`. Principals can be user
1283 # accounts, service accounts, Google groups, and domains (such as G Suite). A
1284 # `role` is a named list of permissions; each `role` can be an IAM predefined
1285 # role or a user-created custom role.
1286 #
1287 # For some types of Google Cloud resources, a `binding` can also specify a
1288 # `condition`, which is a logical expression that allows access to a resource
1289 # only if the expression evaluates to `true`. A condition can add constraints
1290 # based on attributes of the request, the resource, or both. To learn which
1291 # resources support conditions in their IAM policies, see the
1292 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
1293 #
1294 # **JSON example:**
1295 #
1296 # ```
1297 # {
1298 # &quot;bindings&quot;: [
1299 # {
1300 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
1301 # &quot;members&quot;: [
1302 # &quot;user:[email protected]&quot;,
1303 # &quot;group:[email protected]&quot;,
1304 # &quot;domain:google.com&quot;,
1305 # &quot;serviceAccount:[email protected]&quot;
1306 # ]
1307 # },
1308 # {
1309 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
1310 # &quot;members&quot;: [
1311 # &quot;user:[email protected]&quot;
1312 # ],
1313 # &quot;condition&quot;: {
1314 # &quot;title&quot;: &quot;expirable access&quot;,
1315 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
1316 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
1317 # }
1318 # }
1319 # ],
1320 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
1321 # &quot;version&quot;: 3
1322 # }
1323 # ```
1324 #
1325 # **YAML example:**
1326 #
1327 # ```
1328 # bindings:
1329 # - members:
1330 # - user:[email protected]
1331 # - group:[email protected]
1332 # - domain:google.com
1333 # - serviceAccount:[email protected]
1334 # role: roles/resourcemanager.organizationAdmin
1335 # - members:
1336 # - user:[email protected]
1337 # role: roles/resourcemanager.organizationViewer
1338 # condition:
1339 # title: expirable access
1340 # description: Does not grant access after Sep 2020
1341 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
1342 # etag: BwWWja0YfJA=
1343 # version: 3
1344 # ```
1345 #
1346 # For a description of IAM and its features, see the
1347 # [IAM documentation](https://cloud.google.com/iam/docs/).
1348 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
1349 { # Specifies the audit configuration for a service.
1350 # The configuration determines which permission types are logged, and what
1351 # identities, if any, are exempted from logging.
1352 # An AuditConfig must have one or more AuditLogConfigs.
1353 #
1354 # If there are AuditConfigs for both `allServices` and a specific service,
1355 # the union of the two AuditConfigs is used for that service: the log_types
1356 # specified in each AuditConfig are enabled, and the exempted_members in each
1357 # AuditLogConfig are exempted.
1358 #
1359 # Example Policy with multiple AuditConfigs:
1360 #
1361 # {
1362 # &quot;audit_configs&quot;: [
1363 # {
1364 # &quot;service&quot;: &quot;allServices&quot;,
1365 # &quot;audit_log_configs&quot;: [
1366 # {
1367 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
1368 # &quot;exempted_members&quot;: [
1369 # &quot;user:[email protected]&quot;
1370 # ]
1371 # },
1372 # {
1373 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
1374 # },
1375 # {
1376 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
1377 # }
1378 # ]
1379 # },
1380 # {
1381 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
1382 # &quot;audit_log_configs&quot;: [
1383 # {
1384 # &quot;log_type&quot;: &quot;DATA_READ&quot;
1385 # },
1386 # {
1387 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
1388 # &quot;exempted_members&quot;: [
1389 # &quot;user:[email protected]&quot;
1390 # ]
1391 # }
1392 # ]
1393 # }
1394 # ]
1395 # }
1396 #
1397 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
1398 # logging. It also exempts `[email protected]` from DATA_READ logging, and
1399 # `[email protected]` from DATA_WRITE logging.
1400 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
1401 { # Provides the configuration for logging a type of permissions.
1402 # Example:
1403 #
1404 # {
1405 # &quot;audit_log_configs&quot;: [
1406 # {
1407 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
1408 # &quot;exempted_members&quot;: [
1409 # &quot;user:[email protected]&quot;
1410 # ]
1411 # },
1412 # {
1413 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
1414 # }
1415 # ]
1416 # }
1417 #
1418 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
1419 # [email protected] from DATA_READ logging.
1420 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
1421 # permission.
1422 # Follows the same format of Binding.members.
1423 &quot;A String&quot;,
1424 ],
1425 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
1426 },
1427 ],
1428 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
1429 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
1430 # `allServices` is a special value that covers all services.
1431 },
1432 ],
1433 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
1434 # may specify a `condition` that determines how and when the `bindings` are
1435 # applied. Each of the `bindings` must contain at least one principal.
1436 #
1437 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
1438 # of these principals can be Google groups. Each occurrence of a principal
1439 # counts towards these limits. For example, if the `bindings` grant 50
1440 # different roles to `user:[email protected]`, and not to any other
1441 # principal, then you can add another 1,450 principals to the `bindings` in
1442 # the `Policy`.
1443 { # Associates `members`, or principals, with a `role`.
1444 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
1445 #
1446 # If the condition evaluates to `true`, then this binding applies to the
1447 # current request.
1448 #
1449 # If the condition evaluates to `false`, then this binding does not apply to
1450 # the current request. However, a different role binding might grant the same
1451 # role to one or more of the principals in this binding.
1452 #
1453 # To learn which resources support conditions in their IAM policies, see the
1454 # [IAM
1455 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
1456 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
1457 # are documented at https://github.com/google/cel-spec.
1458 #
1459 # Example (Comparison):
1460 #
1461 # title: &quot;Summary size limit&quot;
1462 # description: &quot;Determines if a summary is less than 100 chars&quot;
1463 # expression: &quot;document.summary.size() &lt; 100&quot;
1464 #
1465 # Example (Equality):
1466 #
1467 # title: &quot;Requestor is owner&quot;
1468 # description: &quot;Determines if requestor is the document owner&quot;
1469 # expression: &quot;document.owner == request.auth.claims.email&quot;
1470 #
1471 # Example (Logic):
1472 #
1473 # title: &quot;Public documents&quot;
1474 # description: &quot;Determine whether the document should be publicly visible&quot;
1475 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
1476 #
1477 # Example (Data Manipulation):
1478 #
1479 # title: &quot;Notification string&quot;
1480 # description: &quot;Create a notification string with a timestamp.&quot;
1481 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
1482 #
1483 # The exact variables and functions that may be referenced within an expression
1484 # are determined by the service that evaluates it. See the service
1485 # documentation for additional information.
1486 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
1487 # describes the expression, e.g. when hovered over it in a UI.
1488 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
1489 # syntax.
1490 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
1491 # reporting, e.g. a file name and a position in the file.
1492 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
1493 # its purpose. This can be used e.g. in UIs which allow to enter the
1494 # expression.
1495 },
1496 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
1497 # `members` can have the following values:
1498 #
1499 # * `allUsers`: A special identifier that represents anyone who is
1500 # on the internet; with or without a Google account.
1501 #
1502 # * `allAuthenticatedUsers`: A special identifier that represents anyone
1503 # who is authenticated with a Google account or a service account.
1504 # Does not include identities that come from external identity providers
1505 # (IdPs) through identity federation.
1506 #
1507 # * `user:{emailid}`: An email address that represents a specific Google
1508 # account. For example, `[email protected]` .
1509 #
1510 #
1511 # * `serviceAccount:{emailid}`: An email address that represents a Google
1512 # service account. For example,
1513 # `[email protected]`.
1514 #
1515 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
1516 # identifier for a
1517 # [Kubernetes service
1518 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
1519 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
1520 #
1521 # * `group:{emailid}`: An email address that represents a Google group.
1522 # For example, `[email protected]`.
1523 #
1524 #
1525 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
1526 # users of that domain. For example, `google.com` or `example.com`.
1527 #
1528 #
1529 #
1530 #
1531 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
1532 # A single identity in a workforce identity pool.
1533 #
1534 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
1535 # All workforce identities in a group.
1536 #
1537 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
1538 # All workforce identities with a specific attribute value.
1539 #
1540 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
1541 # All identities in a workforce identity pool.
1542 #
1543 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
1544 # A single identity in a workload identity pool.
1545 #
1546 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
1547 # A workload identity pool group.
1548 #
1549 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
1550 # All identities in a workload identity pool with a certain attribute.
1551 #
1552 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
1553 # All identities in a workload identity pool.
1554 #
1555 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
1556 # identifier) representing a user that has been recently deleted. For
1557 # example, `[email protected]?uid=123456789012345678901`. If the user is
1558 # recovered, this value reverts to `user:{emailid}` and the recovered user
1559 # retains the role in the binding.
1560 #
1561 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
1562 # unique identifier) representing a service account that has been recently
1563 # deleted. For example,
1564 # `[email protected]?uid=123456789012345678901`.
1565 # If the service account is undeleted, this value reverts to
1566 # `serviceAccount:{emailid}` and the undeleted service account retains the
1567 # role in the binding.
1568 #
1569 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
1570 # identifier) representing a Google group that has been recently
1571 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
1572 # the group is recovered, this value reverts to `group:{emailid}` and the
1573 # recovered group retains the role in the binding.
1574 #
1575 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
1576 # Deleted single identity in a workforce identity pool. For example,
1577 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
1578 &quot;A String&quot;,
1579 ],
1580 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
1581 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
1582 #
1583 # For an overview of the IAM roles and permissions, see the
1584 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
1585 # a list of the available pre-defined roles, see
1586 # [here](https://cloud.google.com/iam/docs/understanding-roles).
1587 },
1588 ],
1589 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
1590 # prevent simultaneous updates of a policy from overwriting each other.
1591 # It is strongly suggested that systems make use of the `etag` in the
1592 # read-modify-write cycle to perform policy updates in order to avoid race
1593 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
1594 # systems are expected to put that etag in the request to `setIamPolicy` to
1595 # ensure that their change will be applied to the same version of the policy.
1596 #
1597 # **Important:** If you use IAM Conditions, you must include the `etag` field
1598 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
1599 # you to overwrite a version `3` policy with a version `1` policy, and all of
1600 # the conditions in the version `3` policy are lost.
1601 &quot;version&quot;: 42, # Specifies the format of the policy.
1602 #
1603 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
1604 # are rejected.
1605 #
1606 # Any operation that affects conditional role bindings must specify version
1607 # `3`. This requirement applies to the following operations:
1608 #
1609 # * Getting a policy that includes a conditional role binding
1610 # * Adding a conditional role binding to a policy
1611 # * Changing a conditional role binding in a policy
1612 # * Removing any role binding, with or without a condition, from a policy
1613 # that includes conditions
1614 #
1615 # **Important:** If you use IAM Conditions, you must include the `etag` field
1616 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
1617 # you to overwrite a version `3` policy with a version `1` policy, and all of
1618 # the conditions in the version `3` policy are lost.
1619 #
1620 # If a policy does not include any conditions, operations on that policy may
1621 # specify any valid version or leave the field unset.
1622 #
1623 # To learn which resources support conditions in their IAM policies, see the
1624 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
1625 },
1626 }
1627
1628 x__xgafv: string, V1 error format.
1629 Allowed values
1630 1 - v1 error format
1631 2 - v2 error format
1632
1633 Returns:
1634 An object of the form:
1635
1636 { # An Identity and Access Management (IAM) policy, which specifies access
1637 # controls for Google Cloud resources.
1638 #
1639 #
1640 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
1641 # `members`, or principals, to a single `role`. Principals can be user
1642 # accounts, service accounts, Google groups, and domains (such as G Suite). A
1643 # `role` is a named list of permissions; each `role` can be an IAM predefined
1644 # role or a user-created custom role.
1645 #
1646 # For some types of Google Cloud resources, a `binding` can also specify a
1647 # `condition`, which is a logical expression that allows access to a resource
1648 # only if the expression evaluates to `true`. A condition can add constraints
1649 # based on attributes of the request, the resource, or both. To learn which
1650 # resources support conditions in their IAM policies, see the
1651 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
1652 #
1653 # **JSON example:**
1654 #
1655 # ```
1656 # {
1657 # &quot;bindings&quot;: [
1658 # {
1659 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
1660 # &quot;members&quot;: [
1661 # &quot;user:[email protected]&quot;,
1662 # &quot;group:[email protected]&quot;,
1663 # &quot;domain:google.com&quot;,
1664 # &quot;serviceAccount:[email protected]&quot;
1665 # ]
1666 # },
1667 # {
1668 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
1669 # &quot;members&quot;: [
1670 # &quot;user:[email protected]&quot;
1671 # ],
1672 # &quot;condition&quot;: {
1673 # &quot;title&quot;: &quot;expirable access&quot;,
1674 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
1675 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
1676 # }
1677 # }
1678 # ],
1679 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
1680 # &quot;version&quot;: 3
1681 # }
1682 # ```
1683 #
1684 # **YAML example:**
1685 #
1686 # ```
1687 # bindings:
1688 # - members:
1689 # - user:[email protected]
1690 # - group:[email protected]
1691 # - domain:google.com
1692 # - serviceAccount:[email protected]
1693 # role: roles/resourcemanager.organizationAdmin
1694 # - members:
1695 # - user:[email protected]
1696 # role: roles/resourcemanager.organizationViewer
1697 # condition:
1698 # title: expirable access
1699 # description: Does not grant access after Sep 2020
1700 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
1701 # etag: BwWWja0YfJA=
1702 # version: 3
1703 # ```
1704 #
1705 # For a description of IAM and its features, see the
1706 # [IAM documentation](https://cloud.google.com/iam/docs/).
1707 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
1708 { # Specifies the audit configuration for a service.
1709 # The configuration determines which permission types are logged, and what
1710 # identities, if any, are exempted from logging.
1711 # An AuditConfig must have one or more AuditLogConfigs.
1712 #
1713 # If there are AuditConfigs for both `allServices` and a specific service,
1714 # the union of the two AuditConfigs is used for that service: the log_types
1715 # specified in each AuditConfig are enabled, and the exempted_members in each
1716 # AuditLogConfig are exempted.
1717 #
1718 # Example Policy with multiple AuditConfigs:
1719 #
1720 # {
1721 # &quot;audit_configs&quot;: [
1722 # {
1723 # &quot;service&quot;: &quot;allServices&quot;,
1724 # &quot;audit_log_configs&quot;: [
1725 # {
1726 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
1727 # &quot;exempted_members&quot;: [
1728 # &quot;user:[email protected]&quot;
1729 # ]
1730 # },
1731 # {
1732 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
1733 # },
1734 # {
1735 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
1736 # }
1737 # ]
1738 # },
1739 # {
1740 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
1741 # &quot;audit_log_configs&quot;: [
1742 # {
1743 # &quot;log_type&quot;: &quot;DATA_READ&quot;
1744 # },
1745 # {
1746 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
1747 # &quot;exempted_members&quot;: [
1748 # &quot;user:[email protected]&quot;
1749 # ]
1750 # }
1751 # ]
1752 # }
1753 # ]
1754 # }
1755 #
1756 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
1757 # logging. It also exempts `[email protected]` from DATA_READ logging, and
1758 # `[email protected]` from DATA_WRITE logging.
1759 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
1760 { # Provides the configuration for logging a type of permissions.
1761 # Example:
1762 #
1763 # {
1764 # &quot;audit_log_configs&quot;: [
1765 # {
1766 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
1767 # &quot;exempted_members&quot;: [
1768 # &quot;user:[email protected]&quot;
1769 # ]
1770 # },
1771 # {
1772 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
1773 # }
1774 # ]
1775 # }
1776 #
1777 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
1778 # [email protected] from DATA_READ logging.
1779 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
1780 # permission.
1781 # Follows the same format of Binding.members.
1782 &quot;A String&quot;,
1783 ],
1784 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
1785 },
1786 ],
1787 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
1788 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
1789 # `allServices` is a special value that covers all services.
1790 },
1791 ],
1792 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
1793 # may specify a `condition` that determines how and when the `bindings` are
1794 # applied. Each of the `bindings` must contain at least one principal.
1795 #
1796 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
1797 # of these principals can be Google groups. Each occurrence of a principal
1798 # counts towards these limits. For example, if the `bindings` grant 50
1799 # different roles to `user:[email protected]`, and not to any other
1800 # principal, then you can add another 1,450 principals to the `bindings` in
1801 # the `Policy`.
1802 { # Associates `members`, or principals, with a `role`.
1803 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
1804 #
1805 # If the condition evaluates to `true`, then this binding applies to the
1806 # current request.
1807 #
1808 # If the condition evaluates to `false`, then this binding does not apply to
1809 # the current request. However, a different role binding might grant the same
1810 # role to one or more of the principals in this binding.
1811 #
1812 # To learn which resources support conditions in their IAM policies, see the
1813 # [IAM
1814 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
1815 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
1816 # are documented at https://github.com/google/cel-spec.
1817 #
1818 # Example (Comparison):
1819 #
1820 # title: &quot;Summary size limit&quot;
1821 # description: &quot;Determines if a summary is less than 100 chars&quot;
1822 # expression: &quot;document.summary.size() &lt; 100&quot;
1823 #
1824 # Example (Equality):
1825 #
1826 # title: &quot;Requestor is owner&quot;
1827 # description: &quot;Determines if requestor is the document owner&quot;
1828 # expression: &quot;document.owner == request.auth.claims.email&quot;
1829 #
1830 # Example (Logic):
1831 #
1832 # title: &quot;Public documents&quot;
1833 # description: &quot;Determine whether the document should be publicly visible&quot;
1834 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
1835 #
1836 # Example (Data Manipulation):
1837 #
1838 # title: &quot;Notification string&quot;
1839 # description: &quot;Create a notification string with a timestamp.&quot;
1840 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
1841 #
1842 # The exact variables and functions that may be referenced within an expression
1843 # are determined by the service that evaluates it. See the service
1844 # documentation for additional information.
1845 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
1846 # describes the expression, e.g. when hovered over it in a UI.
1847 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
1848 # syntax.
1849 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
1850 # reporting, e.g. a file name and a position in the file.
1851 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
1852 # its purpose. This can be used e.g. in UIs which allow to enter the
1853 # expression.
1854 },
1855 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
1856 # `members` can have the following values:
1857 #
1858 # * `allUsers`: A special identifier that represents anyone who is
1859 # on the internet; with or without a Google account.
1860 #
1861 # * `allAuthenticatedUsers`: A special identifier that represents anyone
1862 # who is authenticated with a Google account or a service account.
1863 # Does not include identities that come from external identity providers
1864 # (IdPs) through identity federation.
1865 #
1866 # * `user:{emailid}`: An email address that represents a specific Google
1867 # account. For example, `[email protected]` .
1868 #
1869 #
1870 # * `serviceAccount:{emailid}`: An email address that represents a Google
1871 # service account. For example,
1872 # `[email protected]`.
1873 #
1874 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
1875 # identifier for a
1876 # [Kubernetes service
1877 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
1878 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
1879 #
1880 # * `group:{emailid}`: An email address that represents a Google group.
1881 # For example, `[email protected]`.
1882 #
1883 #
1884 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
1885 # users of that domain. For example, `google.com` or `example.com`.
1886 #
1887 #
1888 #
1889 #
1890 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
1891 # A single identity in a workforce identity pool.
1892 #
1893 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
1894 # All workforce identities in a group.
1895 #
1896 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
1897 # All workforce identities with a specific attribute value.
1898 #
1899 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
1900 # All identities in a workforce identity pool.
1901 #
1902 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
1903 # A single identity in a workload identity pool.
1904 #
1905 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
1906 # A workload identity pool group.
1907 #
1908 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
1909 # All identities in a workload identity pool with a certain attribute.
1910 #
1911 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
1912 # All identities in a workload identity pool.
1913 #
1914 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
1915 # identifier) representing a user that has been recently deleted. For
1916 # example, `[email protected]?uid=123456789012345678901`. If the user is
1917 # recovered, this value reverts to `user:{emailid}` and the recovered user
1918 # retains the role in the binding.
1919 #
1920 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
1921 # unique identifier) representing a service account that has been recently
1922 # deleted. For example,
1923 # `[email protected]?uid=123456789012345678901`.
1924 # If the service account is undeleted, this value reverts to
1925 # `serviceAccount:{emailid}` and the undeleted service account retains the
1926 # role in the binding.
1927 #
1928 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
1929 # identifier) representing a Google group that has been recently
1930 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
1931 # the group is recovered, this value reverts to `group:{emailid}` and the
1932 # recovered group retains the role in the binding.
1933 #
1934 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
1935 # Deleted single identity in a workforce identity pool. For example,
1936 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
1937 &quot;A String&quot;,
1938 ],
1939 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
1940 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
1941 #
1942 # For an overview of the IAM roles and permissions, see the
1943 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
1944 # a list of the available pre-defined roles, see
1945 # [here](https://cloud.google.com/iam/docs/understanding-roles).
1946 },
1947 ],
1948 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
1949 # prevent simultaneous updates of a policy from overwriting each other.
1950 # It is strongly suggested that systems make use of the `etag` in the
1951 # read-modify-write cycle to perform policy updates in order to avoid race
1952 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
1953 # systems are expected to put that etag in the request to `setIamPolicy` to
1954 # ensure that their change will be applied to the same version of the policy.
1955 #
1956 # **Important:** If you use IAM Conditions, you must include the `etag` field
1957 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
1958 # you to overwrite a version `3` policy with a version `1` policy, and all of
1959 # the conditions in the version `3` policy are lost.
1960 &quot;version&quot;: 42, # Specifies the format of the policy.
1961 #
1962 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
1963 # are rejected.
1964 #
1965 # Any operation that affects conditional role bindings must specify version
1966 # `3`. This requirement applies to the following operations:
1967 #
1968 # * Getting a policy that includes a conditional role binding
1969 # * Adding a conditional role binding to a policy
1970 # * Changing a conditional role binding in a policy
1971 # * Removing any role binding, with or without a condition, from a policy
1972 # that includes conditions
1973 #
1974 # **Important:** If you use IAM Conditions, you must include the `etag` field
1975 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
1976 # you to overwrite a version `3` policy with a version `1` policy, and all of
1977 # the conditions in the version `3` policy are lost.
1978 #
1979 # If a policy does not include any conditions, operations on that policy may
1980 # specify any valid version or leave the field unset.
1981 #
1982 # To learn which resources support conditions in their IAM policies, see the
1983 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
1984 }</pre>
1985 </div>
1986
1987 <div class="method">
1988 <code class="details" id="testIamPermissions">testIamPermissions(project, zone, parentResource, resource, body=None, x__xgafv=None)</code>
1989 <pre>Returns permissions that a caller has on the specified resource.
1990
1991 Args:
1992 project: string, Project ID for this request. (required)
1993 zone: string, The name of the zone for this request. (required)
1994 parentResource: string, Name or id of parent resource of the resource for this request. (required)
1995 resource: string, Name or id of the resource for this request. (required)
1996 body: object, The request body.
1997 The object takes the form of:
1998
1999 {
2000 &quot;permissions&quot;: [ # The set of permissions to check for the &#x27;resource&#x27;. Permissions with
2001 # wildcards (such as &#x27;*&#x27; or &#x27;storage.*&#x27;) are not allowed.
2002 &quot;A String&quot;,
2003 ],
2004 }
2005
2006 x__xgafv: string, V1 error format.
2007 Allowed values
2008 1 - v1 error format
2009 2 - v2 error format
2010
2011 Returns:
2012 An object of the form:
2013
2014 {
2015 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is
2016 # allowed.
2017 &quot;A String&quot;,
2018 ],
2019 }</pre>
2020 </div>
2021
2022 </body></html>