Debian Codegraph @

docs/dyn/compute_beta.hosts.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <h1><a href="compute_beta.html">Compute Engine API</a> . <a href="compute_beta.hosts.html">hosts</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, association, host, x__xgafv=None)</a></code></p>
82 <p class="firstline">Retrieves information about the specified host.</p>
83 <p class="toc_element">
84 <code><a href="#getVersion">getVersion(project, zone, association, host, body=None, requestId=None, x__xgafv=None)</a></code></p>
85 <p class="firstline">Allows customers to get SBOM versions of a host.</p>
86 <p class="toc_element">
87 <code><a href="#list">list(project, zone, association, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Retrieves a list of hosts.</p>
89 <p class="toc_element">
90 <code><a href="#list_next">list_next()</a></code></p>
91 <p class="firstline">Retrieves the next page of results.</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, association, host, x__xgafv=None)</code>
100 <pre>Retrieves information about the specified host.
101
102 Args:
103 project: string, The project ID for this request. (required)
104 zone: string, The name of the zone for this request, formatted as RFC1035. (required)
105 association: string, The parent resource association for the Host. This field specifies the
106 hierarchical context (e.g., reservation, block, sub-block) when
107 accessing the host. For example, reservations/reservation_name,
108 reservations/reservation_name/reservationBlocks/reservation_block_name or
109 reservations/reservation_name/reservationBlocks/reservation_block_name/reservationSubBlocks/reservation_sub_block_name. (required)
110 host: string, The name of the host, formatted as RFC1035 or a resource ID
111 number. (required)
112 x__xgafv: string, V1 error format.
113 Allowed values
114 1 - v1 error format
115 2 - v2 error format
116
117 Returns:
118 An object of the form:
119
120 { # Represents a host resource.
121 &quot;aliasLinks&quot;: [ # Output only. All aliases for this resource.
122 # e.g.
123 # projects/123/zones/us-centra1-a/reservation/r1/reservationBlock/b1/hosts/h1
124 &quot;A String&quot;,
125 ],
126 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. The creation timestamp, formatted asRFC3339 text.
127 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource.
128 &quot;id&quot;: &quot;A String&quot;, # Output only. The unique identifier for this resource. This identifier is
129 # defined by the server.
130 &quot;kind&quot;: &quot;compute#host&quot;, # Output only. The type of resource. Alwayscompute#host for hosts.
131 &quot;name&quot;: &quot;A String&quot;, # Output only. The name of the host.
132 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. The self link of the host.
133 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. The self link with id of the host.
134 &quot;state&quot;: &quot;A String&quot;, # Output only. The state of the host.
135 &quot;status&quot;: { # Output only. The status of the host
136 &quot;physicalTopology&quot;: { # Output only. The physical topology of the reservation sub-block, if
137 # present
138 &quot;block&quot;: &quot;A String&quot;, # The unique identifier of the capacity block within the cluster.
139 &quot;cluster&quot;: &quot;A String&quot;, # The cluster name of the reservation sub-block.
140 &quot;host&quot;: &quot;A String&quot;, # The unique identifier of the capacity host within the capacity sub-block.
141 &quot;subBlock&quot;: &quot;A String&quot;, # The unique identifier of the capacity sub-block within the capacity
142 # block.
143 },
144 &quot;runningInstances&quot;: [ # Output only. The URIs of the instances currently running on this host.
145 &quot;A String&quot;,
146 ],
147 },
148 &quot;zone&quot;: &quot;A String&quot;, # Output only. The zone in which the host resides.
149 }</pre>
150 </div>
151
152 <div class="method">
153 <code class="details" id="getVersion">getVersion(project, zone, association, host, body=None, requestId=None, x__xgafv=None)</code>
154 <pre>Allows customers to get SBOM versions of a host.
155
156 Args:
157 project: string, Project ID for this request. (required)
158 zone: string, Name of the zone for this request. Zone name should conform to RFC1035. (required)
159 association: string, The parent resource association for the Host. This field specifies the
160 hierarchical context (e.g., reservation, block, sub-block) when
161 accessing the host. (required)
162 host: string, The name of the host, formatted as RFC1035 or a resource ID
163 number. (required)
164 body: object, The request body.
165 The object takes the form of:
166
167 {
168 &quot;sbomSelections&quot;: [ # The SBOM selection to return. Duplicate values in the list will be ignored.
169 &quot;A String&quot;,
170 ],
171 }
172
173 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
174 that if you must retry your request, the server will know to ignore the
175 request if it has already been completed.
176 x__xgafv: string, V1 error format.
177 Allowed values
178 1 - v1 error format
179 2 - v2 error format
180
181 Returns:
182 An object of the form:
183
184 { # Represents an Operation resource.
185 #
186 # Google Compute Engine has three Operation resources:
187 #
188 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
189 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
190 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
191 #
192 # You can use an operation resource to manage asynchronous API requests.
193 # For more information, readHandling
194 # API responses.
195 #
196 # Operations can be global, regional or zonal.
197 #
198 # - For global operations, use the `globalOperations`
199 # resource.
200 # - For regional operations, use the
201 # `regionOperations` resource.
202 # - For zonal operations, use
203 # the `zoneOperations` resource.
204 #
205 #
206 #
207 # For more information, read
208 # Global, Regional, and Zonal Resources.
209 #
210 # Note that completed Operation resources have a limited
211 # retention period.
212 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
213 # Not present otherwise.
214 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
215 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
216 # set when the operation is created.
217 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
218 # text format.
219 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
220 # this field will be populated.
221 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
222 # operation.
223 {
224 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
225 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
226 # details. There is a set of defined message types to use for providing
227 # details.The syntax depends on the error code. For example,
228 # QuotaExceededInfo will have details when the error code is
229 # QUOTA_EXCEEDED.
230 {
231 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
232 #
233 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
234 # is not enabled:
235 #
236 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
237 # &quot;domain&quot;: &quot;googleapis.com&quot;
238 # &quot;metadata&quot;: {
239 # &quot;resource&quot;: &quot;projects/123&quot;,
240 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
241 # }
242 # }
243 #
244 # This response indicates that the pubsub.googleapis.com API is not enabled.
245 #
246 # Example of an error that is returned when attempting to create a Spanner
247 # instance in a region that is out of stock:
248 #
249 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
250 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
251 # &quot;metadata&quot;: {
252 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
253 # }
254 # }
255 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
256 # is typically the registered service name of the tool or product that
257 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
258 # generated by some common infrastructure, the error domain must be a
259 # globally unique value that identifies the infrastructure. For Google API
260 # infrastructure, the error domain is &quot;googleapis.com&quot;.
261 &quot;metadatas&quot;: { # Additional structured details about this error.
262 #
263 # Keys must match a regular expression of `a-z+` but should
264 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
265 # length. When identifying the current value of an exceeded limit, the units
266 # should be contained in the key, not the value. For example, rather than
267 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
268 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
269 # instances that can be created in a single (batch) request.
270 &quot;a_key&quot;: &quot;A String&quot;,
271 },
272 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
273 # proximate cause of the error. Error reasons are unique within a particular
274 # domain of errors. This should be at most 63 characters and match a
275 # regular expression of `A-Z+[A-Z0-9]`, which represents
276 # UPPER_SNAKE_CASE.
277 },
278 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
279 #
280 # For example, if a quota check failed with an error indicating the calling
281 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
282 # directly to the right place in the developer console to flip the bit.
283 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
284 { # Describes a URL link.
285 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
286 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
287 },
288 ],
289 },
290 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
291 # which can be attached to an RPC error.
292 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
293 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
294 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
295 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
296 },
297 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
298 &quot;dimensions&quot;: { # The map holding related quota dimensions.
299 &quot;a_key&quot;: &quot;A String&quot;,
300 },
301 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
302 # type or metric.
303 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
304 # or metric.
305 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
306 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
307 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
308 },
309 },
310 ],
311 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
312 # This property is optional.
313 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
314 },
315 ],
316 },
317 &quot;getVersionOperationMetadata&quot;: {
318 &quot;inlineSbomInfo&quot;: {
319 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
320 # appropriate identifiers.
321 &quot;a_key&quot;: &quot;A String&quot;,
322 },
323 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
324 # identifiers.
325 &quot;a_key&quot;: &quot;A String&quot;,
326 },
327 },
328 },
329 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
330 # message that was returned, such as `NOT FOUND`.
331 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
332 # status code that was returned. For example, a `404` means the
333 # resource was not found.
334 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
335 # defined by the server.
336 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
337 # This value is inRFC3339
338 # text format.
339 &quot;instancesBulkInsertOperationMetadata&quot;: {
340 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
341 # Example key: zones/us-central1-a
342 &quot;a_key&quot;: {
343 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
344 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
345 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
346 # error.
347 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
348 # if the flow is rolling forward or rolling back.
349 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
350 },
351 },
352 },
353 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
354 # Operation resources.
355 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
356 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
357 # group of operations results from a `bulkInsert` API request.
358 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
359 # `update`, or `delete`, and so on.
360 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
361 # There is no requirement that this be linear or support any granularity of
362 # operations. This should not be used to guess when the operation will be
363 # complete. This number should monotonically increase as the operation
364 # progresses.
365 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
366 # applicable when performing regional operations.
367 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
368 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
369 # this field will contain information on all underlying zonal actions and
370 # their state.
371 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
372 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
373 # Example key: zones/us-central1-a
374 &quot;a_key&quot;: {
375 &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
376 # populated.
377 # different programming environments, including REST APIs and RPC APIs. It is
378 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
379 # three pieces of data: error code, error message, and error details.
380 #
381 # You can find out more about this error model and how to work with it in the
382 # [API Design Guide](https://cloud.google.com/apis/design/errors).
383 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
384 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
385 # message types for APIs to use.
386 {
387 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
388 },
389 ],
390 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
391 # user-facing error message should be localized and sent in the
392 # google.rpc.Status.details field, or localized by the client.
393 },
394 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
395 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
396 },
397 },
398 },
399 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
400 # This value is inRFC3339
401 # text format.
402 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
403 # following:
404 # `PENDING`, `RUNNING`, or `DONE`.
405 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
406 # operation.
407 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
408 # of the target resource.
409 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
410 # operations related to creating a snapshot, this points to the disk
411 # that the snapshot was created from.
412 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
413 # `[email protected]` or
414 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
415 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
416 # operation, this field will be populated.
417 {
418 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
419 # Engine returns NO_RESULTS_ON_PAGE if there
420 # are no results in the response.
421 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
422 # value format. For example:
423 #
424 # &quot;data&quot;: [
425 # {
426 # &quot;key&quot;: &quot;scope&quot;,
427 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
428 # }
429 {
430 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
431 # returned. For example, for warnings where there are no results in a list
432 # request for a particular zone, this key might be scope and
433 # the key value might be the zone name. Other examples might be a key
434 # indicating a deprecated resource and a suggested replacement, or a
435 # warning about invalid network settings (for example, if an instance
436 # attempts to perform IP forwarding but is not enabled for IP forwarding).
437 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
438 },
439 ],
440 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
441 },
442 ],
443 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
444 # applicable when performing per-zone operations.
445 }</pre>
446 </div>
447
448 <div class="method">
449 <code class="details" id="list">list(project, zone, association, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
450 <pre>Retrieves a list of hosts.
451
452 Args:
453 project: string, The project ID for this request. (required)
454 zone: string, The name of the zone for this request, formatted as RFC1035. (required)
455 association: string, The parent resource association for the Host. This field specifies the
456 hierarchical context (e.g., reservation, block, sub-block) when
457 accessing the host. For example, reservations/reservation_name,
458 reservations/reservation_name/reservationBlocks/reservation_block_name or
459 reservations/reservation_name/reservationBlocks/reservation_block_name/reservationSubBlocks/reservation_sub_block_name. (required)
460 filter: string, A filter expression that filters resources listed in the response. Most
461 Compute resources support two types of filter expressions:
462 expressions that support regular expressions and expressions that follow
463 API improvement proposal AIP-160.
464 These two types of filter expressions cannot be mixed in one request.
465
466 If you want to use AIP-160, your expression must specify the field name, an
467 operator, and the value that you want to use for filtering. The value
468 must be a string, a number, or a boolean. The operator
469 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
470
471 For example, if you are filtering Compute Engine instances, you can
472 exclude instances named `example-instance` by specifying
473 `name != example-instance`.
474
475 The `:*` comparison can be used to test whether a key has been defined.
476 For example, to find all objects with `owner` label use:
477 ```
478 labels.owner:*
479 ```
480
481 You can also filter nested fields. For example, you could specify
482 `scheduling.automaticRestart = false` to include instances only
483 if they are not scheduled for automatic restarts. You can use filtering
484 on nested fields to filter based onresource labels.
485
486 To filter on multiple expressions, provide each separate expression within
487 parentheses. For example:
488 ```
489 (scheduling.automaticRestart = true)
490 (cpuPlatform = &quot;Intel Skylake&quot;)
491 ```
492 By default, each expression is an `AND` expression. However, you
493 can include `AND` and `OR` expressions explicitly.
494 For example:
495 ```
496 (cpuPlatform = &quot;Intel Skylake&quot;) OR
497 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
498 (scheduling.automaticRestart = true)
499 ```
500
501 If you want to use a regular expression, use the `eq` (equal) or `ne`
502 (not equal) operator against a single un-parenthesized expression with or
503 without quotes or against multiple parenthesized expressions. Examples:
504
505 `fieldname eq unquoted literal`
506 `fieldname eq &#x27;single quoted literal&#x27;`
507 `fieldname eq &quot;double quoted literal&quot;`
508 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
509
510 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
511 The literal value must match the entire field.
512
513 For example, to filter for instances that do not end with name &quot;instance&quot;,
514 you would use `name ne .*instance`.
515
516 You cannot combine constraints on multiple fields using regular
517 expressions.
518 maxResults: integer, The maximum number of results per page that should be returned.
519 If the number of available results is larger than `maxResults`,
520 Compute Engine returns a `nextPageToken` that can be used to get
521 the next page of results in subsequent list requests. Acceptable values are
522 `0` to `500`, inclusive. (Default: `500`)
523 orderBy: string, Sorts list results by a certain order. By default, results
524 are returned in alphanumerical order based on the resource name.
525
526 You can also sort results in descending order based on the creation
527 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
528 results based on the `creationTimestamp` field in
529 reverse chronological order (newest result first). Use this to sort
530 resources like operations so that the newest operation is returned first.
531
532 Currently, only sorting by `name` or
533 `creationTimestamp desc` is supported.
534 pageToken: string, Specifies a page token to use. Set `pageToken` to the
535 `nextPageToken` returned by a previous list request to get
536 the next page of results.
537 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
538 of failure. The default value is false.
539
540 For example, when partial success behavior is enabled, aggregatedList for a
541 single zone scope either returns all resources in the zone or no resources,
542 with an error code.
543 x__xgafv: string, V1 error format.
544 Allowed values
545 1 - v1 error format
546 2 - v2 error format
547
548 Returns:
549 An object of the form:
550
551 {
552 &quot;etag&quot;: &quot;A String&quot;,
553 &quot;id&quot;: &quot;A String&quot;, # The unique identifier for the resource; defined by the server.
554 &quot;items&quot;: [ # A list of host resources.
555 { # Represents a host resource.
556 &quot;aliasLinks&quot;: [ # Output only. All aliases for this resource.
557 # e.g.
558 # projects/123/zones/us-centra1-a/reservation/r1/reservationBlock/b1/hosts/h1
559 &quot;A String&quot;,
560 ],
561 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. The creation timestamp, formatted asRFC3339 text.
562 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource.
563 &quot;id&quot;: &quot;A String&quot;, # Output only. The unique identifier for this resource. This identifier is
564 # defined by the server.
565 &quot;kind&quot;: &quot;compute#host&quot;, # Output only. The type of resource. Alwayscompute#host for hosts.
566 &quot;name&quot;: &quot;A String&quot;, # Output only. The name of the host.
567 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. The self link of the host.
568 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. The self link with id of the host.
569 &quot;state&quot;: &quot;A String&quot;, # Output only. The state of the host.
570 &quot;status&quot;: { # Output only. The status of the host
571 &quot;physicalTopology&quot;: { # Output only. The physical topology of the reservation sub-block, if
572 # present
573 &quot;block&quot;: &quot;A String&quot;, # The unique identifier of the capacity block within the cluster.
574 &quot;cluster&quot;: &quot;A String&quot;, # The cluster name of the reservation sub-block.
575 &quot;host&quot;: &quot;A String&quot;, # The unique identifier of the capacity host within the capacity sub-block.
576 &quot;subBlock&quot;: &quot;A String&quot;, # The unique identifier of the capacity sub-block within the capacity
577 # block.
578 },
579 &quot;runningInstances&quot;: [ # Output only. The URIs of the instances currently running on this host.
580 &quot;A String&quot;,
581 ],
582 },
583 &quot;zone&quot;: &quot;A String&quot;, # Output only. The zone in which the host resides.
584 },
585 ],
586 &quot;kind&quot;: &quot;compute#host&quot;, # The type of resource. Always compute#host for a list of hosts.
587 &quot;nextPageToken&quot;: &quot;A String&quot;, # This token allows you to get the next page of results for
588 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
589 # the query parameter pageToken in the next list request.
590 # Subsequent list requests will have their own nextPageToken to
591 # continue paging through the results.
592 &quot;selfLink&quot;: &quot;A String&quot;, # The server-defined URL for this resource.
593 &quot;unreachables&quot;: [ # Unreachable resources.
594 # end_interface: MixerListResponseWithEtagBuilder
595 &quot;A String&quot;,
596 ],
597 &quot;warning&quot;: { # An informational warning message.
598 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
599 # Engine returns NO_RESULTS_ON_PAGE if there
600 # are no results in the response.
601 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
602 # value format. For example:
603 #
604 # &quot;data&quot;: [
605 # {
606 # &quot;key&quot;: &quot;scope&quot;,
607 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
608 # }
609 {
610 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
611 # returned. For example, for warnings where there are no results in a list
612 # request for a particular zone, this key might be scope and
613 # the key value might be the zone name. Other examples might be a key
614 # indicating a deprecated resource and a suggested replacement, or a
615 # warning about invalid network settings (for example, if an instance
616 # attempts to perform IP forwarding but is not enabled for IP forwarding).
617 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
618 },
619 ],
620 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
621 },
622 }</pre>
623 </div>
624
625 <div class="method">
626 <code class="details" id="list_next">list_next()</code>
627 <pre>Retrieves the next page of results.
628
629 Args:
630 previous_request: The request for the previous page. (required)
631 previous_response: The response from the request for the previous page. (required)
632
633 Returns:
634 A request object that you can call &#x27;execute()&#x27; on to request the next
635 page. Returns None if there are no more items in the collection.
636 </pre>
637 </div>
638
639 </body></html>