Debian Codegraph @

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