Debian Codegraph @

docs/dyn/compute_v1.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_v1.html">Compute Engine API</a> . <a href="compute_v1.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="#close">close()</a></code></p>
85 <p class="firstline">Close httplib2 connections.</p>
86 <p class="toc_element">
87 <code><a href="#get">get(project, region, commitment, x__xgafv=None)</a></code></p>
88 <p class="firstline">Returns the specified commitment resource.</p>
89 <p class="toc_element">
90 <code><a href="#insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</a></code></p>
91 <p class="firstline">Creates a commitment in the specified project using the data</p>
92 <p class="toc_element">
93 <code><a href="#list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
94 <p class="firstline">Retrieves a list of commitments contained within</p>
95 <p class="toc_element">
96 <code><a href="#list_next">list_next()</a></code></p>
97 <p class="firstline">Retrieves the next page of results.</p>
98 <p class="toc_element">
99 <code><a href="#update">update(project, region, commitment, body=None, paths=None, requestId=None, updateMask=None, x__xgafv=None)</a></code></p>
100 <p class="firstline">Updates the specified commitment with the data included in the request.</p>
101 <h3>Method Details</h3>
102 <div class="method">
103 <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>
104 <pre>Retrieves an aggregated list of commitments by region.
105
106 To prevent failure, it is recommended that you set the
107 `returnPartialSuccess` parameter to `true`.
108
109 Args:
110 project: string, Project ID for this request. (required)
111 filter: string, A filter expression that filters resources listed in the response. Most
112 Compute resources support two types of filter expressions:
113 expressions that support regular expressions and expressions that follow
114 API improvement proposal AIP-160.
115 These two types of filter expressions cannot be mixed in one request.
116
117 If you want to use AIP-160, your expression must specify the field name, an
118 operator, and the value that you want to use for filtering. The value
119 must be a string, a number, or a boolean. The operator
120 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
121
122 For example, if you are filtering Compute Engine instances, you can
123 exclude instances named `example-instance` by specifying
124 `name != example-instance`.
125
126 The `:*` comparison can be used to test whether a key has been defined.
127 For example, to find all objects with `owner` label use:
128 ```
129 labels.owner:*
130 ```
131
132 You can also filter nested fields. For example, you could specify
133 `scheduling.automaticRestart = false` to include instances only
134 if they are not scheduled for automatic restarts. You can use filtering
135 on nested fields to filter based onresource labels.
136
137 To filter on multiple expressions, provide each separate expression within
138 parentheses. For example:
139 ```
140 (scheduling.automaticRestart = true)
141 (cpuPlatform = &quot;Intel Skylake&quot;)
142 ```
143 By default, each expression is an `AND` expression. However, you
144 can include `AND` and `OR` expressions explicitly.
145 For example:
146 ```
147 (cpuPlatform = &quot;Intel Skylake&quot;) OR
148 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
149 (scheduling.automaticRestart = true)
150 ```
151
152 If you want to use a regular expression, use the `eq` (equal) or `ne`
153 (not equal) operator against a single un-parenthesized expression with or
154 without quotes or against multiple parenthesized expressions. Examples:
155
156 `fieldname eq unquoted literal`
157 `fieldname eq &#x27;single quoted literal&#x27;`
158 `fieldname eq &quot;double quoted literal&quot;`
159 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
160
161 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
162 The literal value must match the entire field.
163
164 For example, to filter for instances that do not end with name &quot;instance&quot;,
165 you would use `name ne .*instance`.
166
167 You cannot combine constraints on multiple fields using regular
168 expressions.
169 includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region,
170 global) should be included in the response. For new resource types added
171 after this field, the flag has no effect as new resource types will always
172 include every visible scope for each scope type in response. For resource
173 types which predate this field, if this flag is omitted or false, only
174 scopes of the scope types where the resource type is expected to be found
175 will be included.
176 maxResults: integer, The maximum number of results per page that should be returned.
177 If the number of available results is larger than `maxResults`,
178 Compute Engine returns a `nextPageToken` that can be used to get
179 the next page of results in subsequent list requests. Acceptable values are
180 `0` to `500`, inclusive. (Default: `500`)
181 orderBy: string, Sorts list results by a certain order. By default, results
182 are returned in alphanumerical order based on the resource name.
183
184 You can also sort results in descending order based on the creation
185 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
186 results based on the `creationTimestamp` field in
187 reverse chronological order (newest result first). Use this to sort
188 resources like operations so that the newest operation is returned first.
189
190 Currently, only sorting by `name` or
191 `creationTimestamp desc` is supported.
192 pageToken: string, Specifies a page token to use. Set `pageToken` to the
193 `nextPageToken` returned by a previous list request to get
194 the next page of results.
195 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
196 of failure. The default value is false.
197
198 For example, when partial success behavior is enabled, aggregatedList for a
199 single zone scope either returns all resources in the zone or no resources,
200 with an error code.
201 serviceProjectNumber: string, The Shared VPC service project id or service project number for which
202 aggregated list request is invoked for subnetworks list-usable api.
203 x__xgafv: string, V1 error format.
204 Allowed values
205 1 - v1 error format
206 2 - v2 error format
207
208 Returns:
209 An object of the form:
210
211 {
212 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
213 &quot;items&quot;: { # A list of CommitmentsScopedList resources.
214 &quot;a_key&quot;: { # [Output Only] Name of the scope containing this set of commitments.
215 &quot;commitments&quot;: [ # [Output Only] The list of commitments contained in this scope.
216 { # Represents a regional resource-based commitment resource.
217 #
218 # Creating this commitment resource means that you are purchasing a
219 # resource-based committed use contract, with an explicit start and end time.
220 # You can purchase resource-based commitments for both hardware and software
221 # resources. For more information, read
222 # Resource-based committed use discounts
223 &quot;autoRenew&quot;: True or False, # Specifies whether to automatically renew the commitment at the end of its
224 # current term. The default value is false. If you set the field
225 # to true, each time your commitment reaches the end of its
226 # term, Compute Engine automatically renews it for another term. You can
227 # update this field anytime before the commitment expires. For example, if
228 # the commitment is set to expire at 12 AM UTC-8 on January 3, 2027, you can
229 # update this field until 11:59 PM UTC-8 on January 2, 2027.
230 &quot;category&quot;: &quot;A String&quot;, # The category of the commitment; specifies whether the commitment is for
231 # hardware or software resources. Category MACHINE specifies
232 # that you are committing to hardware machine resources such asVCPU or MEMORY, listed in resources.
233 # Category LICENSE specifies that you are committing to software
234 # licenses, listed in licenseResources.
235 # Note that if you specify MACHINE commitments, then you must
236 # also specify a type to indicate the machine series of the
237 # hardware resource that you are committing to.
238 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
239 # text format.
240 &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
241 # commitment&#x27;s end date is later than the start date + term duration.
242 &quot;description&quot;: &quot;A String&quot;, # An optional description of the commitment. You can provide this property
243 # when you create the resource.
244 &quot;endTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Commitment end time inRFC3339
245 # text format.
246 &quot;existingReservations&quot;: [
247 &quot;A String&quot;,
248 ],
249 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
250 # defined by the server.
251 &quot;kind&quot;: &quot;compute#commitment&quot;, # Output only. [Output Only] Type of the resource. Always compute#commitment
252 # for commitments.
253 &quot;licenseResource&quot;: { # Commitment for a particular license resource. # The license specification required as part of a license commitment.
254 &quot;amount&quot;: &quot;A String&quot;, # The number of licenses you plan to purchase.
255 &quot;coresPerLicense&quot;: &quot;A String&quot;, # The number of cores per license.
256 &quot;license&quot;: &quot;A String&quot;, # The applicable license URI.
257 },
258 &quot;mergeSourceCommitments&quot;: [ # The list of source commitments that you are merging to create the new
259 # merged commitment. For more information, see
260 # Merging commitments.
261 &quot;A String&quot;,
262 ],
263 &quot;name&quot;: &quot;A String&quot;, # Name of the commitment. You must specify a name when you purchase the
264 # commitment. The name must be 1-63 characters long, and comply withRFC1035.
265 # Specifically, the name must be 1-63 characters long and match the regular
266 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
267 # character must be a lowercase letter, and all following characters must
268 # be a dash, lowercase letter, or digit, except the last character, which
269 # cannot be a dash.
270 &quot;params&quot;: { # Additional commitment params. # Input only. Additional params passed with the request, but not persisted
271 # as part of resource payload.
272 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the commitment. Tag keys and
273 # values have the same definition as resource
274 # manager tags. Keys and values can be either in numeric format,
275 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
276 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
277 # `{tag_value_short_name}`. The field is ignored (both PUT &amp;
278 # PATCH) when empty.
279 &quot;a_key&quot;: &quot;A String&quot;,
280 },
281 },
282 &quot;plan&quot;: &quot;A String&quot;, # The minimum time duration that you commit to purchasing resources.
283 # The plan that you choose determines the preset term length of the
284 # commitment (which is 1 year or 3 years) and affects the discount rate that
285 # you receive for your resources. Committing to a longer time duration
286 # typically gives you a higher discount rate. The supported values for this
287 # field are TWELVE_MONTH (1 year), andTHIRTY_SIX_MONTH (3 years).
288 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the commitment and committed
289 # resources are located.
290 &quot;reservations&quot;: [ # The list of new reservations that you want to create and attach to this
291 # commitment.
292 #
293 # You must attach reservations to your commitment if your commitment
294 # specifies any GPUs or Local SSD disks. For more information, see
295 # Attach reservations to resource-based commitments.
296 #
297 # Specify this property only if you want to create new
298 # reservations to attach. To attach existing reservations, specify theexistingReservations property instead.
299 { # Represents a reservation resource. A reservation ensures that capacity is
300 # held in a specific zone even if the reserved VMs are not running. For more
301 # information, read Reserving zonal
302 # resources.
303 &quot;advancedDeploymentControl&quot;: { # Advance control for cluster management, applicable only to DENSE deployment # Advanced control for cluster management, applicable only to DENSE
304 # deployment type reservations.
305 # type reservations.
306 &quot;reservationOperationalMode&quot;: &quot;A String&quot;, # Indicates chosen reservation operational mode for the reservation.
307 },
308 &quot;aggregateReservation&quot;: { # This reservation type is specified by total resource amounts (e.g. total # Reservation for aggregated resources, providing shape flexibility.
309 # count of CPUs) and can account for multiple instance SKUs. In other words,
310 # one can create instances of varying shapes against this reservation.
311 &quot;inUseResources&quot;: [ # Output only. [Output only] List of resources currently in use.
312 {
313 &quot;accelerator&quot;: { # Properties of accelerator resources in this reservation.
314 &quot;acceleratorCount&quot;: 42, # Number of accelerators of specified type.
315 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL to accelerator type. e.g.
316 # &quot;projects/{PROJECT}/zones/{ZONE}/acceleratorTypes/ct4l&quot;
317 },
318 },
319 ],
320 &quot;reservedResources&quot;: [ # List of reserved resources (CPUs, memory, accelerators).
321 {
322 &quot;accelerator&quot;: { # Properties of accelerator resources in this reservation.
323 &quot;acceleratorCount&quot;: 42, # Number of accelerators of specified type.
324 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL to accelerator type. e.g.
325 # &quot;projects/{PROJECT}/zones/{ZONE}/acceleratorTypes/ct4l&quot;
326 },
327 },
328 ],
329 &quot;vmFamily&quot;: &quot;A String&quot;, # The VM family that all instances scheduled against this reservation must
330 # belong to.
331 &quot;workloadType&quot;: &quot;A String&quot;, # The workload type of the instances that will target this reservation.
332 },
333 &quot;commitment&quot;: &quot;A String&quot;, # Output only. [Output Only] Full or partial URL to a parent commitment. This field
334 # displays for reservations that are tied to a commitment.
335 &quot;confidentialComputeType&quot;: &quot;A String&quot;,
336 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
337 # text format.
338 &quot;deleteAfterDuration&quot;: { # A Duration represents a fixed-length span of time represented # Duration time relative to reservation creation when Compute Engine will
339 # automatically delete this resource.
340 # as a count of seconds and fractions of seconds at nanosecond
341 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
342 # or &quot;month&quot;. Range is approximately 10,000 years.
343 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
344 # Durations less than one second are represented with a 0
345 # `seconds` field and a positive `nanos` field. Must be from 0
346 # to 999,999,999 inclusive.
347 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
348 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
349 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
350 },
351 &quot;deleteAtTime&quot;: &quot;A String&quot;, # Absolute time in future when the reservation will be
352 # auto-deleted by Compute Engine. Timestamp is represented inRFC3339 text format.
353 &quot;deploymentType&quot;: &quot;A String&quot;, # Specifies the deployment strategy for this reservation.
354 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
355 # create the resource.
356 &quot;earlyAccessMaintenance&quot;: &quot;A String&quot;, # Indicates the early access maintenance for the reservation.
357 # If this field is absent or set to NO_EARLY_ACCESS, the reservation is not
358 # enrolled in early access maintenance and the standard notice applies.
359 &quot;enableEmergentMaintenance&quot;: True or False, # Indicates whether Compute Engine allows unplanned maintenance for your VMs;
360 # for example, to fix hardware errors.
361 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
362 # defined by the server.
363 &quot;kind&quot;: &quot;compute#reservation&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#reservations for reservations.
364 &quot;linkedCommitments&quot;: [ # Output only. [Output Only] Full or partial URL to parent commitments. This field
365 # displays for reservations that are tied to multiple commitments.
366 &quot;A String&quot;,
367 ],
368 &quot;name&quot;: &quot;A String&quot;, # The name of the resource, provided by the client when initially creating
369 # the resource. The resource name must be 1-63 characters long, and comply
370 # withRFC1035.
371 # Specifically, the name must be 1-63 characters long and match the regular
372 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
373 # character must be a lowercase letter, and all following characters must be
374 # a dash, lowercase letter, or digit, except the last character, which cannot
375 # be a dash.
376 &quot;params&quot;: { # Additional reservation params. # Input only. Additional params passed with the request, but not persisted
377 # as part of resource payload.
378 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the reservation. Tag keys and
379 # values have the same definition as resource
380 # manager tags. Keys and values can be either in numeric format,
381 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
382 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
383 # `{tag_value_short_name}`. The field is ignored (both PUT &amp;
384 # PATCH) when empty.
385 &quot;a_key&quot;: &quot;A String&quot;,
386 },
387 },
388 &quot;protectionTier&quot;: &quot;A String&quot;, # Protection tier for the workload which specifies the workload expectations
389 # in the event of infrastructure failures at data center (e.g. power
390 # and/or cooling failures).
391 &quot;reservationSharingPolicy&quot;: { # Specify the reservation sharing policy. If unspecified, the reservation
392 # will not be shared with Google Cloud managed services.
393 &quot;serviceShareType&quot;: &quot;A String&quot;, # Sharing config for all Google Cloud services.
394 },
395 &quot;resourcePolicies&quot;: { # Resource policies to be added to this reservation. The key is defined by
396 # user, and the value is resource policy url. This is to define placement
397 # policy with reservation.
398 &quot;a_key&quot;: &quot;A String&quot;,
399 },
400 &quot;resourceStatus&quot;: { # [Output Only] Contains output only fields. # Output only. [Output Only] Status information for Reservation resource.
401 &quot;healthInfo&quot;: { # Health information for the reservation. # [Output only] Health information for the reservation.
402 &quot;degradedBlockCount&quot;: 42, # The number of reservation blocks that are degraded.
403 &quot;healthStatus&quot;: &quot;A String&quot;, # The health status of the reservation.
404 &quot;healthyBlockCount&quot;: 42, # The number of reservation blocks that are healthy.
405 },
406 &quot;reservationBlockCount&quot;: 42, # The number of reservation blocks associated with this reservation.
407 &quot;reservationMaintenance&quot;: { # Maintenance Info for ReservationBlocks. # Maintenance information for this reservation
408 &quot;instanceMaintenanceOngoingCount&quot;: 42, # Describes number of instances that have ongoing maintenance.
409 &quot;instanceMaintenancePendingCount&quot;: 42, # Describes number of instances that have pending maintenance.
410 &quot;maintenanceOngoingCount&quot;: 42, # Progress for ongoing maintenance for this group of VMs/hosts.
411 # Describes number of hosts in the block that have ongoing maintenance.
412 &quot;maintenancePendingCount&quot;: 42, # Progress for ongoing maintenance for this group of VMs/hosts.
413 # Describes number of hosts in the block that have pending maintenance.
414 &quot;schedulingType&quot;: &quot;A String&quot;, # The type of maintenance for the reservation.
415 &quot;subblockInfraMaintenanceOngoingCount&quot;: 42, # Describes number of subblock Infrastructure that has ongoing maintenance.
416 # Here, Subblock Infrastructure Maintenance pertains to upstream hardware
417 # contained in the Subblock that is necessary for a VM Family(e.g. NVLink
418 # Domains). Not all VM Families will support this field.
419 &quot;subblockInfraMaintenancePendingCount&quot;: 42, # Describes number of subblock Infrastructure that has pending maintenance.
420 # Here, Subblock Infrastructure Maintenance pertains to upstream hardware
421 # contained in the Subblock that is necessary for a VM Family (e.g. NVLink
422 # Domains). Not all VM Families will support this field.
423 &quot;upcomingGroupMaintenance&quot;: { # Upcoming Maintenance notification information. # Maintenance information on this group of VMs.
424 &quot;canReschedule&quot;: True or False, # Indicates if the maintenance can be customer triggered.
425 &quot;latestWindowStartTime&quot;: &quot;A String&quot;, # The latest time for the planned maintenance window to start.
426 # This timestamp value is in RFC3339 text format.
427 &quot;maintenanceOnShutdown&quot;: True or False, # Indicates whether the UpcomingMaintenance will be triggered on VM shutdown.
428 &quot;maintenanceReasons&quot;: [ # The reasons for the maintenance. Only valid for vms.
429 &quot;A String&quot;,
430 ],
431 &quot;maintenanceStatus&quot;: &quot;A String&quot;,
432 &quot;type&quot;: &quot;A String&quot;, # Defines the type of maintenance.
433 &quot;windowEndTime&quot;: &quot;A String&quot;, # The time by which the maintenance disruption will be completed.
434 # This timestamp value is in RFC3339 text format.
435 &quot;windowStartTime&quot;: &quot;A String&quot;, # The current start time of the maintenance window.
436 # This timestamp value is in RFC3339 text format.
437 },
438 },
439 &quot;specificSkuAllocation&quot;: { # Contains Properties set for the reservation. # Allocation Properties of this reservation.
440 &quot;sourceInstanceTemplateId&quot;: &quot;A String&quot;, # ID of the instance template used to populate reservation properties.
441 &quot;utilizations&quot;: { # Per service utilization breakdown. The Key is the Google Cloud managed
442 # service name.
443 &quot;a_key&quot;: &quot;A String&quot;,
444 },
445 },
446 },
447 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
448 &quot;schedulingType&quot;: &quot;A String&quot;, # The type of maintenance for the reservation.
449 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined fully-qualified URL for this resource.
450 &quot;shareSettings&quot;: { # The share setting for reservations and sole tenancy node groups. # Specify share-settings to create a shared reservation. This property is
451 # optional. For more information about the syntax and options for this
452 # field and its subfields, see the guide for creating
453 # a shared reservation.
454 &quot;projectMap&quot;: { # A map of project id and project config. This is only valid when
455 # share_type&#x27;s value is SPECIFIC_PROJECTS.
456 &quot;a_key&quot;: { # Config for each project in the share settings.
457 &quot;projectId&quot;: &quot;A String&quot;, # The project ID, should be same as the key of this project config in the
458 # parent map.
459 },
460 },
461 &quot;shareType&quot;: &quot;A String&quot;, # Type of sharing for this shared-reservation
462 },
463 &quot;specificReservation&quot;: { # This reservation type allows to pre allocate specific instance # Reservation for instances with specific machine shapes.
464 # configuration.
465 &quot;assuredCount&quot;: &quot;A String&quot;, # Output only. [Output Only] Indicates how many instances are actually usable currently.
466 &quot;count&quot;: &quot;A String&quot;, # Specifies the number of resources that are allocated.
467 &quot;inUseCount&quot;: &quot;A String&quot;, # Output only. [Output Only] Indicates how many instances are in use.
468 &quot;instanceProperties&quot;: { # Properties of the SKU instances being reserved. # The instance properties for the reservation.
469 # Next ID: 10
470 &quot;guestAccelerators&quot;: [ # Specifies accelerator type and count.
471 { # A specification of the type and number of accelerator cards attached to the
472 # instance.
473 &quot;acceleratorCount&quot;: 42, # The number of the guest accelerator cards exposed to this instance.
474 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL of the accelerator type resource to attach to this
475 # instance. For example:projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100
476 # If you are creating an instance template, specify only the
477 # accelerator name.
478 # See GPUs on Compute Engine
479 # for a full list of accelerator types.
480 },
481 ],
482 &quot;localSsds&quot;: [ # Specifies amount of local ssd to reserve with each instance. The type
483 # of disk is local-ssd.
484 {
485 &quot;diskSizeGb&quot;: &quot;A String&quot;, # Specifies the size of the disk in base-2 GB.
486 &quot;interface&quot;: &quot;A String&quot;, # Specifies the disk interface to use for attaching this disk, which is
487 # either SCSI or NVME. The default isSCSI.
488 # For performance characteristics of SCSI over NVMe, seeLocal SSD performance.
489 },
490 ],
491 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the allocation close to other
492 # resources.
493 # This field is for use by internal tools that use the public API.
494 &quot;machineType&quot;: &quot;A String&quot;, # Specifies type of machine (name only) which has fixed number of vCPUs
495 # and fixed amount of memory. This also includes specifying custom
496 # machine type following custom-NUMBER_OF_CPUS-AMOUNT_OF_MEMORY pattern.
497 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # Minimum cpu platform the reservation.
498 },
499 &quot;sourceInstanceTemplate&quot;: &quot;A String&quot;, # Specifies the instance template to create the reservation. If you use
500 # this field, you must exclude the instanceProperties field.
501 #
502 # This field is optional, and it can be a full or partial URL. For example,
503 # the following are all valid URLs to an instance template:
504 #
505 #
506 # - https://www.googleapis.com/compute/v1/projects/project/global/instanceTemplates/instanceTemplate
507 # - projects/project/global/instanceTemplates/instanceTemplate
508 # - global/instanceTemplates/instanceTemplate
509 },
510 &quot;specificReservationRequired&quot;: True or False, # Indicates whether the reservation can be consumed by VMs with affinity
511 # for &quot;any&quot; reservation. If the field is set, then only VMs that target
512 # the reservation by name can consume from this reservation.
513 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only] The status of the reservation.
514 #
515 #
516 # - CREATING: Reservation resources are being
517 # allocated.
518 # - READY: Reservation resources have been allocated,
519 # and the reservation is ready for use.
520 # - DELETING: Reservation deletion is in progress.
521 # - UPDATING: Reservation update is in progress.
522 &quot;zone&quot;: &quot;A String&quot;, # Zone in which the reservation resides. A zone must be provided if the
523 # reservation is created within a commitment.
524 },
525 ],
526 &quot;resourceStatus&quot;: { # [Output Only] Contains output only fields. # Output only. [Output Only] Status information for Commitment resource.
527 &quot;customTermEligibilityEndTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Indicates the end time of customer&#x27;s eligibility to send
528 # custom term requests in RFC3339 text format. Term extension requests that
529 # (not the end time in the request) after this time will be rejected.
530 },
531 &quot;resources&quot;: [ # The list of all the hardware resources, with their types and amounts, that
532 # you want to commit to. Specify as a separate entry in the list for each
533 # individual resource type.
534 { # Commitment for a particular hardware resource (a commitment is composed of
535 # one or more of these).
536 &quot;acceleratorType&quot;: &quot;A String&quot;, # Name of the accelerator type or GPU resource. Specify this field only when
537 # the type of hardware resource is ACCELERATOR.
538 &quot;amount&quot;: &quot;A String&quot;, # The quantity of the hardware resource that you want to commit to purchasing
539 # (in a type-dependent unit).
540 #
541 # - For vCPUs, you must specify an integer value.
542 # - For memory, you specify the amount of MB that you want. The value you
543 # specify must be a multiple of 256 MB, with up to 6.5 GB of
544 # memory per every vCPU.
545 # - For GPUs, you must specify an integer value.
546 # - For Local SSD disks, you must specify the amount in GB. The size of a
547 # single Local SSD disk is 375 GB.
548 &quot;type&quot;: &quot;A String&quot;, # The type of hardware resource that you want to specify.
549 # You can specify any of the following values:
550 #
551 # - VCPU
552 # - MEMORY
553 # - LOCAL_SSD
554 # - ACCELERATOR
555 #
556 #
557 #
558 # Specify as a separate entry in the list for each
559 # individual resource type.
560 },
561 ],
562 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
563 &quot;splitSourceCommitment&quot;: &quot;A String&quot;, # The source commitment from which you are transferring resources to create
564 # the new split commitment. For more information, see
565 # Split commitments.
566 &quot;startTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Commitment start time inRFC3339
567 # text format.
568 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only] Status of the commitment with regards to eventual expiration
569 # (each commitment has an end date defined). Status can be one of the
570 # following values: NOT_YET_ACTIVE, ACTIVE, orEXPIRED.
571 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. [Output Only] An optional, human-readable explanation of the status.
572 &quot;type&quot;: &quot;A String&quot;, # The type of commitment; specifies the
573 # machine series for which you want to commit to purchasing resources.
574 # The choice of machine series affects the discount rate and the eligible
575 # resource types.
576 #
577 # The type must be one of the following:ACCELERATOR_OPTIMIZED, ACCELERATOR_OPTIMIZED_A3,ACCELERATOR_OPTIMIZED_A3_MEGA,COMPUTE_OPTIMIZED, COMPUTE_OPTIMIZED_C2D,
578 # 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
579 # example, type MEMORY_OPTIMIZED specifies a commitment that
580 # applies only to eligible resources of memory optimized M1 and M2 machine
581 # series. Type GENERAL_PURPOSE specifies a commitment that
582 # applies only to eligible resources of general purpose N1 machine series.
583 },
584 ],
585 &quot;warning&quot;: { # [Output Only] Informational warning which replaces the list of commitments
586 # when the list is empty.
587 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
588 # Engine returns NO_RESULTS_ON_PAGE if there
589 # are no results in the response.
590 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
591 # value format. For example:
592 #
593 # &quot;data&quot;: [
594 # {
595 # &quot;key&quot;: &quot;scope&quot;,
596 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
597 # }
598 {
599 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
600 # returned. For example, for warnings where there are no results in a list
601 # request for a particular zone, this key might be scope and
602 # the key value might be the zone name. Other examples might be a key
603 # indicating a deprecated resource and a suggested replacement, or a
604 # warning about invalid network settings (for example, if an instance
605 # attempts to perform IP forwarding but is not enabled for IP forwarding).
606 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
607 },
608 ],
609 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
610 },
611 },
612 },
613 &quot;kind&quot;: &quot;compute#commitmentAggregatedList&quot;, # Output only. [Output Only] Type of resource. Alwayscompute#commitmentAggregatedList for aggregated lists of
614 # commitments.
615 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
616 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
617 # the query parameter pageToken in the next list request.
618 # Subsequent list requests will have their own nextPageToken to
619 # continue paging through the results.
620 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
621 &quot;unreachables&quot;: [ # Output only. [Output Only] Unreachable resources.
622 &quot;A String&quot;,
623 ],
624 &quot;warning&quot;: { # [Output Only] Informational warning message.
625 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
626 # Engine returns NO_RESULTS_ON_PAGE if there
627 # are no results in the response.
628 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
629 # value format. For example:
630 #
631 # &quot;data&quot;: [
632 # {
633 # &quot;key&quot;: &quot;scope&quot;,
634 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
635 # }
636 {
637 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
638 # returned. For example, for warnings where there are no results in a list
639 # request for a particular zone, this key might be scope and
640 # the key value might be the zone name. Other examples might be a key
641 # indicating a deprecated resource and a suggested replacement, or a
642 # warning about invalid network settings (for example, if an instance
643 # attempts to perform IP forwarding but is not enabled for IP forwarding).
644 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
645 },
646 ],
647 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
648 },
649 }</pre>
650 </div>
651
652 <div class="method">
653 <code class="details" id="aggregatedList_next">aggregatedList_next()</code>
654 <pre>Retrieves the next page of results.
655
656 Args:
657 previous_request: The request for the previous page. (required)
658 previous_response: The response from the request for the previous page. (required)
659
660 Returns:
661 A request object that you can call &#x27;execute()&#x27; on to request the next
662 page. Returns None if there are no more items in the collection.
663 </pre>
664 </div>
665
666 <div class="method">
667 <code class="details" id="close">close()</code>
668 <pre>Close httplib2 connections.</pre>
669 </div>
670
671 <div class="method">
672 <code class="details" id="get">get(project, region, commitment, x__xgafv=None)</code>
673 <pre>Returns the specified commitment resource.
674
675 Args:
676 project: string, Project ID for this request. (required)
677 region: string, Name of the region for this request. (required)
678 commitment: string, Name of the commitment to return. (required)
679 x__xgafv: string, V1 error format.
680 Allowed values
681 1 - v1 error format
682 2 - v2 error format
683
684 Returns:
685 An object of the form:
686
687 { # Represents a regional resource-based commitment resource.
688 #
689 # Creating this commitment resource means that you are purchasing a
690 # resource-based committed use contract, with an explicit start and end time.
691 # You can purchase resource-based commitments for both hardware and software
692 # resources. For more information, read
693 # Resource-based committed use discounts
694 &quot;autoRenew&quot;: True or False, # Specifies whether to automatically renew the commitment at the end of its
695 # current term. The default value is false. If you set the field
696 # to true, each time your commitment reaches the end of its
697 # term, Compute Engine automatically renews it for another term. You can
698 # update this field anytime before the commitment expires. For example, if
699 # the commitment is set to expire at 12 AM UTC-8 on January 3, 2027, you can
700 # update this field until 11:59 PM UTC-8 on January 2, 2027.
701 &quot;category&quot;: &quot;A String&quot;, # The category of the commitment; specifies whether the commitment is for
702 # hardware or software resources. Category MACHINE specifies
703 # that you are committing to hardware machine resources such asVCPU or MEMORY, listed in resources.
704 # Category LICENSE specifies that you are committing to software
705 # licenses, listed in licenseResources.
706 # Note that if you specify MACHINE commitments, then you must
707 # also specify a type to indicate the machine series of the
708 # hardware resource that you are committing to.
709 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
710 # text format.
711 &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
712 # commitment&#x27;s end date is later than the start date + term duration.
713 &quot;description&quot;: &quot;A String&quot;, # An optional description of the commitment. You can provide this property
714 # when you create the resource.
715 &quot;endTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Commitment end time inRFC3339
716 # text format.
717 &quot;existingReservations&quot;: [
718 &quot;A String&quot;,
719 ],
720 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
721 # defined by the server.
722 &quot;kind&quot;: &quot;compute#commitment&quot;, # Output only. [Output Only] Type of the resource. Always compute#commitment
723 # for commitments.
724 &quot;licenseResource&quot;: { # Commitment for a particular license resource. # The license specification required as part of a license commitment.
725 &quot;amount&quot;: &quot;A String&quot;, # The number of licenses you plan to purchase.
726 &quot;coresPerLicense&quot;: &quot;A String&quot;, # The number of cores per license.
727 &quot;license&quot;: &quot;A String&quot;, # The applicable license URI.
728 },
729 &quot;mergeSourceCommitments&quot;: [ # The list of source commitments that you are merging to create the new
730 # merged commitment. For more information, see
731 # Merging commitments.
732 &quot;A String&quot;,
733 ],
734 &quot;name&quot;: &quot;A String&quot;, # Name of the commitment. You must specify a name when you purchase the
735 # commitment. The name must be 1-63 characters long, and comply withRFC1035.
736 # Specifically, the name must be 1-63 characters long and match the regular
737 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
738 # character must be a lowercase letter, and all following characters must
739 # be a dash, lowercase letter, or digit, except the last character, which
740 # cannot be a dash.
741 &quot;params&quot;: { # Additional commitment params. # Input only. Additional params passed with the request, but not persisted
742 # as part of resource payload.
743 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the commitment. Tag keys and
744 # values have the same definition as resource
745 # manager tags. Keys and values can be either in numeric format,
746 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
747 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
748 # `{tag_value_short_name}`. The field is ignored (both PUT &amp;
749 # PATCH) when empty.
750 &quot;a_key&quot;: &quot;A String&quot;,
751 },
752 },
753 &quot;plan&quot;: &quot;A String&quot;, # The minimum time duration that you commit to purchasing resources.
754 # The plan that you choose determines the preset term length of the
755 # commitment (which is 1 year or 3 years) and affects the discount rate that
756 # you receive for your resources. Committing to a longer time duration
757 # typically gives you a higher discount rate. The supported values for this
758 # field are TWELVE_MONTH (1 year), andTHIRTY_SIX_MONTH (3 years).
759 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the commitment and committed
760 # resources are located.
761 &quot;reservations&quot;: [ # The list of new reservations that you want to create and attach to this
762 # commitment.
763 #
764 # You must attach reservations to your commitment if your commitment
765 # specifies any GPUs or Local SSD disks. For more information, see
766 # Attach reservations to resource-based commitments.
767 #
768 # Specify this property only if you want to create new
769 # reservations to attach. To attach existing reservations, specify theexistingReservations property instead.
770 { # Represents a reservation resource. A reservation ensures that capacity is
771 # held in a specific zone even if the reserved VMs are not running. For more
772 # information, read Reserving zonal
773 # resources.
774 &quot;advancedDeploymentControl&quot;: { # Advance control for cluster management, applicable only to DENSE deployment # Advanced control for cluster management, applicable only to DENSE
775 # deployment type reservations.
776 # type reservations.
777 &quot;reservationOperationalMode&quot;: &quot;A String&quot;, # Indicates chosen reservation operational mode for the reservation.
778 },
779 &quot;aggregateReservation&quot;: { # This reservation type is specified by total resource amounts (e.g. total # Reservation for aggregated resources, providing shape flexibility.
780 # count of CPUs) and can account for multiple instance SKUs. In other words,
781 # one can create instances of varying shapes against this reservation.
782 &quot;inUseResources&quot;: [ # Output only. [Output only] List of resources currently in use.
783 {
784 &quot;accelerator&quot;: { # Properties of accelerator resources in this reservation.
785 &quot;acceleratorCount&quot;: 42, # Number of accelerators of specified type.
786 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL to accelerator type. e.g.
787 # &quot;projects/{PROJECT}/zones/{ZONE}/acceleratorTypes/ct4l&quot;
788 },
789 },
790 ],
791 &quot;reservedResources&quot;: [ # List of reserved resources (CPUs, memory, accelerators).
792 {
793 &quot;accelerator&quot;: { # Properties of accelerator resources in this reservation.
794 &quot;acceleratorCount&quot;: 42, # Number of accelerators of specified type.
795 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL to accelerator type. e.g.
796 # &quot;projects/{PROJECT}/zones/{ZONE}/acceleratorTypes/ct4l&quot;
797 },
798 },
799 ],
800 &quot;vmFamily&quot;: &quot;A String&quot;, # The VM family that all instances scheduled against this reservation must
801 # belong to.
802 &quot;workloadType&quot;: &quot;A String&quot;, # The workload type of the instances that will target this reservation.
803 },
804 &quot;commitment&quot;: &quot;A String&quot;, # Output only. [Output Only] Full or partial URL to a parent commitment. This field
805 # displays for reservations that are tied to a commitment.
806 &quot;confidentialComputeType&quot;: &quot;A String&quot;,
807 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
808 # text format.
809 &quot;deleteAfterDuration&quot;: { # A Duration represents a fixed-length span of time represented # Duration time relative to reservation creation when Compute Engine will
810 # automatically delete this resource.
811 # as a count of seconds and fractions of seconds at nanosecond
812 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
813 # or &quot;month&quot;. Range is approximately 10,000 years.
814 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
815 # Durations less than one second are represented with a 0
816 # `seconds` field and a positive `nanos` field. Must be from 0
817 # to 999,999,999 inclusive.
818 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
819 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
820 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
821 },
822 &quot;deleteAtTime&quot;: &quot;A String&quot;, # Absolute time in future when the reservation will be
823 # auto-deleted by Compute Engine. Timestamp is represented inRFC3339 text format.
824 &quot;deploymentType&quot;: &quot;A String&quot;, # Specifies the deployment strategy for this reservation.
825 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
826 # create the resource.
827 &quot;earlyAccessMaintenance&quot;: &quot;A String&quot;, # Indicates the early access maintenance for the reservation.
828 # If this field is absent or set to NO_EARLY_ACCESS, the reservation is not
829 # enrolled in early access maintenance and the standard notice applies.
830 &quot;enableEmergentMaintenance&quot;: True or False, # Indicates whether Compute Engine allows unplanned maintenance for your VMs;
831 # for example, to fix hardware errors.
832 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
833 # defined by the server.
834 &quot;kind&quot;: &quot;compute#reservation&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#reservations for reservations.
835 &quot;linkedCommitments&quot;: [ # Output only. [Output Only] Full or partial URL to parent commitments. This field
836 # displays for reservations that are tied to multiple commitments.
837 &quot;A String&quot;,
838 ],
839 &quot;name&quot;: &quot;A String&quot;, # The name of the resource, provided by the client when initially creating
840 # the resource. The resource name must be 1-63 characters long, and comply
841 # withRFC1035.
842 # Specifically, the name must be 1-63 characters long and match the regular
843 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
844 # character must be a lowercase letter, and all following characters must be
845 # a dash, lowercase letter, or digit, except the last character, which cannot
846 # be a dash.
847 &quot;params&quot;: { # Additional reservation params. # Input only. Additional params passed with the request, but not persisted
848 # as part of resource payload.
849 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the reservation. Tag keys and
850 # values have the same definition as resource
851 # manager tags. Keys and values can be either in numeric format,
852 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
853 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
854 # `{tag_value_short_name}`. The field is ignored (both PUT &amp;
855 # PATCH) when empty.
856 &quot;a_key&quot;: &quot;A String&quot;,
857 },
858 },
859 &quot;protectionTier&quot;: &quot;A String&quot;, # Protection tier for the workload which specifies the workload expectations
860 # in the event of infrastructure failures at data center (e.g. power
861 # and/or cooling failures).
862 &quot;reservationSharingPolicy&quot;: { # Specify the reservation sharing policy. If unspecified, the reservation
863 # will not be shared with Google Cloud managed services.
864 &quot;serviceShareType&quot;: &quot;A String&quot;, # Sharing config for all Google Cloud services.
865 },
866 &quot;resourcePolicies&quot;: { # Resource policies to be added to this reservation. The key is defined by
867 # user, and the value is resource policy url. This is to define placement
868 # policy with reservation.
869 &quot;a_key&quot;: &quot;A String&quot;,
870 },
871 &quot;resourceStatus&quot;: { # [Output Only] Contains output only fields. # Output only. [Output Only] Status information for Reservation resource.
872 &quot;healthInfo&quot;: { # Health information for the reservation. # [Output only] Health information for the reservation.
873 &quot;degradedBlockCount&quot;: 42, # The number of reservation blocks that are degraded.
874 &quot;healthStatus&quot;: &quot;A String&quot;, # The health status of the reservation.
875 &quot;healthyBlockCount&quot;: 42, # The number of reservation blocks that are healthy.
876 },
877 &quot;reservationBlockCount&quot;: 42, # The number of reservation blocks associated with this reservation.
878 &quot;reservationMaintenance&quot;: { # Maintenance Info for ReservationBlocks. # Maintenance information for this reservation
879 &quot;instanceMaintenanceOngoingCount&quot;: 42, # Describes number of instances that have ongoing maintenance.
880 &quot;instanceMaintenancePendingCount&quot;: 42, # Describes number of instances that have pending maintenance.
881 &quot;maintenanceOngoingCount&quot;: 42, # Progress for ongoing maintenance for this group of VMs/hosts.
882 # Describes number of hosts in the block that have ongoing maintenance.
883 &quot;maintenancePendingCount&quot;: 42, # Progress for ongoing maintenance for this group of VMs/hosts.
884 # Describes number of hosts in the block that have pending maintenance.
885 &quot;schedulingType&quot;: &quot;A String&quot;, # The type of maintenance for the reservation.
886 &quot;subblockInfraMaintenanceOngoingCount&quot;: 42, # Describes number of subblock Infrastructure that has ongoing maintenance.
887 # Here, Subblock Infrastructure Maintenance pertains to upstream hardware
888 # contained in the Subblock that is necessary for a VM Family(e.g. NVLink
889 # Domains). Not all VM Families will support this field.
890 &quot;subblockInfraMaintenancePendingCount&quot;: 42, # Describes number of subblock Infrastructure that has pending maintenance.
891 # Here, Subblock Infrastructure Maintenance pertains to upstream hardware
892 # contained in the Subblock that is necessary for a VM Family (e.g. NVLink
893 # Domains). Not all VM Families will support this field.
894 &quot;upcomingGroupMaintenance&quot;: { # Upcoming Maintenance notification information. # Maintenance information on this group of VMs.
895 &quot;canReschedule&quot;: True or False, # Indicates if the maintenance can be customer triggered.
896 &quot;latestWindowStartTime&quot;: &quot;A String&quot;, # The latest time for the planned maintenance window to start.
897 # This timestamp value is in RFC3339 text format.
898 &quot;maintenanceOnShutdown&quot;: True or False, # Indicates whether the UpcomingMaintenance will be triggered on VM shutdown.
899 &quot;maintenanceReasons&quot;: [ # The reasons for the maintenance. Only valid for vms.
900 &quot;A String&quot;,
901 ],
902 &quot;maintenanceStatus&quot;: &quot;A String&quot;,
903 &quot;type&quot;: &quot;A String&quot;, # Defines the type of maintenance.
904 &quot;windowEndTime&quot;: &quot;A String&quot;, # The time by which the maintenance disruption will be completed.
905 # This timestamp value is in RFC3339 text format.
906 &quot;windowStartTime&quot;: &quot;A String&quot;, # The current start time of the maintenance window.
907 # This timestamp value is in RFC3339 text format.
908 },
909 },
910 &quot;specificSkuAllocation&quot;: { # Contains Properties set for the reservation. # Allocation Properties of this reservation.
911 &quot;sourceInstanceTemplateId&quot;: &quot;A String&quot;, # ID of the instance template used to populate reservation properties.
912 &quot;utilizations&quot;: { # Per service utilization breakdown. The Key is the Google Cloud managed
913 # service name.
914 &quot;a_key&quot;: &quot;A String&quot;,
915 },
916 },
917 },
918 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
919 &quot;schedulingType&quot;: &quot;A String&quot;, # The type of maintenance for the reservation.
920 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined fully-qualified URL for this resource.
921 &quot;shareSettings&quot;: { # The share setting for reservations and sole tenancy node groups. # Specify share-settings to create a shared reservation. This property is
922 # optional. For more information about the syntax and options for this
923 # field and its subfields, see the guide for creating
924 # a shared reservation.
925 &quot;projectMap&quot;: { # A map of project id and project config. This is only valid when
926 # share_type&#x27;s value is SPECIFIC_PROJECTS.
927 &quot;a_key&quot;: { # Config for each project in the share settings.
928 &quot;projectId&quot;: &quot;A String&quot;, # The project ID, should be same as the key of this project config in the
929 # parent map.
930 },
931 },
932 &quot;shareType&quot;: &quot;A String&quot;, # Type of sharing for this shared-reservation
933 },
934 &quot;specificReservation&quot;: { # This reservation type allows to pre allocate specific instance # Reservation for instances with specific machine shapes.
935 # configuration.
936 &quot;assuredCount&quot;: &quot;A String&quot;, # Output only. [Output Only] Indicates how many instances are actually usable currently.
937 &quot;count&quot;: &quot;A String&quot;, # Specifies the number of resources that are allocated.
938 &quot;inUseCount&quot;: &quot;A String&quot;, # Output only. [Output Only] Indicates how many instances are in use.
939 &quot;instanceProperties&quot;: { # Properties of the SKU instances being reserved. # The instance properties for the reservation.
940 # Next ID: 10
941 &quot;guestAccelerators&quot;: [ # Specifies accelerator type and count.
942 { # A specification of the type and number of accelerator cards attached to the
943 # instance.
944 &quot;acceleratorCount&quot;: 42, # The number of the guest accelerator cards exposed to this instance.
945 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL of the accelerator type resource to attach to this
946 # instance. For example:projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100
947 # If you are creating an instance template, specify only the
948 # accelerator name.
949 # See GPUs on Compute Engine
950 # for a full list of accelerator types.
951 },
952 ],
953 &quot;localSsds&quot;: [ # Specifies amount of local ssd to reserve with each instance. The type
954 # of disk is local-ssd.
955 {
956 &quot;diskSizeGb&quot;: &quot;A String&quot;, # Specifies the size of the disk in base-2 GB.
957 &quot;interface&quot;: &quot;A String&quot;, # Specifies the disk interface to use for attaching this disk, which is
958 # either SCSI or NVME. The default isSCSI.
959 # For performance characteristics of SCSI over NVMe, seeLocal SSD performance.
960 },
961 ],
962 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the allocation close to other
963 # resources.
964 # This field is for use by internal tools that use the public API.
965 &quot;machineType&quot;: &quot;A String&quot;, # Specifies type of machine (name only) which has fixed number of vCPUs
966 # and fixed amount of memory. This also includes specifying custom
967 # machine type following custom-NUMBER_OF_CPUS-AMOUNT_OF_MEMORY pattern.
968 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # Minimum cpu platform the reservation.
969 },
970 &quot;sourceInstanceTemplate&quot;: &quot;A String&quot;, # Specifies the instance template to create the reservation. If you use
971 # this field, you must exclude the instanceProperties field.
972 #
973 # This field is optional, and it can be a full or partial URL. For example,
974 # the following are all valid URLs to an instance template:
975 #
976 #
977 # - https://www.googleapis.com/compute/v1/projects/project/global/instanceTemplates/instanceTemplate
978 # - projects/project/global/instanceTemplates/instanceTemplate
979 # - global/instanceTemplates/instanceTemplate
980 },
981 &quot;specificReservationRequired&quot;: True or False, # Indicates whether the reservation can be consumed by VMs with affinity
982 # for &quot;any&quot; reservation. If the field is set, then only VMs that target
983 # the reservation by name can consume from this reservation.
984 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only] The status of the reservation.
985 #
986 #
987 # - CREATING: Reservation resources are being
988 # allocated.
989 # - READY: Reservation resources have been allocated,
990 # and the reservation is ready for use.
991 # - DELETING: Reservation deletion is in progress.
992 # - UPDATING: Reservation update is in progress.
993 &quot;zone&quot;: &quot;A String&quot;, # Zone in which the reservation resides. A zone must be provided if the
994 # reservation is created within a commitment.
995 },
996 ],
997 &quot;resourceStatus&quot;: { # [Output Only] Contains output only fields. # Output only. [Output Only] Status information for Commitment resource.
998 &quot;customTermEligibilityEndTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Indicates the end time of customer&#x27;s eligibility to send
999 # custom term requests in RFC3339 text format. Term extension requests that
1000 # (not the end time in the request) after this time will be rejected.
1001 },
1002 &quot;resources&quot;: [ # The list of all the hardware resources, with their types and amounts, that
1003 # you want to commit to. Specify as a separate entry in the list for each
1004 # individual resource type.
1005 { # Commitment for a particular hardware resource (a commitment is composed of
1006 # one or more of these).
1007 &quot;acceleratorType&quot;: &quot;A String&quot;, # Name of the accelerator type or GPU resource. Specify this field only when
1008 # the type of hardware resource is ACCELERATOR.
1009 &quot;amount&quot;: &quot;A String&quot;, # The quantity of the hardware resource that you want to commit to purchasing
1010 # (in a type-dependent unit).
1011 #
1012 # - For vCPUs, you must specify an integer value.
1013 # - For memory, you specify the amount of MB that you want. The value you
1014 # specify must be a multiple of 256 MB, with up to 6.5 GB of
1015 # memory per every vCPU.
1016 # - For GPUs, you must specify an integer value.
1017 # - For Local SSD disks, you must specify the amount in GB. The size of a
1018 # single Local SSD disk is 375 GB.
1019 &quot;type&quot;: &quot;A String&quot;, # The type of hardware resource that you want to specify.
1020 # You can specify any of the following values:
1021 #
1022 # - VCPU
1023 # - MEMORY
1024 # - LOCAL_SSD
1025 # - ACCELERATOR
1026 #
1027 #
1028 #
1029 # Specify as a separate entry in the list for each
1030 # individual resource type.
1031 },
1032 ],
1033 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
1034 &quot;splitSourceCommitment&quot;: &quot;A String&quot;, # The source commitment from which you are transferring resources to create
1035 # the new split commitment. For more information, see
1036 # Split commitments.
1037 &quot;startTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Commitment start time inRFC3339
1038 # text format.
1039 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only] Status of the commitment with regards to eventual expiration
1040 # (each commitment has an end date defined). Status can be one of the
1041 # following values: NOT_YET_ACTIVE, ACTIVE, orEXPIRED.
1042 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. [Output Only] An optional, human-readable explanation of the status.
1043 &quot;type&quot;: &quot;A String&quot;, # The type of commitment; specifies the
1044 # machine series for which you want to commit to purchasing resources.
1045 # The choice of machine series affects the discount rate and the eligible
1046 # resource types.
1047 #
1048 # The type must be one of the following:ACCELERATOR_OPTIMIZED, ACCELERATOR_OPTIMIZED_A3,ACCELERATOR_OPTIMIZED_A3_MEGA,COMPUTE_OPTIMIZED, COMPUTE_OPTIMIZED_C2D,
1049 # 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
1050 # example, type MEMORY_OPTIMIZED specifies a commitment that
1051 # applies only to eligible resources of memory optimized M1 and M2 machine
1052 # series. Type GENERAL_PURPOSE specifies a commitment that
1053 # applies only to eligible resources of general purpose N1 machine series.
1054 }</pre>
1055 </div>
1056
1057 <div class="method">
1058 <code class="details" id="insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</code>
1059 <pre>Creates a commitment in the specified project using the data
1060 included in the request.
1061
1062 Args:
1063 project: string, Project ID for this request. (required)
1064 region: string, Name of the region for this request. (required)
1065 body: object, The request body.
1066 The object takes the form of:
1067
1068 { # Represents a regional resource-based commitment resource.
1069 #
1070 # Creating this commitment resource means that you are purchasing a
1071 # resource-based committed use contract, with an explicit start and end time.
1072 # You can purchase resource-based commitments for both hardware and software
1073 # resources. For more information, read
1074 # Resource-based committed use discounts
1075 &quot;autoRenew&quot;: True or False, # Specifies whether to automatically renew the commitment at the end of its
1076 # current term. The default value is false. If you set the field
1077 # to true, each time your commitment reaches the end of its
1078 # term, Compute Engine automatically renews it for another term. You can
1079 # update this field anytime before the commitment expires. For example, if
1080 # the commitment is set to expire at 12 AM UTC-8 on January 3, 2027, you can
1081 # update this field until 11:59 PM UTC-8 on January 2, 2027.
1082 &quot;category&quot;: &quot;A String&quot;, # The category of the commitment; specifies whether the commitment is for
1083 # hardware or software resources. Category MACHINE specifies
1084 # that you are committing to hardware machine resources such asVCPU or MEMORY, listed in resources.
1085 # Category LICENSE specifies that you are committing to software
1086 # licenses, listed in licenseResources.
1087 # Note that if you specify MACHINE commitments, then you must
1088 # also specify a type to indicate the machine series of the
1089 # hardware resource that you are committing to.
1090 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
1091 # text format.
1092 &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
1093 # commitment&#x27;s end date is later than the start date + term duration.
1094 &quot;description&quot;: &quot;A String&quot;, # An optional description of the commitment. You can provide this property
1095 # when you create the resource.
1096 &quot;endTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Commitment end time inRFC3339
1097 # text format.
1098 &quot;existingReservations&quot;: [
1099 &quot;A String&quot;,
1100 ],
1101 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
1102 # defined by the server.
1103 &quot;kind&quot;: &quot;compute#commitment&quot;, # Output only. [Output Only] Type of the resource. Always compute#commitment
1104 # for commitments.
1105 &quot;licenseResource&quot;: { # Commitment for a particular license resource. # The license specification required as part of a license commitment.
1106 &quot;amount&quot;: &quot;A String&quot;, # The number of licenses you plan to purchase.
1107 &quot;coresPerLicense&quot;: &quot;A String&quot;, # The number of cores per license.
1108 &quot;license&quot;: &quot;A String&quot;, # The applicable license URI.
1109 },
1110 &quot;mergeSourceCommitments&quot;: [ # The list of source commitments that you are merging to create the new
1111 # merged commitment. For more information, see
1112 # Merging commitments.
1113 &quot;A String&quot;,
1114 ],
1115 &quot;name&quot;: &quot;A String&quot;, # Name of the commitment. You must specify a name when you purchase the
1116 # commitment. The name must be 1-63 characters long, and comply withRFC1035.
1117 # Specifically, the name must be 1-63 characters long and match the regular
1118 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
1119 # character must be a lowercase letter, and all following characters must
1120 # be a dash, lowercase letter, or digit, except the last character, which
1121 # cannot be a dash.
1122 &quot;params&quot;: { # Additional commitment params. # Input only. Additional params passed with the request, but not persisted
1123 # as part of resource payload.
1124 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the commitment. Tag keys and
1125 # values have the same definition as resource
1126 # manager tags. Keys and values can be either in numeric format,
1127 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
1128 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
1129 # `{tag_value_short_name}`. The field is ignored (both PUT &amp;
1130 # PATCH) when empty.
1131 &quot;a_key&quot;: &quot;A String&quot;,
1132 },
1133 },
1134 &quot;plan&quot;: &quot;A String&quot;, # The minimum time duration that you commit to purchasing resources.
1135 # The plan that you choose determines the preset term length of the
1136 # commitment (which is 1 year or 3 years) and affects the discount rate that
1137 # you receive for your resources. Committing to a longer time duration
1138 # typically gives you a higher discount rate. The supported values for this
1139 # field are TWELVE_MONTH (1 year), andTHIRTY_SIX_MONTH (3 years).
1140 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the commitment and committed
1141 # resources are located.
1142 &quot;reservations&quot;: [ # The list of new reservations that you want to create and attach to this
1143 # commitment.
1144 #
1145 # You must attach reservations to your commitment if your commitment
1146 # specifies any GPUs or Local SSD disks. For more information, see
1147 # Attach reservations to resource-based commitments.
1148 #
1149 # Specify this property only if you want to create new
1150 # reservations to attach. To attach existing reservations, specify theexistingReservations property instead.
1151 { # Represents a reservation resource. A reservation ensures that capacity is
1152 # held in a specific zone even if the reserved VMs are not running. For more
1153 # information, read Reserving zonal
1154 # resources.
1155 &quot;advancedDeploymentControl&quot;: { # Advance control for cluster management, applicable only to DENSE deployment # Advanced control for cluster management, applicable only to DENSE
1156 # deployment type reservations.
1157 # type reservations.
1158 &quot;reservationOperationalMode&quot;: &quot;A String&quot;, # Indicates chosen reservation operational mode for the reservation.
1159 },
1160 &quot;aggregateReservation&quot;: { # This reservation type is specified by total resource amounts (e.g. total # Reservation for aggregated resources, providing shape flexibility.
1161 # count of CPUs) and can account for multiple instance SKUs. In other words,
1162 # one can create instances of varying shapes against this reservation.
1163 &quot;inUseResources&quot;: [ # Output only. [Output only] List of resources currently in use.
1164 {
1165 &quot;accelerator&quot;: { # Properties of accelerator resources in this reservation.
1166 &quot;acceleratorCount&quot;: 42, # Number of accelerators of specified type.
1167 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL to accelerator type. e.g.
1168 # &quot;projects/{PROJECT}/zones/{ZONE}/acceleratorTypes/ct4l&quot;
1169 },
1170 },
1171 ],
1172 &quot;reservedResources&quot;: [ # List of reserved resources (CPUs, memory, accelerators).
1173 {
1174 &quot;accelerator&quot;: { # Properties of accelerator resources in this reservation.
1175 &quot;acceleratorCount&quot;: 42, # Number of accelerators of specified type.
1176 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL to accelerator type. e.g.
1177 # &quot;projects/{PROJECT}/zones/{ZONE}/acceleratorTypes/ct4l&quot;
1178 },
1179 },
1180 ],
1181 &quot;vmFamily&quot;: &quot;A String&quot;, # The VM family that all instances scheduled against this reservation must
1182 # belong to.
1183 &quot;workloadType&quot;: &quot;A String&quot;, # The workload type of the instances that will target this reservation.
1184 },
1185 &quot;commitment&quot;: &quot;A String&quot;, # Output only. [Output Only] Full or partial URL to a parent commitment. This field
1186 # displays for reservations that are tied to a commitment.
1187 &quot;confidentialComputeType&quot;: &quot;A String&quot;,
1188 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
1189 # text format.
1190 &quot;deleteAfterDuration&quot;: { # A Duration represents a fixed-length span of time represented # Duration time relative to reservation creation when Compute Engine will
1191 # automatically delete this resource.
1192 # as a count of seconds and fractions of seconds at nanosecond
1193 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
1194 # or &quot;month&quot;. Range is approximately 10,000 years.
1195 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
1196 # Durations less than one second are represented with a 0
1197 # `seconds` field and a positive `nanos` field. Must be from 0
1198 # to 999,999,999 inclusive.
1199 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
1200 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
1201 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
1202 },
1203 &quot;deleteAtTime&quot;: &quot;A String&quot;, # Absolute time in future when the reservation will be
1204 # auto-deleted by Compute Engine. Timestamp is represented inRFC3339 text format.
1205 &quot;deploymentType&quot;: &quot;A String&quot;, # Specifies the deployment strategy for this reservation.
1206 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
1207 # create the resource.
1208 &quot;earlyAccessMaintenance&quot;: &quot;A String&quot;, # Indicates the early access maintenance for the reservation.
1209 # If this field is absent or set to NO_EARLY_ACCESS, the reservation is not
1210 # enrolled in early access maintenance and the standard notice applies.
1211 &quot;enableEmergentMaintenance&quot;: True or False, # Indicates whether Compute Engine allows unplanned maintenance for your VMs;
1212 # for example, to fix hardware errors.
1213 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
1214 # defined by the server.
1215 &quot;kind&quot;: &quot;compute#reservation&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#reservations for reservations.
1216 &quot;linkedCommitments&quot;: [ # Output only. [Output Only] Full or partial URL to parent commitments. This field
1217 # displays for reservations that are tied to multiple commitments.
1218 &quot;A String&quot;,
1219 ],
1220 &quot;name&quot;: &quot;A String&quot;, # The name of the resource, provided by the client when initially creating
1221 # the resource. The resource name must be 1-63 characters long, and comply
1222 # withRFC1035.
1223 # Specifically, the name must be 1-63 characters long and match the regular
1224 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
1225 # character must be a lowercase letter, and all following characters must be
1226 # a dash, lowercase letter, or digit, except the last character, which cannot
1227 # be a dash.
1228 &quot;params&quot;: { # Additional reservation params. # Input only. Additional params passed with the request, but not persisted
1229 # as part of resource payload.
1230 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the reservation. Tag keys and
1231 # values have the same definition as resource
1232 # manager tags. Keys and values can be either in numeric format,
1233 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
1234 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
1235 # `{tag_value_short_name}`. The field is ignored (both PUT &amp;
1236 # PATCH) when empty.
1237 &quot;a_key&quot;: &quot;A String&quot;,
1238 },
1239 },
1240 &quot;protectionTier&quot;: &quot;A String&quot;, # Protection tier for the workload which specifies the workload expectations
1241 # in the event of infrastructure failures at data center (e.g. power
1242 # and/or cooling failures).
1243 &quot;reservationSharingPolicy&quot;: { # Specify the reservation sharing policy. If unspecified, the reservation
1244 # will not be shared with Google Cloud managed services.
1245 &quot;serviceShareType&quot;: &quot;A String&quot;, # Sharing config for all Google Cloud services.
1246 },
1247 &quot;resourcePolicies&quot;: { # Resource policies to be added to this reservation. The key is defined by
1248 # user, and the value is resource policy url. This is to define placement
1249 # policy with reservation.
1250 &quot;a_key&quot;: &quot;A String&quot;,
1251 },
1252 &quot;resourceStatus&quot;: { # [Output Only] Contains output only fields. # Output only. [Output Only] Status information for Reservation resource.
1253 &quot;healthInfo&quot;: { # Health information for the reservation. # [Output only] Health information for the reservation.
1254 &quot;degradedBlockCount&quot;: 42, # The number of reservation blocks that are degraded.
1255 &quot;healthStatus&quot;: &quot;A String&quot;, # The health status of the reservation.
1256 &quot;healthyBlockCount&quot;: 42, # The number of reservation blocks that are healthy.
1257 },
1258 &quot;reservationBlockCount&quot;: 42, # The number of reservation blocks associated with this reservation.
1259 &quot;reservationMaintenance&quot;: { # Maintenance Info for ReservationBlocks. # Maintenance information for this reservation
1260 &quot;instanceMaintenanceOngoingCount&quot;: 42, # Describes number of instances that have ongoing maintenance.
1261 &quot;instanceMaintenancePendingCount&quot;: 42, # Describes number of instances that have pending maintenance.
1262 &quot;maintenanceOngoingCount&quot;: 42, # Progress for ongoing maintenance for this group of VMs/hosts.
1263 # Describes number of hosts in the block that have ongoing maintenance.
1264 &quot;maintenancePendingCount&quot;: 42, # Progress for ongoing maintenance for this group of VMs/hosts.
1265 # Describes number of hosts in the block that have pending maintenance.
1266 &quot;schedulingType&quot;: &quot;A String&quot;, # The type of maintenance for the reservation.
1267 &quot;subblockInfraMaintenanceOngoingCount&quot;: 42, # Describes number of subblock Infrastructure that has ongoing maintenance.
1268 # Here, Subblock Infrastructure Maintenance pertains to upstream hardware
1269 # contained in the Subblock that is necessary for a VM Family(e.g. NVLink
1270 # Domains). Not all VM Families will support this field.
1271 &quot;subblockInfraMaintenancePendingCount&quot;: 42, # Describes number of subblock Infrastructure that has pending maintenance.
1272 # Here, Subblock Infrastructure Maintenance pertains to upstream hardware
1273 # contained in the Subblock that is necessary for a VM Family (e.g. NVLink
1274 # Domains). Not all VM Families will support this field.
1275 &quot;upcomingGroupMaintenance&quot;: { # Upcoming Maintenance notification information. # Maintenance information on this group of VMs.
1276 &quot;canReschedule&quot;: True or False, # Indicates if the maintenance can be customer triggered.
1277 &quot;latestWindowStartTime&quot;: &quot;A String&quot;, # The latest time for the planned maintenance window to start.
1278 # This timestamp value is in RFC3339 text format.
1279 &quot;maintenanceOnShutdown&quot;: True or False, # Indicates whether the UpcomingMaintenance will be triggered on VM shutdown.
1280 &quot;maintenanceReasons&quot;: [ # The reasons for the maintenance. Only valid for vms.
1281 &quot;A String&quot;,
1282 ],
1283 &quot;maintenanceStatus&quot;: &quot;A String&quot;,
1284 &quot;type&quot;: &quot;A String&quot;, # Defines the type of maintenance.
1285 &quot;windowEndTime&quot;: &quot;A String&quot;, # The time by which the maintenance disruption will be completed.
1286 # This timestamp value is in RFC3339 text format.
1287 &quot;windowStartTime&quot;: &quot;A String&quot;, # The current start time of the maintenance window.
1288 # This timestamp value is in RFC3339 text format.
1289 },
1290 },
1291 &quot;specificSkuAllocation&quot;: { # Contains Properties set for the reservation. # Allocation Properties of this reservation.
1292 &quot;sourceInstanceTemplateId&quot;: &quot;A String&quot;, # ID of the instance template used to populate reservation properties.
1293 &quot;utilizations&quot;: { # Per service utilization breakdown. The Key is the Google Cloud managed
1294 # service name.
1295 &quot;a_key&quot;: &quot;A String&quot;,
1296 },
1297 },
1298 },
1299 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
1300 &quot;schedulingType&quot;: &quot;A String&quot;, # The type of maintenance for the reservation.
1301 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined fully-qualified URL for this resource.
1302 &quot;shareSettings&quot;: { # The share setting for reservations and sole tenancy node groups. # Specify share-settings to create a shared reservation. This property is
1303 # optional. For more information about the syntax and options for this
1304 # field and its subfields, see the guide for creating
1305 # a shared reservation.
1306 &quot;projectMap&quot;: { # A map of project id and project config. This is only valid when
1307 # share_type&#x27;s value is SPECIFIC_PROJECTS.
1308 &quot;a_key&quot;: { # Config for each project in the share settings.
1309 &quot;projectId&quot;: &quot;A String&quot;, # The project ID, should be same as the key of this project config in the
1310 # parent map.
1311 },
1312 },
1313 &quot;shareType&quot;: &quot;A String&quot;, # Type of sharing for this shared-reservation
1314 },
1315 &quot;specificReservation&quot;: { # This reservation type allows to pre allocate specific instance # Reservation for instances with specific machine shapes.
1316 # configuration.
1317 &quot;assuredCount&quot;: &quot;A String&quot;, # Output only. [Output Only] Indicates how many instances are actually usable currently.
1318 &quot;count&quot;: &quot;A String&quot;, # Specifies the number of resources that are allocated.
1319 &quot;inUseCount&quot;: &quot;A String&quot;, # Output only. [Output Only] Indicates how many instances are in use.
1320 &quot;instanceProperties&quot;: { # Properties of the SKU instances being reserved. # The instance properties for the reservation.
1321 # Next ID: 10
1322 &quot;guestAccelerators&quot;: [ # Specifies accelerator type and count.
1323 { # A specification of the type and number of accelerator cards attached to the
1324 # instance.
1325 &quot;acceleratorCount&quot;: 42, # The number of the guest accelerator cards exposed to this instance.
1326 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL of the accelerator type resource to attach to this
1327 # instance. For example:projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100
1328 # If you are creating an instance template, specify only the
1329 # accelerator name.
1330 # See GPUs on Compute Engine
1331 # for a full list of accelerator types.
1332 },
1333 ],
1334 &quot;localSsds&quot;: [ # Specifies amount of local ssd to reserve with each instance. The type
1335 # of disk is local-ssd.
1336 {
1337 &quot;diskSizeGb&quot;: &quot;A String&quot;, # Specifies the size of the disk in base-2 GB.
1338 &quot;interface&quot;: &quot;A String&quot;, # Specifies the disk interface to use for attaching this disk, which is
1339 # either SCSI or NVME. The default isSCSI.
1340 # For performance characteristics of SCSI over NVMe, seeLocal SSD performance.
1341 },
1342 ],
1343 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the allocation close to other
1344 # resources.
1345 # This field is for use by internal tools that use the public API.
1346 &quot;machineType&quot;: &quot;A String&quot;, # Specifies type of machine (name only) which has fixed number of vCPUs
1347 # and fixed amount of memory. This also includes specifying custom
1348 # machine type following custom-NUMBER_OF_CPUS-AMOUNT_OF_MEMORY pattern.
1349 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # Minimum cpu platform the reservation.
1350 },
1351 &quot;sourceInstanceTemplate&quot;: &quot;A String&quot;, # Specifies the instance template to create the reservation. If you use
1352 # this field, you must exclude the instanceProperties field.
1353 #
1354 # This field is optional, and it can be a full or partial URL. For example,
1355 # the following are all valid URLs to an instance template:
1356 #
1357 #
1358 # - https://www.googleapis.com/compute/v1/projects/project/global/instanceTemplates/instanceTemplate
1359 # - projects/project/global/instanceTemplates/instanceTemplate
1360 # - global/instanceTemplates/instanceTemplate
1361 },
1362 &quot;specificReservationRequired&quot;: True or False, # Indicates whether the reservation can be consumed by VMs with affinity
1363 # for &quot;any&quot; reservation. If the field is set, then only VMs that target
1364 # the reservation by name can consume from this reservation.
1365 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only] The status of the reservation.
1366 #
1367 #
1368 # - CREATING: Reservation resources are being
1369 # allocated.
1370 # - READY: Reservation resources have been allocated,
1371 # and the reservation is ready for use.
1372 # - DELETING: Reservation deletion is in progress.
1373 # - UPDATING: Reservation update is in progress.
1374 &quot;zone&quot;: &quot;A String&quot;, # Zone in which the reservation resides. A zone must be provided if the
1375 # reservation is created within a commitment.
1376 },
1377 ],
1378 &quot;resourceStatus&quot;: { # [Output Only] Contains output only fields. # Output only. [Output Only] Status information for Commitment resource.
1379 &quot;customTermEligibilityEndTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Indicates the end time of customer&#x27;s eligibility to send
1380 # custom term requests in RFC3339 text format. Term extension requests that
1381 # (not the end time in the request) after this time will be rejected.
1382 },
1383 &quot;resources&quot;: [ # The list of all the hardware resources, with their types and amounts, that
1384 # you want to commit to. Specify as a separate entry in the list for each
1385 # individual resource type.
1386 { # Commitment for a particular hardware resource (a commitment is composed of
1387 # one or more of these).
1388 &quot;acceleratorType&quot;: &quot;A String&quot;, # Name of the accelerator type or GPU resource. Specify this field only when
1389 # the type of hardware resource is ACCELERATOR.
1390 &quot;amount&quot;: &quot;A String&quot;, # The quantity of the hardware resource that you want to commit to purchasing
1391 # (in a type-dependent unit).
1392 #
1393 # - For vCPUs, you must specify an integer value.
1394 # - For memory, you specify the amount of MB that you want. The value you
1395 # specify must be a multiple of 256 MB, with up to 6.5 GB of
1396 # memory per every vCPU.
1397 # - For GPUs, you must specify an integer value.
1398 # - For Local SSD disks, you must specify the amount in GB. The size of a
1399 # single Local SSD disk is 375 GB.
1400 &quot;type&quot;: &quot;A String&quot;, # The type of hardware resource that you want to specify.
1401 # You can specify any of the following values:
1402 #
1403 # - VCPU
1404 # - MEMORY
1405 # - LOCAL_SSD
1406 # - ACCELERATOR
1407 #
1408 #
1409 #
1410 # Specify as a separate entry in the list for each
1411 # individual resource type.
1412 },
1413 ],
1414 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
1415 &quot;splitSourceCommitment&quot;: &quot;A String&quot;, # The source commitment from which you are transferring resources to create
1416 # the new split commitment. For more information, see
1417 # Split commitments.
1418 &quot;startTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Commitment start time inRFC3339
1419 # text format.
1420 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only] Status of the commitment with regards to eventual expiration
1421 # (each commitment has an end date defined). Status can be one of the
1422 # following values: NOT_YET_ACTIVE, ACTIVE, orEXPIRED.
1423 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. [Output Only] An optional, human-readable explanation of the status.
1424 &quot;type&quot;: &quot;A String&quot;, # The type of commitment; specifies the
1425 # machine series for which you want to commit to purchasing resources.
1426 # The choice of machine series affects the discount rate and the eligible
1427 # resource types.
1428 #
1429 # The type must be one of the following:ACCELERATOR_OPTIMIZED, ACCELERATOR_OPTIMIZED_A3,ACCELERATOR_OPTIMIZED_A3_MEGA,COMPUTE_OPTIMIZED, COMPUTE_OPTIMIZED_C2D,
1430 # 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
1431 # example, type MEMORY_OPTIMIZED specifies a commitment that
1432 # applies only to eligible resources of memory optimized M1 and M2 machine
1433 # series. Type GENERAL_PURPOSE specifies a commitment that
1434 # applies only to eligible resources of general purpose N1 machine series.
1435 }
1436
1437 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
1438 that if you must retry your request, the server will know to ignore the
1439 request if it has already been completed.
1440
1441 For example, consider a situation where you make an initial request and
1442 the request times out. If you make the request again with the same
1443 request ID, the server can check if original operation with the same
1444 request ID was received, and if so, will ignore the second request. This
1445 prevents clients from accidentally creating duplicate commitments.
1446
1447 The request ID must be
1448 a valid UUID with the exception that zero UUID is not supported
1449 (00000000-0000-0000-0000-000000000000).
1450 x__xgafv: string, V1 error format.
1451 Allowed values
1452 1 - v1 error format
1453 2 - v2 error format
1454
1455 Returns:
1456 An object of the form:
1457
1458 { # Represents an Operation resource.
1459 #
1460 # Google Compute Engine has three Operation resources:
1461 #
1462 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
1463 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
1464 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
1465 #
1466 # You can use an operation resource to manage asynchronous API requests.
1467 # For more information, readHandling
1468 # API responses.
1469 #
1470 # Operations can be global, regional or zonal.
1471 #
1472 # - For global operations, use the `globalOperations`
1473 # resource.
1474 # - For regional operations, use the
1475 # `regionOperations` resource.
1476 # - For zonal operations, use
1477 # the `zoneOperations` resource.
1478 #
1479 #
1480 #
1481 # For more information, read
1482 # Global, Regional, and Zonal Resources.
1483 #
1484 # Note that completed Operation resources have a limited
1485 # retention period.
1486 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
1487 # Not present otherwise.
1488 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1489 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
1490 # set when the operation is created.
1491 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
1492 # text format.
1493 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
1494 # this field will be populated.
1495 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
1496 # operation.
1497 {
1498 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1499 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
1500 # details. There is a set of defined message types to use for providing
1501 # details.The syntax depends on the error code. For example,
1502 # QuotaExceededInfo will have details when the error code is
1503 # QUOTA_EXCEEDED.
1504 {
1505 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
1506 #
1507 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
1508 # is not enabled:
1509 #
1510 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
1511 # &quot;domain&quot;: &quot;googleapis.com&quot;
1512 # &quot;metadata&quot;: {
1513 # &quot;resource&quot;: &quot;projects/123&quot;,
1514 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
1515 # }
1516 # }
1517 #
1518 # This response indicates that the pubsub.googleapis.com API is not enabled.
1519 #
1520 # Example of an error that is returned when attempting to create a Spanner
1521 # instance in a region that is out of stock:
1522 #
1523 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
1524 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
1525 # &quot;metadata&quot;: {
1526 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
1527 # }
1528 # }
1529 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
1530 # is typically the registered service name of the tool or product that
1531 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
1532 # generated by some common infrastructure, the error domain must be a
1533 # globally unique value that identifies the infrastructure. For Google API
1534 # infrastructure, the error domain is &quot;googleapis.com&quot;.
1535 &quot;metadatas&quot;: { # Additional structured details about this error.
1536 #
1537 # Keys must match a regular expression of `a-z+` but should
1538 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
1539 # length. When identifying the current value of an exceeded limit, the units
1540 # should be contained in the key, not the value. For example, rather than
1541 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1542 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1543 # instances that can be created in a single (batch) request.
1544 &quot;a_key&quot;: &quot;A String&quot;,
1545 },
1546 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1547 # proximate cause of the error. Error reasons are unique within a particular
1548 # domain of errors. This should be at most 63 characters and match a
1549 # regular expression of `A-Z+[A-Z0-9]`, which represents
1550 # UPPER_SNAKE_CASE.
1551 },
1552 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1553 #
1554 # For example, if a quota check failed with an error indicating the calling
1555 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1556 # directly to the right place in the developer console to flip the bit.
1557 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1558 { # Describes a URL link.
1559 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1560 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1561 },
1562 ],
1563 },
1564 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1565 # which can be attached to an RPC error.
1566 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1567 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1568 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1569 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1570 },
1571 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1572 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1573 &quot;a_key&quot;: &quot;A String&quot;,
1574 },
1575 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1576 # type or metric.
1577 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1578 # or metric.
1579 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1580 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1581 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1582 },
1583 },
1584 ],
1585 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1586 # This property is optional.
1587 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1588 },
1589 ],
1590 },
1591 &quot;getVersionOperationMetadata&quot;: {
1592 &quot;inlineSbomInfo&quot;: {
1593 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1594 # appropriate identifiers.
1595 &quot;a_key&quot;: &quot;A String&quot;,
1596 },
1597 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
1598 # identifiers.
1599 &quot;a_key&quot;: &quot;A String&quot;,
1600 },
1601 },
1602 },
1603 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1604 # message that was returned, such as `NOT FOUND`.
1605 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1606 # status code that was returned. For example, a `404` means the
1607 # resource was not found.
1608 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1609 # defined by the server.
1610 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1611 # This value is inRFC3339
1612 # text format.
1613 &quot;instancesBulkInsertOperationMetadata&quot;: {
1614 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1615 # Example key: zones/us-central1-a
1616 &quot;a_key&quot;: {
1617 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1618 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1619 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1620 # error.
1621 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1622 # if the flow is rolling forward or rolling back.
1623 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1624 },
1625 },
1626 },
1627 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1628 # Operation resources.
1629 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1630 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1631 # group of operations results from a `bulkInsert` API request.
1632 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1633 # `update`, or `delete`, and so on.
1634 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1635 # There is no requirement that this be linear or support any granularity of
1636 # operations. This should not be used to guess when the operation will be
1637 # complete. This number should monotonically increase as the operation
1638 # progresses.
1639 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1640 # applicable when performing regional operations.
1641 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1642 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1643 # this field will contain information on all underlying zonal actions and
1644 # their state.
1645 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1646 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1647 # Example key: zones/us-central1-a
1648 &quot;a_key&quot;: {
1649 &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
1650 # populated.
1651 # different programming environments, including REST APIs and RPC APIs. It is
1652 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1653 # three pieces of data: error code, error message, and error details.
1654 #
1655 # You can find out more about this error model and how to work with it in the
1656 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1657 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1658 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1659 # message types for APIs to use.
1660 {
1661 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1662 },
1663 ],
1664 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1665 # user-facing error message should be localized and sent in the
1666 # google.rpc.Status.details field, or localized by the client.
1667 },
1668 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1669 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1670 },
1671 },
1672 },
1673 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1674 # This value is inRFC3339
1675 # text format.
1676 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1677 # following:
1678 # `PENDING`, `RUNNING`, or `DONE`.
1679 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1680 # operation.
1681 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1682 # of the target resource.
1683 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1684 # operations related to creating a snapshot, this points to the disk
1685 # that the snapshot was created from.
1686 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1687 # `[email protected]` or
1688 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1689 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1690 # operation, this field will be populated.
1691 {
1692 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1693 # Engine returns NO_RESULTS_ON_PAGE if there
1694 # are no results in the response.
1695 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1696 # value format. For example:
1697 #
1698 # &quot;data&quot;: [
1699 # {
1700 # &quot;key&quot;: &quot;scope&quot;,
1701 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1702 # }
1703 {
1704 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1705 # returned. For example, for warnings where there are no results in a list
1706 # request for a particular zone, this key might be scope and
1707 # the key value might be the zone name. Other examples might be a key
1708 # indicating a deprecated resource and a suggested replacement, or a
1709 # warning about invalid network settings (for example, if an instance
1710 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1711 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1712 },
1713 ],
1714 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1715 },
1716 ],
1717 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1718 # applicable when performing per-zone operations.
1719 }</pre>
1720 </div>
1721
1722 <div class="method">
1723 <code class="details" id="list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
1724 <pre>Retrieves a list of commitments contained within
1725 the specified region.
1726
1727 Args:
1728 project: string, Project ID for this request. (required)
1729 region: string, Name of the region for this request. (required)
1730 filter: string, A filter expression that filters resources listed in the response. Most
1731 Compute resources support two types of filter expressions:
1732 expressions that support regular expressions and expressions that follow
1733 API improvement proposal AIP-160.
1734 These two types of filter expressions cannot be mixed in one request.
1735
1736 If you want to use AIP-160, your expression must specify the field name, an
1737 operator, and the value that you want to use for filtering. The value
1738 must be a string, a number, or a boolean. The operator
1739 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
1740
1741 For example, if you are filtering Compute Engine instances, you can
1742 exclude instances named `example-instance` by specifying
1743 `name != example-instance`.
1744
1745 The `:*` comparison can be used to test whether a key has been defined.
1746 For example, to find all objects with `owner` label use:
1747 ```
1748 labels.owner:*
1749 ```
1750
1751 You can also filter nested fields. For example, you could specify
1752 `scheduling.automaticRestart = false` to include instances only
1753 if they are not scheduled for automatic restarts. You can use filtering
1754 on nested fields to filter based onresource labels.
1755
1756 To filter on multiple expressions, provide each separate expression within
1757 parentheses. For example:
1758 ```
1759 (scheduling.automaticRestart = true)
1760 (cpuPlatform = &quot;Intel Skylake&quot;)
1761 ```
1762 By default, each expression is an `AND` expression. However, you
1763 can include `AND` and `OR` expressions explicitly.
1764 For example:
1765 ```
1766 (cpuPlatform = &quot;Intel Skylake&quot;) OR
1767 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
1768 (scheduling.automaticRestart = true)
1769 ```
1770
1771 If you want to use a regular expression, use the `eq` (equal) or `ne`
1772 (not equal) operator against a single un-parenthesized expression with or
1773 without quotes or against multiple parenthesized expressions. Examples:
1774
1775 `fieldname eq unquoted literal`
1776 `fieldname eq &#x27;single quoted literal&#x27;`
1777 `fieldname eq &quot;double quoted literal&quot;`
1778 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
1779
1780 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
1781 The literal value must match the entire field.
1782
1783 For example, to filter for instances that do not end with name &quot;instance&quot;,
1784 you would use `name ne .*instance`.
1785
1786 You cannot combine constraints on multiple fields using regular
1787 expressions.
1788 maxResults: integer, The maximum number of results per page that should be returned.
1789 If the number of available results is larger than `maxResults`,
1790 Compute Engine returns a `nextPageToken` that can be used to get
1791 the next page of results in subsequent list requests. Acceptable values are
1792 `0` to `500`, inclusive. (Default: `500`)
1793 orderBy: string, Sorts list results by a certain order. By default, results
1794 are returned in alphanumerical order based on the resource name.
1795
1796 You can also sort results in descending order based on the creation
1797 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
1798 results based on the `creationTimestamp` field in
1799 reverse chronological order (newest result first). Use this to sort
1800 resources like operations so that the newest operation is returned first.
1801
1802 Currently, only sorting by `name` or
1803 `creationTimestamp desc` is supported.
1804 pageToken: string, Specifies a page token to use. Set `pageToken` to the
1805 `nextPageToken` returned by a previous list request to get
1806 the next page of results.
1807 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
1808 of failure. The default value is false.
1809
1810 For example, when partial success behavior is enabled, aggregatedList for a
1811 single zone scope either returns all resources in the zone or no resources,
1812 with an error code.
1813 x__xgafv: string, V1 error format.
1814 Allowed values
1815 1 - v1 error format
1816 2 - v2 error format
1817
1818 Returns:
1819 An object of the form:
1820
1821 { # Contains a list of Commitment resources.
1822 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
1823 &quot;items&quot;: [ # A list of Commitment resources.
1824 { # Represents a regional resource-based commitment resource.
1825 #
1826 # Creating this commitment resource means that you are purchasing a
1827 # resource-based committed use contract, with an explicit start and end time.
1828 # You can purchase resource-based commitments for both hardware and software
1829 # resources. For more information, read
1830 # Resource-based committed use discounts
1831 &quot;autoRenew&quot;: True or False, # Specifies whether to automatically renew the commitment at the end of its
1832 # current term. The default value is false. If you set the field
1833 # to true, each time your commitment reaches the end of its
1834 # term, Compute Engine automatically renews it for another term. You can
1835 # update this field anytime before the commitment expires. For example, if
1836 # the commitment is set to expire at 12 AM UTC-8 on January 3, 2027, you can
1837 # update this field until 11:59 PM UTC-8 on January 2, 2027.
1838 &quot;category&quot;: &quot;A String&quot;, # The category of the commitment; specifies whether the commitment is for
1839 # hardware or software resources. Category MACHINE specifies
1840 # that you are committing to hardware machine resources such asVCPU or MEMORY, listed in resources.
1841 # Category LICENSE specifies that you are committing to software
1842 # licenses, listed in licenseResources.
1843 # Note that if you specify MACHINE commitments, then you must
1844 # also specify a type to indicate the machine series of the
1845 # hardware resource that you are committing to.
1846 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
1847 # text format.
1848 &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
1849 # commitment&#x27;s end date is later than the start date + term duration.
1850 &quot;description&quot;: &quot;A String&quot;, # An optional description of the commitment. You can provide this property
1851 # when you create the resource.
1852 &quot;endTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Commitment end time inRFC3339
1853 # text format.
1854 &quot;existingReservations&quot;: [
1855 &quot;A String&quot;,
1856 ],
1857 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
1858 # defined by the server.
1859 &quot;kind&quot;: &quot;compute#commitment&quot;, # Output only. [Output Only] Type of the resource. Always compute#commitment
1860 # for commitments.
1861 &quot;licenseResource&quot;: { # Commitment for a particular license resource. # The license specification required as part of a license commitment.
1862 &quot;amount&quot;: &quot;A String&quot;, # The number of licenses you plan to purchase.
1863 &quot;coresPerLicense&quot;: &quot;A String&quot;, # The number of cores per license.
1864 &quot;license&quot;: &quot;A String&quot;, # The applicable license URI.
1865 },
1866 &quot;mergeSourceCommitments&quot;: [ # The list of source commitments that you are merging to create the new
1867 # merged commitment. For more information, see
1868 # Merging commitments.
1869 &quot;A String&quot;,
1870 ],
1871 &quot;name&quot;: &quot;A String&quot;, # Name of the commitment. You must specify a name when you purchase the
1872 # commitment. The name must be 1-63 characters long, and comply withRFC1035.
1873 # Specifically, the name must be 1-63 characters long and match the regular
1874 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
1875 # character must be a lowercase letter, and all following characters must
1876 # be a dash, lowercase letter, or digit, except the last character, which
1877 # cannot be a dash.
1878 &quot;params&quot;: { # Additional commitment params. # Input only. Additional params passed with the request, but not persisted
1879 # as part of resource payload.
1880 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the commitment. Tag keys and
1881 # values have the same definition as resource
1882 # manager tags. Keys and values can be either in numeric format,
1883 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
1884 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
1885 # `{tag_value_short_name}`. The field is ignored (both PUT &amp;
1886 # PATCH) when empty.
1887 &quot;a_key&quot;: &quot;A String&quot;,
1888 },
1889 },
1890 &quot;plan&quot;: &quot;A String&quot;, # The minimum time duration that you commit to purchasing resources.
1891 # The plan that you choose determines the preset term length of the
1892 # commitment (which is 1 year or 3 years) and affects the discount rate that
1893 # you receive for your resources. Committing to a longer time duration
1894 # typically gives you a higher discount rate. The supported values for this
1895 # field are TWELVE_MONTH (1 year), andTHIRTY_SIX_MONTH (3 years).
1896 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the commitment and committed
1897 # resources are located.
1898 &quot;reservations&quot;: [ # The list of new reservations that you want to create and attach to this
1899 # commitment.
1900 #
1901 # You must attach reservations to your commitment if your commitment
1902 # specifies any GPUs or Local SSD disks. For more information, see
1903 # Attach reservations to resource-based commitments.
1904 #
1905 # Specify this property only if you want to create new
1906 # reservations to attach. To attach existing reservations, specify theexistingReservations property instead.
1907 { # Represents a reservation resource. A reservation ensures that capacity is
1908 # held in a specific zone even if the reserved VMs are not running. For more
1909 # information, read Reserving zonal
1910 # resources.
1911 &quot;advancedDeploymentControl&quot;: { # Advance control for cluster management, applicable only to DENSE deployment # Advanced control for cluster management, applicable only to DENSE
1912 # deployment type reservations.
1913 # type reservations.
1914 &quot;reservationOperationalMode&quot;: &quot;A String&quot;, # Indicates chosen reservation operational mode for the reservation.
1915 },
1916 &quot;aggregateReservation&quot;: { # This reservation type is specified by total resource amounts (e.g. total # Reservation for aggregated resources, providing shape flexibility.
1917 # count of CPUs) and can account for multiple instance SKUs. In other words,
1918 # one can create instances of varying shapes against this reservation.
1919 &quot;inUseResources&quot;: [ # Output only. [Output only] List of resources currently in use.
1920 {
1921 &quot;accelerator&quot;: { # Properties of accelerator resources in this reservation.
1922 &quot;acceleratorCount&quot;: 42, # Number of accelerators of specified type.
1923 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL to accelerator type. e.g.
1924 # &quot;projects/{PROJECT}/zones/{ZONE}/acceleratorTypes/ct4l&quot;
1925 },
1926 },
1927 ],
1928 &quot;reservedResources&quot;: [ # List of reserved resources (CPUs, memory, accelerators).
1929 {
1930 &quot;accelerator&quot;: { # Properties of accelerator resources in this reservation.
1931 &quot;acceleratorCount&quot;: 42, # Number of accelerators of specified type.
1932 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL to accelerator type. e.g.
1933 # &quot;projects/{PROJECT}/zones/{ZONE}/acceleratorTypes/ct4l&quot;
1934 },
1935 },
1936 ],
1937 &quot;vmFamily&quot;: &quot;A String&quot;, # The VM family that all instances scheduled against this reservation must
1938 # belong to.
1939 &quot;workloadType&quot;: &quot;A String&quot;, # The workload type of the instances that will target this reservation.
1940 },
1941 &quot;commitment&quot;: &quot;A String&quot;, # Output only. [Output Only] Full or partial URL to a parent commitment. This field
1942 # displays for reservations that are tied to a commitment.
1943 &quot;confidentialComputeType&quot;: &quot;A String&quot;,
1944 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
1945 # text format.
1946 &quot;deleteAfterDuration&quot;: { # A Duration represents a fixed-length span of time represented # Duration time relative to reservation creation when Compute Engine will
1947 # automatically delete this resource.
1948 # as a count of seconds and fractions of seconds at nanosecond
1949 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
1950 # or &quot;month&quot;. Range is approximately 10,000 years.
1951 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
1952 # Durations less than one second are represented with a 0
1953 # `seconds` field and a positive `nanos` field. Must be from 0
1954 # to 999,999,999 inclusive.
1955 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
1956 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
1957 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
1958 },
1959 &quot;deleteAtTime&quot;: &quot;A String&quot;, # Absolute time in future when the reservation will be
1960 # auto-deleted by Compute Engine. Timestamp is represented inRFC3339 text format.
1961 &quot;deploymentType&quot;: &quot;A String&quot;, # Specifies the deployment strategy for this reservation.
1962 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
1963 # create the resource.
1964 &quot;earlyAccessMaintenance&quot;: &quot;A String&quot;, # Indicates the early access maintenance for the reservation.
1965 # If this field is absent or set to NO_EARLY_ACCESS, the reservation is not
1966 # enrolled in early access maintenance and the standard notice applies.
1967 &quot;enableEmergentMaintenance&quot;: True or False, # Indicates whether Compute Engine allows unplanned maintenance for your VMs;
1968 # for example, to fix hardware errors.
1969 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
1970 # defined by the server.
1971 &quot;kind&quot;: &quot;compute#reservation&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#reservations for reservations.
1972 &quot;linkedCommitments&quot;: [ # Output only. [Output Only] Full or partial URL to parent commitments. This field
1973 # displays for reservations that are tied to multiple commitments.
1974 &quot;A String&quot;,
1975 ],
1976 &quot;name&quot;: &quot;A String&quot;, # The name of the resource, provided by the client when initially creating
1977 # the resource. The resource name must be 1-63 characters long, and comply
1978 # withRFC1035.
1979 # Specifically, the name must be 1-63 characters long and match the regular
1980 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
1981 # character must be a lowercase letter, and all following characters must be
1982 # a dash, lowercase letter, or digit, except the last character, which cannot
1983 # be a dash.
1984 &quot;params&quot;: { # Additional reservation params. # Input only. Additional params passed with the request, but not persisted
1985 # as part of resource payload.
1986 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the reservation. Tag keys and
1987 # values have the same definition as resource
1988 # manager tags. Keys and values can be either in numeric format,
1989 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
1990 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
1991 # `{tag_value_short_name}`. The field is ignored (both PUT &amp;
1992 # PATCH) when empty.
1993 &quot;a_key&quot;: &quot;A String&quot;,
1994 },
1995 },
1996 &quot;protectionTier&quot;: &quot;A String&quot;, # Protection tier for the workload which specifies the workload expectations
1997 # in the event of infrastructure failures at data center (e.g. power
1998 # and/or cooling failures).
1999 &quot;reservationSharingPolicy&quot;: { # Specify the reservation sharing policy. If unspecified, the reservation
2000 # will not be shared with Google Cloud managed services.
2001 &quot;serviceShareType&quot;: &quot;A String&quot;, # Sharing config for all Google Cloud services.
2002 },
2003 &quot;resourcePolicies&quot;: { # Resource policies to be added to this reservation. The key is defined by
2004 # user, and the value is resource policy url. This is to define placement
2005 # policy with reservation.
2006 &quot;a_key&quot;: &quot;A String&quot;,
2007 },
2008 &quot;resourceStatus&quot;: { # [Output Only] Contains output only fields. # Output only. [Output Only] Status information for Reservation resource.
2009 &quot;healthInfo&quot;: { # Health information for the reservation. # [Output only] Health information for the reservation.
2010 &quot;degradedBlockCount&quot;: 42, # The number of reservation blocks that are degraded.
2011 &quot;healthStatus&quot;: &quot;A String&quot;, # The health status of the reservation.
2012 &quot;healthyBlockCount&quot;: 42, # The number of reservation blocks that are healthy.
2013 },
2014 &quot;reservationBlockCount&quot;: 42, # The number of reservation blocks associated with this reservation.
2015 &quot;reservationMaintenance&quot;: { # Maintenance Info for ReservationBlocks. # Maintenance information for this reservation
2016 &quot;instanceMaintenanceOngoingCount&quot;: 42, # Describes number of instances that have ongoing maintenance.
2017 &quot;instanceMaintenancePendingCount&quot;: 42, # Describes number of instances that have pending maintenance.
2018 &quot;maintenanceOngoingCount&quot;: 42, # Progress for ongoing maintenance for this group of VMs/hosts.
2019 # Describes number of hosts in the block that have ongoing maintenance.
2020 &quot;maintenancePendingCount&quot;: 42, # Progress for ongoing maintenance for this group of VMs/hosts.
2021 # Describes number of hosts in the block that have pending maintenance.
2022 &quot;schedulingType&quot;: &quot;A String&quot;, # The type of maintenance for the reservation.
2023 &quot;subblockInfraMaintenanceOngoingCount&quot;: 42, # Describes number of subblock Infrastructure that has ongoing maintenance.
2024 # Here, Subblock Infrastructure Maintenance pertains to upstream hardware
2025 # contained in the Subblock that is necessary for a VM Family(e.g. NVLink
2026 # Domains). Not all VM Families will support this field.
2027 &quot;subblockInfraMaintenancePendingCount&quot;: 42, # Describes number of subblock Infrastructure that has pending maintenance.
2028 # Here, Subblock Infrastructure Maintenance pertains to upstream hardware
2029 # contained in the Subblock that is necessary for a VM Family (e.g. NVLink
2030 # Domains). Not all VM Families will support this field.
2031 &quot;upcomingGroupMaintenance&quot;: { # Upcoming Maintenance notification information. # Maintenance information on this group of VMs.
2032 &quot;canReschedule&quot;: True or False, # Indicates if the maintenance can be customer triggered.
2033 &quot;latestWindowStartTime&quot;: &quot;A String&quot;, # The latest time for the planned maintenance window to start.
2034 # This timestamp value is in RFC3339 text format.
2035 &quot;maintenanceOnShutdown&quot;: True or False, # Indicates whether the UpcomingMaintenance will be triggered on VM shutdown.
2036 &quot;maintenanceReasons&quot;: [ # The reasons for the maintenance. Only valid for vms.
2037 &quot;A String&quot;,
2038 ],
2039 &quot;maintenanceStatus&quot;: &quot;A String&quot;,
2040 &quot;type&quot;: &quot;A String&quot;, # Defines the type of maintenance.
2041 &quot;windowEndTime&quot;: &quot;A String&quot;, # The time by which the maintenance disruption will be completed.
2042 # This timestamp value is in RFC3339 text format.
2043 &quot;windowStartTime&quot;: &quot;A String&quot;, # The current start time of the maintenance window.
2044 # This timestamp value is in RFC3339 text format.
2045 },
2046 },
2047 &quot;specificSkuAllocation&quot;: { # Contains Properties set for the reservation. # Allocation Properties of this reservation.
2048 &quot;sourceInstanceTemplateId&quot;: &quot;A String&quot;, # ID of the instance template used to populate reservation properties.
2049 &quot;utilizations&quot;: { # Per service utilization breakdown. The Key is the Google Cloud managed
2050 # service name.
2051 &quot;a_key&quot;: &quot;A String&quot;,
2052 },
2053 },
2054 },
2055 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
2056 &quot;schedulingType&quot;: &quot;A String&quot;, # The type of maintenance for the reservation.
2057 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined fully-qualified URL for this resource.
2058 &quot;shareSettings&quot;: { # The share setting for reservations and sole tenancy node groups. # Specify share-settings to create a shared reservation. This property is
2059 # optional. For more information about the syntax and options for this
2060 # field and its subfields, see the guide for creating
2061 # a shared reservation.
2062 &quot;projectMap&quot;: { # A map of project id and project config. This is only valid when
2063 # share_type&#x27;s value is SPECIFIC_PROJECTS.
2064 &quot;a_key&quot;: { # Config for each project in the share settings.
2065 &quot;projectId&quot;: &quot;A String&quot;, # The project ID, should be same as the key of this project config in the
2066 # parent map.
2067 },
2068 },
2069 &quot;shareType&quot;: &quot;A String&quot;, # Type of sharing for this shared-reservation
2070 },
2071 &quot;specificReservation&quot;: { # This reservation type allows to pre allocate specific instance # Reservation for instances with specific machine shapes.
2072 # configuration.
2073 &quot;assuredCount&quot;: &quot;A String&quot;, # Output only. [Output Only] Indicates how many instances are actually usable currently.
2074 &quot;count&quot;: &quot;A String&quot;, # Specifies the number of resources that are allocated.
2075 &quot;inUseCount&quot;: &quot;A String&quot;, # Output only. [Output Only] Indicates how many instances are in use.
2076 &quot;instanceProperties&quot;: { # Properties of the SKU instances being reserved. # The instance properties for the reservation.
2077 # Next ID: 10
2078 &quot;guestAccelerators&quot;: [ # Specifies accelerator type and count.
2079 { # A specification of the type and number of accelerator cards attached to the
2080 # instance.
2081 &quot;acceleratorCount&quot;: 42, # The number of the guest accelerator cards exposed to this instance.
2082 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL of the accelerator type resource to attach to this
2083 # instance. For example:projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100
2084 # If you are creating an instance template, specify only the
2085 # accelerator name.
2086 # See GPUs on Compute Engine
2087 # for a full list of accelerator types.
2088 },
2089 ],
2090 &quot;localSsds&quot;: [ # Specifies amount of local ssd to reserve with each instance. The type
2091 # of disk is local-ssd.
2092 {
2093 &quot;diskSizeGb&quot;: &quot;A String&quot;, # Specifies the size of the disk in base-2 GB.
2094 &quot;interface&quot;: &quot;A String&quot;, # Specifies the disk interface to use for attaching this disk, which is
2095 # either SCSI or NVME. The default isSCSI.
2096 # For performance characteristics of SCSI over NVMe, seeLocal SSD performance.
2097 },
2098 ],
2099 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the allocation close to other
2100 # resources.
2101 # This field is for use by internal tools that use the public API.
2102 &quot;machineType&quot;: &quot;A String&quot;, # Specifies type of machine (name only) which has fixed number of vCPUs
2103 # and fixed amount of memory. This also includes specifying custom
2104 # machine type following custom-NUMBER_OF_CPUS-AMOUNT_OF_MEMORY pattern.
2105 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # Minimum cpu platform the reservation.
2106 },
2107 &quot;sourceInstanceTemplate&quot;: &quot;A String&quot;, # Specifies the instance template to create the reservation. If you use
2108 # this field, you must exclude the instanceProperties field.
2109 #
2110 # This field is optional, and it can be a full or partial URL. For example,
2111 # the following are all valid URLs to an instance template:
2112 #
2113 #
2114 # - https://www.googleapis.com/compute/v1/projects/project/global/instanceTemplates/instanceTemplate
2115 # - projects/project/global/instanceTemplates/instanceTemplate
2116 # - global/instanceTemplates/instanceTemplate
2117 },
2118 &quot;specificReservationRequired&quot;: True or False, # Indicates whether the reservation can be consumed by VMs with affinity
2119 # for &quot;any&quot; reservation. If the field is set, then only VMs that target
2120 # the reservation by name can consume from this reservation.
2121 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only] The status of the reservation.
2122 #
2123 #
2124 # - CREATING: Reservation resources are being
2125 # allocated.
2126 # - READY: Reservation resources have been allocated,
2127 # and the reservation is ready for use.
2128 # - DELETING: Reservation deletion is in progress.
2129 # - UPDATING: Reservation update is in progress.
2130 &quot;zone&quot;: &quot;A String&quot;, # Zone in which the reservation resides. A zone must be provided if the
2131 # reservation is created within a commitment.
2132 },
2133 ],
2134 &quot;resourceStatus&quot;: { # [Output Only] Contains output only fields. # Output only. [Output Only] Status information for Commitment resource.
2135 &quot;customTermEligibilityEndTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Indicates the end time of customer&#x27;s eligibility to send
2136 # custom term requests in RFC3339 text format. Term extension requests that
2137 # (not the end time in the request) after this time will be rejected.
2138 },
2139 &quot;resources&quot;: [ # The list of all the hardware resources, with their types and amounts, that
2140 # you want to commit to. Specify as a separate entry in the list for each
2141 # individual resource type.
2142 { # Commitment for a particular hardware resource (a commitment is composed of
2143 # one or more of these).
2144 &quot;acceleratorType&quot;: &quot;A String&quot;, # Name of the accelerator type or GPU resource. Specify this field only when
2145 # the type of hardware resource is ACCELERATOR.
2146 &quot;amount&quot;: &quot;A String&quot;, # The quantity of the hardware resource that you want to commit to purchasing
2147 # (in a type-dependent unit).
2148 #
2149 # - For vCPUs, you must specify an integer value.
2150 # - For memory, you specify the amount of MB that you want. The value you
2151 # specify must be a multiple of 256 MB, with up to 6.5 GB of
2152 # memory per every vCPU.
2153 # - For GPUs, you must specify an integer value.
2154 # - For Local SSD disks, you must specify the amount in GB. The size of a
2155 # single Local SSD disk is 375 GB.
2156 &quot;type&quot;: &quot;A String&quot;, # The type of hardware resource that you want to specify.
2157 # You can specify any of the following values:
2158 #
2159 # - VCPU
2160 # - MEMORY
2161 # - LOCAL_SSD
2162 # - ACCELERATOR
2163 #
2164 #
2165 #
2166 # Specify as a separate entry in the list for each
2167 # individual resource type.
2168 },
2169 ],
2170 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
2171 &quot;splitSourceCommitment&quot;: &quot;A String&quot;, # The source commitment from which you are transferring resources to create
2172 # the new split commitment. For more information, see
2173 # Split commitments.
2174 &quot;startTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Commitment start time inRFC3339
2175 # text format.
2176 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only] Status of the commitment with regards to eventual expiration
2177 # (each commitment has an end date defined). Status can be one of the
2178 # following values: NOT_YET_ACTIVE, ACTIVE, orEXPIRED.
2179 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. [Output Only] An optional, human-readable explanation of the status.
2180 &quot;type&quot;: &quot;A String&quot;, # The type of commitment; specifies the
2181 # machine series for which you want to commit to purchasing resources.
2182 # The choice of machine series affects the discount rate and the eligible
2183 # resource types.
2184 #
2185 # The type must be one of the following:ACCELERATOR_OPTIMIZED, ACCELERATOR_OPTIMIZED_A3,ACCELERATOR_OPTIMIZED_A3_MEGA,COMPUTE_OPTIMIZED, COMPUTE_OPTIMIZED_C2D,
2186 # 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
2187 # example, type MEMORY_OPTIMIZED specifies a commitment that
2188 # applies only to eligible resources of memory optimized M1 and M2 machine
2189 # series. Type GENERAL_PURPOSE specifies a commitment that
2190 # applies only to eligible resources of general purpose N1 machine series.
2191 },
2192 ],
2193 &quot;kind&quot;: &quot;compute#commitmentList&quot;, # Output only. [Output Only] Type of resource. Always compute#commitmentList
2194 # for lists of commitments.
2195 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
2196 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
2197 # the query parameter pageToken in the next list request.
2198 # Subsequent list requests will have their own nextPageToken to
2199 # continue paging through the results.
2200 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
2201 &quot;warning&quot;: { # [Output Only] Informational warning message.
2202 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2203 # Engine returns NO_RESULTS_ON_PAGE if there
2204 # are no results in the response.
2205 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2206 # value format. For example:
2207 #
2208 # &quot;data&quot;: [
2209 # {
2210 # &quot;key&quot;: &quot;scope&quot;,
2211 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2212 # }
2213 {
2214 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2215 # returned. For example, for warnings where there are no results in a list
2216 # request for a particular zone, this key might be scope and
2217 # the key value might be the zone name. Other examples might be a key
2218 # indicating a deprecated resource and a suggested replacement, or a
2219 # warning about invalid network settings (for example, if an instance
2220 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2221 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2222 },
2223 ],
2224 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2225 },
2226 }</pre>
2227 </div>
2228
2229 <div class="method">
2230 <code class="details" id="list_next">list_next()</code>
2231 <pre>Retrieves the next page of results.
2232
2233 Args:
2234 previous_request: The request for the previous page. (required)
2235 previous_response: The response from the request for the previous page. (required)
2236
2237 Returns:
2238 A request object that you can call &#x27;execute()&#x27; on to request the next
2239 page. Returns None if there are no more items in the collection.
2240 </pre>
2241 </div>
2242
2243 <div class="method">
2244 <code class="details" id="update">update(project, region, commitment, body=None, paths=None, requestId=None, updateMask=None, x__xgafv=None)</code>
2245 <pre>Updates the specified commitment with the data included in the request.
2246 Update is performed only on selected fields included as part of
2247 update-mask. Only the following fields can be updated: auto_renew and plan.
2248
2249 Args:
2250 project: string, Project ID for this request. (required)
2251 region: string, Name of the region for this request. (required)
2252 commitment: string, Name of the commitment that you want to update. (required)
2253 body: object, The request body.
2254 The object takes the form of:
2255
2256 { # Represents a regional resource-based commitment resource.
2257 #
2258 # Creating this commitment resource means that you are purchasing a
2259 # resource-based committed use contract, with an explicit start and end time.
2260 # You can purchase resource-based commitments for both hardware and software
2261 # resources. For more information, read
2262 # Resource-based committed use discounts
2263 &quot;autoRenew&quot;: True or False, # Specifies whether to automatically renew the commitment at the end of its
2264 # current term. The default value is false. If you set the field
2265 # to true, each time your commitment reaches the end of its
2266 # term, Compute Engine automatically renews it for another term. You can
2267 # update this field anytime before the commitment expires. For example, if
2268 # the commitment is set to expire at 12 AM UTC-8 on January 3, 2027, you can
2269 # update this field until 11:59 PM UTC-8 on January 2, 2027.
2270 &quot;category&quot;: &quot;A String&quot;, # The category of the commitment; specifies whether the commitment is for
2271 # hardware or software resources. Category MACHINE specifies
2272 # that you are committing to hardware machine resources such asVCPU or MEMORY, listed in resources.
2273 # Category LICENSE specifies that you are committing to software
2274 # licenses, listed in licenseResources.
2275 # Note that if you specify MACHINE commitments, then you must
2276 # also specify a type to indicate the machine series of the
2277 # hardware resource that you are committing to.
2278 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
2279 # text format.
2280 &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
2281 # commitment&#x27;s end date is later than the start date + term duration.
2282 &quot;description&quot;: &quot;A String&quot;, # An optional description of the commitment. You can provide this property
2283 # when you create the resource.
2284 &quot;endTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Commitment end time inRFC3339
2285 # text format.
2286 &quot;existingReservations&quot;: [
2287 &quot;A String&quot;,
2288 ],
2289 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
2290 # defined by the server.
2291 &quot;kind&quot;: &quot;compute#commitment&quot;, # Output only. [Output Only] Type of the resource. Always compute#commitment
2292 # for commitments.
2293 &quot;licenseResource&quot;: { # Commitment for a particular license resource. # The license specification required as part of a license commitment.
2294 &quot;amount&quot;: &quot;A String&quot;, # The number of licenses you plan to purchase.
2295 &quot;coresPerLicense&quot;: &quot;A String&quot;, # The number of cores per license.
2296 &quot;license&quot;: &quot;A String&quot;, # The applicable license URI.
2297 },
2298 &quot;mergeSourceCommitments&quot;: [ # The list of source commitments that you are merging to create the new
2299 # merged commitment. For more information, see
2300 # Merging commitments.
2301 &quot;A String&quot;,
2302 ],
2303 &quot;name&quot;: &quot;A String&quot;, # Name of the commitment. You must specify a name when you purchase the
2304 # commitment. The name must be 1-63 characters long, and comply withRFC1035.
2305 # Specifically, the name must be 1-63 characters long and match the regular
2306 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
2307 # character must be a lowercase letter, and all following characters must
2308 # be a dash, lowercase letter, or digit, except the last character, which
2309 # cannot be a dash.
2310 &quot;params&quot;: { # Additional commitment params. # Input only. Additional params passed with the request, but not persisted
2311 # as part of resource payload.
2312 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the commitment. Tag keys and
2313 # values have the same definition as resource
2314 # manager tags. Keys and values can be either in numeric format,
2315 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
2316 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
2317 # `{tag_value_short_name}`. The field is ignored (both PUT &amp;
2318 # PATCH) when empty.
2319 &quot;a_key&quot;: &quot;A String&quot;,
2320 },
2321 },
2322 &quot;plan&quot;: &quot;A String&quot;, # The minimum time duration that you commit to purchasing resources.
2323 # The plan that you choose determines the preset term length of the
2324 # commitment (which is 1 year or 3 years) and affects the discount rate that
2325 # you receive for your resources. Committing to a longer time duration
2326 # typically gives you a higher discount rate. The supported values for this
2327 # field are TWELVE_MONTH (1 year), andTHIRTY_SIX_MONTH (3 years).
2328 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the commitment and committed
2329 # resources are located.
2330 &quot;reservations&quot;: [ # The list of new reservations that you want to create and attach to this
2331 # commitment.
2332 #
2333 # You must attach reservations to your commitment if your commitment
2334 # specifies any GPUs or Local SSD disks. For more information, see
2335 # Attach reservations to resource-based commitments.
2336 #
2337 # Specify this property only if you want to create new
2338 # reservations to attach. To attach existing reservations, specify theexistingReservations property instead.
2339 { # Represents a reservation resource. A reservation ensures that capacity is
2340 # held in a specific zone even if the reserved VMs are not running. For more
2341 # information, read Reserving zonal
2342 # resources.
2343 &quot;advancedDeploymentControl&quot;: { # Advance control for cluster management, applicable only to DENSE deployment # Advanced control for cluster management, applicable only to DENSE
2344 # deployment type reservations.
2345 # type reservations.
2346 &quot;reservationOperationalMode&quot;: &quot;A String&quot;, # Indicates chosen reservation operational mode for the reservation.
2347 },
2348 &quot;aggregateReservation&quot;: { # This reservation type is specified by total resource amounts (e.g. total # Reservation for aggregated resources, providing shape flexibility.
2349 # count of CPUs) and can account for multiple instance SKUs. In other words,
2350 # one can create instances of varying shapes against this reservation.
2351 &quot;inUseResources&quot;: [ # Output only. [Output only] List of resources currently in use.
2352 {
2353 &quot;accelerator&quot;: { # Properties of accelerator resources in this reservation.
2354 &quot;acceleratorCount&quot;: 42, # Number of accelerators of specified type.
2355 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL to accelerator type. e.g.
2356 # &quot;projects/{PROJECT}/zones/{ZONE}/acceleratorTypes/ct4l&quot;
2357 },
2358 },
2359 ],
2360 &quot;reservedResources&quot;: [ # List of reserved resources (CPUs, memory, accelerators).
2361 {
2362 &quot;accelerator&quot;: { # Properties of accelerator resources in this reservation.
2363 &quot;acceleratorCount&quot;: 42, # Number of accelerators of specified type.
2364 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL to accelerator type. e.g.
2365 # &quot;projects/{PROJECT}/zones/{ZONE}/acceleratorTypes/ct4l&quot;
2366 },
2367 },
2368 ],
2369 &quot;vmFamily&quot;: &quot;A String&quot;, # The VM family that all instances scheduled against this reservation must
2370 # belong to.
2371 &quot;workloadType&quot;: &quot;A String&quot;, # The workload type of the instances that will target this reservation.
2372 },
2373 &quot;commitment&quot;: &quot;A String&quot;, # Output only. [Output Only] Full or partial URL to a parent commitment. This field
2374 # displays for reservations that are tied to a commitment.
2375 &quot;confidentialComputeType&quot;: &quot;A String&quot;,
2376 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
2377 # text format.
2378 &quot;deleteAfterDuration&quot;: { # A Duration represents a fixed-length span of time represented # Duration time relative to reservation creation when Compute Engine will
2379 # automatically delete this resource.
2380 # as a count of seconds and fractions of seconds at nanosecond
2381 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
2382 # or &quot;month&quot;. Range is approximately 10,000 years.
2383 &quot;nanos&quot;: 42, # Span of time that&#x27;s a fraction of a second at nanosecond resolution.
2384 # Durations less than one second are represented with a 0
2385 # `seconds` field and a positive `nanos` field. Must be from 0
2386 # to 999,999,999 inclusive.
2387 &quot;seconds&quot;: &quot;A String&quot;, # Span of time at a resolution of a second. Must be from 0
2388 # to 315,576,000,000 inclusive. Note: these bounds are computed from:
2389 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
2390 },
2391 &quot;deleteAtTime&quot;: &quot;A String&quot;, # Absolute time in future when the reservation will be
2392 # auto-deleted by Compute Engine. Timestamp is represented inRFC3339 text format.
2393 &quot;deploymentType&quot;: &quot;A String&quot;, # Specifies the deployment strategy for this reservation.
2394 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
2395 # create the resource.
2396 &quot;earlyAccessMaintenance&quot;: &quot;A String&quot;, # Indicates the early access maintenance for the reservation.
2397 # If this field is absent or set to NO_EARLY_ACCESS, the reservation is not
2398 # enrolled in early access maintenance and the standard notice applies.
2399 &quot;enableEmergentMaintenance&quot;: True or False, # Indicates whether Compute Engine allows unplanned maintenance for your VMs;
2400 # for example, to fix hardware errors.
2401 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
2402 # defined by the server.
2403 &quot;kind&quot;: &quot;compute#reservation&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#reservations for reservations.
2404 &quot;linkedCommitments&quot;: [ # Output only. [Output Only] Full or partial URL to parent commitments. This field
2405 # displays for reservations that are tied to multiple commitments.
2406 &quot;A String&quot;,
2407 ],
2408 &quot;name&quot;: &quot;A String&quot;, # The name of the resource, provided by the client when initially creating
2409 # the resource. The resource name must be 1-63 characters long, and comply
2410 # withRFC1035.
2411 # Specifically, the name must be 1-63 characters long and match the regular
2412 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
2413 # character must be a lowercase letter, and all following characters must be
2414 # a dash, lowercase letter, or digit, except the last character, which cannot
2415 # be a dash.
2416 &quot;params&quot;: { # Additional reservation params. # Input only. Additional params passed with the request, but not persisted
2417 # as part of resource payload.
2418 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the reservation. Tag keys and
2419 # values have the same definition as resource
2420 # manager tags. Keys and values can be either in numeric format,
2421 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
2422 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
2423 # `{tag_value_short_name}`. The field is ignored (both PUT &amp;
2424 # PATCH) when empty.
2425 &quot;a_key&quot;: &quot;A String&quot;,
2426 },
2427 },
2428 &quot;protectionTier&quot;: &quot;A String&quot;, # Protection tier for the workload which specifies the workload expectations
2429 # in the event of infrastructure failures at data center (e.g. power
2430 # and/or cooling failures).
2431 &quot;reservationSharingPolicy&quot;: { # Specify the reservation sharing policy. If unspecified, the reservation
2432 # will not be shared with Google Cloud managed services.
2433 &quot;serviceShareType&quot;: &quot;A String&quot;, # Sharing config for all Google Cloud services.
2434 },
2435 &quot;resourcePolicies&quot;: { # Resource policies to be added to this reservation. The key is defined by
2436 # user, and the value is resource policy url. This is to define placement
2437 # policy with reservation.
2438 &quot;a_key&quot;: &quot;A String&quot;,
2439 },
2440 &quot;resourceStatus&quot;: { # [Output Only] Contains output only fields. # Output only. [Output Only] Status information for Reservation resource.
2441 &quot;healthInfo&quot;: { # Health information for the reservation. # [Output only] Health information for the reservation.
2442 &quot;degradedBlockCount&quot;: 42, # The number of reservation blocks that are degraded.
2443 &quot;healthStatus&quot;: &quot;A String&quot;, # The health status of the reservation.
2444 &quot;healthyBlockCount&quot;: 42, # The number of reservation blocks that are healthy.
2445 },
2446 &quot;reservationBlockCount&quot;: 42, # The number of reservation blocks associated with this reservation.
2447 &quot;reservationMaintenance&quot;: { # Maintenance Info for ReservationBlocks. # Maintenance information for this reservation
2448 &quot;instanceMaintenanceOngoingCount&quot;: 42, # Describes number of instances that have ongoing maintenance.
2449 &quot;instanceMaintenancePendingCount&quot;: 42, # Describes number of instances that have pending maintenance.
2450 &quot;maintenanceOngoingCount&quot;: 42, # Progress for ongoing maintenance for this group of VMs/hosts.
2451 # Describes number of hosts in the block that have ongoing maintenance.
2452 &quot;maintenancePendingCount&quot;: 42, # Progress for ongoing maintenance for this group of VMs/hosts.
2453 # Describes number of hosts in the block that have pending maintenance.
2454 &quot;schedulingType&quot;: &quot;A String&quot;, # The type of maintenance for the reservation.
2455 &quot;subblockInfraMaintenanceOngoingCount&quot;: 42, # Describes number of subblock Infrastructure that has ongoing maintenance.
2456 # Here, Subblock Infrastructure Maintenance pertains to upstream hardware
2457 # contained in the Subblock that is necessary for a VM Family(e.g. NVLink
2458 # Domains). Not all VM Families will support this field.
2459 &quot;subblockInfraMaintenancePendingCount&quot;: 42, # Describes number of subblock Infrastructure that has pending maintenance.
2460 # Here, Subblock Infrastructure Maintenance pertains to upstream hardware
2461 # contained in the Subblock that is necessary for a VM Family (e.g. NVLink
2462 # Domains). Not all VM Families will support this field.
2463 &quot;upcomingGroupMaintenance&quot;: { # Upcoming Maintenance notification information. # Maintenance information on this group of VMs.
2464 &quot;canReschedule&quot;: True or False, # Indicates if the maintenance can be customer triggered.
2465 &quot;latestWindowStartTime&quot;: &quot;A String&quot;, # The latest time for the planned maintenance window to start.
2466 # This timestamp value is in RFC3339 text format.
2467 &quot;maintenanceOnShutdown&quot;: True or False, # Indicates whether the UpcomingMaintenance will be triggered on VM shutdown.
2468 &quot;maintenanceReasons&quot;: [ # The reasons for the maintenance. Only valid for vms.
2469 &quot;A String&quot;,
2470 ],
2471 &quot;maintenanceStatus&quot;: &quot;A String&quot;,
2472 &quot;type&quot;: &quot;A String&quot;, # Defines the type of maintenance.
2473 &quot;windowEndTime&quot;: &quot;A String&quot;, # The time by which the maintenance disruption will be completed.
2474 # This timestamp value is in RFC3339 text format.
2475 &quot;windowStartTime&quot;: &quot;A String&quot;, # The current start time of the maintenance window.
2476 # This timestamp value is in RFC3339 text format.
2477 },
2478 },
2479 &quot;specificSkuAllocation&quot;: { # Contains Properties set for the reservation. # Allocation Properties of this reservation.
2480 &quot;sourceInstanceTemplateId&quot;: &quot;A String&quot;, # ID of the instance template used to populate reservation properties.
2481 &quot;utilizations&quot;: { # Per service utilization breakdown. The Key is the Google Cloud managed
2482 # service name.
2483 &quot;a_key&quot;: &quot;A String&quot;,
2484 },
2485 },
2486 },
2487 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
2488 &quot;schedulingType&quot;: &quot;A String&quot;, # The type of maintenance for the reservation.
2489 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined fully-qualified URL for this resource.
2490 &quot;shareSettings&quot;: { # The share setting for reservations and sole tenancy node groups. # Specify share-settings to create a shared reservation. This property is
2491 # optional. For more information about the syntax and options for this
2492 # field and its subfields, see the guide for creating
2493 # a shared reservation.
2494 &quot;projectMap&quot;: { # A map of project id and project config. This is only valid when
2495 # share_type&#x27;s value is SPECIFIC_PROJECTS.
2496 &quot;a_key&quot;: { # Config for each project in the share settings.
2497 &quot;projectId&quot;: &quot;A String&quot;, # The project ID, should be same as the key of this project config in the
2498 # parent map.
2499 },
2500 },
2501 &quot;shareType&quot;: &quot;A String&quot;, # Type of sharing for this shared-reservation
2502 },
2503 &quot;specificReservation&quot;: { # This reservation type allows to pre allocate specific instance # Reservation for instances with specific machine shapes.
2504 # configuration.
2505 &quot;assuredCount&quot;: &quot;A String&quot;, # Output only. [Output Only] Indicates how many instances are actually usable currently.
2506 &quot;count&quot;: &quot;A String&quot;, # Specifies the number of resources that are allocated.
2507 &quot;inUseCount&quot;: &quot;A String&quot;, # Output only. [Output Only] Indicates how many instances are in use.
2508 &quot;instanceProperties&quot;: { # Properties of the SKU instances being reserved. # The instance properties for the reservation.
2509 # Next ID: 10
2510 &quot;guestAccelerators&quot;: [ # Specifies accelerator type and count.
2511 { # A specification of the type and number of accelerator cards attached to the
2512 # instance.
2513 &quot;acceleratorCount&quot;: 42, # The number of the guest accelerator cards exposed to this instance.
2514 &quot;acceleratorType&quot;: &quot;A String&quot;, # Full or partial URL of the accelerator type resource to attach to this
2515 # instance. For example:projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100
2516 # If you are creating an instance template, specify only the
2517 # accelerator name.
2518 # See GPUs on Compute Engine
2519 # for a full list of accelerator types.
2520 },
2521 ],
2522 &quot;localSsds&quot;: [ # Specifies amount of local ssd to reserve with each instance. The type
2523 # of disk is local-ssd.
2524 {
2525 &quot;diskSizeGb&quot;: &quot;A String&quot;, # Specifies the size of the disk in base-2 GB.
2526 &quot;interface&quot;: &quot;A String&quot;, # Specifies the disk interface to use for attaching this disk, which is
2527 # either SCSI or NVME. The default isSCSI.
2528 # For performance characteristics of SCSI over NVMe, seeLocal SSD performance.
2529 },
2530 ],
2531 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the allocation close to other
2532 # resources.
2533 # This field is for use by internal tools that use the public API.
2534 &quot;machineType&quot;: &quot;A String&quot;, # Specifies type of machine (name only) which has fixed number of vCPUs
2535 # and fixed amount of memory. This also includes specifying custom
2536 # machine type following custom-NUMBER_OF_CPUS-AMOUNT_OF_MEMORY pattern.
2537 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # Minimum cpu platform the reservation.
2538 },
2539 &quot;sourceInstanceTemplate&quot;: &quot;A String&quot;, # Specifies the instance template to create the reservation. If you use
2540 # this field, you must exclude the instanceProperties field.
2541 #
2542 # This field is optional, and it can be a full or partial URL. For example,
2543 # the following are all valid URLs to an instance template:
2544 #
2545 #
2546 # - https://www.googleapis.com/compute/v1/projects/project/global/instanceTemplates/instanceTemplate
2547 # - projects/project/global/instanceTemplates/instanceTemplate
2548 # - global/instanceTemplates/instanceTemplate
2549 },
2550 &quot;specificReservationRequired&quot;: True or False, # Indicates whether the reservation can be consumed by VMs with affinity
2551 # for &quot;any&quot; reservation. If the field is set, then only VMs that target
2552 # the reservation by name can consume from this reservation.
2553 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only] The status of the reservation.
2554 #
2555 #
2556 # - CREATING: Reservation resources are being
2557 # allocated.
2558 # - READY: Reservation resources have been allocated,
2559 # and the reservation is ready for use.
2560 # - DELETING: Reservation deletion is in progress.
2561 # - UPDATING: Reservation update is in progress.
2562 &quot;zone&quot;: &quot;A String&quot;, # Zone in which the reservation resides. A zone must be provided if the
2563 # reservation is created within a commitment.
2564 },
2565 ],
2566 &quot;resourceStatus&quot;: { # [Output Only] Contains output only fields. # Output only. [Output Only] Status information for Commitment resource.
2567 &quot;customTermEligibilityEndTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Indicates the end time of customer&#x27;s eligibility to send
2568 # custom term requests in RFC3339 text format. Term extension requests that
2569 # (not the end time in the request) after this time will be rejected.
2570 },
2571 &quot;resources&quot;: [ # The list of all the hardware resources, with their types and amounts, that
2572 # you want to commit to. Specify as a separate entry in the list for each
2573 # individual resource type.
2574 { # Commitment for a particular hardware resource (a commitment is composed of
2575 # one or more of these).
2576 &quot;acceleratorType&quot;: &quot;A String&quot;, # Name of the accelerator type or GPU resource. Specify this field only when
2577 # the type of hardware resource is ACCELERATOR.
2578 &quot;amount&quot;: &quot;A String&quot;, # The quantity of the hardware resource that you want to commit to purchasing
2579 # (in a type-dependent unit).
2580 #
2581 # - For vCPUs, you must specify an integer value.
2582 # - For memory, you specify the amount of MB that you want. The value you
2583 # specify must be a multiple of 256 MB, with up to 6.5 GB of
2584 # memory per every vCPU.
2585 # - For GPUs, you must specify an integer value.
2586 # - For Local SSD disks, you must specify the amount in GB. The size of a
2587 # single Local SSD disk is 375 GB.
2588 &quot;type&quot;: &quot;A String&quot;, # The type of hardware resource that you want to specify.
2589 # You can specify any of the following values:
2590 #
2591 # - VCPU
2592 # - MEMORY
2593 # - LOCAL_SSD
2594 # - ACCELERATOR
2595 #
2596 #
2597 #
2598 # Specify as a separate entry in the list for each
2599 # individual resource type.
2600 },
2601 ],
2602 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
2603 &quot;splitSourceCommitment&quot;: &quot;A String&quot;, # The source commitment from which you are transferring resources to create
2604 # the new split commitment. For more information, see
2605 # Split commitments.
2606 &quot;startTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Commitment start time inRFC3339
2607 # text format.
2608 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only] Status of the commitment with regards to eventual expiration
2609 # (each commitment has an end date defined). Status can be one of the
2610 # following values: NOT_YET_ACTIVE, ACTIVE, orEXPIRED.
2611 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. [Output Only] An optional, human-readable explanation of the status.
2612 &quot;type&quot;: &quot;A String&quot;, # The type of commitment; specifies the
2613 # machine series for which you want to commit to purchasing resources.
2614 # The choice of machine series affects the discount rate and the eligible
2615 # resource types.
2616 #
2617 # The type must be one of the following:ACCELERATOR_OPTIMIZED, ACCELERATOR_OPTIMIZED_A3,ACCELERATOR_OPTIMIZED_A3_MEGA,COMPUTE_OPTIMIZED, COMPUTE_OPTIMIZED_C2D,
2618 # 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
2619 # example, type MEMORY_OPTIMIZED specifies a commitment that
2620 # applies only to eligible resources of memory optimized M1 and M2 machine
2621 # series. Type GENERAL_PURPOSE specifies a commitment that
2622 # applies only to eligible resources of general purpose N1 machine series.
2623 }
2624
2625 paths: string, A parameter (repeated)
2626 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
2627 that if you must retry your request, the server will know to ignore the
2628 request if it has already been completed.
2629
2630 For example, consider a situation where you make an initial request and
2631 the request times out. If you make the request again with the same
2632 request ID, the server can check if original operation with the same
2633 request ID was received, and if so, will ignore the second request. This
2634 prevents clients from accidentally creating duplicate commitments.
2635
2636 The request ID must be
2637 a valid UUID with the exception that zero UUID is not supported
2638 (00000000-0000-0000-0000-000000000000).
2639 updateMask: string, update_mask indicates fields to be updated as part of this request.
2640 x__xgafv: string, V1 error format.
2641 Allowed values
2642 1 - v1 error format
2643 2 - v2 error format
2644
2645 Returns:
2646 An object of the form:
2647
2648 { # Represents an Operation resource.
2649 #
2650 # Google Compute Engine has three Operation resources:
2651 #
2652 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
2653 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
2654 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
2655 #
2656 # You can use an operation resource to manage asynchronous API requests.
2657 # For more information, readHandling
2658 # API responses.
2659 #
2660 # Operations can be global, regional or zonal.
2661 #
2662 # - For global operations, use the `globalOperations`
2663 # resource.
2664 # - For regional operations, use the
2665 # `regionOperations` resource.
2666 # - For zonal operations, use
2667 # the `zoneOperations` resource.
2668 #
2669 #
2670 #
2671 # For more information, read
2672 # Global, Regional, and Zonal Resources.
2673 #
2674 # Note that completed Operation resources have a limited
2675 # retention period.
2676 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
2677 # Not present otherwise.
2678 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
2679 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
2680 # set when the operation is created.
2681 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
2682 # text format.
2683 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
2684 # this field will be populated.
2685 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
2686 # operation.
2687 {
2688 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
2689 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
2690 # details. There is a set of defined message types to use for providing
2691 # details.The syntax depends on the error code. For example,
2692 # QuotaExceededInfo will have details when the error code is
2693 # QUOTA_EXCEEDED.
2694 {
2695 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
2696 #
2697 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
2698 # is not enabled:
2699 #
2700 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
2701 # &quot;domain&quot;: &quot;googleapis.com&quot;
2702 # &quot;metadata&quot;: {
2703 # &quot;resource&quot;: &quot;projects/123&quot;,
2704 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
2705 # }
2706 # }
2707 #
2708 # This response indicates that the pubsub.googleapis.com API is not enabled.
2709 #
2710 # Example of an error that is returned when attempting to create a Spanner
2711 # instance in a region that is out of stock:
2712 #
2713 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
2714 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
2715 # &quot;metadata&quot;: {
2716 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
2717 # }
2718 # }
2719 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
2720 # is typically the registered service name of the tool or product that
2721 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
2722 # generated by some common infrastructure, the error domain must be a
2723 # globally unique value that identifies the infrastructure. For Google API
2724 # infrastructure, the error domain is &quot;googleapis.com&quot;.
2725 &quot;metadatas&quot;: { # Additional structured details about this error.
2726 #
2727 # Keys must match a regular expression of `a-z+` but should
2728 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
2729 # length. When identifying the current value of an exceeded limit, the units
2730 # should be contained in the key, not the value. For example, rather than
2731 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
2732 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
2733 # instances that can be created in a single (batch) request.
2734 &quot;a_key&quot;: &quot;A String&quot;,
2735 },
2736 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
2737 # proximate cause of the error. Error reasons are unique within a particular
2738 # domain of errors. This should be at most 63 characters and match a
2739 # regular expression of `A-Z+[A-Z0-9]`, which represents
2740 # UPPER_SNAKE_CASE.
2741 },
2742 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
2743 #
2744 # For example, if a quota check failed with an error indicating the calling
2745 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
2746 # directly to the right place in the developer console to flip the bit.
2747 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
2748 { # Describes a URL link.
2749 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
2750 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
2751 },
2752 ],
2753 },
2754 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
2755 # which can be attached to an RPC error.
2756 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
2757 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
2758 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
2759 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
2760 },
2761 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
2762 &quot;dimensions&quot;: { # The map holding related quota dimensions.
2763 &quot;a_key&quot;: &quot;A String&quot;,
2764 },
2765 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
2766 # type or metric.
2767 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
2768 # or metric.
2769 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
2770 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
2771 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
2772 },
2773 },
2774 ],
2775 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
2776 # This property is optional.
2777 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
2778 },
2779 ],
2780 },
2781 &quot;getVersionOperationMetadata&quot;: {
2782 &quot;inlineSbomInfo&quot;: {
2783 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
2784 # appropriate identifiers.
2785 &quot;a_key&quot;: &quot;A String&quot;,
2786 },
2787 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
2788 # identifiers.
2789 &quot;a_key&quot;: &quot;A String&quot;,
2790 },
2791 },
2792 },
2793 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
2794 # message that was returned, such as `NOT FOUND`.
2795 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
2796 # status code that was returned. For example, a `404` means the
2797 # resource was not found.
2798 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
2799 # defined by the server.
2800 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
2801 # This value is inRFC3339
2802 # text format.
2803 &quot;instancesBulkInsertOperationMetadata&quot;: {
2804 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
2805 # Example key: zones/us-central1-a
2806 &quot;a_key&quot;: {
2807 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
2808 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
2809 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
2810 # error.
2811 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
2812 # if the flow is rolling forward or rolling back.
2813 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
2814 },
2815 },
2816 },
2817 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
2818 # Operation resources.
2819 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
2820 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
2821 # group of operations results from a `bulkInsert` API request.
2822 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
2823 # `update`, or `delete`, and so on.
2824 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
2825 # There is no requirement that this be linear or support any granularity of
2826 # operations. This should not be used to guess when the operation will be
2827 # complete. This number should monotonically increase as the operation
2828 # progresses.
2829 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
2830 # applicable when performing regional operations.
2831 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
2832 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
2833 # this field will contain information on all underlying zonal actions and
2834 # their state.
2835 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
2836 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
2837 # Example key: zones/us-central1-a
2838 &quot;a_key&quot;: {
2839 &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
2840 # populated.
2841 # different programming environments, including REST APIs and RPC APIs. It is
2842 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
2843 # three pieces of data: error code, error message, and error details.
2844 #
2845 # You can find out more about this error model and how to work with it in the
2846 # [API Design Guide](https://cloud.google.com/apis/design/errors).
2847 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
2848 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
2849 # message types for APIs to use.
2850 {
2851 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
2852 },
2853 ],
2854 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
2855 # user-facing error message should be localized and sent in the
2856 # google.rpc.Status.details field, or localized by the client.
2857 },
2858 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
2859 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
2860 },
2861 },
2862 },
2863 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
2864 # This value is inRFC3339
2865 # text format.
2866 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
2867 # following:
2868 # `PENDING`, `RUNNING`, or `DONE`.
2869 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
2870 # operation.
2871 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
2872 # of the target resource.
2873 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
2874 # operations related to creating a snapshot, this points to the disk
2875 # that the snapshot was created from.
2876 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
2877 # `[email protected]` or
2878 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
2879 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
2880 # operation, this field will be populated.
2881 {
2882 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2883 # Engine returns NO_RESULTS_ON_PAGE if there
2884 # are no results in the response.
2885 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2886 # value format. For example:
2887 #
2888 # &quot;data&quot;: [
2889 # {
2890 # &quot;key&quot;: &quot;scope&quot;,
2891 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2892 # }
2893 {
2894 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2895 # returned. For example, for warnings where there are no results in a list
2896 # request for a particular zone, this key might be scope and
2897 # the key value might be the zone name. Other examples might be a key
2898 # indicating a deprecated resource and a suggested replacement, or a
2899 # warning about invalid network settings (for example, if an instance
2900 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2901 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2902 },
2903 ],
2904 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2905 },
2906 ],
2907 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
2908 # applicable when performing per-zone operations.
2909 }</pre>
2910 </div>
2911
2912 </body></html>