Debian Codegraph @

docs/dyn/compute_alpha.reservationBlocks.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <h1><a href="compute_alpha.html">Compute Engine API</a> . <a href="compute_alpha.reservationBlocks.html">reservationBlocks</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#get">get(project, zone, reservation, reservationBlock, view=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Retrieves information about the specified reservation block.</p>
83 <p class="toc_element">
84 <code><a href="#list">list(project, zone, reservation, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
85 <p class="firstline">Retrieves a list of reservation blocks under a single reservation.</p>
86 <p class="toc_element">
87 <code><a href="#list_next">list_next()</a></code></p>
88 <p class="firstline">Retrieves the next page of results.</p>
89 <p class="toc_element">
90 <code><a href="#performMaintenance">performMaintenance(project, zone, reservation, reservationBlock, body=None, requestId=None, x__xgafv=None)</a></code></p>
91 <p class="firstline">Allows customers to perform maintenance on a reservation block</p>
92 <h3>Method Details</h3>
93 <div class="method">
94 <code class="details" id="close">close()</code>
95 <pre>Close httplib2 connections.</pre>
96 </div>
97
98 <div class="method">
99 <code class="details" id="get">get(project, zone, reservation, reservationBlock, view=None, x__xgafv=None)</code>
100 <pre>Retrieves information about the specified reservation block.
101
102 Args:
103 project: string, Project ID for this request. (required)
104 zone: string, Name of the zone for this request. Zone name should conform to RFC1035. (required)
105 reservation: string, The name of the reservation.
106 Name should conform to RFC1035 or be a resource ID. (required)
107 reservationBlock: string, The name of the reservation block.
108 Name should conform to RFC1035 or be a resource ID. (required)
109 view: string, View of the Block.
110 Allowed values
111 BASIC - This view includes basic information about the reservation block
112 BLOCK_VIEW_UNSPECIFIED - The default / unset value. The API will default to the BASIC view.
113 FULL - Includes detailed topology view.
114 x__xgafv: string, V1 error format.
115 Allowed values
116 1 - v1 error format
117 2 - v2 error format
118
119 Returns:
120 An object of the form:
121
122 {
123 &quot;resource&quot;: { # Represents a reservation block resource.
124 &quot;blockHealthInfo&quot;: { # Health information for the reservation block. # Output only. [Output Only] Health information for the reservation block.
125 &quot;degradedSubBlockCount&quot;: 42, # The number of subBlocks that are degraded.
126 &quot;healthStatus&quot;: &quot;A String&quot;, # The health status of the reservation block.
127 &quot;healthySubBlockCount&quot;: 42, # The number of subBlocks that are healthy.
128 },
129 &quot;count&quot;: 42, # Output only. [Output Only] The number of resources that are allocated in this
130 # reservation block.
131 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339 text format.
132 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
133 # defined by the server.
134 &quot;inUseCount&quot;: 42, # Output only. [Output Only] The number of instances that are currently in use on this
135 # reservation block.
136 &quot;inUseHostCount&quot;: 42, # Output only. Number of hosts currently in use. If there is one or more Instances running
137 # on the host, it is considered in use.
138 &quot;kind&quot;: &quot;compute#reservationBlock&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#reservationBlock for reservation blocks.
139 &quot;locationPrefix&quot;: &quot;A String&quot;, # Output only. [Output Only] Obfuscated location where this reservation block physically
140 # resides in format /CCCC/GGGG. This matches the tripod specified in the VM
141 # topology information. Example: /USEAB1/0101/ is the location prefix in
142 # /USEAB1/0101/031/003
143 &quot;name&quot;: &quot;A String&quot;, # Output only. [Output Only] The name of this reservation block generated by Google
144 # Compute Engine. The name must be 1-63 characters long, and comply with
145 # RFC1035 @pattern [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
146 &quot;physicalTopology&quot;: { # Output only. [Output Only] The physical topology of the reservation block.
147 &quot;block&quot;: &quot;A String&quot;, # The hash of the capacity block within the cluster.
148 &quot;cluster&quot;: &quot;A String&quot;, # The cluster name of the reservation block.
149 &quot;instances&quot;: [ # Output only. The detailed instances information for a given Block
150 { # The instances information for a given Block
151 &quot;instanceId&quot;: &quot;A String&quot;, # The InstanceId of the instance
152 &quot;physicalHostTopology&quot;: { # The PhysicalHostTopology of the instance within a Block resource. # Output only. The PhysicalHostTopology of instances within a Block resource.
153 &quot;host&quot;: &quot;A String&quot;, # Host hash for a given instance
154 &quot;subBlock&quot;: &quot;A String&quot;, # Sub block hash for a given instance
155 },
156 &quot;projectId&quot;: &quot;A String&quot;, # Project where the instance lives
157 },
158 ],
159 },
160 &quot;reservationMaintenance&quot;: { # Maintenance Info for ReservationBlocks. # Output only. [Output Only] Maintenance information for this reservation block.
161 &quot;instanceMaintenanceOngoingCount&quot;: 42, # Describes number of instances that have ongoing maintenance.
162 &quot;instanceMaintenancePendingCount&quot;: 42, # Describes number of instances that have pending maintenance.
163 &quot;maintenanceOngoingCount&quot;: 42, # Progress for ongoing maintenance for this group of VMs/hosts.
164 # Describes number of hosts in the block that have ongoing maintenance.
165 &quot;maintenancePendingCount&quot;: 42, # Progress for ongoing maintenance for this group of VMs/hosts.
166 # Describes number of hosts in the block that have pending maintenance.
167 &quot;schedulingType&quot;: &quot;A String&quot;, # The type of maintenance for the reservation.
168 &quot;subblockInfraMaintenanceOngoingCount&quot;: 42, # Describes number of subblock Infrastructure that has ongoing maintenance.
169 # Here, Subblock Infrastructure Maintenance pertains to upstream hardware
170 # contained in the Subblock that is necessary for a VM Family(e.g. NVLink
171 # Domains). Not all VM Families will support this field.
172 &quot;subblockInfraMaintenancePendingCount&quot;: 42, # Describes number of subblock Infrastructure that has pending maintenance.
173 # Here, Subblock Infrastructure Maintenance pertains to upstream hardware
174 # contained in the Subblock that is necessary for a VM Family (e.g. NVLink
175 # Domains). Not all VM Families will support this field.
176 &quot;upcomingGroupMaintenance&quot;: { # Upcoming Maintenance notification information. # Maintenance information on this group of VMs.
177 &quot;canReschedule&quot;: True or False, # Indicates if the maintenance can be customer triggered.
178 &quot;date&quot;: &quot;A String&quot;, # [Output Only] The date when the maintenance will take place.
179 # This value is inRFC3339
180 # text format.
181 # DEPRECATED: Use window_start_time instead.
182 &quot;latestWindowStartTime&quot;: &quot;A String&quot;, # The latest time for the planned maintenance window to start.
183 # This timestamp value is in RFC3339 text format.
184 &quot;maintenanceMethod&quot;: &quot;A String&quot;, # Output only. Maintenance method for the upcoming maintenance.
185 &quot;maintenanceOnShutdown&quot;: True or False, # Indicates whether the UpcomingMaintenance will be triggered on VM shutdown.
186 &quot;maintenanceReasons&quot;: [ # The reasons for the maintenance. Only valid for vms.
187 &quot;A String&quot;,
188 ],
189 &quot;maintenanceStatus&quot;: &quot;A String&quot;,
190 &quot;startTimeWindow&quot;: { # Represents a window of time using two timestamps: `earliest` and `latest`. # [Output Only] The start time window of the maintenance disruption.
191 # DEPRECATED: Use window_start_time instead.
192 # TimeWindow is a container for two strings that represent timestamps in
193 # &quot;yyyy-MM-dd&#x27;T&#x27;HH:mm:ssZ&quot; text format.
194 &quot;earliest&quot;: &quot;A String&quot;,
195 &quot;latest&quot;: &quot;A String&quot;,
196 },
197 &quot;time&quot;: &quot;A String&quot;, # [Output Only] The time when the maintenance will take place.
198 # This value is inRFC3339
199 # text format.
200 # DEPRECATED: Use window_start_time instead.
201 &quot;type&quot;: &quot;A String&quot;, # Defines the type of maintenance.
202 &quot;windowEndTime&quot;: &quot;A String&quot;, # The time by which the maintenance disruption will be completed.
203 # This timestamp value is in RFC3339 text format.
204 &quot;windowStartTime&quot;: &quot;A String&quot;, # The current start time of the maintenance window.
205 # This timestamp value is in RFC3339 text format.
206 },
207 },
208 &quot;reservationSubBlockCount&quot;: 42, # Output only. [Output Only] The number of reservation subBlocks associated with this
209 # reservation block.
210 &quot;reservationSubBlockInUseCount&quot;: 42, # Output only. [Output Only] The number of in-use reservation subBlocks associated with
211 # this reservation block. If at least one VM is running on a subBlock, it is
212 # considered in-use.
213 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined fully-qualified URL for this resource.
214 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
215 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only] Status of the reservation block.
216 &quot;zone&quot;: &quot;A String&quot;, # Output only. [Output Only] Zone in which the reservation block resides.
217 },
218 }</pre>
219 </div>
220
221 <div class="method">
222 <code class="details" id="list">list(project, zone, reservation, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
223 <pre>Retrieves a list of reservation blocks under a single reservation.
224
225 Args:
226 project: string, Project ID for this request. (required)
227 zone: string, Name of the zone for this request. Zone name should conform to RFC1035. (required)
228 reservation: string, The name of the reservation.
229 Name should conform to RFC1035 or be a resource ID. (required)
230 filter: string, A filter expression that filters resources listed in the response. Most
231 Compute resources support two types of filter expressions:
232 expressions that support regular expressions and expressions that follow
233 API improvement proposal AIP-160.
234 These two types of filter expressions cannot be mixed in one request.
235
236 If you want to use AIP-160, your expression must specify the field name, an
237 operator, and the value that you want to use for filtering. The value
238 must be a string, a number, or a boolean. The operator
239 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
240
241 For example, if you are filtering Compute Engine instances, you can
242 exclude instances named `example-instance` by specifying
243 `name != example-instance`.
244
245 The `:*` comparison can be used to test whether a key has been defined.
246 For example, to find all objects with `owner` label use:
247 ```
248 labels.owner:*
249 ```
250
251 You can also filter nested fields. For example, you could specify
252 `scheduling.automaticRestart = false` to include instances only
253 if they are not scheduled for automatic restarts. You can use filtering
254 on nested fields to filter based onresource labels.
255
256 To filter on multiple expressions, provide each separate expression within
257 parentheses. For example:
258 ```
259 (scheduling.automaticRestart = true)
260 (cpuPlatform = &quot;Intel Skylake&quot;)
261 ```
262 By default, each expression is an `AND` expression. However, you
263 can include `AND` and `OR` expressions explicitly.
264 For example:
265 ```
266 (cpuPlatform = &quot;Intel Skylake&quot;) OR
267 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
268 (scheduling.automaticRestart = true)
269 ```
270
271 If you want to use a regular expression, use the `eq` (equal) or `ne`
272 (not equal) operator against a single un-parenthesized expression with or
273 without quotes or against multiple parenthesized expressions. Examples:
274
275 `fieldname eq unquoted literal`
276 `fieldname eq &#x27;single quoted literal&#x27;`
277 `fieldname eq &quot;double quoted literal&quot;`
278 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
279
280 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
281 The literal value must match the entire field.
282
283 For example, to filter for instances that do not end with name &quot;instance&quot;,
284 you would use `name ne .*instance`.
285
286 You cannot combine constraints on multiple fields using regular
287 expressions.
288 maxResults: integer, The maximum number of results per page that should be returned.
289 If the number of available results is larger than `maxResults`,
290 Compute Engine returns a `nextPageToken` that can be used to get
291 the next page of results in subsequent list requests. Acceptable values are
292 `0` to `500`, inclusive. (Default: `500`)
293 orderBy: string, Sorts list results by a certain order. By default, results
294 are returned in alphanumerical order based on the resource name.
295
296 You can also sort results in descending order based on the creation
297 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
298 results based on the `creationTimestamp` field in
299 reverse chronological order (newest result first). Use this to sort
300 resources like operations so that the newest operation is returned first.
301
302 Currently, only sorting by `name` or
303 `creationTimestamp desc` is supported.
304 pageToken: string, Specifies a page token to use. Set `pageToken` to the
305 `nextPageToken` returned by a previous list request to get
306 the next page of results.
307 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
308 of failure. The default value is false.
309
310 For example, when partial success behavior is enabled, aggregatedList for a
311 single zone scope either returns all resources in the zone or no resources,
312 with an error code.
313 x__xgafv: string, V1 error format.
314 Allowed values
315 1 - v1 error format
316 2 - v2 error format
317
318 Returns:
319 An object of the form:
320
321 { # A list of reservation blocks under a single reservation.
322 &quot;id&quot;: &quot;A String&quot;, # Unique identifier for the resource; defined by the server.
323 &quot;items&quot;: [ # A list of reservation block resources.
324 { # Represents a reservation block resource.
325 &quot;blockHealthInfo&quot;: { # Health information for the reservation block. # Output only. [Output Only] Health information for the reservation block.
326 &quot;degradedSubBlockCount&quot;: 42, # The number of subBlocks that are degraded.
327 &quot;healthStatus&quot;: &quot;A String&quot;, # The health status of the reservation block.
328 &quot;healthySubBlockCount&quot;: 42, # The number of subBlocks that are healthy.
329 },
330 &quot;count&quot;: 42, # Output only. [Output Only] The number of resources that are allocated in this
331 # reservation block.
332 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339 text format.
333 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
334 # defined by the server.
335 &quot;inUseCount&quot;: 42, # Output only. [Output Only] The number of instances that are currently in use on this
336 # reservation block.
337 &quot;inUseHostCount&quot;: 42, # Output only. Number of hosts currently in use. If there is one or more Instances running
338 # on the host, it is considered in use.
339 &quot;kind&quot;: &quot;compute#reservationBlock&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#reservationBlock for reservation blocks.
340 &quot;locationPrefix&quot;: &quot;A String&quot;, # Output only. [Output Only] Obfuscated location where this reservation block physically
341 # resides in format /CCCC/GGGG. This matches the tripod specified in the VM
342 # topology information. Example: /USEAB1/0101/ is the location prefix in
343 # /USEAB1/0101/031/003
344 &quot;name&quot;: &quot;A String&quot;, # Output only. [Output Only] The name of this reservation block generated by Google
345 # Compute Engine. The name must be 1-63 characters long, and comply with
346 # RFC1035 @pattern [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
347 &quot;physicalTopology&quot;: { # Output only. [Output Only] The physical topology of the reservation block.
348 &quot;block&quot;: &quot;A String&quot;, # The hash of the capacity block within the cluster.
349 &quot;cluster&quot;: &quot;A String&quot;, # The cluster name of the reservation block.
350 &quot;instances&quot;: [ # Output only. The detailed instances information for a given Block
351 { # The instances information for a given Block
352 &quot;instanceId&quot;: &quot;A String&quot;, # The InstanceId of the instance
353 &quot;physicalHostTopology&quot;: { # The PhysicalHostTopology of the instance within a Block resource. # Output only. The PhysicalHostTopology of instances within a Block resource.
354 &quot;host&quot;: &quot;A String&quot;, # Host hash for a given instance
355 &quot;subBlock&quot;: &quot;A String&quot;, # Sub block hash for a given instance
356 },
357 &quot;projectId&quot;: &quot;A String&quot;, # Project where the instance lives
358 },
359 ],
360 },
361 &quot;reservationMaintenance&quot;: { # Maintenance Info for ReservationBlocks. # Output only. [Output Only] Maintenance information for this reservation block.
362 &quot;instanceMaintenanceOngoingCount&quot;: 42, # Describes number of instances that have ongoing maintenance.
363 &quot;instanceMaintenancePendingCount&quot;: 42, # Describes number of instances that have pending maintenance.
364 &quot;maintenanceOngoingCount&quot;: 42, # Progress for ongoing maintenance for this group of VMs/hosts.
365 # Describes number of hosts in the block that have ongoing maintenance.
366 &quot;maintenancePendingCount&quot;: 42, # Progress for ongoing maintenance for this group of VMs/hosts.
367 # Describes number of hosts in the block that have pending maintenance.
368 &quot;schedulingType&quot;: &quot;A String&quot;, # The type of maintenance for the reservation.
369 &quot;subblockInfraMaintenanceOngoingCount&quot;: 42, # Describes number of subblock Infrastructure that has ongoing maintenance.
370 # Here, Subblock Infrastructure Maintenance pertains to upstream hardware
371 # contained in the Subblock that is necessary for a VM Family(e.g. NVLink
372 # Domains). Not all VM Families will support this field.
373 &quot;subblockInfraMaintenancePendingCount&quot;: 42, # Describes number of subblock Infrastructure that has pending maintenance.
374 # Here, Subblock Infrastructure Maintenance pertains to upstream hardware
375 # contained in the Subblock that is necessary for a VM Family (e.g. NVLink
376 # Domains). Not all VM Families will support this field.
377 &quot;upcomingGroupMaintenance&quot;: { # Upcoming Maintenance notification information. # Maintenance information on this group of VMs.
378 &quot;canReschedule&quot;: True or False, # Indicates if the maintenance can be customer triggered.
379 &quot;date&quot;: &quot;A String&quot;, # [Output Only] The date when the maintenance will take place.
380 # This value is inRFC3339
381 # text format.
382 # DEPRECATED: Use window_start_time instead.
383 &quot;latestWindowStartTime&quot;: &quot;A String&quot;, # The latest time for the planned maintenance window to start.
384 # This timestamp value is in RFC3339 text format.
385 &quot;maintenanceMethod&quot;: &quot;A String&quot;, # Output only. Maintenance method for the upcoming maintenance.
386 &quot;maintenanceOnShutdown&quot;: True or False, # Indicates whether the UpcomingMaintenance will be triggered on VM shutdown.
387 &quot;maintenanceReasons&quot;: [ # The reasons for the maintenance. Only valid for vms.
388 &quot;A String&quot;,
389 ],
390 &quot;maintenanceStatus&quot;: &quot;A String&quot;,
391 &quot;startTimeWindow&quot;: { # Represents a window of time using two timestamps: `earliest` and `latest`. # [Output Only] The start time window of the maintenance disruption.
392 # DEPRECATED: Use window_start_time instead.
393 # TimeWindow is a container for two strings that represent timestamps in
394 # &quot;yyyy-MM-dd&#x27;T&#x27;HH:mm:ssZ&quot; text format.
395 &quot;earliest&quot;: &quot;A String&quot;,
396 &quot;latest&quot;: &quot;A String&quot;,
397 },
398 &quot;time&quot;: &quot;A String&quot;, # [Output Only] The time when the maintenance will take place.
399 # This value is inRFC3339
400 # text format.
401 # DEPRECATED: Use window_start_time instead.
402 &quot;type&quot;: &quot;A String&quot;, # Defines the type of maintenance.
403 &quot;windowEndTime&quot;: &quot;A String&quot;, # The time by which the maintenance disruption will be completed.
404 # This timestamp value is in RFC3339 text format.
405 &quot;windowStartTime&quot;: &quot;A String&quot;, # The current start time of the maintenance window.
406 # This timestamp value is in RFC3339 text format.
407 },
408 },
409 &quot;reservationSubBlockCount&quot;: 42, # Output only. [Output Only] The number of reservation subBlocks associated with this
410 # reservation block.
411 &quot;reservationSubBlockInUseCount&quot;: 42, # Output only. [Output Only] The number of in-use reservation subBlocks associated with
412 # this reservation block. If at least one VM is running on a subBlock, it is
413 # considered in-use.
414 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined fully-qualified URL for this resource.
415 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
416 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only] Status of the reservation block.
417 &quot;zone&quot;: &quot;A String&quot;, # Output only. [Output Only] Zone in which the reservation block resides.
418 },
419 ],
420 &quot;kind&quot;: &quot;compute#reservationBlock&quot;, # Type of the resource. Alwayscompute#reservationBlock for a list of reservation blocks.
421 &quot;nextPageToken&quot;: &quot;A String&quot;, # This token allows you to get the next page of results for
422 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
423 # the query parameter pageToken in the next list request.
424 # Subsequent list requests will have their own nextPageToken to
425 # continue paging through the results.
426 &quot;selfLink&quot;: &quot;A String&quot;, # Server-defined URL for this resource.
427 &quot;warning&quot;: { # Informational warning message.
428 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
429 # Engine returns NO_RESULTS_ON_PAGE if there
430 # are no results in the response.
431 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
432 # value format. For example:
433 #
434 # &quot;data&quot;: [
435 # {
436 # &quot;key&quot;: &quot;scope&quot;,
437 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
438 # }
439 {
440 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
441 # returned. For example, for warnings where there are no results in a list
442 # request for a particular zone, this key might be scope and
443 # the key value might be the zone name. Other examples might be a key
444 # indicating a deprecated resource and a suggested replacement, or a
445 # warning about invalid network settings (for example, if an instance
446 # attempts to perform IP forwarding but is not enabled for IP forwarding).
447 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
448 },
449 ],
450 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
451 },
452 }</pre>
453 </div>
454
455 <div class="method">
456 <code class="details" id="list_next">list_next()</code>
457 <pre>Retrieves the next page of results.
458
459 Args:
460 previous_request: The request for the previous page. (required)
461 previous_response: The response from the request for the previous page. (required)
462
463 Returns:
464 A request object that you can call &#x27;execute()&#x27; on to request the next
465 page. Returns None if there are no more items in the collection.
466 </pre>
467 </div>
468
469 <div class="method">
470 <code class="details" id="performMaintenance">performMaintenance(project, zone, reservation, reservationBlock, body=None, requestId=None, x__xgafv=None)</code>
471 <pre>Allows customers to perform maintenance on a reservation block
472
473 Args:
474 project: string, Project ID for this request. (required)
475 zone: string, Name of the zone for this request. Zone name should conform to RFC1035. (required)
476 reservation: string, The name of the reservation.
477 Name should conform to RFC1035 or be a resource ID. (required)
478 reservationBlock: string, The name of the reservation block.
479 Name should conform to RFC1035 or be a resource ID. (required)
480 body: object, The request body.
481 The object takes the form of:
482
483 {
484 &quot;maintenanceScope&quot;: &quot;A String&quot;, # Specifies if all, running or unused hosts are in scope for this request.
485 }
486
487 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
488 that if you must retry your request, the server will know to ignore the
489 request if it has already been completed.
490
491 For example, consider a situation where you make an initial request and
492 the request times out. If you make the request again with the same
493 request ID, the server can check if original operation with the same
494 request ID was received, and if so, will ignore the second request. This
495 prevents clients from accidentally creating duplicate commitments.
496
497 The request ID must be
498 a valid UUID with the exception that zero UUID is not supported
499 (00000000-0000-0000-0000-000000000000).
500 x__xgafv: string, V1 error format.
501 Allowed values
502 1 - v1 error format
503 2 - v2 error format
504
505 Returns:
506 An object of the form:
507
508 { # Represents an Operation resource.
509 #
510 # Google Compute Engine has three Operation resources:
511 #
512 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
513 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
514 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
515 #
516 # You can use an operation resource to manage asynchronous API requests.
517 # For more information, readHandling
518 # API responses.
519 #
520 # Operations can be global, regional or zonal.
521 #
522 # - For global operations, use the `globalOperations`
523 # resource.
524 # - For regional operations, use the
525 # `regionOperations` resource.
526 # - For zonal operations, use
527 # the `zoneOperations` resource.
528 #
529 #
530 #
531 # For more information, read
532 # Global, Regional, and Zonal Resources.
533 #
534 # Note that completed Operation resources have a limited
535 # retention period.
536 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
537 # Not present otherwise.
538 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
539 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
540 # set when the operation is created.
541 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
542 # text format.
543 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
544 # this field will be populated.
545 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
546 # operation.
547 {
548 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
549 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
550 # details. There is a set of defined message types to use for providing
551 # details.The syntax depends on the error code. For example,
552 # QuotaExceededInfo will have details when the error code is
553 # QUOTA_EXCEEDED.
554 {
555 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
556 #
557 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
558 # is not enabled:
559 #
560 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
561 # &quot;domain&quot;: &quot;googleapis.com&quot;
562 # &quot;metadata&quot;: {
563 # &quot;resource&quot;: &quot;projects/123&quot;,
564 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
565 # }
566 # }
567 #
568 # This response indicates that the pubsub.googleapis.com API is not enabled.
569 #
570 # Example of an error that is returned when attempting to create a Spanner
571 # instance in a region that is out of stock:
572 #
573 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
574 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
575 # &quot;metadata&quot;: {
576 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
577 # }
578 # }
579 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
580 # is typically the registered service name of the tool or product that
581 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
582 # generated by some common infrastructure, the error domain must be a
583 # globally unique value that identifies the infrastructure. For Google API
584 # infrastructure, the error domain is &quot;googleapis.com&quot;.
585 &quot;metadatas&quot;: { # Additional structured details about this error.
586 #
587 # Keys must match a regular expression of `a-z+` but should
588 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
589 # length. When identifying the current value of an exceeded limit, the units
590 # should be contained in the key, not the value. For example, rather than
591 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
592 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
593 # instances that can be created in a single (batch) request.
594 &quot;a_key&quot;: &quot;A String&quot;,
595 },
596 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
597 # proximate cause of the error. Error reasons are unique within a particular
598 # domain of errors. This should be at most 63 characters and match a
599 # regular expression of `A-Z+[A-Z0-9]`, which represents
600 # UPPER_SNAKE_CASE.
601 },
602 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
603 #
604 # For example, if a quota check failed with an error indicating the calling
605 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
606 # directly to the right place in the developer console to flip the bit.
607 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
608 { # Describes a URL link.
609 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
610 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
611 },
612 ],
613 },
614 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
615 # which can be attached to an RPC error.
616 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
617 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
618 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
619 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
620 },
621 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
622 &quot;dimensions&quot;: { # The map holding related quota dimensions.
623 &quot;a_key&quot;: &quot;A String&quot;,
624 },
625 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
626 # type or metric.
627 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
628 # or metric.
629 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
630 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
631 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
632 },
633 },
634 ],
635 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
636 # This property is optional.
637 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
638 },
639 ],
640 },
641 &quot;getVersionOperationMetadata&quot;: {
642 &quot;inlineSbomInfo&quot;: {
643 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
644 # appropriate identifiers.
645 &quot;a_key&quot;: &quot;A String&quot;,
646 },
647 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
648 # identifiers.
649 &quot;a_key&quot;: &quot;A String&quot;,
650 },
651 },
652 },
653 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
654 # message that was returned, such as `NOT FOUND`.
655 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
656 # status code that was returned. For example, a `404` means the
657 # resource was not found.
658 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
659 # defined by the server.
660 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
661 # This value is inRFC3339
662 # text format.
663 &quot;instancesBulkInsertOperationMetadata&quot;: {
664 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
665 # Example key: zones/us-central1-a
666 &quot;a_key&quot;: {
667 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
668 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
669 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
670 # error.
671 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
672 # if the flow is rolling forward or rolling back.
673 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
674 },
675 },
676 },
677 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
678 # Operation resources.
679 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
680 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
681 # group of operations results from a `bulkInsert` API request.
682 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
683 # `update`, or `delete`, and so on.
684 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
685 # There is no requirement that this be linear or support any granularity of
686 # operations. This should not be used to guess when the operation will be
687 # complete. This number should monotonically increase as the operation
688 # progresses.
689 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
690 # applicable when performing regional operations.
691 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
692 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
693 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
694 # this field will contain information on all underlying zonal actions and
695 # their state.
696 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
697 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
698 # Example key: zones/us-central1-a
699 &quot;a_key&quot;: {
700 &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
701 # populated.
702 # different programming environments, including REST APIs and RPC APIs. It is
703 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
704 # three pieces of data: error code, error message, and error details.
705 #
706 # You can find out more about this error model and how to work with it in the
707 # [API Design Guide](https://cloud.google.com/apis/design/errors).
708 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
709 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
710 # message types for APIs to use.
711 {
712 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
713 },
714 ],
715 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
716 # user-facing error message should be localized and sent in the
717 # google.rpc.Status.details field, or localized by the client.
718 },
719 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
720 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
721 },
722 },
723 },
724 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
725 # This value is inRFC3339
726 # text format.
727 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
728 # following:
729 # `PENDING`, `RUNNING`, or `DONE`.
730 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
731 # operation.
732 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
733 # of the target resource.
734 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
735 # operations related to creating a snapshot, this points to the disk
736 # that the snapshot was created from.
737 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
738 # `[email protected]` or
739 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
740 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
741 # operation, this field will be populated.
742 {
743 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
744 # Engine returns NO_RESULTS_ON_PAGE if there
745 # are no results in the response.
746 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
747 # value format. For example:
748 #
749 # &quot;data&quot;: [
750 # {
751 # &quot;key&quot;: &quot;scope&quot;,
752 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
753 # }
754 {
755 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
756 # returned. For example, for warnings where there are no results in a list
757 # request for a particular zone, this key might be scope and
758 # the key value might be the zone name. Other examples might be a key
759 # indicating a deprecated resource and a suggested replacement, or a
760 # warning about invalid network settings (for example, if an instance
761 # attempts to perform IP forwarding but is not enabled for IP forwarding).
762 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
763 },
764 ],
765 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
766 },
767 ],
768 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
769 # applicable when performing per-zone operations.
770 }</pre>
771 </div>
772
773 </body></html>