Debian Codegraph @

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