Debian Codegraph @

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