Debian Codegraph @

docs/dyn/compute_alpha.machineTypes.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.machineTypes.html">machineTypes</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 machine types.</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="#close">close()</a></code></p>
85 <p class="firstline">Close httplib2 connections.</p>
86 <p class="toc_element">
87 <code><a href="#get">get(project, zone, machineType, x__xgafv=None)</a></code></p>
88 <p class="firstline">Returns the specified machine type.</p>
89 <p class="toc_element">
90 <code><a href="#list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
91 <p class="firstline">Retrieves a list of machine types available to the specified</p>
92 <p class="toc_element">
93 <code><a href="#list_next">list_next()</a></code></p>
94 <p class="firstline">Retrieves the next page of results.</p>
95 <h3>Method Details</h3>
96 <div class="method">
97 <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>
98 <pre>Retrieves an aggregated list of machine types.
99
100 To prevent failure, Google recommends that you set the
101 `returnPartialSuccess` parameter to `true`.
102
103 Args:
104 project: string, Project ID for this request. (required)
105 filter: string, A filter expression that filters resources listed in the response. Most
106 Compute resources support two types of filter expressions:
107 expressions that support regular expressions and expressions that follow
108 API improvement proposal AIP-160.
109 These two types of filter expressions cannot be mixed in one request.
110
111 If you want to use AIP-160, your expression must specify the field name, an
112 operator, and the value that you want to use for filtering. The value
113 must be a string, a number, or a boolean. The operator
114 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
115
116 For example, if you are filtering Compute Engine instances, you can
117 exclude instances named `example-instance` by specifying
118 `name != example-instance`.
119
120 The `:*` comparison can be used to test whether a key has been defined.
121 For example, to find all objects with `owner` label use:
122 ```
123 labels.owner:*
124 ```
125
126 You can also filter nested fields. For example, you could specify
127 `scheduling.automaticRestart = false` to include instances only
128 if they are not scheduled for automatic restarts. You can use filtering
129 on nested fields to filter based onresource labels.
130
131 To filter on multiple expressions, provide each separate expression within
132 parentheses. For example:
133 ```
134 (scheduling.automaticRestart = true)
135 (cpuPlatform = &quot;Intel Skylake&quot;)
136 ```
137 By default, each expression is an `AND` expression. However, you
138 can include `AND` and `OR` expressions explicitly.
139 For example:
140 ```
141 (cpuPlatform = &quot;Intel Skylake&quot;) OR
142 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
143 (scheduling.automaticRestart = true)
144 ```
145
146 If you want to use a regular expression, use the `eq` (equal) or `ne`
147 (not equal) operator against a single un-parenthesized expression with or
148 without quotes or against multiple parenthesized expressions. Examples:
149
150 `fieldname eq unquoted literal`
151 `fieldname eq &#x27;single quoted literal&#x27;`
152 `fieldname eq &quot;double quoted literal&quot;`
153 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
154
155 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
156 The literal value must match the entire field.
157
158 For example, to filter for instances that do not end with name &quot;instance&quot;,
159 you would use `name ne .*instance`.
160
161 You cannot combine constraints on multiple fields using regular
162 expressions.
163 includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region,
164 global) should be included in the response. For new resource types added
165 after this field, the flag has no effect as new resource types will always
166 include every visible scope for each scope type in response. For resource
167 types which predate this field, if this flag is omitted or false, only
168 scopes of the scope types where the resource type is expected to be found
169 will be included.
170 maxResults: integer, The maximum number of results per page that should be returned.
171 If the number of available results is larger than `maxResults`,
172 Compute Engine returns a `nextPageToken` that can be used to get
173 the next page of results in subsequent list requests. Acceptable values are
174 `0` to `500`, inclusive. (Default: `500`)
175 orderBy: string, Sorts list results by a certain order. By default, results
176 are returned in alphanumerical order based on the resource name.
177
178 You can also sort results in descending order based on the creation
179 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
180 results based on the `creationTimestamp` field in
181 reverse chronological order (newest result first). Use this to sort
182 resources like operations so that the newest operation is returned first.
183
184 Currently, only sorting by `name` or
185 `creationTimestamp desc` is supported.
186 pageToken: string, Specifies a page token to use. Set `pageToken` to the
187 `nextPageToken` returned by a previous list request to get
188 the next page of results.
189 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
190 of failure. The default value is false.
191
192 For example, when partial success behavior is enabled, aggregatedList for a
193 single zone scope either returns all resources in the zone or no resources,
194 with an error code.
195 serviceProjectNumber: string, The Shared VPC service project id or service project number for which
196 aggregated list request is invoked for subnetworks list-usable api.
197 x__xgafv: string, V1 error format.
198 Allowed values
199 1 - v1 error format
200 2 - v2 error format
201
202 Returns:
203 An object of the form:
204
205 {
206 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
207 &quot;items&quot;: { # A list of MachineTypesScopedList resources.
208 &quot;a_key&quot;: { # [Output Only] Name of the scope containing this set of machine types.
209 &quot;machineTypes&quot;: [ # [Output Only] A list of machine types contained in this scope.
210 { # Represents a Machine Type resource.
211 #
212 # You can use specific machine types for your VM instances based on performance
213 # and pricing requirements. For more information, readMachine Types.
214 &quot;accelerators&quot;: [ # [Output Only] A list of accelerator configurations assigned to this
215 # machine type.
216 {
217 &quot;guestAcceleratorCount&quot;: 42, # Number of accelerator cards exposed to the guest.
218 &quot;guestAcceleratorType&quot;: &quot;A String&quot;, # The accelerator type resource name, not a full URL, e.g.nvidia-tesla-t4.
219 },
220 ],
221 &quot;architecture&quot;: &quot;A String&quot;, # [Output Only] The architecture of the machine type.
222 &quot;bundledLocalSsds&quot;: { # [Output Only] The configuration of bundled local SSD for the machine type.
223 &quot;defaultInterface&quot;: &quot;A String&quot;, # The default disk interface if the interface is not specified.
224 &quot;partitionCount&quot;: 42, # The number of partitions.
225 },
226 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp inRFC3339
227 # text format.
228 &quot;deprecated&quot;: { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this machine type.
229 # Only applicable if the machine type is unavailable.
230 &quot;deleted&quot;: &quot;A String&quot;, # An optional RFC3339 timestamp on or after which the state of this
231 # resource is intended to change to DELETED. This is only
232 # informational and the status will not change unless the client explicitly
233 # changes it.
234 &quot;deprecated&quot;: &quot;A String&quot;, # An optional RFC3339 timestamp on or after which the state of this
235 # resource is intended to change to DEPRECATED. This is only
236 # informational and the status will not change unless the client explicitly
237 # changes it.
238 &quot;obsolete&quot;: &quot;A String&quot;, # An optional RFC3339 timestamp on or after which the state of this
239 # resource is intended to change to OBSOLETE. This is only
240 # informational and the status will not change unless the client explicitly
241 # changes it.
242 &quot;replacement&quot;: &quot;A String&quot;, # The URL of the suggested replacement for a deprecated resource.
243 # The suggested replacement resource must be the same kind of resource as the
244 # deprecated resource.
245 &quot;state&quot;: &quot;A String&quot;, # The deprecation state of this resource. This can be ACTIVE,DEPRECATED, OBSOLETE, or DELETED.
246 # Operations which communicate the end of life date for an image, can useACTIVE. Operations which create a new resource using aDEPRECATED resource will return successfully, but with a
247 # warning indicating the deprecated resource and recommending its
248 # replacement. Operations which use OBSOLETE orDELETED resources will be rejected and result in an error.
249 &quot;stateOverride&quot;: { # A rollout policy configuration. # The rollout policy for this deprecation. This policy is only enforced by
250 # image family views. The rollout policy restricts the zones where the
251 # associated resource is considered in a deprecated state. When the rollout
252 # policy does not include the user specified zone, or if the zone is rolled
253 # out, the associated resource is considered in a deprecated state.
254 #
255 # The rollout policy for this deprecation is read-only, except for
256 # allowlisted users. This field might not be configured. To view the latest
257 # non-deprecated image in a specific zone, use theimageFamilyViews.get method.
258 &quot;defaultRolloutTime&quot;: &quot;A String&quot;, # An optional RFC3339 timestamp on or after which the update is
259 # considered rolled out to any zone that is not explicitly stated.
260 &quot;locationRolloutPolicies&quot;: { # Location based rollout policies to apply to the resource.
261 #
262 # Currently only zone names are supported and must be represented
263 # as valid URLs, like: zones/us-central1-a.
264 #
265 # The value expects an RFC3339 timestamp on or after which the update is
266 # considered rolled out to the specified location.
267 &quot;a_key&quot;: &quot;A String&quot;,
268 },
269 },
270 },
271 &quot;description&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the resource.
272 &quot;guestCpus&quot;: 42, # [Output Only] The number of virtual CPUs that are available to the
273 # instance.
274 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
275 # defined by the server.
276 &quot;isSharedCpu&quot;: True or False, # [Output Only] Whether this machine type has a shared CPU. SeeShared-core machine
277 # types for more information.
278 &quot;kind&quot;: &quot;compute#machineType&quot;, # Output only. [Output Only] The type of the resource. Alwayscompute#machineType for machine types.
279 &quot;maximumPersistentDisks&quot;: 42, # [Output Only] Maximum persistent disks allowed.
280 &quot;maximumPersistentDisksSizeGb&quot;: &quot;A String&quot;, # [Output Only] Maximum total persistent disks size (GB) allowed.
281 &quot;memoryMb&quot;: 42, # [Output Only] The amount of physical memory available to the instance,
282 # defined in MB.
283 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the resource.
284 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
285 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
286 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The name of the zone where the machine type resides,
287 # such as us-central1-a.
288 },
289 ],
290 &quot;warning&quot;: { # [Output Only] An informational warning that appears when the machine types
291 # list is empty.
292 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
293 # Engine returns NO_RESULTS_ON_PAGE if there
294 # are no results in the response.
295 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
296 # value format. For example:
297 #
298 # &quot;data&quot;: [
299 # {
300 # &quot;key&quot;: &quot;scope&quot;,
301 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
302 # }
303 {
304 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
305 # returned. For example, for warnings where there are no results in a list
306 # request for a particular zone, this key might be scope and
307 # the key value might be the zone name. Other examples might be a key
308 # indicating a deprecated resource and a suggested replacement, or a
309 # warning about invalid network settings (for example, if an instance
310 # attempts to perform IP forwarding but is not enabled for IP forwarding).
311 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
312 },
313 ],
314 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
315 },
316 },
317 },
318 &quot;kind&quot;: &quot;compute#machineTypeAggregatedList&quot;, # Output only. [Output Only] Type of resource. Alwayscompute#machineTypeAggregatedList for aggregated lists of
319 # machine types.
320 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
321 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
322 # the query parameter pageToken in the next list request.
323 # Subsequent list requests will have their own nextPageToken to
324 # continue paging through the results.
325 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
326 &quot;unreachables&quot;: [ # Output only. [Output Only] Unreachable resources.
327 &quot;A String&quot;,
328 ],
329 &quot;warning&quot;: { # [Output Only] Informational warning message.
330 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
331 # Engine returns NO_RESULTS_ON_PAGE if there
332 # are no results in the response.
333 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
334 # value format. For example:
335 #
336 # &quot;data&quot;: [
337 # {
338 # &quot;key&quot;: &quot;scope&quot;,
339 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
340 # }
341 {
342 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
343 # returned. For example, for warnings where there are no results in a list
344 # request for a particular zone, this key might be scope and
345 # the key value might be the zone name. Other examples might be a key
346 # indicating a deprecated resource and a suggested replacement, or a
347 # warning about invalid network settings (for example, if an instance
348 # attempts to perform IP forwarding but is not enabled for IP forwarding).
349 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
350 },
351 ],
352 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
353 },
354 }</pre>
355 </div>
356
357 <div class="method">
358 <code class="details" id="aggregatedList_next">aggregatedList_next()</code>
359 <pre>Retrieves the next page of results.
360
361 Args:
362 previous_request: The request for the previous page. (required)
363 previous_response: The response from the request for the previous page. (required)
364
365 Returns:
366 A request object that you can call &#x27;execute()&#x27; on to request the next
367 page. Returns None if there are no more items in the collection.
368 </pre>
369 </div>
370
371 <div class="method">
372 <code class="details" id="close">close()</code>
373 <pre>Close httplib2 connections.</pre>
374 </div>
375
376 <div class="method">
377 <code class="details" id="get">get(project, zone, machineType, x__xgafv=None)</code>
378 <pre>Returns the specified machine type.
379
380 Args:
381 project: string, Project ID for this request. (required)
382 zone: string, The name of the zone for this request. (required)
383 machineType: string, Name of the machine type to return. (required)
384 x__xgafv: string, V1 error format.
385 Allowed values
386 1 - v1 error format
387 2 - v2 error format
388
389 Returns:
390 An object of the form:
391
392 { # Represents a Machine Type resource.
393 #
394 # You can use specific machine types for your VM instances based on performance
395 # and pricing requirements. For more information, readMachine Types.
396 &quot;accelerators&quot;: [ # [Output Only] A list of accelerator configurations assigned to this
397 # machine type.
398 {
399 &quot;guestAcceleratorCount&quot;: 42, # Number of accelerator cards exposed to the guest.
400 &quot;guestAcceleratorType&quot;: &quot;A String&quot;, # The accelerator type resource name, not a full URL, e.g.nvidia-tesla-t4.
401 },
402 ],
403 &quot;architecture&quot;: &quot;A String&quot;, # [Output Only] The architecture of the machine type.
404 &quot;bundledLocalSsds&quot;: { # [Output Only] The configuration of bundled local SSD for the machine type.
405 &quot;defaultInterface&quot;: &quot;A String&quot;, # The default disk interface if the interface is not specified.
406 &quot;partitionCount&quot;: 42, # The number of partitions.
407 },
408 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp inRFC3339
409 # text format.
410 &quot;deprecated&quot;: { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this machine type.
411 # Only applicable if the machine type is unavailable.
412 &quot;deleted&quot;: &quot;A String&quot;, # An optional RFC3339 timestamp on or after which the state of this
413 # resource is intended to change to DELETED. This is only
414 # informational and the status will not change unless the client explicitly
415 # changes it.
416 &quot;deprecated&quot;: &quot;A String&quot;, # An optional RFC3339 timestamp on or after which the state of this
417 # resource is intended to change to DEPRECATED. This is only
418 # informational and the status will not change unless the client explicitly
419 # changes it.
420 &quot;obsolete&quot;: &quot;A String&quot;, # An optional RFC3339 timestamp on or after which the state of this
421 # resource is intended to change to OBSOLETE. This is only
422 # informational and the status will not change unless the client explicitly
423 # changes it.
424 &quot;replacement&quot;: &quot;A String&quot;, # The URL of the suggested replacement for a deprecated resource.
425 # The suggested replacement resource must be the same kind of resource as the
426 # deprecated resource.
427 &quot;state&quot;: &quot;A String&quot;, # The deprecation state of this resource. This can be ACTIVE,DEPRECATED, OBSOLETE, or DELETED.
428 # Operations which communicate the end of life date for an image, can useACTIVE. Operations which create a new resource using aDEPRECATED resource will return successfully, but with a
429 # warning indicating the deprecated resource and recommending its
430 # replacement. Operations which use OBSOLETE orDELETED resources will be rejected and result in an error.
431 &quot;stateOverride&quot;: { # A rollout policy configuration. # The rollout policy for this deprecation. This policy is only enforced by
432 # image family views. The rollout policy restricts the zones where the
433 # associated resource is considered in a deprecated state. When the rollout
434 # policy does not include the user specified zone, or if the zone is rolled
435 # out, the associated resource is considered in a deprecated state.
436 #
437 # The rollout policy for this deprecation is read-only, except for
438 # allowlisted users. This field might not be configured. To view the latest
439 # non-deprecated image in a specific zone, use theimageFamilyViews.get method.
440 &quot;defaultRolloutTime&quot;: &quot;A String&quot;, # An optional RFC3339 timestamp on or after which the update is
441 # considered rolled out to any zone that is not explicitly stated.
442 &quot;locationRolloutPolicies&quot;: { # Location based rollout policies to apply to the resource.
443 #
444 # Currently only zone names are supported and must be represented
445 # as valid URLs, like: zones/us-central1-a.
446 #
447 # The value expects an RFC3339 timestamp on or after which the update is
448 # considered rolled out to the specified location.
449 &quot;a_key&quot;: &quot;A String&quot;,
450 },
451 },
452 },
453 &quot;description&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the resource.
454 &quot;guestCpus&quot;: 42, # [Output Only] The number of virtual CPUs that are available to the
455 # instance.
456 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
457 # defined by the server.
458 &quot;isSharedCpu&quot;: True or False, # [Output Only] Whether this machine type has a shared CPU. SeeShared-core machine
459 # types for more information.
460 &quot;kind&quot;: &quot;compute#machineType&quot;, # Output only. [Output Only] The type of the resource. Alwayscompute#machineType for machine types.
461 &quot;maximumPersistentDisks&quot;: 42, # [Output Only] Maximum persistent disks allowed.
462 &quot;maximumPersistentDisksSizeGb&quot;: &quot;A String&quot;, # [Output Only] Maximum total persistent disks size (GB) allowed.
463 &quot;memoryMb&quot;: 42, # [Output Only] The amount of physical memory available to the instance,
464 # defined in MB.
465 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the resource.
466 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
467 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
468 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The name of the zone where the machine type resides,
469 # such as us-central1-a.
470 }</pre>
471 </div>
472
473 <div class="method">
474 <code class="details" id="list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
475 <pre>Retrieves a list of machine types available to the specified
476 project.
477
478 Args:
479 project: string, Project ID for this request. (required)
480 zone: string, The name of the zone for this request. (required)
481 filter: string, A filter expression that filters resources listed in the response. Most
482 Compute resources support two types of filter expressions:
483 expressions that support regular expressions and expressions that follow
484 API improvement proposal AIP-160.
485 These two types of filter expressions cannot be mixed in one request.
486
487 If you want to use AIP-160, your expression must specify the field name, an
488 operator, and the value that you want to use for filtering. The value
489 must be a string, a number, or a boolean. The operator
490 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
491
492 For example, if you are filtering Compute Engine instances, you can
493 exclude instances named `example-instance` by specifying
494 `name != example-instance`.
495
496 The `:*` comparison can be used to test whether a key has been defined.
497 For example, to find all objects with `owner` label use:
498 ```
499 labels.owner:*
500 ```
501
502 You can also filter nested fields. For example, you could specify
503 `scheduling.automaticRestart = false` to include instances only
504 if they are not scheduled for automatic restarts. You can use filtering
505 on nested fields to filter based onresource labels.
506
507 To filter on multiple expressions, provide each separate expression within
508 parentheses. For example:
509 ```
510 (scheduling.automaticRestart = true)
511 (cpuPlatform = &quot;Intel Skylake&quot;)
512 ```
513 By default, each expression is an `AND` expression. However, you
514 can include `AND` and `OR` expressions explicitly.
515 For example:
516 ```
517 (cpuPlatform = &quot;Intel Skylake&quot;) OR
518 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
519 (scheduling.automaticRestart = true)
520 ```
521
522 If you want to use a regular expression, use the `eq` (equal) or `ne`
523 (not equal) operator against a single un-parenthesized expression with or
524 without quotes or against multiple parenthesized expressions. Examples:
525
526 `fieldname eq unquoted literal`
527 `fieldname eq &#x27;single quoted literal&#x27;`
528 `fieldname eq &quot;double quoted literal&quot;`
529 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
530
531 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
532 The literal value must match the entire field.
533
534 For example, to filter for instances that do not end with name &quot;instance&quot;,
535 you would use `name ne .*instance`.
536
537 You cannot combine constraints on multiple fields using regular
538 expressions.
539 maxResults: integer, The maximum number of results per page that should be returned.
540 If the number of available results is larger than `maxResults`,
541 Compute Engine returns a `nextPageToken` that can be used to get
542 the next page of results in subsequent list requests. Acceptable values are
543 `0` to `500`, inclusive. (Default: `500`)
544 orderBy: string, Sorts list results by a certain order. By default, results
545 are returned in alphanumerical order based on the resource name.
546
547 You can also sort results in descending order based on the creation
548 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
549 results based on the `creationTimestamp` field in
550 reverse chronological order (newest result first). Use this to sort
551 resources like operations so that the newest operation is returned first.
552
553 Currently, only sorting by `name` or
554 `creationTimestamp desc` is supported.
555 pageToken: string, Specifies a page token to use. Set `pageToken` to the
556 `nextPageToken` returned by a previous list request to get
557 the next page of results.
558 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
559 of failure. The default value is false.
560
561 For example, when partial success behavior is enabled, aggregatedList for a
562 single zone scope either returns all resources in the zone or no resources,
563 with an error code.
564 x__xgafv: string, V1 error format.
565 Allowed values
566 1 - v1 error format
567 2 - v2 error format
568
569 Returns:
570 An object of the form:
571
572 { # Contains a list of machine types.
573 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
574 &quot;items&quot;: [ # A list of MachineType resources.
575 { # Represents a Machine Type resource.
576 #
577 # You can use specific machine types for your VM instances based on performance
578 # and pricing requirements. For more information, readMachine Types.
579 &quot;accelerators&quot;: [ # [Output Only] A list of accelerator configurations assigned to this
580 # machine type.
581 {
582 &quot;guestAcceleratorCount&quot;: 42, # Number of accelerator cards exposed to the guest.
583 &quot;guestAcceleratorType&quot;: &quot;A String&quot;, # The accelerator type resource name, not a full URL, e.g.nvidia-tesla-t4.
584 },
585 ],
586 &quot;architecture&quot;: &quot;A String&quot;, # [Output Only] The architecture of the machine type.
587 &quot;bundledLocalSsds&quot;: { # [Output Only] The configuration of bundled local SSD for the machine type.
588 &quot;defaultInterface&quot;: &quot;A String&quot;, # The default disk interface if the interface is not specified.
589 &quot;partitionCount&quot;: 42, # The number of partitions.
590 },
591 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp inRFC3339
592 # text format.
593 &quot;deprecated&quot;: { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this machine type.
594 # Only applicable if the machine type is unavailable.
595 &quot;deleted&quot;: &quot;A String&quot;, # An optional RFC3339 timestamp on or after which the state of this
596 # resource is intended to change to DELETED. This is only
597 # informational and the status will not change unless the client explicitly
598 # changes it.
599 &quot;deprecated&quot;: &quot;A String&quot;, # An optional RFC3339 timestamp on or after which the state of this
600 # resource is intended to change to DEPRECATED. This is only
601 # informational and the status will not change unless the client explicitly
602 # changes it.
603 &quot;obsolete&quot;: &quot;A String&quot;, # An optional RFC3339 timestamp on or after which the state of this
604 # resource is intended to change to OBSOLETE. This is only
605 # informational and the status will not change unless the client explicitly
606 # changes it.
607 &quot;replacement&quot;: &quot;A String&quot;, # The URL of the suggested replacement for a deprecated resource.
608 # The suggested replacement resource must be the same kind of resource as the
609 # deprecated resource.
610 &quot;state&quot;: &quot;A String&quot;, # The deprecation state of this resource. This can be ACTIVE,DEPRECATED, OBSOLETE, or DELETED.
611 # Operations which communicate the end of life date for an image, can useACTIVE. Operations which create a new resource using aDEPRECATED resource will return successfully, but with a
612 # warning indicating the deprecated resource and recommending its
613 # replacement. Operations which use OBSOLETE orDELETED resources will be rejected and result in an error.
614 &quot;stateOverride&quot;: { # A rollout policy configuration. # The rollout policy for this deprecation. This policy is only enforced by
615 # image family views. The rollout policy restricts the zones where the
616 # associated resource is considered in a deprecated state. When the rollout
617 # policy does not include the user specified zone, or if the zone is rolled
618 # out, the associated resource is considered in a deprecated state.
619 #
620 # The rollout policy for this deprecation is read-only, except for
621 # allowlisted users. This field might not be configured. To view the latest
622 # non-deprecated image in a specific zone, use theimageFamilyViews.get method.
623 &quot;defaultRolloutTime&quot;: &quot;A String&quot;, # An optional RFC3339 timestamp on or after which the update is
624 # considered rolled out to any zone that is not explicitly stated.
625 &quot;locationRolloutPolicies&quot;: { # Location based rollout policies to apply to the resource.
626 #
627 # Currently only zone names are supported and must be represented
628 # as valid URLs, like: zones/us-central1-a.
629 #
630 # The value expects an RFC3339 timestamp on or after which the update is
631 # considered rolled out to the specified location.
632 &quot;a_key&quot;: &quot;A String&quot;,
633 },
634 },
635 },
636 &quot;description&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the resource.
637 &quot;guestCpus&quot;: 42, # [Output Only] The number of virtual CPUs that are available to the
638 # instance.
639 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
640 # defined by the server.
641 &quot;isSharedCpu&quot;: True or False, # [Output Only] Whether this machine type has a shared CPU. SeeShared-core machine
642 # types for more information.
643 &quot;kind&quot;: &quot;compute#machineType&quot;, # Output only. [Output Only] The type of the resource. Alwayscompute#machineType for machine types.
644 &quot;maximumPersistentDisks&quot;: 42, # [Output Only] Maximum persistent disks allowed.
645 &quot;maximumPersistentDisksSizeGb&quot;: &quot;A String&quot;, # [Output Only] Maximum total persistent disks size (GB) allowed.
646 &quot;memoryMb&quot;: 42, # [Output Only] The amount of physical memory available to the instance,
647 # defined in MB.
648 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the resource.
649 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
650 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
651 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The name of the zone where the machine type resides,
652 # such as us-central1-a.
653 },
654 ],
655 &quot;kind&quot;: &quot;compute#machineTypeList&quot;, # Output only. [Output Only] Type of resource. Always compute#machineTypeList
656 # for lists of machine types.
657 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
658 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
659 # the query parameter pageToken in the next list request.
660 # Subsequent list requests will have their own nextPageToken to
661 # continue paging through the results.
662 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
663 &quot;warning&quot;: { # [Output Only] Informational warning message.
664 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
665 # Engine returns NO_RESULTS_ON_PAGE if there
666 # are no results in the response.
667 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
668 # value format. For example:
669 #
670 # &quot;data&quot;: [
671 # {
672 # &quot;key&quot;: &quot;scope&quot;,
673 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
674 # }
675 {
676 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
677 # returned. For example, for warnings where there are no results in a list
678 # request for a particular zone, this key might be scope and
679 # the key value might be the zone name. Other examples might be a key
680 # indicating a deprecated resource and a suggested replacement, or a
681 # warning about invalid network settings (for example, if an instance
682 # attempts to perform IP forwarding but is not enabled for IP forwarding).
683 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
684 },
685 ],
686 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
687 },
688 }</pre>
689 </div>
690
691 <div class="method">
692 <code class="details" id="list_next">list_next()</code>
693 <pre>Retrieves the next page of results.
694
695 Args:
696 previous_request: The request for the previous page. (required)
697 previous_response: The response from the request for the previous page. (required)
698
699 Returns:
700 A request object that you can call &#x27;execute()&#x27; on to request the next
701 page. Returns None if there are no more items in the collection.
702 </pre>
703 </div>
704
705 </body></html>