Debian Codegraph @

docs/dyn/compute_v1.reservations.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.reservations.html">reservations</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)</a></code></p>
79 <p class="firstline">Retrieves an aggregated list of reservations.</p>
80 <p class="toc_element">
81 <code><a href="#aggregatedList_next">aggregatedList_next()</a></code></p>
82 <p class="firstline">Retrieves the next page of results.</p>
83 <p class="toc_element">
84 <code><a href="#close">close()</a></code></p>
85 <p class="firstline">Close httplib2 connections.</p>
86 <p class="toc_element">
87 <code><a href="#delete">delete(project, zone, reservation, requestId=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Deletes the specified reservation.</p>
89 <p class="toc_element">
90 <code><a href="#get">get(project, zone, reservation, x__xgafv=None)</a></code></p>
91 <p class="firstline">Retrieves information about the specified reservation.</p>
92 <p class="toc_element">
93 <code><a href="#getIamPolicy">getIamPolicy(project, zone, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</a></code></p>
94 <p class="firstline">Gets the access control policy for a resource. May be empty if no such</p>
95 <p class="toc_element">
96 <code><a href="#insert">insert(project, zone, body=None, requestId=None, x__xgafv=None)</a></code></p>
97 <p class="firstline">Creates a new reservation. For more information, readReserving zonal</p>
98 <p class="toc_element">
99 <code><a href="#list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
100 <p class="firstline">A list of all the reservations that have been configured for the</p>
101 <p class="toc_element">
102 <code><a href="#list_next">list_next()</a></code></p>
103 <p class="firstline">Retrieves the next page of results.</p>
104 <p class="toc_element">
105 <code><a href="#performMaintenance">performMaintenance(project, zone, reservation, body=None, requestId=None, x__xgafv=None)</a></code></p>
106 <p class="firstline">Perform maintenance on an extended reservation</p>
107 <p class="toc_element">
108 <code><a href="#resize">resize(project, zone, reservation, body=None, requestId=None, x__xgafv=None)</a></code></p>
109 <p class="firstline">Resizes the reservation (applicable to standalone reservations only). For</p>
110 <p class="toc_element">
111 <code><a href="#setIamPolicy">setIamPolicy(project, zone, resource, body=None, x__xgafv=None)</a></code></p>
112 <p class="firstline">Sets the access control policy on the specified resource.</p>
113 <p class="toc_element">
114 <code><a href="#testIamPermissions">testIamPermissions(project, zone, resource, body=None, x__xgafv=None)</a></code></p>
115 <p class="firstline">Returns permissions that a caller has on the specified resource.</p>
116 <p class="toc_element">
117 <code><a href="#update">update(project, zone, reservation, body=None, paths=None, requestId=None, updateMask=None, x__xgafv=None)</a></code></p>
118 <p class="firstline">Update share settings of the reservation.</p>
119 <h3>Method Details</h3>
120 <div class="method">
121 <code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)</code>
122 <pre>Retrieves an aggregated list of reservations.
123
124 To prevent failure, it is recommended that you set the
125 `returnPartialSuccess` parameter to `true`.
126
127 Args:
128 project: string, Project ID for this request. (required)
129 filter: string, A filter expression that filters resources listed in the response. Most
130 Compute resources support two types of filter expressions:
131 expressions that support regular expressions and expressions that follow
132 API improvement proposal AIP-160.
133 These two types of filter expressions cannot be mixed in one request.
134
135 If you want to use AIP-160, your expression must specify the field name, an
136 operator, and the value that you want to use for filtering. The value
137 must be a string, a number, or a boolean. The operator
138 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
139
140 For example, if you are filtering Compute Engine instances, you can
141 exclude instances named `example-instance` by specifying
142 `name != example-instance`.
143
144 The `:*` comparison can be used to test whether a key has been defined.
145 For example, to find all objects with `owner` label use:
146 ```
147 labels.owner:*
148 ```
149
150 You can also filter nested fields. For example, you could specify
151 `scheduling.automaticRestart = false` to include instances only
152 if they are not scheduled for automatic restarts. You can use filtering
153 on nested fields to filter based onresource labels.
154
155 To filter on multiple expressions, provide each separate expression within
156 parentheses. For example:
157 ```
158 (scheduling.automaticRestart = true)
159 (cpuPlatform = &quot;Intel Skylake&quot;)
160 ```
161 By default, each expression is an `AND` expression. However, you
162 can include `AND` and `OR` expressions explicitly.
163 For example:
164 ```
165 (cpuPlatform = &quot;Intel Skylake&quot;) OR
166 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
167 (scheduling.automaticRestart = true)
168 ```
169
170 If you want to use a regular expression, use the `eq` (equal) or `ne`
171 (not equal) operator against a single un-parenthesized expression with or
172 without quotes or against multiple parenthesized expressions. Examples:
173
174 `fieldname eq unquoted literal`
175 `fieldname eq &#x27;single quoted literal&#x27;`
176 `fieldname eq &quot;double quoted literal&quot;`
177 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
178
179 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
180 The literal value must match the entire field.
181
182 For example, to filter for instances that do not end with name &quot;instance&quot;,
183 you would use `name ne .*instance`.
184
185 You cannot combine constraints on multiple fields using regular
186 expressions.
187 includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region,
188 global) should be included in the response. For new resource types added
189 after this field, the flag has no effect as new resource types will always
190 include every visible scope for each scope type in response. For resource
191 types which predate this field, if this flag is omitted or false, only
192 scopes of the scope types where the resource type is expected to be found
193 will be included.
194 maxResults: integer, The maximum number of results per page that should be returned.
195 If the number of available results is larger than `maxResults`,
196 Compute Engine returns a `nextPageToken` that can be used to get
197 the next page of results in subsequent list requests. Acceptable values are
198 `0` to `500`, inclusive. (Default: `500`)
199 orderBy: string, Sorts list results by a certain order. By default, results
200 are returned in alphanumerical order based on the resource name.
201
202 You can also sort results in descending order based on the creation
203 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
204 results based on the `creationTimestamp` field in
205 reverse chronological order (newest result first). Use this to sort
206 resources like operations so that the newest operation is returned first.
207
208 Currently, only sorting by `name` or
209 `creationTimestamp desc` is supported.
210 pageToken: string, Specifies a page token to use. Set `pageToken` to the
211 `nextPageToken` returned by a previous list request to get
212 the next page of results.
213 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
214 of failure. The default value is false.
215
216 For example, when partial success behavior is enabled, aggregatedList for a
217 single zone scope either returns all resources in the zone or no resources,
218 with an error code.
219 serviceProjectNumber: string, The Shared VPC service project id or service project number for which
220 aggregated list request is invoked for subnetworks list-usable api.
221 x__xgafv: string, V1 error format.
222 Allowed values
223 1 - v1 error format
224 2 - v2 error format
225
226 Returns:
227 An object of the form:
228
229 { # Contains a list of reservations.
230 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
231 &quot;items&quot;: { # A list of Allocation resources.
232 &quot;a_key&quot;: { # Name of the scope containing this set of reservations.
233 &quot;reservations&quot;: [ # A list of reservations contained in this scope.
234 { # Represents a reservation resource. A reservation ensures that capacity is
235 # held in a specific zone even if the reserved VMs are not running. For more
236 # information, read Reserving zonal
237 # resources.
238 &quot;advancedDeploymentControl&quot;: { # Advance control for cluster management, applicable only to DENSE deployment # Advanced control for cluster management, applicable only to DENSE
239 # deployment type reservations.
240 # type reservations.
241 &quot;reservationOperationalMode&quot;: &quot;A String&quot;, # Indicates chosen reservation operational mode for the reservation.
242 },
243 &quot;aggregateReservation&quot;: { # This reservation type is specified by total resource amounts (e.g. total # Reservation for aggregated resources, providing shape flexibility.
244 # count of CPUs) and can account for multiple instance SKUs. In other words,
245 # one can create instances of varying shapes against this reservation.
246 &quot;inUseResources&quot;: [ # Output only. [Output only] List of resources currently in use.
247 {
248 &quot;accelerator&quot;: { # Properties of accelerator resources in this reservation.
249 &quot;acceleratorCount&quot;: 42, # Number of accelerators of specified type.
250 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL to accelerator type. e.g.
251 # &quot;projects/{PROJECT}/zones/{ZONE}/acceleratorTypes/ct4l&quot;
252 },
253 },
254 ],
255 &quot;reservedResources&quot;: [ # List of reserved resources (CPUs, memory, accelerators).
256 {
257 &quot;accelerator&quot;: { # Properties of accelerator resources in this reservation.
258 &quot;acceleratorCount&quot;: 42, # Number of accelerators of specified type.
259 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL to accelerator type. e.g.
260 # &quot;projects/{PROJECT}/zones/{ZONE}/acceleratorTypes/ct4l&quot;
261 },
262 },
263 ],
264 &quot;vmFamily&quot;: &quot;A String&quot;, # The VM family that all instances scheduled against this reservation must
265 # belong to.
266 &quot;workloadType&quot;: &quot;A String&quot;, # The workload type of the instances that will target this reservation.
267 },
268 &quot;commitment&quot;: &quot;A String&quot;, # Output only. [Output Only] Full or partial URL to a parent commitment. This field
269 # displays for reservations that are tied to a commitment.
270 &quot;confidentialComputeType&quot;: &quot;A String&quot;,
271 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
272 # text format.
273 &quot;deleteAfterDuration&quot;: { # A Duration represents a fixed-length span of time represented # Duration time relative to reservation creation when Compute Engine will
274 # automatically delete this resource.
275 # as a count of seconds and fractions of seconds at nanosecond
276 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
277 # or &quot;month&quot;. Range is approximately 10,000 years.
278 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
279 # Durations less than one second are represented with a 0
280 # `seconds` field and a positive `nanos` field. Must be from 0
281 # to 999,999,999 inclusive.
282 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
283 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
284 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
285 },
286 &quot;deleteAtTime&quot;: &quot;A String&quot;, # Absolute time in future when the reservation will be
287 # auto-deleted by Compute Engine. Timestamp is represented inRFC3339 text format.
288 &quot;deploymentType&quot;: &quot;A String&quot;, # Specifies the deployment strategy for this reservation.
289 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
290 # create the resource.
291 &quot;earlyAccessMaintenance&quot;: &quot;A String&quot;, # Indicates the early access maintenance for the reservation.
292 # If this field is absent or set to NO_EARLY_ACCESS, the reservation is not
293 # enrolled in early access maintenance and the standard notice applies.
294 &quot;enableEmergentMaintenance&quot;: True or False, # Indicates whether Compute Engine allows unplanned maintenance for your VMs;
295 # for example, to fix hardware errors.
296 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
297 # defined by the server.
298 &quot;kind&quot;: &quot;compute#reservation&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#reservations for reservations.
299 &quot;linkedCommitments&quot;: [ # Output only. [Output Only] Full or partial URL to parent commitments. This field
300 # displays for reservations that are tied to multiple commitments.
301 &quot;A String&quot;,
302 ],
303 &quot;name&quot;: &quot;A String&quot;, # The name of the resource, provided by the client when initially creating
304 # the resource. The resource name must be 1-63 characters long, and comply
305 # withRFC1035.
306 # Specifically, the name must be 1-63 characters long and match the regular
307 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
308 # character must be a lowercase letter, and all following characters must be
309 # a dash, lowercase letter, or digit, except the last character, which cannot
310 # be a dash.
311 &quot;params&quot;: { # Additional reservation params. # Input only. Additional params passed with the request, but not persisted
312 # as part of resource payload.
313 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the reservation. Tag keys and
314 # values have the same definition as resource
315 # manager tags. Keys and values can be either in numeric format,
316 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
317 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
318 # `{tag_value_short_name}`. The field is ignored (both PUT &amp;
319 # PATCH) when empty.
320 &quot;a_key&quot;: &quot;A String&quot;,
321 },
322 },
323 &quot;protectionTier&quot;: &quot;A String&quot;, # Protection tier for the workload which specifies the workload expectations
324 # in the event of infrastructure failures at data center (e.g. power
325 # and/or cooling failures).
326 &quot;reservationSharingPolicy&quot;: { # Specify the reservation sharing policy. If unspecified, the reservation
327 # will not be shared with Google Cloud managed services.
328 &quot;serviceShareType&quot;: &quot;A String&quot;, # Sharing config for all Google Cloud services.
329 },
330 &quot;resourcePolicies&quot;: { # Resource policies to be added to this reservation. The key is defined by
331 # user, and the value is resource policy url. This is to define placement
332 # policy with reservation.
333 &quot;a_key&quot;: &quot;A String&quot;,
334 },
335 &quot;resourceStatus&quot;: { # [Output Only] Contains output only fields. # Output only. [Output Only] Status information for Reservation resource.
336 &quot;healthInfo&quot;: { # Health information for the reservation. # [Output only] Health information for the reservation.
337 &quot;degradedBlockCount&quot;: 42, # The number of reservation blocks that are degraded.
338 &quot;healthStatus&quot;: &quot;A String&quot;, # The health status of the reservation.
339 &quot;healthyBlockCount&quot;: 42, # The number of reservation blocks that are healthy.
340 },
341 &quot;reservationBlockCount&quot;: 42, # The number of reservation blocks associated with this reservation.
342 &quot;reservationMaintenance&quot;: { # Maintenance Info for ReservationBlocks. # Maintenance information for this reservation
343 &quot;instanceMaintenanceOngoingCount&quot;: 42, # Describes number of instances that have ongoing maintenance.
344 &quot;instanceMaintenancePendingCount&quot;: 42, # Describes number of instances that have pending maintenance.
345 &quot;maintenanceOngoingCount&quot;: 42, # Progress for ongoing maintenance for this group of VMs/hosts.
346 # Describes number of hosts in the block that have ongoing maintenance.
347 &quot;maintenancePendingCount&quot;: 42, # Progress for ongoing maintenance for this group of VMs/hosts.
348 # Describes number of hosts in the block that have pending maintenance.
349 &quot;schedulingType&quot;: &quot;A String&quot;, # The type of maintenance for the reservation.
350 &quot;subblockInfraMaintenanceOngoingCount&quot;: 42, # Describes number of subblock Infrastructure that has ongoing maintenance.
351 # Here, Subblock Infrastructure Maintenance pertains to upstream hardware
352 # contained in the Subblock that is necessary for a VM Family(e.g. NVLink
353 # Domains). Not all VM Families will support this field.
354 &quot;subblockInfraMaintenancePendingCount&quot;: 42, # Describes number of subblock Infrastructure that has pending maintenance.
355 # Here, Subblock Infrastructure Maintenance pertains to upstream hardware
356 # contained in the Subblock that is necessary for a VM Family (e.g. NVLink
357 # Domains). Not all VM Families will support this field.
358 &quot;upcomingGroupMaintenance&quot;: { # Upcoming Maintenance notification information. # Maintenance information on this group of VMs.
359 &quot;canReschedule&quot;: True or False, # Indicates if the maintenance can be customer triggered.
360 &quot;latestWindowStartTime&quot;: &quot;A String&quot;, # The latest time for the planned maintenance window to start.
361 # This timestamp value is in RFC3339 text format.
362 &quot;maintenanceOnShutdown&quot;: True or False, # Indicates whether the UpcomingMaintenance will be triggered on VM shutdown.
363 &quot;maintenanceReasons&quot;: [ # The reasons for the maintenance. Only valid for vms.
364 &quot;A String&quot;,
365 ],
366 &quot;maintenanceStatus&quot;: &quot;A String&quot;,
367 &quot;type&quot;: &quot;A String&quot;, # Defines the type of maintenance.
368 &quot;windowEndTime&quot;: &quot;A String&quot;, # The time by which the maintenance disruption will be completed.
369 # This timestamp value is in RFC3339 text format.
370 &quot;windowStartTime&quot;: &quot;A String&quot;, # The current start time of the maintenance window.
371 # This timestamp value is in RFC3339 text format.
372 },
373 },
374 &quot;specificSkuAllocation&quot;: { # Contains Properties set for the reservation. # Allocation Properties of this reservation.
375 &quot;sourceInstanceTemplateId&quot;: &quot;A String&quot;, # ID of the instance template used to populate reservation properties.
376 &quot;utilizations&quot;: { # Per service utilization breakdown. The Key is the Google Cloud managed
377 # service name.
378 &quot;a_key&quot;: &quot;A String&quot;,
379 },
380 },
381 },
382 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
383 &quot;schedulingType&quot;: &quot;A String&quot;, # The type of maintenance for the reservation.
384 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined fully-qualified URL for this resource.
385 &quot;shareSettings&quot;: { # The share setting for reservations and sole tenancy node groups. # Specify share-settings to create a shared reservation. This property is
386 # optional. For more information about the syntax and options for this
387 # field and its subfields, see the guide for creating
388 # a shared reservation.
389 &quot;projectMap&quot;: { # A map of project id and project config. This is only valid when
390 # share_type&#x27;s value is SPECIFIC_PROJECTS.
391 &quot;a_key&quot;: { # Config for each project in the share settings.
392 &quot;projectId&quot;: &quot;A String&quot;, # The project ID, should be same as the key of this project config in the
393 # parent map.
394 },
395 },
396 &quot;shareType&quot;: &quot;A String&quot;, # Type of sharing for this shared-reservation
397 },
398 &quot;specificReservation&quot;: { # This reservation type allows to pre allocate specific instance # Reservation for instances with specific machine shapes.
399 # configuration.
400 &quot;assuredCount&quot;: &quot;A String&quot;, # Output only. [Output Only] Indicates how many instances are actually usable currently.
401 &quot;count&quot;: &quot;A String&quot;, # Specifies the number of resources that are allocated.
402 &quot;inUseCount&quot;: &quot;A String&quot;, # Output only. [Output Only] Indicates how many instances are in use.
403 &quot;instanceProperties&quot;: { # Properties of the SKU instances being reserved. # The instance properties for the reservation.
404 # Next ID: 10
405 &quot;guestAccelerators&quot;: [ # Specifies accelerator type and count.
406 { # A specification of the type and number of accelerator cards attached to the
407 # instance.
408 &quot;acceleratorCount&quot;: 42, # The number of the guest accelerator cards exposed to this instance.
409 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL of the accelerator type resource to attach to this
410 # instance. For example:projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100
411 # If you are creating an instance template, specify only the
412 # accelerator name.
413 # See GPUs on Compute Engine
414 # for a full list of accelerator types.
415 },
416 ],
417 &quot;localSsds&quot;: [ # Specifies amount of local ssd to reserve with each instance. The type
418 # of disk is local-ssd.
419 {
420 &quot;diskSizeGb&quot;: &quot;A String&quot;, # Specifies the size of the disk in base-2 GB.
421 &quot;interface&quot;: &quot;A String&quot;, # Specifies the disk interface to use for attaching this disk, which is
422 # either SCSI or NVME. The default isSCSI.
423 # For performance characteristics of SCSI over NVMe, seeLocal SSD performance.
424 },
425 ],
426 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the allocation close to other
427 # resources.
428 # This field is for use by internal tools that use the public API.
429 &quot;machineType&quot;: &quot;A String&quot;, # Specifies type of machine (name only) which has fixed number of vCPUs
430 # and fixed amount of memory. This also includes specifying custom
431 # machine type following custom-NUMBER_OF_CPUS-AMOUNT_OF_MEMORY pattern.
432 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # Minimum cpu platform the reservation.
433 },
434 &quot;sourceInstanceTemplate&quot;: &quot;A String&quot;, # Specifies the instance template to create the reservation. If you use
435 # this field, you must exclude the instanceProperties field.
436 #
437 # This field is optional, and it can be a full or partial URL. For example,
438 # the following are all valid URLs to an instance template:
439 #
440 #
441 # - https://www.googleapis.com/compute/v1/projects/project/global/instanceTemplates/instanceTemplate
442 # - projects/project/global/instanceTemplates/instanceTemplate
443 # - global/instanceTemplates/instanceTemplate
444 },
445 &quot;specificReservationRequired&quot;: True or False, # Indicates whether the reservation can be consumed by VMs with affinity
446 # for &quot;any&quot; reservation. If the field is set, then only VMs that target
447 # the reservation by name can consume from this reservation.
448 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only] The status of the reservation.
449 #
450 #
451 # - CREATING: Reservation resources are being
452 # allocated.
453 # - READY: Reservation resources have been allocated,
454 # and the reservation is ready for use.
455 # - DELETING: Reservation deletion is in progress.
456 # - UPDATING: Reservation update is in progress.
457 &quot;zone&quot;: &quot;A String&quot;, # Zone in which the reservation resides. A zone must be provided if the
458 # reservation is created within a commitment.
459 },
460 ],
461 &quot;warning&quot;: { # Informational warning which replaces the list of reservations when
462 # the list is empty.
463 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
464 # Engine returns NO_RESULTS_ON_PAGE if there
465 # are no results in the response.
466 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
467 # value format. For example:
468 #
469 # &quot;data&quot;: [
470 # {
471 # &quot;key&quot;: &quot;scope&quot;,
472 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
473 # }
474 {
475 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
476 # returned. For example, for warnings where there are no results in a list
477 # request for a particular zone, this key might be scope and
478 # the key value might be the zone name. Other examples might be a key
479 # indicating a deprecated resource and a suggested replacement, or a
480 # warning about invalid network settings (for example, if an instance
481 # attempts to perform IP forwarding but is not enabled for IP forwarding).
482 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
483 },
484 ],
485 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
486 },
487 },
488 },
489 &quot;kind&quot;: &quot;compute#reservationAggregatedList&quot;, # Output only. Type of resource.
490 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
491 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
492 # the query parameter pageToken in the next list request.
493 # Subsequent list requests will have their own nextPageToken to
494 # continue paging through the results.
495 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
496 &quot;unreachables&quot;: [ # Output only. [Output Only] Unreachable resources.
497 &quot;A String&quot;,
498 ],
499 &quot;warning&quot;: { # [Output Only] Informational warning message.
500 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
501 # Engine returns NO_RESULTS_ON_PAGE if there
502 # are no results in the response.
503 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
504 # value format. For example:
505 #
506 # &quot;data&quot;: [
507 # {
508 # &quot;key&quot;: &quot;scope&quot;,
509 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
510 # }
511 {
512 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
513 # returned. For example, for warnings where there are no results in a list
514 # request for a particular zone, this key might be scope and
515 # the key value might be the zone name. Other examples might be a key
516 # indicating a deprecated resource and a suggested replacement, or a
517 # warning about invalid network settings (for example, if an instance
518 # attempts to perform IP forwarding but is not enabled for IP forwarding).
519 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
520 },
521 ],
522 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
523 },
524 }</pre>
525 </div>
526
527 <div class="method">
528 <code class="details" id="aggregatedList_next">aggregatedList_next()</code>
529 <pre>Retrieves the next page of results.
530
531 Args:
532 previous_request: The request for the previous page. (required)
533 previous_response: The response from the request for the previous page. (required)
534
535 Returns:
536 A request object that you can call &#x27;execute()&#x27; on to request the next
537 page. Returns None if there are no more items in the collection.
538 </pre>
539 </div>
540
541 <div class="method">
542 <code class="details" id="close">close()</code>
543 <pre>Close httplib2 connections.</pre>
544 </div>
545
546 <div class="method">
547 <code class="details" id="delete">delete(project, zone, reservation, requestId=None, x__xgafv=None)</code>
548 <pre>Deletes the specified reservation.
549
550 Args:
551 project: string, Project ID for this request. (required)
552 zone: string, Name of the zone for this request. (required)
553 reservation: string, Name of the reservation to delete. (required)
554 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
555 that if you must retry your request, the server will know to ignore the
556 request if it has already been completed.
557
558 For example, consider a situation where you make an initial request and
559 the request times out. If you make the request again with the same
560 request ID, the server can check if original operation with the same
561 request ID was received, and if so, will ignore the second request. This
562 prevents clients from accidentally creating duplicate commitments.
563
564 The request ID must be
565 a valid UUID with the exception that zero UUID is not supported
566 (00000000-0000-0000-0000-000000000000).
567 x__xgafv: string, V1 error format.
568 Allowed values
569 1 - v1 error format
570 2 - v2 error format
571
572 Returns:
573 An object of the form:
574
575 { # Represents an Operation resource.
576 #
577 # Google Compute Engine has three Operation resources:
578 #
579 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
580 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
581 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
582 #
583 # You can use an operation resource to manage asynchronous API requests.
584 # For more information, readHandling
585 # API responses.
586 #
587 # Operations can be global, regional or zonal.
588 #
589 # - For global operations, use the `globalOperations`
590 # resource.
591 # - For regional operations, use the
592 # `regionOperations` resource.
593 # - For zonal operations, use
594 # the `zoneOperations` resource.
595 #
596 #
597 #
598 # For more information, read
599 # Global, Regional, and Zonal Resources.
600 #
601 # Note that completed Operation resources have a limited
602 # retention period.
603 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
604 # Not present otherwise.
605 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
606 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
607 # set when the operation is created.
608 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
609 # text format.
610 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
611 # this field will be populated.
612 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
613 # operation.
614 {
615 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
616 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
617 # details. There is a set of defined message types to use for providing
618 # details.The syntax depends on the error code. For example,
619 # QuotaExceededInfo will have details when the error code is
620 # QUOTA_EXCEEDED.
621 {
622 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
623 #
624 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
625 # is not enabled:
626 #
627 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
628 # &quot;domain&quot;: &quot;googleapis.com&quot;
629 # &quot;metadata&quot;: {
630 # &quot;resource&quot;: &quot;projects/123&quot;,
631 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
632 # }
633 # }
634 #
635 # This response indicates that the pubsub.googleapis.com API is not enabled.
636 #
637 # Example of an error that is returned when attempting to create a Spanner
638 # instance in a region that is out of stock:
639 #
640 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
641 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
642 # &quot;metadata&quot;: {
643 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
644 # }
645 # }
646 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
647 # is typically the registered service name of the tool or product that
648 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
649 # generated by some common infrastructure, the error domain must be a
650 # globally unique value that identifies the infrastructure. For Google API
651 # infrastructure, the error domain is &quot;googleapis.com&quot;.
652 &quot;metadatas&quot;: { # Additional structured details about this error.
653 #
654 # Keys must match a regular expression of `a-z+` but should
655 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
656 # length. When identifying the current value of an exceeded limit, the units
657 # should be contained in the key, not the value. For example, rather than
658 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
659 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
660 # instances that can be created in a single (batch) request.
661 &quot;a_key&quot;: &quot;A String&quot;,
662 },
663 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
664 # proximate cause of the error. Error reasons are unique within a particular
665 # domain of errors. This should be at most 63 characters and match a
666 # regular expression of `A-Z+[A-Z0-9]`, which represents
667 # UPPER_SNAKE_CASE.
668 },
669 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
670 #
671 # For example, if a quota check failed with an error indicating the calling
672 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
673 # directly to the right place in the developer console to flip the bit.
674 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
675 { # Describes a URL link.
676 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
677 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
678 },
679 ],
680 },
681 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
682 # which can be attached to an RPC error.
683 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
684 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
685 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
686 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
687 },
688 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
689 &quot;dimensions&quot;: { # The map holding related quota dimensions.
690 &quot;a_key&quot;: &quot;A String&quot;,
691 },
692 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
693 # type or metric.
694 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
695 # or metric.
696 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
697 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
698 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
699 },
700 },
701 ],
702 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
703 # This property is optional.
704 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
705 },
706 ],
707 },
708 &quot;getVersionOperationMetadata&quot;: {
709 &quot;inlineSbomInfo&quot;: {
710 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
711 # appropriate identifiers.
712 &quot;a_key&quot;: &quot;A String&quot;,
713 },
714 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
715 # identifiers.
716 &quot;a_key&quot;: &quot;A String&quot;,
717 },
718 },
719 },
720 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
721 # message that was returned, such as `NOT FOUND`.
722 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
723 # status code that was returned. For example, a `404` means the
724 # resource was not found.
725 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
726 # defined by the server.
727 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
728 # This value is inRFC3339
729 # text format.
730 &quot;instancesBulkInsertOperationMetadata&quot;: {
731 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
732 # Example key: zones/us-central1-a
733 &quot;a_key&quot;: {
734 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
735 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
736 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
737 # error.
738 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
739 # if the flow is rolling forward or rolling back.
740 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
741 },
742 },
743 },
744 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
745 # Operation resources.
746 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
747 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
748 # group of operations results from a `bulkInsert` API request.
749 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
750 # `update`, or `delete`, and so on.
751 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
752 # There is no requirement that this be linear or support any granularity of
753 # operations. This should not be used to guess when the operation will be
754 # complete. This number should monotonically increase as the operation
755 # progresses.
756 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
757 # applicable when performing regional operations.
758 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
759 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
760 # this field will contain information on all underlying zonal actions and
761 # their state.
762 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
763 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
764 # Example key: zones/us-central1-a
765 &quot;a_key&quot;: {
766 &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
767 # populated.
768 # different programming environments, including REST APIs and RPC APIs. It is
769 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
770 # three pieces of data: error code, error message, and error details.
771 #
772 # You can find out more about this error model and how to work with it in the
773 # [API Design Guide](https://cloud.google.com/apis/design/errors).
774 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
775 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
776 # message types for APIs to use.
777 {
778 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
779 },
780 ],
781 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
782 # user-facing error message should be localized and sent in the
783 # google.rpc.Status.details field, or localized by the client.
784 },
785 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
786 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
787 },
788 },
789 },
790 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
791 # This value is inRFC3339
792 # text format.
793 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
794 # following:
795 # `PENDING`, `RUNNING`, or `DONE`.
796 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
797 # operation.
798 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
799 # of the target resource.
800 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
801 # operations related to creating a snapshot, this points to the disk
802 # that the snapshot was created from.
803 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
804 # `[email protected]` or
805 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
806 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
807 # operation, this field will be populated.
808 {
809 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
810 # Engine returns NO_RESULTS_ON_PAGE if there
811 # are no results in the response.
812 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
813 # value format. For example:
814 #
815 # &quot;data&quot;: [
816 # {
817 # &quot;key&quot;: &quot;scope&quot;,
818 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
819 # }
820 {
821 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
822 # returned. For example, for warnings where there are no results in a list
823 # request for a particular zone, this key might be scope and
824 # the key value might be the zone name. Other examples might be a key
825 # indicating a deprecated resource and a suggested replacement, or a
826 # warning about invalid network settings (for example, if an instance
827 # attempts to perform IP forwarding but is not enabled for IP forwarding).
828 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
829 },
830 ],
831 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
832 },
833 ],
834 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
835 # applicable when performing per-zone operations.
836 }</pre>
837 </div>
838
839 <div class="method">
840 <code class="details" id="get">get(project, zone, reservation, x__xgafv=None)</code>
841 <pre>Retrieves information about the specified reservation.
842
843 Args:
844 project: string, Project ID for this request. (required)
845 zone: string, Name of the zone for this request. (required)
846 reservation: string, Name of the reservation to retrieve. (required)
847 x__xgafv: string, V1 error format.
848 Allowed values
849 1 - v1 error format
850 2 - v2 error format
851
852 Returns:
853 An object of the form:
854
855 { # Represents a reservation resource. A reservation ensures that capacity is
856 # held in a specific zone even if the reserved VMs are not running. For more
857 # information, read Reserving zonal
858 # resources.
859 &quot;advancedDeploymentControl&quot;: { # Advance control for cluster management, applicable only to DENSE deployment # Advanced control for cluster management, applicable only to DENSE
860 # deployment type reservations.
861 # type reservations.
862 &quot;reservationOperationalMode&quot;: &quot;A String&quot;, # Indicates chosen reservation operational mode for the reservation.
863 },
864 &quot;aggregateReservation&quot;: { # This reservation type is specified by total resource amounts (e.g. total # Reservation for aggregated resources, providing shape flexibility.
865 # count of CPUs) and can account for multiple instance SKUs. In other words,
866 # one can create instances of varying shapes against this reservation.
867 &quot;inUseResources&quot;: [ # Output only. [Output only] List of resources currently in use.
868 {
869 &quot;accelerator&quot;: { # Properties of accelerator resources in this reservation.
870 &quot;acceleratorCount&quot;: 42, # Number of accelerators of specified type.
871 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL to accelerator type. e.g.
872 # &quot;projects/{PROJECT}/zones/{ZONE}/acceleratorTypes/ct4l&quot;
873 },
874 },
875 ],
876 &quot;reservedResources&quot;: [ # List of reserved resources (CPUs, memory, accelerators).
877 {
878 &quot;accelerator&quot;: { # Properties of accelerator resources in this reservation.
879 &quot;acceleratorCount&quot;: 42, # Number of accelerators of specified type.
880 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL to accelerator type. e.g.
881 # &quot;projects/{PROJECT}/zones/{ZONE}/acceleratorTypes/ct4l&quot;
882 },
883 },
884 ],
885 &quot;vmFamily&quot;: &quot;A String&quot;, # The VM family that all instances scheduled against this reservation must
886 # belong to.
887 &quot;workloadType&quot;: &quot;A String&quot;, # The workload type of the instances that will target this reservation.
888 },
889 &quot;commitment&quot;: &quot;A String&quot;, # Output only. [Output Only] Full or partial URL to a parent commitment. This field
890 # displays for reservations that are tied to a commitment.
891 &quot;confidentialComputeType&quot;: &quot;A String&quot;,
892 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
893 # text format.
894 &quot;deleteAfterDuration&quot;: { # A Duration represents a fixed-length span of time represented # Duration time relative to reservation creation when Compute Engine will
895 # automatically delete this resource.
896 # as a count of seconds and fractions of seconds at nanosecond
897 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
898 # or &quot;month&quot;. Range is approximately 10,000 years.
899 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
900 # Durations less than one second are represented with a 0
901 # `seconds` field and a positive `nanos` field. Must be from 0
902 # to 999,999,999 inclusive.
903 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
904 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
905 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
906 },
907 &quot;deleteAtTime&quot;: &quot;A String&quot;, # Absolute time in future when the reservation will be
908 # auto-deleted by Compute Engine. Timestamp is represented inRFC3339 text format.
909 &quot;deploymentType&quot;: &quot;A String&quot;, # Specifies the deployment strategy for this reservation.
910 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
911 # create the resource.
912 &quot;earlyAccessMaintenance&quot;: &quot;A String&quot;, # Indicates the early access maintenance for the reservation.
913 # If this field is absent or set to NO_EARLY_ACCESS, the reservation is not
914 # enrolled in early access maintenance and the standard notice applies.
915 &quot;enableEmergentMaintenance&quot;: True or False, # Indicates whether Compute Engine allows unplanned maintenance for your VMs;
916 # for example, to fix hardware errors.
917 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
918 # defined by the server.
919 &quot;kind&quot;: &quot;compute#reservation&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#reservations for reservations.
920 &quot;linkedCommitments&quot;: [ # Output only. [Output Only] Full or partial URL to parent commitments. This field
921 # displays for reservations that are tied to multiple commitments.
922 &quot;A String&quot;,
923 ],
924 &quot;name&quot;: &quot;A String&quot;, # The name of the resource, provided by the client when initially creating
925 # the resource. The resource name must be 1-63 characters long, and comply
926 # withRFC1035.
927 # Specifically, the name must be 1-63 characters long and match the regular
928 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
929 # character must be a lowercase letter, and all following characters must be
930 # a dash, lowercase letter, or digit, except the last character, which cannot
931 # be a dash.
932 &quot;params&quot;: { # Additional reservation params. # Input only. Additional params passed with the request, but not persisted
933 # as part of resource payload.
934 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the reservation. Tag keys and
935 # values have the same definition as resource
936 # manager tags. Keys and values can be either in numeric format,
937 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
938 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
939 # `{tag_value_short_name}`. The field is ignored (both PUT &amp;
940 # PATCH) when empty.
941 &quot;a_key&quot;: &quot;A String&quot;,
942 },
943 },
944 &quot;protectionTier&quot;: &quot;A String&quot;, # Protection tier for the workload which specifies the workload expectations
945 # in the event of infrastructure failures at data center (e.g. power
946 # and/or cooling failures).
947 &quot;reservationSharingPolicy&quot;: { # Specify the reservation sharing policy. If unspecified, the reservation
948 # will not be shared with Google Cloud managed services.
949 &quot;serviceShareType&quot;: &quot;A String&quot;, # Sharing config for all Google Cloud services.
950 },
951 &quot;resourcePolicies&quot;: { # Resource policies to be added to this reservation. The key is defined by
952 # user, and the value is resource policy url. This is to define placement
953 # policy with reservation.
954 &quot;a_key&quot;: &quot;A String&quot;,
955 },
956 &quot;resourceStatus&quot;: { # [Output Only] Contains output only fields. # Output only. [Output Only] Status information for Reservation resource.
957 &quot;healthInfo&quot;: { # Health information for the reservation. # [Output only] Health information for the reservation.
958 &quot;degradedBlockCount&quot;: 42, # The number of reservation blocks that are degraded.
959 &quot;healthStatus&quot;: &quot;A String&quot;, # The health status of the reservation.
960 &quot;healthyBlockCount&quot;: 42, # The number of reservation blocks that are healthy.
961 },
962 &quot;reservationBlockCount&quot;: 42, # The number of reservation blocks associated with this reservation.
963 &quot;reservationMaintenance&quot;: { # Maintenance Info for ReservationBlocks. # Maintenance information for this reservation
964 &quot;instanceMaintenanceOngoingCount&quot;: 42, # Describes number of instances that have ongoing maintenance.
965 &quot;instanceMaintenancePendingCount&quot;: 42, # Describes number of instances that have pending maintenance.
966 &quot;maintenanceOngoingCount&quot;: 42, # Progress for ongoing maintenance for this group of VMs/hosts.
967 # Describes number of hosts in the block that have ongoing maintenance.
968 &quot;maintenancePendingCount&quot;: 42, # Progress for ongoing maintenance for this group of VMs/hosts.
969 # Describes number of hosts in the block that have pending maintenance.
970 &quot;schedulingType&quot;: &quot;A String&quot;, # The type of maintenance for the reservation.
971 &quot;subblockInfraMaintenanceOngoingCount&quot;: 42, # Describes number of subblock Infrastructure that has ongoing maintenance.
972 # Here, Subblock Infrastructure Maintenance pertains to upstream hardware
973 # contained in the Subblock that is necessary for a VM Family(e.g. NVLink
974 # Domains). Not all VM Families will support this field.
975 &quot;subblockInfraMaintenancePendingCount&quot;: 42, # Describes number of subblock Infrastructure that has pending maintenance.
976 # Here, Subblock Infrastructure Maintenance pertains to upstream hardware
977 # contained in the Subblock that is necessary for a VM Family (e.g. NVLink
978 # Domains). Not all VM Families will support this field.
979 &quot;upcomingGroupMaintenance&quot;: { # Upcoming Maintenance notification information. # Maintenance information on this group of VMs.
980 &quot;canReschedule&quot;: True or False, # Indicates if the maintenance can be customer triggered.
981 &quot;latestWindowStartTime&quot;: &quot;A String&quot;, # The latest time for the planned maintenance window to start.
982 # This timestamp value is in RFC3339 text format.
983 &quot;maintenanceOnShutdown&quot;: True or False, # Indicates whether the UpcomingMaintenance will be triggered on VM shutdown.
984 &quot;maintenanceReasons&quot;: [ # The reasons for the maintenance. Only valid for vms.
985 &quot;A String&quot;,
986 ],
987 &quot;maintenanceStatus&quot;: &quot;A String&quot;,
988 &quot;type&quot;: &quot;A String&quot;, # Defines the type of maintenance.
989 &quot;windowEndTime&quot;: &quot;A String&quot;, # The time by which the maintenance disruption will be completed.
990 # This timestamp value is in RFC3339 text format.
991 &quot;windowStartTime&quot;: &quot;A String&quot;, # The current start time of the maintenance window.
992 # This timestamp value is in RFC3339 text format.
993 },
994 },
995 &quot;specificSkuAllocation&quot;: { # Contains Properties set for the reservation. # Allocation Properties of this reservation.
996 &quot;sourceInstanceTemplateId&quot;: &quot;A String&quot;, # ID of the instance template used to populate reservation properties.
997 &quot;utilizations&quot;: { # Per service utilization breakdown. The Key is the Google Cloud managed
998 # service name.
999 &quot;a_key&quot;: &quot;A String&quot;,
1000 },
1001 },
1002 },
1003 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
1004 &quot;schedulingType&quot;: &quot;A String&quot;, # The type of maintenance for the reservation.
1005 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined fully-qualified URL for this resource.
1006 &quot;shareSettings&quot;: { # The share setting for reservations and sole tenancy node groups. # Specify share-settings to create a shared reservation. This property is
1007 # optional. For more information about the syntax and options for this
1008 # field and its subfields, see the guide for creating
1009 # a shared reservation.
1010 &quot;projectMap&quot;: { # A map of project id and project config. This is only valid when
1011 # share_type&#x27;s value is SPECIFIC_PROJECTS.
1012 &quot;a_key&quot;: { # Config for each project in the share settings.
1013 &quot;projectId&quot;: &quot;A String&quot;, # The project ID, should be same as the key of this project config in the
1014 # parent map.
1015 },
1016 },
1017 &quot;shareType&quot;: &quot;A String&quot;, # Type of sharing for this shared-reservation
1018 },
1019 &quot;specificReservation&quot;: { # This reservation type allows to pre allocate specific instance # Reservation for instances with specific machine shapes.
1020 # configuration.
1021 &quot;assuredCount&quot;: &quot;A String&quot;, # Output only. [Output Only] Indicates how many instances are actually usable currently.
1022 &quot;count&quot;: &quot;A String&quot;, # Specifies the number of resources that are allocated.
1023 &quot;inUseCount&quot;: &quot;A String&quot;, # Output only. [Output Only] Indicates how many instances are in use.
1024 &quot;instanceProperties&quot;: { # Properties of the SKU instances being reserved. # The instance properties for the reservation.
1025 # Next ID: 10
1026 &quot;guestAccelerators&quot;: [ # Specifies accelerator type and count.
1027 { # A specification of the type and number of accelerator cards attached to the
1028 # instance.
1029 &quot;acceleratorCount&quot;: 42, # The number of the guest accelerator cards exposed to this instance.
1030 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL of the accelerator type resource to attach to this
1031 # instance. For example:projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100
1032 # If you are creating an instance template, specify only the
1033 # accelerator name.
1034 # See GPUs on Compute Engine
1035 # for a full list of accelerator types.
1036 },
1037 ],
1038 &quot;localSsds&quot;: [ # Specifies amount of local ssd to reserve with each instance. The type
1039 # of disk is local-ssd.
1040 {
1041 &quot;diskSizeGb&quot;: &quot;A String&quot;, # Specifies the size of the disk in base-2 GB.
1042 &quot;interface&quot;: &quot;A String&quot;, # Specifies the disk interface to use for attaching this disk, which is
1043 # either SCSI or NVME. The default isSCSI.
1044 # For performance characteristics of SCSI over NVMe, seeLocal SSD performance.
1045 },
1046 ],
1047 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the allocation close to other
1048 # resources.
1049 # This field is for use by internal tools that use the public API.
1050 &quot;machineType&quot;: &quot;A String&quot;, # Specifies type of machine (name only) which has fixed number of vCPUs
1051 # and fixed amount of memory. This also includes specifying custom
1052 # machine type following custom-NUMBER_OF_CPUS-AMOUNT_OF_MEMORY pattern.
1053 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # Minimum cpu platform the reservation.
1054 },
1055 &quot;sourceInstanceTemplate&quot;: &quot;A String&quot;, # Specifies the instance template to create the reservation. If you use
1056 # this field, you must exclude the instanceProperties field.
1057 #
1058 # This field is optional, and it can be a full or partial URL. For example,
1059 # the following are all valid URLs to an instance template:
1060 #
1061 #
1062 # - https://www.googleapis.com/compute/v1/projects/project/global/instanceTemplates/instanceTemplate
1063 # - projects/project/global/instanceTemplates/instanceTemplate
1064 # - global/instanceTemplates/instanceTemplate
1065 },
1066 &quot;specificReservationRequired&quot;: True or False, # Indicates whether the reservation can be consumed by VMs with affinity
1067 # for &quot;any&quot; reservation. If the field is set, then only VMs that target
1068 # the reservation by name can consume from this reservation.
1069 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only] The status of the reservation.
1070 #
1071 #
1072 # - CREATING: Reservation resources are being
1073 # allocated.
1074 # - READY: Reservation resources have been allocated,
1075 # and the reservation is ready for use.
1076 # - DELETING: Reservation deletion is in progress.
1077 # - UPDATING: Reservation update is in progress.
1078 &quot;zone&quot;: &quot;A String&quot;, # Zone in which the reservation resides. A zone must be provided if the
1079 # reservation is created within a commitment.
1080 }</pre>
1081 </div>
1082
1083 <div class="method">
1084 <code class="details" id="getIamPolicy">getIamPolicy(project, zone, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</code>
1085 <pre>Gets the access control policy for a resource. May be empty if no such
1086 policy or resource exists.
1087
1088 Args:
1089 project: string, Project ID for this request. (required)
1090 zone: string, The name of the zone for this request. (required)
1091 resource: string, Name or id of the resource for this request. (required)
1092 optionsRequestedPolicyVersion: integer, Requested IAM Policy version.
1093 x__xgafv: string, V1 error format.
1094 Allowed values
1095 1 - v1 error format
1096 2 - v2 error format
1097
1098 Returns:
1099 An object of the form:
1100
1101 { # An Identity and Access Management (IAM) policy, which specifies access
1102 # controls for Google Cloud resources.
1103 #
1104 #
1105 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
1106 # `members`, or principals, to a single `role`. Principals can be user
1107 # accounts, service accounts, Google groups, and domains (such as G Suite). A
1108 # `role` is a named list of permissions; each `role` can be an IAM predefined
1109 # role or a user-created custom role.
1110 #
1111 # For some types of Google Cloud resources, a `binding` can also specify a
1112 # `condition`, which is a logical expression that allows access to a resource
1113 # only if the expression evaluates to `true`. A condition can add constraints
1114 # based on attributes of the request, the resource, or both. To learn which
1115 # resources support conditions in their IAM policies, see the
1116 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
1117 #
1118 # **JSON example:**
1119 #
1120 # ```
1121 # {
1122 # &quot;bindings&quot;: [
1123 # {
1124 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
1125 # &quot;members&quot;: [
1126 # &quot;user:[email protected]&quot;,
1127 # &quot;group:[email protected]&quot;,
1128 # &quot;domain:google.com&quot;,
1129 # &quot;serviceAccount:[email protected]&quot;
1130 # ]
1131 # },
1132 # {
1133 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
1134 # &quot;members&quot;: [
1135 # &quot;user:[email protected]&quot;
1136 # ],
1137 # &quot;condition&quot;: {
1138 # &quot;title&quot;: &quot;expirable access&quot;,
1139 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
1140 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
1141 # }
1142 # }
1143 # ],
1144 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
1145 # &quot;version&quot;: 3
1146 # }
1147 # ```
1148 #
1149 # **YAML example:**
1150 #
1151 # ```
1152 # bindings:
1153 # - members:
1154 # - user:[email protected]
1155 # - group:[email protected]
1156 # - domain:google.com
1157 # - serviceAccount:[email protected]
1158 # role: roles/resourcemanager.organizationAdmin
1159 # - members:
1160 # - user:[email protected]
1161 # role: roles/resourcemanager.organizationViewer
1162 # condition:
1163 # title: expirable access
1164 # description: Does not grant access after Sep 2020
1165 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
1166 # etag: BwWWja0YfJA=
1167 # version: 3
1168 # ```
1169 #
1170 # For a description of IAM and its features, see the
1171 # [IAM documentation](https://cloud.google.com/iam/docs/).
1172 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
1173 { # Specifies the audit configuration for a service.
1174 # The configuration determines which permission types are logged, and what
1175 # identities, if any, are exempted from logging.
1176 # An AuditConfig must have one or more AuditLogConfigs.
1177 #
1178 # If there are AuditConfigs for both `allServices` and a specific service,
1179 # the union of the two AuditConfigs is used for that service: the log_types
1180 # specified in each AuditConfig are enabled, and the exempted_members in each
1181 # AuditLogConfig are exempted.
1182 #
1183 # Example Policy with multiple AuditConfigs:
1184 #
1185 # {
1186 # &quot;audit_configs&quot;: [
1187 # {
1188 # &quot;service&quot;: &quot;allServices&quot;,
1189 # &quot;audit_log_configs&quot;: [
1190 # {
1191 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
1192 # &quot;exempted_members&quot;: [
1193 # &quot;user:[email protected]&quot;
1194 # ]
1195 # },
1196 # {
1197 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
1198 # },
1199 # {
1200 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
1201 # }
1202 # ]
1203 # },
1204 # {
1205 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
1206 # &quot;audit_log_configs&quot;: [
1207 # {
1208 # &quot;log_type&quot;: &quot;DATA_READ&quot;
1209 # },
1210 # {
1211 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
1212 # &quot;exempted_members&quot;: [
1213 # &quot;user:[email protected]&quot;
1214 # ]
1215 # }
1216 # ]
1217 # }
1218 # ]
1219 # }
1220 #
1221 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
1222 # logging. It also exempts `[email protected]` from DATA_READ logging, and
1223 # `[email protected]` from DATA_WRITE logging.
1224 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
1225 { # Provides the configuration for logging a type of permissions.
1226 # Example:
1227 #
1228 # {
1229 # &quot;audit_log_configs&quot;: [
1230 # {
1231 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
1232 # &quot;exempted_members&quot;: [
1233 # &quot;user:[email protected]&quot;
1234 # ]
1235 # },
1236 # {
1237 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
1238 # }
1239 # ]
1240 # }
1241 #
1242 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
1243 # [email protected] from DATA_READ logging.
1244 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
1245 # permission.
1246 # Follows the same format of Binding.members.
1247 &quot;A String&quot;,
1248 ],
1249 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
1250 },
1251 ],
1252 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
1253 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
1254 # `allServices` is a special value that covers all services.
1255 },
1256 ],
1257 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
1258 # may specify a `condition` that determines how and when the `bindings` are
1259 # applied. Each of the `bindings` must contain at least one principal.
1260 #
1261 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
1262 # of these principals can be Google groups. Each occurrence of a principal
1263 # counts towards these limits. For example, if the `bindings` grant 50
1264 # different roles to `user:[email protected]`, and not to any other
1265 # principal, then you can add another 1,450 principals to the `bindings` in
1266 # the `Policy`.
1267 { # Associates `members`, or principals, with a `role`.
1268 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
1269 #
1270 # If the condition evaluates to `true`, then this binding applies to the
1271 # current request.
1272 #
1273 # If the condition evaluates to `false`, then this binding does not apply to
1274 # the current request. However, a different role binding might grant the same
1275 # role to one or more of the principals in this binding.
1276 #
1277 # To learn which resources support conditions in their IAM policies, see the
1278 # [IAM
1279 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
1280 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
1281 # are documented at https://github.com/google/cel-spec.
1282 #
1283 # Example (Comparison):
1284 #
1285 # title: &quot;Summary size limit&quot;
1286 # description: &quot;Determines if a summary is less than 100 chars&quot;
1287 # expression: &quot;document.summary.size() &lt; 100&quot;
1288 #
1289 # Example (Equality):
1290 #
1291 # title: &quot;Requestor is owner&quot;
1292 # description: &quot;Determines if requestor is the document owner&quot;
1293 # expression: &quot;document.owner == request.auth.claims.email&quot;
1294 #
1295 # Example (Logic):
1296 #
1297 # title: &quot;Public documents&quot;
1298 # description: &quot;Determine whether the document should be publicly visible&quot;
1299 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
1300 #
1301 # Example (Data Manipulation):
1302 #
1303 # title: &quot;Notification string&quot;
1304 # description: &quot;Create a notification string with a timestamp.&quot;
1305 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
1306 #
1307 # The exact variables and functions that may be referenced within an expression
1308 # are determined by the service that evaluates it. See the service
1309 # documentation for additional information.
1310 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
1311 # describes the expression, e.g. when hovered over it in a UI.
1312 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
1313 # syntax.
1314 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
1315 # reporting, e.g. a file name and a position in the file.
1316 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
1317 # its purpose. This can be used e.g. in UIs which allow to enter the
1318 # expression.
1319 },
1320 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
1321 # `members` can have the following values:
1322 #
1323 # * `allUsers`: A special identifier that represents anyone who is
1324 # on the internet; with or without a Google account.
1325 #
1326 # * `allAuthenticatedUsers`: A special identifier that represents anyone
1327 # who is authenticated with a Google account or a service account.
1328 # Does not include identities that come from external identity providers
1329 # (IdPs) through identity federation.
1330 #
1331 # * `user:{emailid}`: An email address that represents a specific Google
1332 # account. For example, `[email protected]` .
1333 #
1334 #
1335 # * `serviceAccount:{emailid}`: An email address that represents a Google
1336 # service account. For example,
1337 # `[email protected]`.
1338 #
1339 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
1340 # identifier for a
1341 # [Kubernetes service
1342 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
1343 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
1344 #
1345 # * `group:{emailid}`: An email address that represents a Google group.
1346 # For example, `[email protected]`.
1347 #
1348 #
1349 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
1350 # users of that domain. For example, `google.com` or `example.com`.
1351 #
1352 #
1353 #
1354 #
1355 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
1356 # A single identity in a workforce identity pool.
1357 #
1358 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
1359 # All workforce identities in a group.
1360 #
1361 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
1362 # All workforce identities with a specific attribute value.
1363 #
1364 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
1365 # All identities in a workforce identity pool.
1366 #
1367 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
1368 # A single identity in a workload identity pool.
1369 #
1370 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
1371 # A workload identity pool group.
1372 #
1373 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
1374 # All identities in a workload identity pool with a certain attribute.
1375 #
1376 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
1377 # All identities in a workload identity pool.
1378 #
1379 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
1380 # identifier) representing a user that has been recently deleted. For
1381 # example, `[email protected]?uid=123456789012345678901`. If the user is
1382 # recovered, this value reverts to `user:{emailid}` and the recovered user
1383 # retains the role in the binding.
1384 #
1385 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
1386 # unique identifier) representing a service account that has been recently
1387 # deleted. For example,
1388 # `[email protected]?uid=123456789012345678901`.
1389 # If the service account is undeleted, this value reverts to
1390 # `serviceAccount:{emailid}` and the undeleted service account retains the
1391 # role in the binding.
1392 #
1393 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
1394 # identifier) representing a Google group that has been recently
1395 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
1396 # the group is recovered, this value reverts to `group:{emailid}` and the
1397 # recovered group retains the role in the binding.
1398 #
1399 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
1400 # Deleted single identity in a workforce identity pool. For example,
1401 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
1402 &quot;A String&quot;,
1403 ],
1404 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
1405 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
1406 #
1407 # For an overview of the IAM roles and permissions, see the
1408 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
1409 # a list of the available pre-defined roles, see
1410 # [here](https://cloud.google.com/iam/docs/understanding-roles).
1411 },
1412 ],
1413 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
1414 # prevent simultaneous updates of a policy from overwriting each other.
1415 # It is strongly suggested that systems make use of the `etag` in the
1416 # read-modify-write cycle to perform policy updates in order to avoid race
1417 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
1418 # systems are expected to put that etag in the request to `setIamPolicy` to
1419 # ensure that their change will be applied to the same version of the policy.
1420 #
1421 # **Important:** If you use IAM Conditions, you must include the `etag` field
1422 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
1423 # you to overwrite a version `3` policy with a version `1` policy, and all of
1424 # the conditions in the version `3` policy are lost.
1425 &quot;version&quot;: 42, # Specifies the format of the policy.
1426 #
1427 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
1428 # are rejected.
1429 #
1430 # Any operation that affects conditional role bindings must specify version
1431 # `3`. This requirement applies to the following operations:
1432 #
1433 # * Getting a policy that includes a conditional role binding
1434 # * Adding a conditional role binding to a policy
1435 # * Changing a conditional role binding in a policy
1436 # * Removing any role binding, with or without a condition, from a policy
1437 # that includes conditions
1438 #
1439 # **Important:** If you use IAM Conditions, you must include the `etag` field
1440 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
1441 # you to overwrite a version `3` policy with a version `1` policy, and all of
1442 # the conditions in the version `3` policy are lost.
1443 #
1444 # If a policy does not include any conditions, operations on that policy may
1445 # specify any valid version or leave the field unset.
1446 #
1447 # To learn which resources support conditions in their IAM policies, see the
1448 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
1449 }</pre>
1450 </div>
1451
1452 <div class="method">
1453 <code class="details" id="insert">insert(project, zone, body=None, requestId=None, x__xgafv=None)</code>
1454 <pre>Creates a new reservation. For more information, readReserving zonal
1455 resources.
1456
1457 Args:
1458 project: string, Project ID for this request. (required)
1459 zone: string, Name of the zone for this request. (required)
1460 body: object, The request body.
1461 The object takes the form of:
1462
1463 { # Represents a reservation resource. A reservation ensures that capacity is
1464 # held in a specific zone even if the reserved VMs are not running. For more
1465 # information, read Reserving zonal
1466 # resources.
1467 &quot;advancedDeploymentControl&quot;: { # Advance control for cluster management, applicable only to DENSE deployment # Advanced control for cluster management, applicable only to DENSE
1468 # deployment type reservations.
1469 # type reservations.
1470 &quot;reservationOperationalMode&quot;: &quot;A String&quot;, # Indicates chosen reservation operational mode for the reservation.
1471 },
1472 &quot;aggregateReservation&quot;: { # This reservation type is specified by total resource amounts (e.g. total # Reservation for aggregated resources, providing shape flexibility.
1473 # count of CPUs) and can account for multiple instance SKUs. In other words,
1474 # one can create instances of varying shapes against this reservation.
1475 &quot;inUseResources&quot;: [ # Output only. [Output only] List of resources currently in use.
1476 {
1477 &quot;accelerator&quot;: { # Properties of accelerator resources in this reservation.
1478 &quot;acceleratorCount&quot;: 42, # Number of accelerators of specified type.
1479 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL to accelerator type. e.g.
1480 # &quot;projects/{PROJECT}/zones/{ZONE}/acceleratorTypes/ct4l&quot;
1481 },
1482 },
1483 ],
1484 &quot;reservedResources&quot;: [ # List of reserved resources (CPUs, memory, accelerators).
1485 {
1486 &quot;accelerator&quot;: { # Properties of accelerator resources in this reservation.
1487 &quot;acceleratorCount&quot;: 42, # Number of accelerators of specified type.
1488 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL to accelerator type. e.g.
1489 # &quot;projects/{PROJECT}/zones/{ZONE}/acceleratorTypes/ct4l&quot;
1490 },
1491 },
1492 ],
1493 &quot;vmFamily&quot;: &quot;A String&quot;, # The VM family that all instances scheduled against this reservation must
1494 # belong to.
1495 &quot;workloadType&quot;: &quot;A String&quot;, # The workload type of the instances that will target this reservation.
1496 },
1497 &quot;commitment&quot;: &quot;A String&quot;, # Output only. [Output Only] Full or partial URL to a parent commitment. This field
1498 # displays for reservations that are tied to a commitment.
1499 &quot;confidentialComputeType&quot;: &quot;A String&quot;,
1500 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
1501 # text format.
1502 &quot;deleteAfterDuration&quot;: { # A Duration represents a fixed-length span of time represented # Duration time relative to reservation creation when Compute Engine will
1503 # automatically delete this resource.
1504 # as a count of seconds and fractions of seconds at nanosecond
1505 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
1506 # or &quot;month&quot;. Range is approximately 10,000 years.
1507 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
1508 # Durations less than one second are represented with a 0
1509 # `seconds` field and a positive `nanos` field. Must be from 0
1510 # to 999,999,999 inclusive.
1511 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
1512 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
1513 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
1514 },
1515 &quot;deleteAtTime&quot;: &quot;A String&quot;, # Absolute time in future when the reservation will be
1516 # auto-deleted by Compute Engine. Timestamp is represented inRFC3339 text format.
1517 &quot;deploymentType&quot;: &quot;A String&quot;, # Specifies the deployment strategy for this reservation.
1518 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
1519 # create the resource.
1520 &quot;earlyAccessMaintenance&quot;: &quot;A String&quot;, # Indicates the early access maintenance for the reservation.
1521 # If this field is absent or set to NO_EARLY_ACCESS, the reservation is not
1522 # enrolled in early access maintenance and the standard notice applies.
1523 &quot;enableEmergentMaintenance&quot;: True or False, # Indicates whether Compute Engine allows unplanned maintenance for your VMs;
1524 # for example, to fix hardware errors.
1525 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
1526 # defined by the server.
1527 &quot;kind&quot;: &quot;compute#reservation&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#reservations for reservations.
1528 &quot;linkedCommitments&quot;: [ # Output only. [Output Only] Full or partial URL to parent commitments. This field
1529 # displays for reservations that are tied to multiple commitments.
1530 &quot;A String&quot;,
1531 ],
1532 &quot;name&quot;: &quot;A String&quot;, # The name of the resource, provided by the client when initially creating
1533 # the resource. The resource name must be 1-63 characters long, and comply
1534 # withRFC1035.
1535 # Specifically, the name must be 1-63 characters long and match the regular
1536 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
1537 # character must be a lowercase letter, and all following characters must be
1538 # a dash, lowercase letter, or digit, except the last character, which cannot
1539 # be a dash.
1540 &quot;params&quot;: { # Additional reservation params. # Input only. Additional params passed with the request, but not persisted
1541 # as part of resource payload.
1542 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the reservation. Tag keys and
1543 # values have the same definition as resource
1544 # manager tags. Keys and values can be either in numeric format,
1545 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
1546 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
1547 # `{tag_value_short_name}`. The field is ignored (both PUT &amp;
1548 # PATCH) when empty.
1549 &quot;a_key&quot;: &quot;A String&quot;,
1550 },
1551 },
1552 &quot;protectionTier&quot;: &quot;A String&quot;, # Protection tier for the workload which specifies the workload expectations
1553 # in the event of infrastructure failures at data center (e.g. power
1554 # and/or cooling failures).
1555 &quot;reservationSharingPolicy&quot;: { # Specify the reservation sharing policy. If unspecified, the reservation
1556 # will not be shared with Google Cloud managed services.
1557 &quot;serviceShareType&quot;: &quot;A String&quot;, # Sharing config for all Google Cloud services.
1558 },
1559 &quot;resourcePolicies&quot;: { # Resource policies to be added to this reservation. The key is defined by
1560 # user, and the value is resource policy url. This is to define placement
1561 # policy with reservation.
1562 &quot;a_key&quot;: &quot;A String&quot;,
1563 },
1564 &quot;resourceStatus&quot;: { # [Output Only] Contains output only fields. # Output only. [Output Only] Status information for Reservation resource.
1565 &quot;healthInfo&quot;: { # Health information for the reservation. # [Output only] Health information for the reservation.
1566 &quot;degradedBlockCount&quot;: 42, # The number of reservation blocks that are degraded.
1567 &quot;healthStatus&quot;: &quot;A String&quot;, # The health status of the reservation.
1568 &quot;healthyBlockCount&quot;: 42, # The number of reservation blocks that are healthy.
1569 },
1570 &quot;reservationBlockCount&quot;: 42, # The number of reservation blocks associated with this reservation.
1571 &quot;reservationMaintenance&quot;: { # Maintenance Info for ReservationBlocks. # Maintenance information for this reservation
1572 &quot;instanceMaintenanceOngoingCount&quot;: 42, # Describes number of instances that have ongoing maintenance.
1573 &quot;instanceMaintenancePendingCount&quot;: 42, # Describes number of instances that have pending maintenance.
1574 &quot;maintenanceOngoingCount&quot;: 42, # Progress for ongoing maintenance for this group of VMs/hosts.
1575 # Describes number of hosts in the block that have ongoing maintenance.
1576 &quot;maintenancePendingCount&quot;: 42, # Progress for ongoing maintenance for this group of VMs/hosts.
1577 # Describes number of hosts in the block that have pending maintenance.
1578 &quot;schedulingType&quot;: &quot;A String&quot;, # The type of maintenance for the reservation.
1579 &quot;subblockInfraMaintenanceOngoingCount&quot;: 42, # Describes number of subblock Infrastructure that has ongoing maintenance.
1580 # Here, Subblock Infrastructure Maintenance pertains to upstream hardware
1581 # contained in the Subblock that is necessary for a VM Family(e.g. NVLink
1582 # Domains). Not all VM Families will support this field.
1583 &quot;subblockInfraMaintenancePendingCount&quot;: 42, # Describes number of subblock Infrastructure that has pending maintenance.
1584 # Here, Subblock Infrastructure Maintenance pertains to upstream hardware
1585 # contained in the Subblock that is necessary for a VM Family (e.g. NVLink
1586 # Domains). Not all VM Families will support this field.
1587 &quot;upcomingGroupMaintenance&quot;: { # Upcoming Maintenance notification information. # Maintenance information on this group of VMs.
1588 &quot;canReschedule&quot;: True or False, # Indicates if the maintenance can be customer triggered.
1589 &quot;latestWindowStartTime&quot;: &quot;A String&quot;, # The latest time for the planned maintenance window to start.
1590 # This timestamp value is in RFC3339 text format.
1591 &quot;maintenanceOnShutdown&quot;: True or False, # Indicates whether the UpcomingMaintenance will be triggered on VM shutdown.
1592 &quot;maintenanceReasons&quot;: [ # The reasons for the maintenance. Only valid for vms.
1593 &quot;A String&quot;,
1594 ],
1595 &quot;maintenanceStatus&quot;: &quot;A String&quot;,
1596 &quot;type&quot;: &quot;A String&quot;, # Defines the type of maintenance.
1597 &quot;windowEndTime&quot;: &quot;A String&quot;, # The time by which the maintenance disruption will be completed.
1598 # This timestamp value is in RFC3339 text format.
1599 &quot;windowStartTime&quot;: &quot;A String&quot;, # The current start time of the maintenance window.
1600 # This timestamp value is in RFC3339 text format.
1601 },
1602 },
1603 &quot;specificSkuAllocation&quot;: { # Contains Properties set for the reservation. # Allocation Properties of this reservation.
1604 &quot;sourceInstanceTemplateId&quot;: &quot;A String&quot;, # ID of the instance template used to populate reservation properties.
1605 &quot;utilizations&quot;: { # Per service utilization breakdown. The Key is the Google Cloud managed
1606 # service name.
1607 &quot;a_key&quot;: &quot;A String&quot;,
1608 },
1609 },
1610 },
1611 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
1612 &quot;schedulingType&quot;: &quot;A String&quot;, # The type of maintenance for the reservation.
1613 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined fully-qualified URL for this resource.
1614 &quot;shareSettings&quot;: { # The share setting for reservations and sole tenancy node groups. # Specify share-settings to create a shared reservation. This property is
1615 # optional. For more information about the syntax and options for this
1616 # field and its subfields, see the guide for creating
1617 # a shared reservation.
1618 &quot;projectMap&quot;: { # A map of project id and project config. This is only valid when
1619 # share_type&#x27;s value is SPECIFIC_PROJECTS.
1620 &quot;a_key&quot;: { # Config for each project in the share settings.
1621 &quot;projectId&quot;: &quot;A String&quot;, # The project ID, should be same as the key of this project config in the
1622 # parent map.
1623 },
1624 },
1625 &quot;shareType&quot;: &quot;A String&quot;, # Type of sharing for this shared-reservation
1626 },
1627 &quot;specificReservation&quot;: { # This reservation type allows to pre allocate specific instance # Reservation for instances with specific machine shapes.
1628 # configuration.
1629 &quot;assuredCount&quot;: &quot;A String&quot;, # Output only. [Output Only] Indicates how many instances are actually usable currently.
1630 &quot;count&quot;: &quot;A String&quot;, # Specifies the number of resources that are allocated.
1631 &quot;inUseCount&quot;: &quot;A String&quot;, # Output only. [Output Only] Indicates how many instances are in use.
1632 &quot;instanceProperties&quot;: { # Properties of the SKU instances being reserved. # The instance properties for the reservation.
1633 # Next ID: 10
1634 &quot;guestAccelerators&quot;: [ # Specifies accelerator type and count.
1635 { # A specification of the type and number of accelerator cards attached to the
1636 # instance.
1637 &quot;acceleratorCount&quot;: 42, # The number of the guest accelerator cards exposed to this instance.
1638 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL of the accelerator type resource to attach to this
1639 # instance. For example:projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100
1640 # If you are creating an instance template, specify only the
1641 # accelerator name.
1642 # See GPUs on Compute Engine
1643 # for a full list of accelerator types.
1644 },
1645 ],
1646 &quot;localSsds&quot;: [ # Specifies amount of local ssd to reserve with each instance. The type
1647 # of disk is local-ssd.
1648 {
1649 &quot;diskSizeGb&quot;: &quot;A String&quot;, # Specifies the size of the disk in base-2 GB.
1650 &quot;interface&quot;: &quot;A String&quot;, # Specifies the disk interface to use for attaching this disk, which is
1651 # either SCSI or NVME. The default isSCSI.
1652 # For performance characteristics of SCSI over NVMe, seeLocal SSD performance.
1653 },
1654 ],
1655 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the allocation close to other
1656 # resources.
1657 # This field is for use by internal tools that use the public API.
1658 &quot;machineType&quot;: &quot;A String&quot;, # Specifies type of machine (name only) which has fixed number of vCPUs
1659 # and fixed amount of memory. This also includes specifying custom
1660 # machine type following custom-NUMBER_OF_CPUS-AMOUNT_OF_MEMORY pattern.
1661 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # Minimum cpu platform the reservation.
1662 },
1663 &quot;sourceInstanceTemplate&quot;: &quot;A String&quot;, # Specifies the instance template to create the reservation. If you use
1664 # this field, you must exclude the instanceProperties field.
1665 #
1666 # This field is optional, and it can be a full or partial URL. For example,
1667 # the following are all valid URLs to an instance template:
1668 #
1669 #
1670 # - https://www.googleapis.com/compute/v1/projects/project/global/instanceTemplates/instanceTemplate
1671 # - projects/project/global/instanceTemplates/instanceTemplate
1672 # - global/instanceTemplates/instanceTemplate
1673 },
1674 &quot;specificReservationRequired&quot;: True or False, # Indicates whether the reservation can be consumed by VMs with affinity
1675 # for &quot;any&quot; reservation. If the field is set, then only VMs that target
1676 # the reservation by name can consume from this reservation.
1677 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only] The status of the reservation.
1678 #
1679 #
1680 # - CREATING: Reservation resources are being
1681 # allocated.
1682 # - READY: Reservation resources have been allocated,
1683 # and the reservation is ready for use.
1684 # - DELETING: Reservation deletion is in progress.
1685 # - UPDATING: Reservation update is in progress.
1686 &quot;zone&quot;: &quot;A String&quot;, # Zone in which the reservation resides. A zone must be provided if the
1687 # reservation is created within a commitment.
1688 }
1689
1690 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
1691 that if you must retry your request, the server will know to ignore the
1692 request if it has already been completed.
1693
1694 For example, consider a situation where you make an initial request and
1695 the request times out. If you make the request again with the same
1696 request ID, the server can check if original operation with the same
1697 request ID was received, and if so, will ignore the second request. This
1698 prevents clients from accidentally creating duplicate commitments.
1699
1700 The request ID must be
1701 a valid UUID with the exception that zero UUID is not supported
1702 (00000000-0000-0000-0000-000000000000).
1703 x__xgafv: string, V1 error format.
1704 Allowed values
1705 1 - v1 error format
1706 2 - v2 error format
1707
1708 Returns:
1709 An object of the form:
1710
1711 { # Represents an Operation resource.
1712 #
1713 # Google Compute Engine has three Operation resources:
1714 #
1715 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
1716 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
1717 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
1718 #
1719 # You can use an operation resource to manage asynchronous API requests.
1720 # For more information, readHandling
1721 # API responses.
1722 #
1723 # Operations can be global, regional or zonal.
1724 #
1725 # - For global operations, use the `globalOperations`
1726 # resource.
1727 # - For regional operations, use the
1728 # `regionOperations` resource.
1729 # - For zonal operations, use
1730 # the `zoneOperations` resource.
1731 #
1732 #
1733 #
1734 # For more information, read
1735 # Global, Regional, and Zonal Resources.
1736 #
1737 # Note that completed Operation resources have a limited
1738 # retention period.
1739 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
1740 # Not present otherwise.
1741 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1742 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
1743 # set when the operation is created.
1744 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
1745 # text format.
1746 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
1747 # this field will be populated.
1748 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
1749 # operation.
1750 {
1751 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1752 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
1753 # details. There is a set of defined message types to use for providing
1754 # details.The syntax depends on the error code. For example,
1755 # QuotaExceededInfo will have details when the error code is
1756 # QUOTA_EXCEEDED.
1757 {
1758 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
1759 #
1760 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
1761 # is not enabled:
1762 #
1763 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
1764 # &quot;domain&quot;: &quot;googleapis.com&quot;
1765 # &quot;metadata&quot;: {
1766 # &quot;resource&quot;: &quot;projects/123&quot;,
1767 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
1768 # }
1769 # }
1770 #
1771 # This response indicates that the pubsub.googleapis.com API is not enabled.
1772 #
1773 # Example of an error that is returned when attempting to create a Spanner
1774 # instance in a region that is out of stock:
1775 #
1776 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
1777 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
1778 # &quot;metadata&quot;: {
1779 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
1780 # }
1781 # }
1782 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
1783 # is typically the registered service name of the tool or product that
1784 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
1785 # generated by some common infrastructure, the error domain must be a
1786 # globally unique value that identifies the infrastructure. For Google API
1787 # infrastructure, the error domain is &quot;googleapis.com&quot;.
1788 &quot;metadatas&quot;: { # Additional structured details about this error.
1789 #
1790 # Keys must match a regular expression of `a-z+` but should
1791 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
1792 # length. When identifying the current value of an exceeded limit, the units
1793 # should be contained in the key, not the value. For example, rather than
1794 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1795 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1796 # instances that can be created in a single (batch) request.
1797 &quot;a_key&quot;: &quot;A String&quot;,
1798 },
1799 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1800 # proximate cause of the error. Error reasons are unique within a particular
1801 # domain of errors. This should be at most 63 characters and match a
1802 # regular expression of `A-Z+[A-Z0-9]`, which represents
1803 # UPPER_SNAKE_CASE.
1804 },
1805 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1806 #
1807 # For example, if a quota check failed with an error indicating the calling
1808 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1809 # directly to the right place in the developer console to flip the bit.
1810 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1811 { # Describes a URL link.
1812 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1813 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1814 },
1815 ],
1816 },
1817 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1818 # which can be attached to an RPC error.
1819 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1820 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1821 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1822 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1823 },
1824 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1825 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1826 &quot;a_key&quot;: &quot;A String&quot;,
1827 },
1828 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1829 # type or metric.
1830 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1831 # or metric.
1832 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1833 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1834 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1835 },
1836 },
1837 ],
1838 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1839 # This property is optional.
1840 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1841 },
1842 ],
1843 },
1844 &quot;getVersionOperationMetadata&quot;: {
1845 &quot;inlineSbomInfo&quot;: {
1846 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1847 # appropriate identifiers.
1848 &quot;a_key&quot;: &quot;A String&quot;,
1849 },
1850 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
1851 # identifiers.
1852 &quot;a_key&quot;: &quot;A String&quot;,
1853 },
1854 },
1855 },
1856 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1857 # message that was returned, such as `NOT FOUND`.
1858 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1859 # status code that was returned. For example, a `404` means the
1860 # resource was not found.
1861 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1862 # defined by the server.
1863 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1864 # This value is inRFC3339
1865 # text format.
1866 &quot;instancesBulkInsertOperationMetadata&quot;: {
1867 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1868 # Example key: zones/us-central1-a
1869 &quot;a_key&quot;: {
1870 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1871 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1872 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1873 # error.
1874 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1875 # if the flow is rolling forward or rolling back.
1876 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1877 },
1878 },
1879 },
1880 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1881 # Operation resources.
1882 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1883 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1884 # group of operations results from a `bulkInsert` API request.
1885 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1886 # `update`, or `delete`, and so on.
1887 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1888 # There is no requirement that this be linear or support any granularity of
1889 # operations. This should not be used to guess when the operation will be
1890 # complete. This number should monotonically increase as the operation
1891 # progresses.
1892 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1893 # applicable when performing regional operations.
1894 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1895 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1896 # this field will contain information on all underlying zonal actions and
1897 # their state.
1898 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1899 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1900 # Example key: zones/us-central1-a
1901 &quot;a_key&quot;: {
1902 &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
1903 # populated.
1904 # different programming environments, including REST APIs and RPC APIs. It is
1905 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1906 # three pieces of data: error code, error message, and error details.
1907 #
1908 # You can find out more about this error model and how to work with it in the
1909 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1910 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1911 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1912 # message types for APIs to use.
1913 {
1914 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1915 },
1916 ],
1917 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1918 # user-facing error message should be localized and sent in the
1919 # google.rpc.Status.details field, or localized by the client.
1920 },
1921 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1922 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1923 },
1924 },
1925 },
1926 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1927 # This value is inRFC3339
1928 # text format.
1929 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1930 # following:
1931 # `PENDING`, `RUNNING`, or `DONE`.
1932 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1933 # operation.
1934 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1935 # of the target resource.
1936 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1937 # operations related to creating a snapshot, this points to the disk
1938 # that the snapshot was created from.
1939 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1940 # `[email protected]` or
1941 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1942 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1943 # operation, this field will be populated.
1944 {
1945 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1946 # Engine returns NO_RESULTS_ON_PAGE if there
1947 # are no results in the response.
1948 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1949 # value format. For example:
1950 #
1951 # &quot;data&quot;: [
1952 # {
1953 # &quot;key&quot;: &quot;scope&quot;,
1954 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1955 # }
1956 {
1957 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1958 # returned. For example, for warnings where there are no results in a list
1959 # request for a particular zone, this key might be scope and
1960 # the key value might be the zone name. Other examples might be a key
1961 # indicating a deprecated resource and a suggested replacement, or a
1962 # warning about invalid network settings (for example, if an instance
1963 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1964 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1965 },
1966 ],
1967 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1968 },
1969 ],
1970 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1971 # applicable when performing per-zone operations.
1972 }</pre>
1973 </div>
1974
1975 <div class="method">
1976 <code class="details" id="list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
1977 <pre>A list of all the reservations that have been configured for the
1978 specified project in specified zone.
1979
1980 Args:
1981 project: string, Project ID for this request. (required)
1982 zone: string, Name of the zone for this request. (required)
1983 filter: string, A filter expression that filters resources listed in the response. Most
1984 Compute resources support two types of filter expressions:
1985 expressions that support regular expressions and expressions that follow
1986 API improvement proposal AIP-160.
1987 These two types of filter expressions cannot be mixed in one request.
1988
1989 If you want to use AIP-160, your expression must specify the field name, an
1990 operator, and the value that you want to use for filtering. The value
1991 must be a string, a number, or a boolean. The operator
1992 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
1993
1994 For example, if you are filtering Compute Engine instances, you can
1995 exclude instances named `example-instance` by specifying
1996 `name != example-instance`.
1997
1998 The `:*` comparison can be used to test whether a key has been defined.
1999 For example, to find all objects with `owner` label use:
2000 ```
2001 labels.owner:*
2002 ```
2003
2004 You can also filter nested fields. For example, you could specify
2005 `scheduling.automaticRestart = false` to include instances only
2006 if they are not scheduled for automatic restarts. You can use filtering
2007 on nested fields to filter based onresource labels.
2008
2009 To filter on multiple expressions, provide each separate expression within
2010 parentheses. For example:
2011 ```
2012 (scheduling.automaticRestart = true)
2013 (cpuPlatform = &quot;Intel Skylake&quot;)
2014 ```
2015 By default, each expression is an `AND` expression. However, you
2016 can include `AND` and `OR` expressions explicitly.
2017 For example:
2018 ```
2019 (cpuPlatform = &quot;Intel Skylake&quot;) OR
2020 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
2021 (scheduling.automaticRestart = true)
2022 ```
2023
2024 If you want to use a regular expression, use the `eq` (equal) or `ne`
2025 (not equal) operator against a single un-parenthesized expression with or
2026 without quotes or against multiple parenthesized expressions. Examples:
2027
2028 `fieldname eq unquoted literal`
2029 `fieldname eq &#x27;single quoted literal&#x27;`
2030 `fieldname eq &quot;double quoted literal&quot;`
2031 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
2032
2033 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
2034 The literal value must match the entire field.
2035
2036 For example, to filter for instances that do not end with name &quot;instance&quot;,
2037 you would use `name ne .*instance`.
2038
2039 You cannot combine constraints on multiple fields using regular
2040 expressions.
2041 maxResults: integer, The maximum number of results per page that should be returned.
2042 If the number of available results is larger than `maxResults`,
2043 Compute Engine returns a `nextPageToken` that can be used to get
2044 the next page of results in subsequent list requests. Acceptable values are
2045 `0` to `500`, inclusive. (Default: `500`)
2046 orderBy: string, Sorts list results by a certain order. By default, results
2047 are returned in alphanumerical order based on the resource name.
2048
2049 You can also sort results in descending order based on the creation
2050 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
2051 results based on the `creationTimestamp` field in
2052 reverse chronological order (newest result first). Use this to sort
2053 resources like operations so that the newest operation is returned first.
2054
2055 Currently, only sorting by `name` or
2056 `creationTimestamp desc` is supported.
2057 pageToken: string, Specifies a page token to use. Set `pageToken` to the
2058 `nextPageToken` returned by a previous list request to get
2059 the next page of results.
2060 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
2061 of failure. The default value is false.
2062
2063 For example, when partial success behavior is enabled, aggregatedList for a
2064 single zone scope either returns all resources in the zone or no resources,
2065 with an error code.
2066 x__xgafv: string, V1 error format.
2067 Allowed values
2068 1 - v1 error format
2069 2 - v2 error format
2070
2071 Returns:
2072 An object of the form:
2073
2074 {
2075 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
2076 # defined by the server.
2077 &quot;items&quot;: [ # [Output Only] A list of Allocation resources.
2078 { # Represents a reservation resource. A reservation ensures that capacity is
2079 # held in a specific zone even if the reserved VMs are not running. For more
2080 # information, read Reserving zonal
2081 # resources.
2082 &quot;advancedDeploymentControl&quot;: { # Advance control for cluster management, applicable only to DENSE deployment # Advanced control for cluster management, applicable only to DENSE
2083 # deployment type reservations.
2084 # type reservations.
2085 &quot;reservationOperationalMode&quot;: &quot;A String&quot;, # Indicates chosen reservation operational mode for the reservation.
2086 },
2087 &quot;aggregateReservation&quot;: { # This reservation type is specified by total resource amounts (e.g. total # Reservation for aggregated resources, providing shape flexibility.
2088 # count of CPUs) and can account for multiple instance SKUs. In other words,
2089 # one can create instances of varying shapes against this reservation.
2090 &quot;inUseResources&quot;: [ # Output only. [Output only] List of resources currently in use.
2091 {
2092 &quot;accelerator&quot;: { # Properties of accelerator resources in this reservation.
2093 &quot;acceleratorCount&quot;: 42, # Number of accelerators of specified type.
2094 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL to accelerator type. e.g.
2095 # &quot;projects/{PROJECT}/zones/{ZONE}/acceleratorTypes/ct4l&quot;
2096 },
2097 },
2098 ],
2099 &quot;reservedResources&quot;: [ # List of reserved resources (CPUs, memory, accelerators).
2100 {
2101 &quot;accelerator&quot;: { # Properties of accelerator resources in this reservation.
2102 &quot;acceleratorCount&quot;: 42, # Number of accelerators of specified type.
2103 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL to accelerator type. e.g.
2104 # &quot;projects/{PROJECT}/zones/{ZONE}/acceleratorTypes/ct4l&quot;
2105 },
2106 },
2107 ],
2108 &quot;vmFamily&quot;: &quot;A String&quot;, # The VM family that all instances scheduled against this reservation must
2109 # belong to.
2110 &quot;workloadType&quot;: &quot;A String&quot;, # The workload type of the instances that will target this reservation.
2111 },
2112 &quot;commitment&quot;: &quot;A String&quot;, # Output only. [Output Only] Full or partial URL to a parent commitment. This field
2113 # displays for reservations that are tied to a commitment.
2114 &quot;confidentialComputeType&quot;: &quot;A String&quot;,
2115 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
2116 # text format.
2117 &quot;deleteAfterDuration&quot;: { # A Duration represents a fixed-length span of time represented # Duration time relative to reservation creation when Compute Engine will
2118 # automatically delete this resource.
2119 # as a count of seconds and fractions of seconds at nanosecond
2120 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
2121 # or &quot;month&quot;. Range is approximately 10,000 years.
2122 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
2123 # Durations less than one second are represented with a 0
2124 # `seconds` field and a positive `nanos` field. Must be from 0
2125 # to 999,999,999 inclusive.
2126 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
2127 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
2128 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
2129 },
2130 &quot;deleteAtTime&quot;: &quot;A String&quot;, # Absolute time in future when the reservation will be
2131 # auto-deleted by Compute Engine. Timestamp is represented inRFC3339 text format.
2132 &quot;deploymentType&quot;: &quot;A String&quot;, # Specifies the deployment strategy for this reservation.
2133 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
2134 # create the resource.
2135 &quot;earlyAccessMaintenance&quot;: &quot;A String&quot;, # Indicates the early access maintenance for the reservation.
2136 # If this field is absent or set to NO_EARLY_ACCESS, the reservation is not
2137 # enrolled in early access maintenance and the standard notice applies.
2138 &quot;enableEmergentMaintenance&quot;: True or False, # Indicates whether Compute Engine allows unplanned maintenance for your VMs;
2139 # for example, to fix hardware errors.
2140 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
2141 # defined by the server.
2142 &quot;kind&quot;: &quot;compute#reservation&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#reservations for reservations.
2143 &quot;linkedCommitments&quot;: [ # Output only. [Output Only] Full or partial URL to parent commitments. This field
2144 # displays for reservations that are tied to multiple commitments.
2145 &quot;A String&quot;,
2146 ],
2147 &quot;name&quot;: &quot;A String&quot;, # The name of the resource, provided by the client when initially creating
2148 # the resource. The resource name must be 1-63 characters long, and comply
2149 # withRFC1035.
2150 # Specifically, the name must be 1-63 characters long and match the regular
2151 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
2152 # character must be a lowercase letter, and all following characters must be
2153 # a dash, lowercase letter, or digit, except the last character, which cannot
2154 # be a dash.
2155 &quot;params&quot;: { # Additional reservation params. # Input only. Additional params passed with the request, but not persisted
2156 # as part of resource payload.
2157 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the reservation. Tag keys and
2158 # values have the same definition as resource
2159 # manager tags. Keys and values can be either in numeric format,
2160 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
2161 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
2162 # `{tag_value_short_name}`. The field is ignored (both PUT &amp;
2163 # PATCH) when empty.
2164 &quot;a_key&quot;: &quot;A String&quot;,
2165 },
2166 },
2167 &quot;protectionTier&quot;: &quot;A String&quot;, # Protection tier for the workload which specifies the workload expectations
2168 # in the event of infrastructure failures at data center (e.g. power
2169 # and/or cooling failures).
2170 &quot;reservationSharingPolicy&quot;: { # Specify the reservation sharing policy. If unspecified, the reservation
2171 # will not be shared with Google Cloud managed services.
2172 &quot;serviceShareType&quot;: &quot;A String&quot;, # Sharing config for all Google Cloud services.
2173 },
2174 &quot;resourcePolicies&quot;: { # Resource policies to be added to this reservation. The key is defined by
2175 # user, and the value is resource policy url. This is to define placement
2176 # policy with reservation.
2177 &quot;a_key&quot;: &quot;A String&quot;,
2178 },
2179 &quot;resourceStatus&quot;: { # [Output Only] Contains output only fields. # Output only. [Output Only] Status information for Reservation resource.
2180 &quot;healthInfo&quot;: { # Health information for the reservation. # [Output only] Health information for the reservation.
2181 &quot;degradedBlockCount&quot;: 42, # The number of reservation blocks that are degraded.
2182 &quot;healthStatus&quot;: &quot;A String&quot;, # The health status of the reservation.
2183 &quot;healthyBlockCount&quot;: 42, # The number of reservation blocks that are healthy.
2184 },
2185 &quot;reservationBlockCount&quot;: 42, # The number of reservation blocks associated with this reservation.
2186 &quot;reservationMaintenance&quot;: { # Maintenance Info for ReservationBlocks. # Maintenance information for this reservation
2187 &quot;instanceMaintenanceOngoingCount&quot;: 42, # Describes number of instances that have ongoing maintenance.
2188 &quot;instanceMaintenancePendingCount&quot;: 42, # Describes number of instances that have pending maintenance.
2189 &quot;maintenanceOngoingCount&quot;: 42, # Progress for ongoing maintenance for this group of VMs/hosts.
2190 # Describes number of hosts in the block that have ongoing maintenance.
2191 &quot;maintenancePendingCount&quot;: 42, # Progress for ongoing maintenance for this group of VMs/hosts.
2192 # Describes number of hosts in the block that have pending maintenance.
2193 &quot;schedulingType&quot;: &quot;A String&quot;, # The type of maintenance for the reservation.
2194 &quot;subblockInfraMaintenanceOngoingCount&quot;: 42, # Describes number of subblock Infrastructure that has ongoing maintenance.
2195 # Here, Subblock Infrastructure Maintenance pertains to upstream hardware
2196 # contained in the Subblock that is necessary for a VM Family(e.g. NVLink
2197 # Domains). Not all VM Families will support this field.
2198 &quot;subblockInfraMaintenancePendingCount&quot;: 42, # Describes number of subblock Infrastructure that has pending maintenance.
2199 # Here, Subblock Infrastructure Maintenance pertains to upstream hardware
2200 # contained in the Subblock that is necessary for a VM Family (e.g. NVLink
2201 # Domains). Not all VM Families will support this field.
2202 &quot;upcomingGroupMaintenance&quot;: { # Upcoming Maintenance notification information. # Maintenance information on this group of VMs.
2203 &quot;canReschedule&quot;: True or False, # Indicates if the maintenance can be customer triggered.
2204 &quot;latestWindowStartTime&quot;: &quot;A String&quot;, # The latest time for the planned maintenance window to start.
2205 # This timestamp value is in RFC3339 text format.
2206 &quot;maintenanceOnShutdown&quot;: True or False, # Indicates whether the UpcomingMaintenance will be triggered on VM shutdown.
2207 &quot;maintenanceReasons&quot;: [ # The reasons for the maintenance. Only valid for vms.
2208 &quot;A String&quot;,
2209 ],
2210 &quot;maintenanceStatus&quot;: &quot;A String&quot;,
2211 &quot;type&quot;: &quot;A String&quot;, # Defines the type of maintenance.
2212 &quot;windowEndTime&quot;: &quot;A String&quot;, # The time by which the maintenance disruption will be completed.
2213 # This timestamp value is in RFC3339 text format.
2214 &quot;windowStartTime&quot;: &quot;A String&quot;, # The current start time of the maintenance window.
2215 # This timestamp value is in RFC3339 text format.
2216 },
2217 },
2218 &quot;specificSkuAllocation&quot;: { # Contains Properties set for the reservation. # Allocation Properties of this reservation.
2219 &quot;sourceInstanceTemplateId&quot;: &quot;A String&quot;, # ID of the instance template used to populate reservation properties.
2220 &quot;utilizations&quot;: { # Per service utilization breakdown. The Key is the Google Cloud managed
2221 # service name.
2222 &quot;a_key&quot;: &quot;A String&quot;,
2223 },
2224 },
2225 },
2226 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
2227 &quot;schedulingType&quot;: &quot;A String&quot;, # The type of maintenance for the reservation.
2228 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined fully-qualified URL for this resource.
2229 &quot;shareSettings&quot;: { # The share setting for reservations and sole tenancy node groups. # Specify share-settings to create a shared reservation. This property is
2230 # optional. For more information about the syntax and options for this
2231 # field and its subfields, see the guide for creating
2232 # a shared reservation.
2233 &quot;projectMap&quot;: { # A map of project id and project config. This is only valid when
2234 # share_type&#x27;s value is SPECIFIC_PROJECTS.
2235 &quot;a_key&quot;: { # Config for each project in the share settings.
2236 &quot;projectId&quot;: &quot;A String&quot;, # The project ID, should be same as the key of this project config in the
2237 # parent map.
2238 },
2239 },
2240 &quot;shareType&quot;: &quot;A String&quot;, # Type of sharing for this shared-reservation
2241 },
2242 &quot;specificReservation&quot;: { # This reservation type allows to pre allocate specific instance # Reservation for instances with specific machine shapes.
2243 # configuration.
2244 &quot;assuredCount&quot;: &quot;A String&quot;, # Output only. [Output Only] Indicates how many instances are actually usable currently.
2245 &quot;count&quot;: &quot;A String&quot;, # Specifies the number of resources that are allocated.
2246 &quot;inUseCount&quot;: &quot;A String&quot;, # Output only. [Output Only] Indicates how many instances are in use.
2247 &quot;instanceProperties&quot;: { # Properties of the SKU instances being reserved. # The instance properties for the reservation.
2248 # Next ID: 10
2249 &quot;guestAccelerators&quot;: [ # Specifies accelerator type and count.
2250 { # A specification of the type and number of accelerator cards attached to the
2251 # instance.
2252 &quot;acceleratorCount&quot;: 42, # The number of the guest accelerator cards exposed to this instance.
2253 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL of the accelerator type resource to attach to this
2254 # instance. For example:projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100
2255 # If you are creating an instance template, specify only the
2256 # accelerator name.
2257 # See GPUs on Compute Engine
2258 # for a full list of accelerator types.
2259 },
2260 ],
2261 &quot;localSsds&quot;: [ # Specifies amount of local ssd to reserve with each instance. The type
2262 # of disk is local-ssd.
2263 {
2264 &quot;diskSizeGb&quot;: &quot;A String&quot;, # Specifies the size of the disk in base-2 GB.
2265 &quot;interface&quot;: &quot;A String&quot;, # Specifies the disk interface to use for attaching this disk, which is
2266 # either SCSI or NVME. The default isSCSI.
2267 # For performance characteristics of SCSI over NVMe, seeLocal SSD performance.
2268 },
2269 ],
2270 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the allocation close to other
2271 # resources.
2272 # This field is for use by internal tools that use the public API.
2273 &quot;machineType&quot;: &quot;A String&quot;, # Specifies type of machine (name only) which has fixed number of vCPUs
2274 # and fixed amount of memory. This also includes specifying custom
2275 # machine type following custom-NUMBER_OF_CPUS-AMOUNT_OF_MEMORY pattern.
2276 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # Minimum cpu platform the reservation.
2277 },
2278 &quot;sourceInstanceTemplate&quot;: &quot;A String&quot;, # Specifies the instance template to create the reservation. If you use
2279 # this field, you must exclude the instanceProperties field.
2280 #
2281 # This field is optional, and it can be a full or partial URL. For example,
2282 # the following are all valid URLs to an instance template:
2283 #
2284 #
2285 # - https://www.googleapis.com/compute/v1/projects/project/global/instanceTemplates/instanceTemplate
2286 # - projects/project/global/instanceTemplates/instanceTemplate
2287 # - global/instanceTemplates/instanceTemplate
2288 },
2289 &quot;specificReservationRequired&quot;: True or False, # Indicates whether the reservation can be consumed by VMs with affinity
2290 # for &quot;any&quot; reservation. If the field is set, then only VMs that target
2291 # the reservation by name can consume from this reservation.
2292 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only] The status of the reservation.
2293 #
2294 #
2295 # - CREATING: Reservation resources are being
2296 # allocated.
2297 # - READY: Reservation resources have been allocated,
2298 # and the reservation is ready for use.
2299 # - DELETING: Reservation deletion is in progress.
2300 # - UPDATING: Reservation update is in progress.
2301 &quot;zone&quot;: &quot;A String&quot;, # Zone in which the reservation resides. A zone must be provided if the
2302 # reservation is created within a commitment.
2303 },
2304 ],
2305 &quot;kind&quot;: &quot;compute#reservationList&quot;, # Output only. [Output Only] Type of resource.Always compute#reservationsList
2306 # for listsof reservations
2307 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
2308 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
2309 # the query parameter pageToken in the next list request.
2310 # Subsequent list requests will have their own nextPageToken to
2311 # continue paging through the results.
2312 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
2313 &quot;warning&quot;: { # [Output Only] Informational warning message.
2314 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2315 # Engine returns NO_RESULTS_ON_PAGE if there
2316 # are no results in the response.
2317 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2318 # value format. For example:
2319 #
2320 # &quot;data&quot;: [
2321 # {
2322 # &quot;key&quot;: &quot;scope&quot;,
2323 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2324 # }
2325 {
2326 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2327 # returned. For example, for warnings where there are no results in a list
2328 # request for a particular zone, this key might be scope and
2329 # the key value might be the zone name. Other examples might be a key
2330 # indicating a deprecated resource and a suggested replacement, or a
2331 # warning about invalid network settings (for example, if an instance
2332 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2333 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2334 },
2335 ],
2336 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2337 },
2338 }</pre>
2339 </div>
2340
2341 <div class="method">
2342 <code class="details" id="list_next">list_next()</code>
2343 <pre>Retrieves the next page of results.
2344
2345 Args:
2346 previous_request: The request for the previous page. (required)
2347 previous_response: The response from the request for the previous page. (required)
2348
2349 Returns:
2350 A request object that you can call &#x27;execute()&#x27; on to request the next
2351 page. Returns None if there are no more items in the collection.
2352 </pre>
2353 </div>
2354
2355 <div class="method">
2356 <code class="details" id="performMaintenance">performMaintenance(project, zone, reservation, body=None, requestId=None, x__xgafv=None)</code>
2357 <pre>Perform maintenance on an extended reservation
2358
2359 Args:
2360 project: string, Project ID for this request. (required)
2361 zone: string, Name of the zone for this request. Zone name should conform to RFC1035. (required)
2362 reservation: string, The name of the reservation.
2363 Name should conform to RFC1035 or be a resource ID. (required)
2364 body: object, The request body.
2365 The object takes the form of:
2366
2367 {
2368 &quot;maintenanceScope&quot;: &quot;A String&quot;, # Specifies if all, running or unused hosts are in scope for this request.
2369 }
2370
2371 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
2372 that if you must retry your request, the server will know to ignore the
2373 request if it has already been completed.
2374
2375 For example, consider a situation where you make an initial request and
2376 the request times out. If you make the request again with the same
2377 request ID, the server can check if original operation with the same
2378 request ID was received, and if so, will ignore the second request. This
2379 prevents clients from accidentally creating duplicate commitments.
2380
2381 The request ID must be
2382 a valid UUID with the exception that zero UUID is not supported
2383 (00000000-0000-0000-0000-000000000000).
2384 x__xgafv: string, V1 error format.
2385 Allowed values
2386 1 - v1 error format
2387 2 - v2 error format
2388
2389 Returns:
2390 An object of the form:
2391
2392 { # Represents an Operation resource.
2393 #
2394 # Google Compute Engine has three Operation resources:
2395 #
2396 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
2397 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
2398 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
2399 #
2400 # You can use an operation resource to manage asynchronous API requests.
2401 # For more information, readHandling
2402 # API responses.
2403 #
2404 # Operations can be global, regional or zonal.
2405 #
2406 # - For global operations, use the `globalOperations`
2407 # resource.
2408 # - For regional operations, use the
2409 # `regionOperations` resource.
2410 # - For zonal operations, use
2411 # the `zoneOperations` resource.
2412 #
2413 #
2414 #
2415 # For more information, read
2416 # Global, Regional, and Zonal Resources.
2417 #
2418 # Note that completed Operation resources have a limited
2419 # retention period.
2420 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
2421 # Not present otherwise.
2422 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
2423 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
2424 # set when the operation is created.
2425 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
2426 # text format.
2427 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
2428 # this field will be populated.
2429 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
2430 # operation.
2431 {
2432 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
2433 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
2434 # details. There is a set of defined message types to use for providing
2435 # details.The syntax depends on the error code. For example,
2436 # QuotaExceededInfo will have details when the error code is
2437 # QUOTA_EXCEEDED.
2438 {
2439 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
2440 #
2441 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
2442 # is not enabled:
2443 #
2444 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
2445 # &quot;domain&quot;: &quot;googleapis.com&quot;
2446 # &quot;metadata&quot;: {
2447 # &quot;resource&quot;: &quot;projects/123&quot;,
2448 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
2449 # }
2450 # }
2451 #
2452 # This response indicates that the pubsub.googleapis.com API is not enabled.
2453 #
2454 # Example of an error that is returned when attempting to create a Spanner
2455 # instance in a region that is out of stock:
2456 #
2457 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
2458 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
2459 # &quot;metadata&quot;: {
2460 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
2461 # }
2462 # }
2463 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
2464 # is typically the registered service name of the tool or product that
2465 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
2466 # generated by some common infrastructure, the error domain must be a
2467 # globally unique value that identifies the infrastructure. For Google API
2468 # infrastructure, the error domain is &quot;googleapis.com&quot;.
2469 &quot;metadatas&quot;: { # Additional structured details about this error.
2470 #
2471 # Keys must match a regular expression of `a-z+` but should
2472 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
2473 # length. When identifying the current value of an exceeded limit, the units
2474 # should be contained in the key, not the value. For example, rather than
2475 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
2476 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
2477 # instances that can be created in a single (batch) request.
2478 &quot;a_key&quot;: &quot;A String&quot;,
2479 },
2480 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
2481 # proximate cause of the error. Error reasons are unique within a particular
2482 # domain of errors. This should be at most 63 characters and match a
2483 # regular expression of `A-Z+[A-Z0-9]`, which represents
2484 # UPPER_SNAKE_CASE.
2485 },
2486 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
2487 #
2488 # For example, if a quota check failed with an error indicating the calling
2489 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
2490 # directly to the right place in the developer console to flip the bit.
2491 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
2492 { # Describes a URL link.
2493 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
2494 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
2495 },
2496 ],
2497 },
2498 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
2499 # which can be attached to an RPC error.
2500 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
2501 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
2502 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
2503 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
2504 },
2505 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
2506 &quot;dimensions&quot;: { # The map holding related quota dimensions.
2507 &quot;a_key&quot;: &quot;A String&quot;,
2508 },
2509 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
2510 # type or metric.
2511 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
2512 # or metric.
2513 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
2514 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
2515 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
2516 },
2517 },
2518 ],
2519 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
2520 # This property is optional.
2521 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
2522 },
2523 ],
2524 },
2525 &quot;getVersionOperationMetadata&quot;: {
2526 &quot;inlineSbomInfo&quot;: {
2527 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
2528 # appropriate identifiers.
2529 &quot;a_key&quot;: &quot;A String&quot;,
2530 },
2531 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
2532 # identifiers.
2533 &quot;a_key&quot;: &quot;A String&quot;,
2534 },
2535 },
2536 },
2537 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
2538 # message that was returned, such as `NOT FOUND`.
2539 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
2540 # status code that was returned. For example, a `404` means the
2541 # resource was not found.
2542 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
2543 # defined by the server.
2544 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
2545 # This value is inRFC3339
2546 # text format.
2547 &quot;instancesBulkInsertOperationMetadata&quot;: {
2548 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
2549 # Example key: zones/us-central1-a
2550 &quot;a_key&quot;: {
2551 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
2552 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
2553 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
2554 # error.
2555 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
2556 # if the flow is rolling forward or rolling back.
2557 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
2558 },
2559 },
2560 },
2561 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
2562 # Operation resources.
2563 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
2564 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
2565 # group of operations results from a `bulkInsert` API request.
2566 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
2567 # `update`, or `delete`, and so on.
2568 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
2569 # There is no requirement that this be linear or support any granularity of
2570 # operations. This should not be used to guess when the operation will be
2571 # complete. This number should monotonically increase as the operation
2572 # progresses.
2573 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
2574 # applicable when performing regional operations.
2575 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
2576 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
2577 # this field will contain information on all underlying zonal actions and
2578 # their state.
2579 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
2580 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
2581 # Example key: zones/us-central1-a
2582 &quot;a_key&quot;: {
2583 &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
2584 # populated.
2585 # different programming environments, including REST APIs and RPC APIs. It is
2586 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
2587 # three pieces of data: error code, error message, and error details.
2588 #
2589 # You can find out more about this error model and how to work with it in the
2590 # [API Design Guide](https://cloud.google.com/apis/design/errors).
2591 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
2592 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
2593 # message types for APIs to use.
2594 {
2595 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
2596 },
2597 ],
2598 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
2599 # user-facing error message should be localized and sent in the
2600 # google.rpc.Status.details field, or localized by the client.
2601 },
2602 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
2603 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
2604 },
2605 },
2606 },
2607 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
2608 # This value is inRFC3339
2609 # text format.
2610 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
2611 # following:
2612 # `PENDING`, `RUNNING`, or `DONE`.
2613 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
2614 # operation.
2615 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
2616 # of the target resource.
2617 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
2618 # operations related to creating a snapshot, this points to the disk
2619 # that the snapshot was created from.
2620 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
2621 # `[email protected]` or
2622 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
2623 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
2624 # operation, this field will be populated.
2625 {
2626 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2627 # Engine returns NO_RESULTS_ON_PAGE if there
2628 # are no results in the response.
2629 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2630 # value format. For example:
2631 #
2632 # &quot;data&quot;: [
2633 # {
2634 # &quot;key&quot;: &quot;scope&quot;,
2635 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2636 # }
2637 {
2638 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2639 # returned. For example, for warnings where there are no results in a list
2640 # request for a particular zone, this key might be scope and
2641 # the key value might be the zone name. Other examples might be a key
2642 # indicating a deprecated resource and a suggested replacement, or a
2643 # warning about invalid network settings (for example, if an instance
2644 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2645 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2646 },
2647 ],
2648 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2649 },
2650 ],
2651 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
2652 # applicable when performing per-zone operations.
2653 }</pre>
2654 </div>
2655
2656 <div class="method">
2657 <code class="details" id="resize">resize(project, zone, reservation, body=None, requestId=None, x__xgafv=None)</code>
2658 <pre>Resizes the reservation (applicable to standalone reservations only). For
2659 more information, readModifying
2660 reservations.
2661
2662 Args:
2663 project: string, Project ID for this request. (required)
2664 zone: string, Name of the zone for this request. (required)
2665 reservation: string, Name of the reservation to update. (required)
2666 body: object, The request body.
2667 The object takes the form of:
2668
2669 {
2670 &quot;specificSkuCount&quot;: &quot;A String&quot;, # Number of allocated resources can be resized with minimum = 1 and
2671 # maximum = 1000.
2672 }
2673
2674 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
2675 that if you must retry your request, the server will know to ignore the
2676 request if it has already been completed.
2677
2678 For example, consider a situation where you make an initial request and
2679 the request times out. If you make the request again with the same
2680 request ID, the server can check if original operation with the same
2681 request ID was received, and if so, will ignore the second request. This
2682 prevents clients from accidentally creating duplicate commitments.
2683
2684 The request ID must be
2685 a valid UUID with the exception that zero UUID is not supported
2686 (00000000-0000-0000-0000-000000000000).
2687 x__xgafv: string, V1 error format.
2688 Allowed values
2689 1 - v1 error format
2690 2 - v2 error format
2691
2692 Returns:
2693 An object of the form:
2694
2695 { # Represents an Operation resource.
2696 #
2697 # Google Compute Engine has three Operation resources:
2698 #
2699 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
2700 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
2701 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
2702 #
2703 # You can use an operation resource to manage asynchronous API requests.
2704 # For more information, readHandling
2705 # API responses.
2706 #
2707 # Operations can be global, regional or zonal.
2708 #
2709 # - For global operations, use the `globalOperations`
2710 # resource.
2711 # - For regional operations, use the
2712 # `regionOperations` resource.
2713 # - For zonal operations, use
2714 # the `zoneOperations` resource.
2715 #
2716 #
2717 #
2718 # For more information, read
2719 # Global, Regional, and Zonal Resources.
2720 #
2721 # Note that completed Operation resources have a limited
2722 # retention period.
2723 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
2724 # Not present otherwise.
2725 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
2726 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
2727 # set when the operation is created.
2728 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
2729 # text format.
2730 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
2731 # this field will be populated.
2732 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
2733 # operation.
2734 {
2735 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
2736 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
2737 # details. There is a set of defined message types to use for providing
2738 # details.The syntax depends on the error code. For example,
2739 # QuotaExceededInfo will have details when the error code is
2740 # QUOTA_EXCEEDED.
2741 {
2742 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
2743 #
2744 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
2745 # is not enabled:
2746 #
2747 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
2748 # &quot;domain&quot;: &quot;googleapis.com&quot;
2749 # &quot;metadata&quot;: {
2750 # &quot;resource&quot;: &quot;projects/123&quot;,
2751 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
2752 # }
2753 # }
2754 #
2755 # This response indicates that the pubsub.googleapis.com API is not enabled.
2756 #
2757 # Example of an error that is returned when attempting to create a Spanner
2758 # instance in a region that is out of stock:
2759 #
2760 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
2761 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
2762 # &quot;metadata&quot;: {
2763 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
2764 # }
2765 # }
2766 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
2767 # is typically the registered service name of the tool or product that
2768 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
2769 # generated by some common infrastructure, the error domain must be a
2770 # globally unique value that identifies the infrastructure. For Google API
2771 # infrastructure, the error domain is &quot;googleapis.com&quot;.
2772 &quot;metadatas&quot;: { # Additional structured details about this error.
2773 #
2774 # Keys must match a regular expression of `a-z+` but should
2775 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
2776 # length. When identifying the current value of an exceeded limit, the units
2777 # should be contained in the key, not the value. For example, rather than
2778 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
2779 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
2780 # instances that can be created in a single (batch) request.
2781 &quot;a_key&quot;: &quot;A String&quot;,
2782 },
2783 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
2784 # proximate cause of the error. Error reasons are unique within a particular
2785 # domain of errors. This should be at most 63 characters and match a
2786 # regular expression of `A-Z+[A-Z0-9]`, which represents
2787 # UPPER_SNAKE_CASE.
2788 },
2789 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
2790 #
2791 # For example, if a quota check failed with an error indicating the calling
2792 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
2793 # directly to the right place in the developer console to flip the bit.
2794 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
2795 { # Describes a URL link.
2796 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
2797 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
2798 },
2799 ],
2800 },
2801 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
2802 # which can be attached to an RPC error.
2803 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
2804 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
2805 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
2806 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
2807 },
2808 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
2809 &quot;dimensions&quot;: { # The map holding related quota dimensions.
2810 &quot;a_key&quot;: &quot;A String&quot;,
2811 },
2812 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
2813 # type or metric.
2814 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
2815 # or metric.
2816 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
2817 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
2818 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
2819 },
2820 },
2821 ],
2822 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
2823 # This property is optional.
2824 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
2825 },
2826 ],
2827 },
2828 &quot;getVersionOperationMetadata&quot;: {
2829 &quot;inlineSbomInfo&quot;: {
2830 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
2831 # appropriate identifiers.
2832 &quot;a_key&quot;: &quot;A String&quot;,
2833 },
2834 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
2835 # identifiers.
2836 &quot;a_key&quot;: &quot;A String&quot;,
2837 },
2838 },
2839 },
2840 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
2841 # message that was returned, such as `NOT FOUND`.
2842 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
2843 # status code that was returned. For example, a `404` means the
2844 # resource was not found.
2845 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
2846 # defined by the server.
2847 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
2848 # This value is inRFC3339
2849 # text format.
2850 &quot;instancesBulkInsertOperationMetadata&quot;: {
2851 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
2852 # Example key: zones/us-central1-a
2853 &quot;a_key&quot;: {
2854 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
2855 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
2856 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
2857 # error.
2858 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
2859 # if the flow is rolling forward or rolling back.
2860 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
2861 },
2862 },
2863 },
2864 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
2865 # Operation resources.
2866 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
2867 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
2868 # group of operations results from a `bulkInsert` API request.
2869 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
2870 # `update`, or `delete`, and so on.
2871 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
2872 # There is no requirement that this be linear or support any granularity of
2873 # operations. This should not be used to guess when the operation will be
2874 # complete. This number should monotonically increase as the operation
2875 # progresses.
2876 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
2877 # applicable when performing regional operations.
2878 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
2879 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
2880 # this field will contain information on all underlying zonal actions and
2881 # their state.
2882 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
2883 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
2884 # Example key: zones/us-central1-a
2885 &quot;a_key&quot;: {
2886 &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
2887 # populated.
2888 # different programming environments, including REST APIs and RPC APIs. It is
2889 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
2890 # three pieces of data: error code, error message, and error details.
2891 #
2892 # You can find out more about this error model and how to work with it in the
2893 # [API Design Guide](https://cloud.google.com/apis/design/errors).
2894 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
2895 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
2896 # message types for APIs to use.
2897 {
2898 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
2899 },
2900 ],
2901 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
2902 # user-facing error message should be localized and sent in the
2903 # google.rpc.Status.details field, or localized by the client.
2904 },
2905 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
2906 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
2907 },
2908 },
2909 },
2910 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
2911 # This value is inRFC3339
2912 # text format.
2913 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
2914 # following:
2915 # `PENDING`, `RUNNING`, or `DONE`.
2916 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
2917 # operation.
2918 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
2919 # of the target resource.
2920 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
2921 # operations related to creating a snapshot, this points to the disk
2922 # that the snapshot was created from.
2923 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
2924 # `[email protected]` or
2925 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
2926 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
2927 # operation, this field will be populated.
2928 {
2929 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2930 # Engine returns NO_RESULTS_ON_PAGE if there
2931 # are no results in the response.
2932 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2933 # value format. For example:
2934 #
2935 # &quot;data&quot;: [
2936 # {
2937 # &quot;key&quot;: &quot;scope&quot;,
2938 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2939 # }
2940 {
2941 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2942 # returned. For example, for warnings where there are no results in a list
2943 # request for a particular zone, this key might be scope and
2944 # the key value might be the zone name. Other examples might be a key
2945 # indicating a deprecated resource and a suggested replacement, or a
2946 # warning about invalid network settings (for example, if an instance
2947 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2948 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2949 },
2950 ],
2951 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2952 },
2953 ],
2954 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
2955 # applicable when performing per-zone operations.
2956 }</pre>
2957 </div>
2958
2959 <div class="method">
2960 <code class="details" id="setIamPolicy">setIamPolicy(project, zone, resource, body=None, x__xgafv=None)</code>
2961 <pre>Sets the access control policy on the specified resource.
2962 Replaces any existing policy.
2963
2964 Args:
2965 project: string, Project ID for this request. (required)
2966 zone: string, The name of the zone for this request. (required)
2967 resource: string, Name or id of the resource for this request. (required)
2968 body: object, The request body.
2969 The object takes the form of:
2970
2971 {
2972 &quot;bindings&quot;: [ # Flatten Policy to create a backwacd compatible wire-format.
2973 # Deprecated. Use &#x27;policy&#x27; to specify bindings.
2974 { # Associates `members`, or principals, with a `role`.
2975 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
2976 #
2977 # If the condition evaluates to `true`, then this binding applies to the
2978 # current request.
2979 #
2980 # If the condition evaluates to `false`, then this binding does not apply to
2981 # the current request. However, a different role binding might grant the same
2982 # role to one or more of the principals in this binding.
2983 #
2984 # To learn which resources support conditions in their IAM policies, see the
2985 # [IAM
2986 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
2987 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
2988 # are documented at https://github.com/google/cel-spec.
2989 #
2990 # Example (Comparison):
2991 #
2992 # title: &quot;Summary size limit&quot;
2993 # description: &quot;Determines if a summary is less than 100 chars&quot;
2994 # expression: &quot;document.summary.size() &lt; 100&quot;
2995 #
2996 # Example (Equality):
2997 #
2998 # title: &quot;Requestor is owner&quot;
2999 # description: &quot;Determines if requestor is the document owner&quot;
3000 # expression: &quot;document.owner == request.auth.claims.email&quot;
3001 #
3002 # Example (Logic):
3003 #
3004 # title: &quot;Public documents&quot;
3005 # description: &quot;Determine whether the document should be publicly visible&quot;
3006 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
3007 #
3008 # Example (Data Manipulation):
3009 #
3010 # title: &quot;Notification string&quot;
3011 # description: &quot;Create a notification string with a timestamp.&quot;
3012 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
3013 #
3014 # The exact variables and functions that may be referenced within an expression
3015 # are determined by the service that evaluates it. See the service
3016 # documentation for additional information.
3017 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
3018 # describes the expression, e.g. when hovered over it in a UI.
3019 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
3020 # syntax.
3021 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
3022 # reporting, e.g. a file name and a position in the file.
3023 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
3024 # its purpose. This can be used e.g. in UIs which allow to enter the
3025 # expression.
3026 },
3027 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
3028 # `members` can have the following values:
3029 #
3030 # * `allUsers`: A special identifier that represents anyone who is
3031 # on the internet; with or without a Google account.
3032 #
3033 # * `allAuthenticatedUsers`: A special identifier that represents anyone
3034 # who is authenticated with a Google account or a service account.
3035 # Does not include identities that come from external identity providers
3036 # (IdPs) through identity federation.
3037 #
3038 # * `user:{emailid}`: An email address that represents a specific Google
3039 # account. For example, `[email protected]` .
3040 #
3041 #
3042 # * `serviceAccount:{emailid}`: An email address that represents a Google
3043 # service account. For example,
3044 # `[email protected]`.
3045 #
3046 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
3047 # identifier for a
3048 # [Kubernetes service
3049 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
3050 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
3051 #
3052 # * `group:{emailid}`: An email address that represents a Google group.
3053 # For example, `[email protected]`.
3054 #
3055 #
3056 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
3057 # users of that domain. For example, `google.com` or `example.com`.
3058 #
3059 #
3060 #
3061 #
3062 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
3063 # A single identity in a workforce identity pool.
3064 #
3065 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
3066 # All workforce identities in a group.
3067 #
3068 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
3069 # All workforce identities with a specific attribute value.
3070 #
3071 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
3072 # All identities in a workforce identity pool.
3073 #
3074 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
3075 # A single identity in a workload identity pool.
3076 #
3077 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
3078 # A workload identity pool group.
3079 #
3080 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
3081 # All identities in a workload identity pool with a certain attribute.
3082 #
3083 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
3084 # All identities in a workload identity pool.
3085 #
3086 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
3087 # identifier) representing a user that has been recently deleted. For
3088 # example, `[email protected]?uid=123456789012345678901`. If the user is
3089 # recovered, this value reverts to `user:{emailid}` and the recovered user
3090 # retains the role in the binding.
3091 #
3092 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
3093 # unique identifier) representing a service account that has been recently
3094 # deleted. For example,
3095 # `[email protected]?uid=123456789012345678901`.
3096 # If the service account is undeleted, this value reverts to
3097 # `serviceAccount:{emailid}` and the undeleted service account retains the
3098 # role in the binding.
3099 #
3100 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
3101 # identifier) representing a Google group that has been recently
3102 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
3103 # the group is recovered, this value reverts to `group:{emailid}` and the
3104 # recovered group retains the role in the binding.
3105 #
3106 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
3107 # Deleted single identity in a workforce identity pool. For example,
3108 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
3109 &quot;A String&quot;,
3110 ],
3111 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
3112 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
3113 #
3114 # For an overview of the IAM roles and permissions, see the
3115 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
3116 # a list of the available pre-defined roles, see
3117 # [here](https://cloud.google.com/iam/docs/understanding-roles).
3118 },
3119 ],
3120 &quot;etag&quot;: &quot;A String&quot;, # Flatten Policy to create a backward compatible wire-format.
3121 # Deprecated. Use &#x27;policy&#x27; to specify the etag.
3122 &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
3123 # the policy is limited to a few 10s of KB. An empty policy is in general a
3124 # valid policy but certain services (like Projects) might reject them.
3125 # controls for Google Cloud resources.
3126 #
3127 #
3128 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
3129 # `members`, or principals, to a single `role`. Principals can be user
3130 # accounts, service accounts, Google groups, and domains (such as G Suite). A
3131 # `role` is a named list of permissions; each `role` can be an IAM predefined
3132 # role or a user-created custom role.
3133 #
3134 # For some types of Google Cloud resources, a `binding` can also specify a
3135 # `condition`, which is a logical expression that allows access to a resource
3136 # only if the expression evaluates to `true`. A condition can add constraints
3137 # based on attributes of the request, the resource, or both. To learn which
3138 # resources support conditions in their IAM policies, see the
3139 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
3140 #
3141 # **JSON example:**
3142 #
3143 # ```
3144 # {
3145 # &quot;bindings&quot;: [
3146 # {
3147 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
3148 # &quot;members&quot;: [
3149 # &quot;user:[email protected]&quot;,
3150 # &quot;group:[email protected]&quot;,
3151 # &quot;domain:google.com&quot;,
3152 # &quot;serviceAccount:[email protected]&quot;
3153 # ]
3154 # },
3155 # {
3156 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
3157 # &quot;members&quot;: [
3158 # &quot;user:[email protected]&quot;
3159 # ],
3160 # &quot;condition&quot;: {
3161 # &quot;title&quot;: &quot;expirable access&quot;,
3162 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
3163 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
3164 # }
3165 # }
3166 # ],
3167 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
3168 # &quot;version&quot;: 3
3169 # }
3170 # ```
3171 #
3172 # **YAML example:**
3173 #
3174 # ```
3175 # bindings:
3176 # - members:
3177 # - user:[email protected]
3178 # - group:[email protected]
3179 # - domain:google.com
3180 # - serviceAccount:[email protected]
3181 # role: roles/resourcemanager.organizationAdmin
3182 # - members:
3183 # - user:[email protected]
3184 # role: roles/resourcemanager.organizationViewer
3185 # condition:
3186 # title: expirable access
3187 # description: Does not grant access after Sep 2020
3188 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
3189 # etag: BwWWja0YfJA=
3190 # version: 3
3191 # ```
3192 #
3193 # For a description of IAM and its features, see the
3194 # [IAM documentation](https://cloud.google.com/iam/docs/).
3195 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
3196 { # Specifies the audit configuration for a service.
3197 # The configuration determines which permission types are logged, and what
3198 # identities, if any, are exempted from logging.
3199 # An AuditConfig must have one or more AuditLogConfigs.
3200 #
3201 # If there are AuditConfigs for both `allServices` and a specific service,
3202 # the union of the two AuditConfigs is used for that service: the log_types
3203 # specified in each AuditConfig are enabled, and the exempted_members in each
3204 # AuditLogConfig are exempted.
3205 #
3206 # Example Policy with multiple AuditConfigs:
3207 #
3208 # {
3209 # &quot;audit_configs&quot;: [
3210 # {
3211 # &quot;service&quot;: &quot;allServices&quot;,
3212 # &quot;audit_log_configs&quot;: [
3213 # {
3214 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
3215 # &quot;exempted_members&quot;: [
3216 # &quot;user:[email protected]&quot;
3217 # ]
3218 # },
3219 # {
3220 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
3221 # },
3222 # {
3223 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
3224 # }
3225 # ]
3226 # },
3227 # {
3228 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
3229 # &quot;audit_log_configs&quot;: [
3230 # {
3231 # &quot;log_type&quot;: &quot;DATA_READ&quot;
3232 # },
3233 # {
3234 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
3235 # &quot;exempted_members&quot;: [
3236 # &quot;user:[email protected]&quot;
3237 # ]
3238 # }
3239 # ]
3240 # }
3241 # ]
3242 # }
3243 #
3244 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
3245 # logging. It also exempts `[email protected]` from DATA_READ logging, and
3246 # `[email protected]` from DATA_WRITE logging.
3247 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
3248 { # Provides the configuration for logging a type of permissions.
3249 # Example:
3250 #
3251 # {
3252 # &quot;audit_log_configs&quot;: [
3253 # {
3254 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
3255 # &quot;exempted_members&quot;: [
3256 # &quot;user:[email protected]&quot;
3257 # ]
3258 # },
3259 # {
3260 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
3261 # }
3262 # ]
3263 # }
3264 #
3265 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
3266 # [email protected] from DATA_READ logging.
3267 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
3268 # permission.
3269 # Follows the same format of Binding.members.
3270 &quot;A String&quot;,
3271 ],
3272 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
3273 },
3274 ],
3275 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
3276 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
3277 # `allServices` is a special value that covers all services.
3278 },
3279 ],
3280 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
3281 # may specify a `condition` that determines how and when the `bindings` are
3282 # applied. Each of the `bindings` must contain at least one principal.
3283 #
3284 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
3285 # of these principals can be Google groups. Each occurrence of a principal
3286 # counts towards these limits. For example, if the `bindings` grant 50
3287 # different roles to `user:[email protected]`, and not to any other
3288 # principal, then you can add another 1,450 principals to the `bindings` in
3289 # the `Policy`.
3290 { # Associates `members`, or principals, with a `role`.
3291 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
3292 #
3293 # If the condition evaluates to `true`, then this binding applies to the
3294 # current request.
3295 #
3296 # If the condition evaluates to `false`, then this binding does not apply to
3297 # the current request. However, a different role binding might grant the same
3298 # role to one or more of the principals in this binding.
3299 #
3300 # To learn which resources support conditions in their IAM policies, see the
3301 # [IAM
3302 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
3303 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
3304 # are documented at https://github.com/google/cel-spec.
3305 #
3306 # Example (Comparison):
3307 #
3308 # title: &quot;Summary size limit&quot;
3309 # description: &quot;Determines if a summary is less than 100 chars&quot;
3310 # expression: &quot;document.summary.size() &lt; 100&quot;
3311 #
3312 # Example (Equality):
3313 #
3314 # title: &quot;Requestor is owner&quot;
3315 # description: &quot;Determines if requestor is the document owner&quot;
3316 # expression: &quot;document.owner == request.auth.claims.email&quot;
3317 #
3318 # Example (Logic):
3319 #
3320 # title: &quot;Public documents&quot;
3321 # description: &quot;Determine whether the document should be publicly visible&quot;
3322 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
3323 #
3324 # Example (Data Manipulation):
3325 #
3326 # title: &quot;Notification string&quot;
3327 # description: &quot;Create a notification string with a timestamp.&quot;
3328 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
3329 #
3330 # The exact variables and functions that may be referenced within an expression
3331 # are determined by the service that evaluates it. See the service
3332 # documentation for additional information.
3333 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
3334 # describes the expression, e.g. when hovered over it in a UI.
3335 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
3336 # syntax.
3337 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
3338 # reporting, e.g. a file name and a position in the file.
3339 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
3340 # its purpose. This can be used e.g. in UIs which allow to enter the
3341 # expression.
3342 },
3343 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
3344 # `members` can have the following values:
3345 #
3346 # * `allUsers`: A special identifier that represents anyone who is
3347 # on the internet; with or without a Google account.
3348 #
3349 # * `allAuthenticatedUsers`: A special identifier that represents anyone
3350 # who is authenticated with a Google account or a service account.
3351 # Does not include identities that come from external identity providers
3352 # (IdPs) through identity federation.
3353 #
3354 # * `user:{emailid}`: An email address that represents a specific Google
3355 # account. For example, `[email protected]` .
3356 #
3357 #
3358 # * `serviceAccount:{emailid}`: An email address that represents a Google
3359 # service account. For example,
3360 # `[email protected]`.
3361 #
3362 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
3363 # identifier for a
3364 # [Kubernetes service
3365 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
3366 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
3367 #
3368 # * `group:{emailid}`: An email address that represents a Google group.
3369 # For example, `[email protected]`.
3370 #
3371 #
3372 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
3373 # users of that domain. For example, `google.com` or `example.com`.
3374 #
3375 #
3376 #
3377 #
3378 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
3379 # A single identity in a workforce identity pool.
3380 #
3381 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
3382 # All workforce identities in a group.
3383 #
3384 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
3385 # All workforce identities with a specific attribute value.
3386 #
3387 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
3388 # All identities in a workforce identity pool.
3389 #
3390 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
3391 # A single identity in a workload identity pool.
3392 #
3393 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
3394 # A workload identity pool group.
3395 #
3396 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
3397 # All identities in a workload identity pool with a certain attribute.
3398 #
3399 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
3400 # All identities in a workload identity pool.
3401 #
3402 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
3403 # identifier) representing a user that has been recently deleted. For
3404 # example, `[email protected]?uid=123456789012345678901`. If the user is
3405 # recovered, this value reverts to `user:{emailid}` and the recovered user
3406 # retains the role in the binding.
3407 #
3408 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
3409 # unique identifier) representing a service account that has been recently
3410 # deleted. For example,
3411 # `[email protected]?uid=123456789012345678901`.
3412 # If the service account is undeleted, this value reverts to
3413 # `serviceAccount:{emailid}` and the undeleted service account retains the
3414 # role in the binding.
3415 #
3416 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
3417 # identifier) representing a Google group that has been recently
3418 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
3419 # the group is recovered, this value reverts to `group:{emailid}` and the
3420 # recovered group retains the role in the binding.
3421 #
3422 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
3423 # Deleted single identity in a workforce identity pool. For example,
3424 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
3425 &quot;A String&quot;,
3426 ],
3427 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
3428 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
3429 #
3430 # For an overview of the IAM roles and permissions, see the
3431 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
3432 # a list of the available pre-defined roles, see
3433 # [here](https://cloud.google.com/iam/docs/understanding-roles).
3434 },
3435 ],
3436 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
3437 # prevent simultaneous updates of a policy from overwriting each other.
3438 # It is strongly suggested that systems make use of the `etag` in the
3439 # read-modify-write cycle to perform policy updates in order to avoid race
3440 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
3441 # systems are expected to put that etag in the request to `setIamPolicy` to
3442 # ensure that their change will be applied to the same version of the policy.
3443 #
3444 # **Important:** If you use IAM Conditions, you must include the `etag` field
3445 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
3446 # you to overwrite a version `3` policy with a version `1` policy, and all of
3447 # the conditions in the version `3` policy are lost.
3448 &quot;version&quot;: 42, # Specifies the format of the policy.
3449 #
3450 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
3451 # are rejected.
3452 #
3453 # Any operation that affects conditional role bindings must specify version
3454 # `3`. This requirement applies to the following operations:
3455 #
3456 # * Getting a policy that includes a conditional role binding
3457 # * Adding a conditional role binding to a policy
3458 # * Changing a conditional role binding in a policy
3459 # * Removing any role binding, with or without a condition, from a policy
3460 # that includes conditions
3461 #
3462 # **Important:** If you use IAM Conditions, you must include the `etag` field
3463 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
3464 # you to overwrite a version `3` policy with a version `1` policy, and all of
3465 # the conditions in the version `3` policy are lost.
3466 #
3467 # If a policy does not include any conditions, operations on that policy may
3468 # specify any valid version or leave the field unset.
3469 #
3470 # To learn which resources support conditions in their IAM policies, see the
3471 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
3472 },
3473 }
3474
3475 x__xgafv: string, V1 error format.
3476 Allowed values
3477 1 - v1 error format
3478 2 - v2 error format
3479
3480 Returns:
3481 An object of the form:
3482
3483 { # An Identity and Access Management (IAM) policy, which specifies access
3484 # controls for Google Cloud resources.
3485 #
3486 #
3487 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
3488 # `members`, or principals, to a single `role`. Principals can be user
3489 # accounts, service accounts, Google groups, and domains (such as G Suite). A
3490 # `role` is a named list of permissions; each `role` can be an IAM predefined
3491 # role or a user-created custom role.
3492 #
3493 # For some types of Google Cloud resources, a `binding` can also specify a
3494 # `condition`, which is a logical expression that allows access to a resource
3495 # only if the expression evaluates to `true`. A condition can add constraints
3496 # based on attributes of the request, the resource, or both. To learn which
3497 # resources support conditions in their IAM policies, see the
3498 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
3499 #
3500 # **JSON example:**
3501 #
3502 # ```
3503 # {
3504 # &quot;bindings&quot;: [
3505 # {
3506 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
3507 # &quot;members&quot;: [
3508 # &quot;user:[email protected]&quot;,
3509 # &quot;group:[email protected]&quot;,
3510 # &quot;domain:google.com&quot;,
3511 # &quot;serviceAccount:[email protected]&quot;
3512 # ]
3513 # },
3514 # {
3515 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
3516 # &quot;members&quot;: [
3517 # &quot;user:[email protected]&quot;
3518 # ],
3519 # &quot;condition&quot;: {
3520 # &quot;title&quot;: &quot;expirable access&quot;,
3521 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
3522 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
3523 # }
3524 # }
3525 # ],
3526 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
3527 # &quot;version&quot;: 3
3528 # }
3529 # ```
3530 #
3531 # **YAML example:**
3532 #
3533 # ```
3534 # bindings:
3535 # - members:
3536 # - user:[email protected]
3537 # - group:[email protected]
3538 # - domain:google.com
3539 # - serviceAccount:[email protected]
3540 # role: roles/resourcemanager.organizationAdmin
3541 # - members:
3542 # - user:[email protected]
3543 # role: roles/resourcemanager.organizationViewer
3544 # condition:
3545 # title: expirable access
3546 # description: Does not grant access after Sep 2020
3547 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
3548 # etag: BwWWja0YfJA=
3549 # version: 3
3550 # ```
3551 #
3552 # For a description of IAM and its features, see the
3553 # [IAM documentation](https://cloud.google.com/iam/docs/).
3554 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
3555 { # Specifies the audit configuration for a service.
3556 # The configuration determines which permission types are logged, and what
3557 # identities, if any, are exempted from logging.
3558 # An AuditConfig must have one or more AuditLogConfigs.
3559 #
3560 # If there are AuditConfigs for both `allServices` and a specific service,
3561 # the union of the two AuditConfigs is used for that service: the log_types
3562 # specified in each AuditConfig are enabled, and the exempted_members in each
3563 # AuditLogConfig are exempted.
3564 #
3565 # Example Policy with multiple AuditConfigs:
3566 #
3567 # {
3568 # &quot;audit_configs&quot;: [
3569 # {
3570 # &quot;service&quot;: &quot;allServices&quot;,
3571 # &quot;audit_log_configs&quot;: [
3572 # {
3573 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
3574 # &quot;exempted_members&quot;: [
3575 # &quot;user:[email protected]&quot;
3576 # ]
3577 # },
3578 # {
3579 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
3580 # },
3581 # {
3582 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
3583 # }
3584 # ]
3585 # },
3586 # {
3587 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
3588 # &quot;audit_log_configs&quot;: [
3589 # {
3590 # &quot;log_type&quot;: &quot;DATA_READ&quot;
3591 # },
3592 # {
3593 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
3594 # &quot;exempted_members&quot;: [
3595 # &quot;user:[email protected]&quot;
3596 # ]
3597 # }
3598 # ]
3599 # }
3600 # ]
3601 # }
3602 #
3603 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
3604 # logging. It also exempts `[email protected]` from DATA_READ logging, and
3605 # `[email protected]` from DATA_WRITE logging.
3606 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
3607 { # Provides the configuration for logging a type of permissions.
3608 # Example:
3609 #
3610 # {
3611 # &quot;audit_log_configs&quot;: [
3612 # {
3613 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
3614 # &quot;exempted_members&quot;: [
3615 # &quot;user:[email protected]&quot;
3616 # ]
3617 # },
3618 # {
3619 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
3620 # }
3621 # ]
3622 # }
3623 #
3624 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
3625 # [email protected] from DATA_READ logging.
3626 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
3627 # permission.
3628 # Follows the same format of Binding.members.
3629 &quot;A String&quot;,
3630 ],
3631 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
3632 },
3633 ],
3634 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
3635 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
3636 # `allServices` is a special value that covers all services.
3637 },
3638 ],
3639 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
3640 # may specify a `condition` that determines how and when the `bindings` are
3641 # applied. Each of the `bindings` must contain at least one principal.
3642 #
3643 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
3644 # of these principals can be Google groups. Each occurrence of a principal
3645 # counts towards these limits. For example, if the `bindings` grant 50
3646 # different roles to `user:[email protected]`, and not to any other
3647 # principal, then you can add another 1,450 principals to the `bindings` in
3648 # the `Policy`.
3649 { # Associates `members`, or principals, with a `role`.
3650 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
3651 #
3652 # If the condition evaluates to `true`, then this binding applies to the
3653 # current request.
3654 #
3655 # If the condition evaluates to `false`, then this binding does not apply to
3656 # the current request. However, a different role binding might grant the same
3657 # role to one or more of the principals in this binding.
3658 #
3659 # To learn which resources support conditions in their IAM policies, see the
3660 # [IAM
3661 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
3662 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
3663 # are documented at https://github.com/google/cel-spec.
3664 #
3665 # Example (Comparison):
3666 #
3667 # title: &quot;Summary size limit&quot;
3668 # description: &quot;Determines if a summary is less than 100 chars&quot;
3669 # expression: &quot;document.summary.size() &lt; 100&quot;
3670 #
3671 # Example (Equality):
3672 #
3673 # title: &quot;Requestor is owner&quot;
3674 # description: &quot;Determines if requestor is the document owner&quot;
3675 # expression: &quot;document.owner == request.auth.claims.email&quot;
3676 #
3677 # Example (Logic):
3678 #
3679 # title: &quot;Public documents&quot;
3680 # description: &quot;Determine whether the document should be publicly visible&quot;
3681 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
3682 #
3683 # Example (Data Manipulation):
3684 #
3685 # title: &quot;Notification string&quot;
3686 # description: &quot;Create a notification string with a timestamp.&quot;
3687 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
3688 #
3689 # The exact variables and functions that may be referenced within an expression
3690 # are determined by the service that evaluates it. See the service
3691 # documentation for additional information.
3692 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
3693 # describes the expression, e.g. when hovered over it in a UI.
3694 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
3695 # syntax.
3696 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
3697 # reporting, e.g. a file name and a position in the file.
3698 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
3699 # its purpose. This can be used e.g. in UIs which allow to enter the
3700 # expression.
3701 },
3702 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
3703 # `members` can have the following values:
3704 #
3705 # * `allUsers`: A special identifier that represents anyone who is
3706 # on the internet; with or without a Google account.
3707 #
3708 # * `allAuthenticatedUsers`: A special identifier that represents anyone
3709 # who is authenticated with a Google account or a service account.
3710 # Does not include identities that come from external identity providers
3711 # (IdPs) through identity federation.
3712 #
3713 # * `user:{emailid}`: An email address that represents a specific Google
3714 # account. For example, `[email protected]` .
3715 #
3716 #
3717 # * `serviceAccount:{emailid}`: An email address that represents a Google
3718 # service account. For example,
3719 # `[email protected]`.
3720 #
3721 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
3722 # identifier for a
3723 # [Kubernetes service
3724 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
3725 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
3726 #
3727 # * `group:{emailid}`: An email address that represents a Google group.
3728 # For example, `[email protected]`.
3729 #
3730 #
3731 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
3732 # users of that domain. For example, `google.com` or `example.com`.
3733 #
3734 #
3735 #
3736 #
3737 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
3738 # A single identity in a workforce identity pool.
3739 #
3740 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
3741 # All workforce identities in a group.
3742 #
3743 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
3744 # All workforce identities with a specific attribute value.
3745 #
3746 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
3747 # All identities in a workforce identity pool.
3748 #
3749 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
3750 # A single identity in a workload identity pool.
3751 #
3752 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
3753 # A workload identity pool group.
3754 #
3755 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
3756 # All identities in a workload identity pool with a certain attribute.
3757 #
3758 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
3759 # All identities in a workload identity pool.
3760 #
3761 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
3762 # identifier) representing a user that has been recently deleted. For
3763 # example, `[email protected]?uid=123456789012345678901`. If the user is
3764 # recovered, this value reverts to `user:{emailid}` and the recovered user
3765 # retains the role in the binding.
3766 #
3767 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
3768 # unique identifier) representing a service account that has been recently
3769 # deleted. For example,
3770 # `[email protected]?uid=123456789012345678901`.
3771 # If the service account is undeleted, this value reverts to
3772 # `serviceAccount:{emailid}` and the undeleted service account retains the
3773 # role in the binding.
3774 #
3775 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
3776 # identifier) representing a Google group that has been recently
3777 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
3778 # the group is recovered, this value reverts to `group:{emailid}` and the
3779 # recovered group retains the role in the binding.
3780 #
3781 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
3782 # Deleted single identity in a workforce identity pool. For example,
3783 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
3784 &quot;A String&quot;,
3785 ],
3786 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
3787 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
3788 #
3789 # For an overview of the IAM roles and permissions, see the
3790 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
3791 # a list of the available pre-defined roles, see
3792 # [here](https://cloud.google.com/iam/docs/understanding-roles).
3793 },
3794 ],
3795 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
3796 # prevent simultaneous updates of a policy from overwriting each other.
3797 # It is strongly suggested that systems make use of the `etag` in the
3798 # read-modify-write cycle to perform policy updates in order to avoid race
3799 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
3800 # systems are expected to put that etag in the request to `setIamPolicy` to
3801 # ensure that their change will be applied to the same version of the policy.
3802 #
3803 # **Important:** If you use IAM Conditions, you must include the `etag` field
3804 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
3805 # you to overwrite a version `3` policy with a version `1` policy, and all of
3806 # the conditions in the version `3` policy are lost.
3807 &quot;version&quot;: 42, # Specifies the format of the policy.
3808 #
3809 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
3810 # are rejected.
3811 #
3812 # Any operation that affects conditional role bindings must specify version
3813 # `3`. This requirement applies to the following operations:
3814 #
3815 # * Getting a policy that includes a conditional role binding
3816 # * Adding a conditional role binding to a policy
3817 # * Changing a conditional role binding in a policy
3818 # * Removing any role binding, with or without a condition, from a policy
3819 # that includes conditions
3820 #
3821 # **Important:** If you use IAM Conditions, you must include the `etag` field
3822 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
3823 # you to overwrite a version `3` policy with a version `1` policy, and all of
3824 # the conditions in the version `3` policy are lost.
3825 #
3826 # If a policy does not include any conditions, operations on that policy may
3827 # specify any valid version or leave the field unset.
3828 #
3829 # To learn which resources support conditions in their IAM policies, see the
3830 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
3831 }</pre>
3832 </div>
3833
3834 <div class="method">
3835 <code class="details" id="testIamPermissions">testIamPermissions(project, zone, resource, body=None, x__xgafv=None)</code>
3836 <pre>Returns permissions that a caller has on the specified resource.
3837
3838 Args:
3839 project: string, Project ID for this request. (required)
3840 zone: string, The name of the zone for this request. (required)
3841 resource: string, Name or id of the resource for this request. (required)
3842 body: object, The request body.
3843 The object takes the form of:
3844
3845 {
3846 &quot;permissions&quot;: [ # The set of permissions to check for the &#x27;resource&#x27;. Permissions with
3847 # wildcards (such as &#x27;*&#x27; or &#x27;storage.*&#x27;) are not allowed.
3848 &quot;A String&quot;,
3849 ],
3850 }
3851
3852 x__xgafv: string, V1 error format.
3853 Allowed values
3854 1 - v1 error format
3855 2 - v2 error format
3856
3857 Returns:
3858 An object of the form:
3859
3860 {
3861 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is
3862 # allowed.
3863 &quot;A String&quot;,
3864 ],
3865 }</pre>
3866 </div>
3867
3868 <div class="method">
3869 <code class="details" id="update">update(project, zone, reservation, body=None, paths=None, requestId=None, updateMask=None, x__xgafv=None)</code>
3870 <pre>Update share settings of the reservation.
3871
3872 Args:
3873 project: string, Project ID for this request. (required)
3874 zone: string, Name of the zone for this request. (required)
3875 reservation: string, Name of the reservation to update. (required)
3876 body: object, The request body.
3877 The object takes the form of:
3878
3879 { # Represents a reservation resource. A reservation ensures that capacity is
3880 # held in a specific zone even if the reserved VMs are not running. For more
3881 # information, read Reserving zonal
3882 # resources.
3883 &quot;advancedDeploymentControl&quot;: { # Advance control for cluster management, applicable only to DENSE deployment # Advanced control for cluster management, applicable only to DENSE
3884 # deployment type reservations.
3885 # type reservations.
3886 &quot;reservationOperationalMode&quot;: &quot;A String&quot;, # Indicates chosen reservation operational mode for the reservation.
3887 },
3888 &quot;aggregateReservation&quot;: { # This reservation type is specified by total resource amounts (e.g. total # Reservation for aggregated resources, providing shape flexibility.
3889 # count of CPUs) and can account for multiple instance SKUs. In other words,
3890 # one can create instances of varying shapes against this reservation.
3891 &quot;inUseResources&quot;: [ # Output only. [Output only] List of resources currently in use.
3892 {
3893 &quot;accelerator&quot;: { # Properties of accelerator resources in this reservation.
3894 &quot;acceleratorCount&quot;: 42, # Number of accelerators of specified type.
3895 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL to accelerator type. e.g.
3896 # &quot;projects/{PROJECT}/zones/{ZONE}/acceleratorTypes/ct4l&quot;
3897 },
3898 },
3899 ],
3900 &quot;reservedResources&quot;: [ # List of reserved resources (CPUs, memory, accelerators).
3901 {
3902 &quot;accelerator&quot;: { # Properties of accelerator resources in this reservation.
3903 &quot;acceleratorCount&quot;: 42, # Number of accelerators of specified type.
3904 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL to accelerator type. e.g.
3905 # &quot;projects/{PROJECT}/zones/{ZONE}/acceleratorTypes/ct4l&quot;
3906 },
3907 },
3908 ],
3909 &quot;vmFamily&quot;: &quot;A String&quot;, # The VM family that all instances scheduled against this reservation must
3910 # belong to.
3911 &quot;workloadType&quot;: &quot;A String&quot;, # The workload type of the instances that will target this reservation.
3912 },
3913 &quot;commitment&quot;: &quot;A String&quot;, # Output only. [Output Only] Full or partial URL to a parent commitment. This field
3914 # displays for reservations that are tied to a commitment.
3915 &quot;confidentialComputeType&quot;: &quot;A String&quot;,
3916 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
3917 # text format.
3918 &quot;deleteAfterDuration&quot;: { # A Duration represents a fixed-length span of time represented # Duration time relative to reservation creation when Compute Engine will
3919 # automatically delete this resource.
3920 # as a count of seconds and fractions of seconds at nanosecond
3921 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
3922 # or &quot;month&quot;. Range is approximately 10,000 years.
3923 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
3924 # Durations less than one second are represented with a 0
3925 # `seconds` field and a positive `nanos` field. Must be from 0
3926 # to 999,999,999 inclusive.
3927 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
3928 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
3929 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
3930 },
3931 &quot;deleteAtTime&quot;: &quot;A String&quot;, # Absolute time in future when the reservation will be
3932 # auto-deleted by Compute Engine. Timestamp is represented inRFC3339 text format.
3933 &quot;deploymentType&quot;: &quot;A String&quot;, # Specifies the deployment strategy for this reservation.
3934 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
3935 # create the resource.
3936 &quot;earlyAccessMaintenance&quot;: &quot;A String&quot;, # Indicates the early access maintenance for the reservation.
3937 # If this field is absent or set to NO_EARLY_ACCESS, the reservation is not
3938 # enrolled in early access maintenance and the standard notice applies.
3939 &quot;enableEmergentMaintenance&quot;: True or False, # Indicates whether Compute Engine allows unplanned maintenance for your VMs;
3940 # for example, to fix hardware errors.
3941 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
3942 # defined by the server.
3943 &quot;kind&quot;: &quot;compute#reservation&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#reservations for reservations.
3944 &quot;linkedCommitments&quot;: [ # Output only. [Output Only] Full or partial URL to parent commitments. This field
3945 # displays for reservations that are tied to multiple commitments.
3946 &quot;A String&quot;,
3947 ],
3948 &quot;name&quot;: &quot;A String&quot;, # The name of the resource, provided by the client when initially creating
3949 # the resource. The resource name must be 1-63 characters long, and comply
3950 # withRFC1035.
3951 # Specifically, the name must be 1-63 characters long and match the regular
3952 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
3953 # character must be a lowercase letter, and all following characters must be
3954 # a dash, lowercase letter, or digit, except the last character, which cannot
3955 # be a dash.
3956 &quot;params&quot;: { # Additional reservation params. # Input only. Additional params passed with the request, but not persisted
3957 # as part of resource payload.
3958 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the reservation. Tag keys and
3959 # values have the same definition as resource
3960 # manager tags. Keys and values can be either in numeric format,
3961 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
3962 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
3963 # `{tag_value_short_name}`. The field is ignored (both PUT &amp;
3964 # PATCH) when empty.
3965 &quot;a_key&quot;: &quot;A String&quot;,
3966 },
3967 },
3968 &quot;protectionTier&quot;: &quot;A String&quot;, # Protection tier for the workload which specifies the workload expectations
3969 # in the event of infrastructure failures at data center (e.g. power
3970 # and/or cooling failures).
3971 &quot;reservationSharingPolicy&quot;: { # Specify the reservation sharing policy. If unspecified, the reservation
3972 # will not be shared with Google Cloud managed services.
3973 &quot;serviceShareType&quot;: &quot;A String&quot;, # Sharing config for all Google Cloud services.
3974 },
3975 &quot;resourcePolicies&quot;: { # Resource policies to be added to this reservation. The key is defined by
3976 # user, and the value is resource policy url. This is to define placement
3977 # policy with reservation.
3978 &quot;a_key&quot;: &quot;A String&quot;,
3979 },
3980 &quot;resourceStatus&quot;: { # [Output Only] Contains output only fields. # Output only. [Output Only] Status information for Reservation resource.
3981 &quot;healthInfo&quot;: { # Health information for the reservation. # [Output only] Health information for the reservation.
3982 &quot;degradedBlockCount&quot;: 42, # The number of reservation blocks that are degraded.
3983 &quot;healthStatus&quot;: &quot;A String&quot;, # The health status of the reservation.
3984 &quot;healthyBlockCount&quot;: 42, # The number of reservation blocks that are healthy.
3985 },
3986 &quot;reservationBlockCount&quot;: 42, # The number of reservation blocks associated with this reservation.
3987 &quot;reservationMaintenance&quot;: { # Maintenance Info for ReservationBlocks. # Maintenance information for this reservation
3988 &quot;instanceMaintenanceOngoingCount&quot;: 42, # Describes number of instances that have ongoing maintenance.
3989 &quot;instanceMaintenancePendingCount&quot;: 42, # Describes number of instances that have pending maintenance.
3990 &quot;maintenanceOngoingCount&quot;: 42, # Progress for ongoing maintenance for this group of VMs/hosts.
3991 # Describes number of hosts in the block that have ongoing maintenance.
3992 &quot;maintenancePendingCount&quot;: 42, # Progress for ongoing maintenance for this group of VMs/hosts.
3993 # Describes number of hosts in the block that have pending maintenance.
3994 &quot;schedulingType&quot;: &quot;A String&quot;, # The type of maintenance for the reservation.
3995 &quot;subblockInfraMaintenanceOngoingCount&quot;: 42, # Describes number of subblock Infrastructure that has ongoing maintenance.
3996 # Here, Subblock Infrastructure Maintenance pertains to upstream hardware
3997 # contained in the Subblock that is necessary for a VM Family(e.g. NVLink
3998 # Domains). Not all VM Families will support this field.
3999 &quot;subblockInfraMaintenancePendingCount&quot;: 42, # Describes number of subblock Infrastructure that has pending maintenance.
4000 # Here, Subblock Infrastructure Maintenance pertains to upstream hardware
4001 # contained in the Subblock that is necessary for a VM Family (e.g. NVLink
4002 # Domains). Not all VM Families will support this field.
4003 &quot;upcomingGroupMaintenance&quot;: { # Upcoming Maintenance notification information. # Maintenance information on this group of VMs.
4004 &quot;canReschedule&quot;: True or False, # Indicates if the maintenance can be customer triggered.
4005 &quot;latestWindowStartTime&quot;: &quot;A String&quot;, # The latest time for the planned maintenance window to start.
4006 # This timestamp value is in RFC3339 text format.
4007 &quot;maintenanceOnShutdown&quot;: True or False, # Indicates whether the UpcomingMaintenance will be triggered on VM shutdown.
4008 &quot;maintenanceReasons&quot;: [ # The reasons for the maintenance. Only valid for vms.
4009 &quot;A String&quot;,
4010 ],
4011 &quot;maintenanceStatus&quot;: &quot;A String&quot;,
4012 &quot;type&quot;: &quot;A String&quot;, # Defines the type of maintenance.
4013 &quot;windowEndTime&quot;: &quot;A String&quot;, # The time by which the maintenance disruption will be completed.
4014 # This timestamp value is in RFC3339 text format.
4015 &quot;windowStartTime&quot;: &quot;A String&quot;, # The current start time of the maintenance window.
4016 # This timestamp value is in RFC3339 text format.
4017 },
4018 },
4019 &quot;specificSkuAllocation&quot;: { # Contains Properties set for the reservation. # Allocation Properties of this reservation.
4020 &quot;sourceInstanceTemplateId&quot;: &quot;A String&quot;, # ID of the instance template used to populate reservation properties.
4021 &quot;utilizations&quot;: { # Per service utilization breakdown. The Key is the Google Cloud managed
4022 # service name.
4023 &quot;a_key&quot;: &quot;A String&quot;,
4024 },
4025 },
4026 },
4027 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
4028 &quot;schedulingType&quot;: &quot;A String&quot;, # The type of maintenance for the reservation.
4029 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined fully-qualified URL for this resource.
4030 &quot;shareSettings&quot;: { # The share setting for reservations and sole tenancy node groups. # Specify share-settings to create a shared reservation. This property is
4031 # optional. For more information about the syntax and options for this
4032 # field and its subfields, see the guide for creating
4033 # a shared reservation.
4034 &quot;projectMap&quot;: { # A map of project id and project config. This is only valid when
4035 # share_type&#x27;s value is SPECIFIC_PROJECTS.
4036 &quot;a_key&quot;: { # Config for each project in the share settings.
4037 &quot;projectId&quot;: &quot;A String&quot;, # The project ID, should be same as the key of this project config in the
4038 # parent map.
4039 },
4040 },
4041 &quot;shareType&quot;: &quot;A String&quot;, # Type of sharing for this shared-reservation
4042 },
4043 &quot;specificReservation&quot;: { # This reservation type allows to pre allocate specific instance # Reservation for instances with specific machine shapes.
4044 # configuration.
4045 &quot;assuredCount&quot;: &quot;A String&quot;, # Output only. [Output Only] Indicates how many instances are actually usable currently.
4046 &quot;count&quot;: &quot;A String&quot;, # Specifies the number of resources that are allocated.
4047 &quot;inUseCount&quot;: &quot;A String&quot;, # Output only. [Output Only] Indicates how many instances are in use.
4048 &quot;instanceProperties&quot;: { # Properties of the SKU instances being reserved. # The instance properties for the reservation.
4049 # Next ID: 10
4050 &quot;guestAccelerators&quot;: [ # Specifies accelerator type and count.
4051 { # A specification of the type and number of accelerator cards attached to the
4052 # instance.
4053 &quot;acceleratorCount&quot;: 42, # The number of the guest accelerator cards exposed to this instance.
4054 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL of the accelerator type resource to attach to this
4055 # instance. For example:projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100
4056 # If you are creating an instance template, specify only the
4057 # accelerator name.
4058 # See GPUs on Compute Engine
4059 # for a full list of accelerator types.
4060 },
4061 ],
4062 &quot;localSsds&quot;: [ # Specifies amount of local ssd to reserve with each instance. The type
4063 # of disk is local-ssd.
4064 {
4065 &quot;diskSizeGb&quot;: &quot;A String&quot;, # Specifies the size of the disk in base-2 GB.
4066 &quot;interface&quot;: &quot;A String&quot;, # Specifies the disk interface to use for attaching this disk, which is
4067 # either SCSI or NVME. The default isSCSI.
4068 # For performance characteristics of SCSI over NVMe, seeLocal SSD performance.
4069 },
4070 ],
4071 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the allocation close to other
4072 # resources.
4073 # This field is for use by internal tools that use the public API.
4074 &quot;machineType&quot;: &quot;A String&quot;, # Specifies type of machine (name only) which has fixed number of vCPUs
4075 # and fixed amount of memory. This also includes specifying custom
4076 # machine type following custom-NUMBER_OF_CPUS-AMOUNT_OF_MEMORY pattern.
4077 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # Minimum cpu platform the reservation.
4078 },
4079 &quot;sourceInstanceTemplate&quot;: &quot;A String&quot;, # Specifies the instance template to create the reservation. If you use
4080 # this field, you must exclude the instanceProperties field.
4081 #
4082 # This field is optional, and it can be a full or partial URL. For example,
4083 # the following are all valid URLs to an instance template:
4084 #
4085 #
4086 # - https://www.googleapis.com/compute/v1/projects/project/global/instanceTemplates/instanceTemplate
4087 # - projects/project/global/instanceTemplates/instanceTemplate
4088 # - global/instanceTemplates/instanceTemplate
4089 },
4090 &quot;specificReservationRequired&quot;: True or False, # Indicates whether the reservation can be consumed by VMs with affinity
4091 # for &quot;any&quot; reservation. If the field is set, then only VMs that target
4092 # the reservation by name can consume from this reservation.
4093 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only] The status of the reservation.
4094 #
4095 #
4096 # - CREATING: Reservation resources are being
4097 # allocated.
4098 # - READY: Reservation resources have been allocated,
4099 # and the reservation is ready for use.
4100 # - DELETING: Reservation deletion is in progress.
4101 # - UPDATING: Reservation update is in progress.
4102 &quot;zone&quot;: &quot;A String&quot;, # Zone in which the reservation resides. A zone must be provided if the
4103 # reservation is created within a commitment.
4104 }
4105
4106 paths: string, A parameter (repeated)
4107 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
4108 that if you must retry your request, the server will know to ignore the
4109 request if it has already been completed.
4110
4111 For example, consider a situation where you make an initial request and
4112 the request times out. If you make the request again with the same
4113 request ID, the server can check if original operation with the same
4114 request ID was received, and if so, will ignore the second request. This
4115 prevents clients from accidentally creating duplicate commitments.
4116
4117 The request ID must be
4118 a valid UUID with the exception that zero UUID is not supported
4119 (00000000-0000-0000-0000-000000000000).
4120 updateMask: string, Update_mask indicates fields to be updated as part of this request.
4121 x__xgafv: string, V1 error format.
4122 Allowed values
4123 1 - v1 error format
4124 2 - v2 error format
4125
4126 Returns:
4127 An object of the form:
4128
4129 { # Represents an Operation resource.
4130 #
4131 # Google Compute Engine has three Operation resources:
4132 #
4133 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
4134 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
4135 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
4136 #
4137 # You can use an operation resource to manage asynchronous API requests.
4138 # For more information, readHandling
4139 # API responses.
4140 #
4141 # Operations can be global, regional or zonal.
4142 #
4143 # - For global operations, use the `globalOperations`
4144 # resource.
4145 # - For regional operations, use the
4146 # `regionOperations` resource.
4147 # - For zonal operations, use
4148 # the `zoneOperations` resource.
4149 #
4150 #
4151 #
4152 # For more information, read
4153 # Global, Regional, and Zonal Resources.
4154 #
4155 # Note that completed Operation resources have a limited
4156 # retention period.
4157 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
4158 # Not present otherwise.
4159 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
4160 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
4161 # set when the operation is created.
4162 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
4163 # text format.
4164 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
4165 # this field will be populated.
4166 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
4167 # operation.
4168 {
4169 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
4170 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
4171 # details. There is a set of defined message types to use for providing
4172 # details.The syntax depends on the error code. For example,
4173 # QuotaExceededInfo will have details when the error code is
4174 # QUOTA_EXCEEDED.
4175 {
4176 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
4177 #
4178 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
4179 # is not enabled:
4180 #
4181 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
4182 # &quot;domain&quot;: &quot;googleapis.com&quot;
4183 # &quot;metadata&quot;: {
4184 # &quot;resource&quot;: &quot;projects/123&quot;,
4185 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
4186 # }
4187 # }
4188 #
4189 # This response indicates that the pubsub.googleapis.com API is not enabled.
4190 #
4191 # Example of an error that is returned when attempting to create a Spanner
4192 # instance in a region that is out of stock:
4193 #
4194 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
4195 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
4196 # &quot;metadata&quot;: {
4197 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
4198 # }
4199 # }
4200 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
4201 # is typically the registered service name of the tool or product that
4202 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
4203 # generated by some common infrastructure, the error domain must be a
4204 # globally unique value that identifies the infrastructure. For Google API
4205 # infrastructure, the error domain is &quot;googleapis.com&quot;.
4206 &quot;metadatas&quot;: { # Additional structured details about this error.
4207 #
4208 # Keys must match a regular expression of `a-z+` but should
4209 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
4210 # length. When identifying the current value of an exceeded limit, the units
4211 # should be contained in the key, not the value. For example, rather than
4212 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
4213 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
4214 # instances that can be created in a single (batch) request.
4215 &quot;a_key&quot;: &quot;A String&quot;,
4216 },
4217 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
4218 # proximate cause of the error. Error reasons are unique within a particular
4219 # domain of errors. This should be at most 63 characters and match a
4220 # regular expression of `A-Z+[A-Z0-9]`, which represents
4221 # UPPER_SNAKE_CASE.
4222 },
4223 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
4224 #
4225 # For example, if a quota check failed with an error indicating the calling
4226 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
4227 # directly to the right place in the developer console to flip the bit.
4228 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
4229 { # Describes a URL link.
4230 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
4231 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
4232 },
4233 ],
4234 },
4235 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
4236 # which can be attached to an RPC error.
4237 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
4238 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
4239 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
4240 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
4241 },
4242 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
4243 &quot;dimensions&quot;: { # The map holding related quota dimensions.
4244 &quot;a_key&quot;: &quot;A String&quot;,
4245 },
4246 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
4247 # type or metric.
4248 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
4249 # or metric.
4250 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
4251 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
4252 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
4253 },
4254 },
4255 ],
4256 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
4257 # This property is optional.
4258 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
4259 },
4260 ],
4261 },
4262 &quot;getVersionOperationMetadata&quot;: {
4263 &quot;inlineSbomInfo&quot;: {
4264 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
4265 # appropriate identifiers.
4266 &quot;a_key&quot;: &quot;A String&quot;,
4267 },
4268 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
4269 # identifiers.
4270 &quot;a_key&quot;: &quot;A String&quot;,
4271 },
4272 },
4273 },
4274 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
4275 # message that was returned, such as `NOT FOUND`.
4276 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
4277 # status code that was returned. For example, a `404` means the
4278 # resource was not found.
4279 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
4280 # defined by the server.
4281 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
4282 # This value is inRFC3339
4283 # text format.
4284 &quot;instancesBulkInsertOperationMetadata&quot;: {
4285 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
4286 # Example key: zones/us-central1-a
4287 &quot;a_key&quot;: {
4288 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
4289 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
4290 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
4291 # error.
4292 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
4293 # if the flow is rolling forward or rolling back.
4294 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
4295 },
4296 },
4297 },
4298 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
4299 # Operation resources.
4300 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
4301 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
4302 # group of operations results from a `bulkInsert` API request.
4303 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
4304 # `update`, or `delete`, and so on.
4305 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
4306 # There is no requirement that this be linear or support any granularity of
4307 # operations. This should not be used to guess when the operation will be
4308 # complete. This number should monotonically increase as the operation
4309 # progresses.
4310 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
4311 # applicable when performing regional operations.
4312 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
4313 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
4314 # this field will contain information on all underlying zonal actions and
4315 # their state.
4316 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
4317 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
4318 # Example key: zones/us-central1-a
4319 &quot;a_key&quot;: {
4320 &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
4321 # populated.
4322 # different programming environments, including REST APIs and RPC APIs. It is
4323 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
4324 # three pieces of data: error code, error message, and error details.
4325 #
4326 # You can find out more about this error model and how to work with it in the
4327 # [API Design Guide](https://cloud.google.com/apis/design/errors).
4328 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
4329 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
4330 # message types for APIs to use.
4331 {
4332 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
4333 },
4334 ],
4335 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
4336 # user-facing error message should be localized and sent in the
4337 # google.rpc.Status.details field, or localized by the client.
4338 },
4339 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
4340 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
4341 },
4342 },
4343 },
4344 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
4345 # This value is inRFC3339
4346 # text format.
4347 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
4348 # following:
4349 # `PENDING`, `RUNNING`, or `DONE`.
4350 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
4351 # operation.
4352 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
4353 # of the target resource.
4354 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
4355 # operations related to creating a snapshot, this points to the disk
4356 # that the snapshot was created from.
4357 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
4358 # `[email protected]` or
4359 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
4360 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
4361 # operation, this field will be populated.
4362 {
4363 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
4364 # Engine returns NO_RESULTS_ON_PAGE if there
4365 # are no results in the response.
4366 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
4367 # value format. For example:
4368 #
4369 # &quot;data&quot;: [
4370 # {
4371 # &quot;key&quot;: &quot;scope&quot;,
4372 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
4373 # }
4374 {
4375 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
4376 # returned. For example, for warnings where there are no results in a list
4377 # request for a particular zone, this key might be scope and
4378 # the key value might be the zone name. Other examples might be a key
4379 # indicating a deprecated resource and a suggested replacement, or a
4380 # warning about invalid network settings (for example, if an instance
4381 # attempts to perform IP forwarding but is not enabled for IP forwarding).
4382 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
4383 },
4384 ],
4385 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
4386 },
4387 ],
4388 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
4389 # applicable when performing per-zone operations.
4390 }</pre>
4391 </div>
4392
4393 </body></html>