Debian Codegraph @

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