Debian Codegraph @

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