Debian Codegraph @

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