| 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.acceleratorTypes.html">acceleratorTypes</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 accelerator 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, acceleratorType, x__xgafv=None)</a></code></p> |
| 88 |
<p class="firstline">Returns the specified accelerator 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 accelerator types that are 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 accelerator types. |
| 99 |
|
| 100 |
To prevent failure, it is recommended 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 `=`, `!=`, `>`, `<`, `<=`, `>=` 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 = "Intel Skylake") |
| 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 = "Intel Skylake") OR |
| 142 |
(cpuPlatform = "Intel Broadwell") 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 'single quoted literal'` |
| 152 |
`fieldname eq "double quoted literal"` |
| 153 |
`(fieldname1 eq literal) (fieldname2 ne "literal")` |
| 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 "instance", |
| 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="creationTimestamp desc"`. 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 |
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. |
| 207 |
"items": { # A list of AcceleratorTypesScopedList resources. |
| 208 |
"a_key": { # [Output Only] Name of the scope containing this set of accelerator types. |
| 209 |
"acceleratorTypes": [ # [Output Only] A list of accelerator types contained in this scope. |
| 210 |
{ # Represents an Accelerator Type resource. |
| 211 |
# |
| 212 |
# Google Cloud Platform provides graphics processing units (accelerators) that |
| 213 |
# you can add to VM instances to improve or accelerate performance when working |
| 214 |
# with intensive workloads. For more information, readGPUs on Compute Engine. |
| 215 |
"creationTimestamp": "A String", # [Output Only] Creation timestamp inRFC3339 text format. |
| 216 |
"deprecated": { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this accelerator type. |
| 217 |
"deleted": "A String", # An optional RFC3339 timestamp on or after which the state of this |
| 218 |
# resource is intended to change to DELETED. This is only |
| 219 |
# informational and the status will not change unless the client explicitly |
| 220 |
# changes it. |
| 221 |
"deprecated": "A String", # An optional RFC3339 timestamp on or after which the state of this |
| 222 |
# resource is intended to change to DEPRECATED. This is only |
| 223 |
# informational and the status will not change unless the client explicitly |
| 224 |
# changes it. |
| 225 |
"obsolete": "A String", # An optional RFC3339 timestamp on or after which the state of this |
| 226 |
# resource is intended to change to OBSOLETE. This is only |
| 227 |
# informational and the status will not change unless the client explicitly |
| 228 |
# changes it. |
| 229 |
"replacement": "A String", # The URL of the suggested replacement for a deprecated resource. |
| 230 |
# The suggested replacement resource must be the same kind of resource as the |
| 231 |
# deprecated resource. |
| 232 |
"state": "A String", # The deprecation state of this resource. This can be ACTIVE,DEPRECATED, OBSOLETE, or DELETED. |
| 233 |
# 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 |
| 234 |
# warning indicating the deprecated resource and recommending its |
| 235 |
# replacement. Operations which use OBSOLETE orDELETED resources will be rejected and result in an error. |
| 236 |
"stateOverride": { # A rollout policy configuration. # The rollout policy for this deprecation. This policy is only enforced by |
| 237 |
# image family views. The rollout policy restricts the zones where the |
| 238 |
# associated resource is considered in a deprecated state. When the rollout |
| 239 |
# policy does not include the user specified zone, or if the zone is rolled |
| 240 |
# out, the associated resource is considered in a deprecated state. |
| 241 |
# |
| 242 |
# The rollout policy for this deprecation is read-only, except for |
| 243 |
# allowlisted users. This field might not be configured. To view the latest |
| 244 |
# non-deprecated image in a specific zone, use theimageFamilyViews.get method. |
| 245 |
"defaultRolloutTime": "A String", # An optional RFC3339 timestamp on or after which the update is |
| 246 |
# considered rolled out to any zone that is not explicitly stated. |
| 247 |
"locationRolloutPolicies": { # Location based rollout policies to apply to the resource. |
| 248 |
# |
| 249 |
# Currently only zone names are supported and must be represented |
| 250 |
# as valid URLs, like: zones/us-central1-a. |
| 251 |
# |
| 252 |
# The value expects an RFC3339 timestamp on or after which the update is |
| 253 |
# considered rolled out to the specified location. |
| 254 |
"a_key": "A String", |
| 255 |
}, |
| 256 |
}, |
| 257 |
}, |
| 258 |
"description": "A String", # [Output Only] An optional textual description of the resource. |
| 259 |
"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is |
| 260 |
# defined by the server. |
| 261 |
"kind": "compute#acceleratorType", # Output only. [Output Only] The type of the resource. Alwayscompute#acceleratorType for accelerator types. |
| 262 |
"maximumCardsPerInstance": 42, # [Output Only] Maximum number of accelerator cards allowed per instance. |
| 263 |
"name": "A String", # [Output Only] Name of the resource. |
| 264 |
"selfLink": "A String", # Output only. [Output Only] Server-defined, fully qualified URL for this resource. |
| 265 |
"zone": "A String", # [Output Only] The name of the zone where the accelerator type resides, |
| 266 |
# such as us-central1-a. |
| 267 |
# You must specify this field as part of the HTTP request URL. It is |
| 268 |
# not settable as a field in the request body. |
| 269 |
}, |
| 270 |
], |
| 271 |
"warning": { # [Output Only] An informational warning that appears when the accelerator |
| 272 |
# types list is empty. |
| 273 |
"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute |
| 274 |
# Engine returns NO_RESULTS_ON_PAGE if there |
| 275 |
# are no results in the response. |
| 276 |
"data": [ # [Output Only] Metadata about this warning in key: |
| 277 |
# value format. For example: |
| 278 |
# |
| 279 |
# "data": [ |
| 280 |
# { |
| 281 |
# "key": "scope", |
| 282 |
# "value": "zones/us-east1-d" |
| 283 |
# } |
| 284 |
{ |
| 285 |
"key": "A String", # [Output Only] A key that provides more detail on the warning being |
| 286 |
# returned. For example, for warnings where there are no results in a list |
| 287 |
# request for a particular zone, this key might be scope and |
| 288 |
# the key value might be the zone name. Other examples might be a key |
| 289 |
# indicating a deprecated resource and a suggested replacement, or a |
| 290 |
# warning about invalid network settings (for example, if an instance |
| 291 |
# attempts to perform IP forwarding but is not enabled for IP forwarding). |
| 292 |
"value": "A String", # [Output Only] A warning data value corresponding to the key. |
| 293 |
}, |
| 294 |
], |
| 295 |
"message": "A String", # [Output Only] A human-readable description of the warning code. |
| 296 |
}, |
| 297 |
}, |
| 298 |
}, |
| 299 |
"kind": "compute#acceleratorTypeAggregatedList", # Output only. [Output Only] Type of resource. Alwayscompute#acceleratorTypeAggregatedList for aggregated lists of |
| 300 |
# accelerator types. |
| 301 |
"nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for |
| 302 |
# list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for |
| 303 |
# the query parameter pageToken in the next list request. |
| 304 |
# Subsequent list requests will have their own nextPageToken to |
| 305 |
# continue paging through the results. |
| 306 |
"selfLink": "A String", # Output only. [Output Only] Server-defined URL for this resource. |
| 307 |
"unreachables": [ # Output only. [Output Only] Unreachable resources. |
| 308 |
"A String", |
| 309 |
], |
| 310 |
"warning": { # [Output Only] Informational warning message. |
| 311 |
"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute |
| 312 |
# Engine returns NO_RESULTS_ON_PAGE if there |
| 313 |
# are no results in the response. |
| 314 |
"data": [ # [Output Only] Metadata about this warning in key: |
| 315 |
# value format. For example: |
| 316 |
# |
| 317 |
# "data": [ |
| 318 |
# { |
| 319 |
# "key": "scope", |
| 320 |
# "value": "zones/us-east1-d" |
| 321 |
# } |
| 322 |
{ |
| 323 |
"key": "A String", # [Output Only] A key that provides more detail on the warning being |
| 324 |
# returned. For example, for warnings where there are no results in a list |
| 325 |
# request for a particular zone, this key might be scope and |
| 326 |
# the key value might be the zone name. Other examples might be a key |
| 327 |
# indicating a deprecated resource and a suggested replacement, or a |
| 328 |
# warning about invalid network settings (for example, if an instance |
| 329 |
# attempts to perform IP forwarding but is not enabled for IP forwarding). |
| 330 |
"value": "A String", # [Output Only] A warning data value corresponding to the key. |
| 331 |
}, |
| 332 |
], |
| 333 |
"message": "A String", # [Output Only] A human-readable description of the warning code. |
| 334 |
}, |
| 335 |
}</pre> |
| 336 |
</div> |
| 337 |
|
| 338 |
<div class="method"> |
| 339 |
<code class="details" id="aggregatedList_next">aggregatedList_next()</code> |
| 340 |
<pre>Retrieves the next page of results. |
| 341 |
|
| 342 |
Args: |
| 343 |
previous_request: The request for the previous page. (required) |
| 344 |
previous_response: The response from the request for the previous page. (required) |
| 345 |
|
| 346 |
Returns: |
| 347 |
A request object that you can call 'execute()' on to request the next |
| 348 |
page. Returns None if there are no more items in the collection. |
| 349 |
</pre> |
| 350 |
</div> |
| 351 |
|
| 352 |
<div class="method"> |
| 353 |
<code class="details" id="close">close()</code> |
| 354 |
<pre>Close httplib2 connections.</pre> |
| 355 |
</div> |
| 356 |
|
| 357 |
<div class="method"> |
| 358 |
<code class="details" id="get">get(project, zone, acceleratorType, x__xgafv=None)</code> |
| 359 |
<pre>Returns the specified accelerator type. |
| 360 |
|
| 361 |
Args: |
| 362 |
project: string, Project ID for this request. (required) |
| 363 |
zone: string, The name of the zone for this request. (required) |
| 364 |
acceleratorType: string, Name of the accelerator type to return. (required) |
| 365 |
x__xgafv: string, V1 error format. |
| 366 |
Allowed values |
| 367 |
1 - v1 error format |
| 368 |
2 - v2 error format |
| 369 |
|
| 370 |
Returns: |
| 371 |
An object of the form: |
| 372 |
|
| 373 |
{ # Represents an Accelerator Type resource. |
| 374 |
# |
| 375 |
# Google Cloud Platform provides graphics processing units (accelerators) that |
| 376 |
# you can add to VM instances to improve or accelerate performance when working |
| 377 |
# with intensive workloads. For more information, readGPUs on Compute Engine. |
| 378 |
"creationTimestamp": "A String", # [Output Only] Creation timestamp inRFC3339 text format. |
| 379 |
"deprecated": { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this accelerator type. |
| 380 |
"deleted": "A String", # An optional RFC3339 timestamp on or after which the state of this |
| 381 |
# resource is intended to change to DELETED. This is only |
| 382 |
# informational and the status will not change unless the client explicitly |
| 383 |
# changes it. |
| 384 |
"deprecated": "A String", # An optional RFC3339 timestamp on or after which the state of this |
| 385 |
# resource is intended to change to DEPRECATED. This is only |
| 386 |
# informational and the status will not change unless the client explicitly |
| 387 |
# changes it. |
| 388 |
"obsolete": "A String", # An optional RFC3339 timestamp on or after which the state of this |
| 389 |
# resource is intended to change to OBSOLETE. This is only |
| 390 |
# informational and the status will not change unless the client explicitly |
| 391 |
# changes it. |
| 392 |
"replacement": "A String", # The URL of the suggested replacement for a deprecated resource. |
| 393 |
# The suggested replacement resource must be the same kind of resource as the |
| 394 |
# deprecated resource. |
| 395 |
"state": "A String", # The deprecation state of this resource. This can be ACTIVE,DEPRECATED, OBSOLETE, or DELETED. |
| 396 |
# 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 |
| 397 |
# warning indicating the deprecated resource and recommending its |
| 398 |
# replacement. Operations which use OBSOLETE orDELETED resources will be rejected and result in an error. |
| 399 |
"stateOverride": { # A rollout policy configuration. # The rollout policy for this deprecation. This policy is only enforced by |
| 400 |
# image family views. The rollout policy restricts the zones where the |
| 401 |
# associated resource is considered in a deprecated state. When the rollout |
| 402 |
# policy does not include the user specified zone, or if the zone is rolled |
| 403 |
# out, the associated resource is considered in a deprecated state. |
| 404 |
# |
| 405 |
# The rollout policy for this deprecation is read-only, except for |
| 406 |
# allowlisted users. This field might not be configured. To view the latest |
| 407 |
# non-deprecated image in a specific zone, use theimageFamilyViews.get method. |
| 408 |
"defaultRolloutTime": "A String", # An optional RFC3339 timestamp on or after which the update is |
| 409 |
# considered rolled out to any zone that is not explicitly stated. |
| 410 |
"locationRolloutPolicies": { # Location based rollout policies to apply to the resource. |
| 411 |
# |
| 412 |
# Currently only zone names are supported and must be represented |
| 413 |
# as valid URLs, like: zones/us-central1-a. |
| 414 |
# |
| 415 |
# The value expects an RFC3339 timestamp on or after which the update is |
| 416 |
# considered rolled out to the specified location. |
| 417 |
"a_key": "A String", |
| 418 |
}, |
| 419 |
}, |
| 420 |
}, |
| 421 |
"description": "A String", # [Output Only] An optional textual description of the resource. |
| 422 |
"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is |
| 423 |
# defined by the server. |
| 424 |
"kind": "compute#acceleratorType", # Output only. [Output Only] The type of the resource. Alwayscompute#acceleratorType for accelerator types. |
| 425 |
"maximumCardsPerInstance": 42, # [Output Only] Maximum number of accelerator cards allowed per instance. |
| 426 |
"name": "A String", # [Output Only] Name of the resource. |
| 427 |
"selfLink": "A String", # Output only. [Output Only] Server-defined, fully qualified URL for this resource. |
| 428 |
"zone": "A String", # [Output Only] The name of the zone where the accelerator type resides, |
| 429 |
# such as us-central1-a. |
| 430 |
# You must specify this field as part of the HTTP request URL. It is |
| 431 |
# not settable as a field in the request body. |
| 432 |
}</pre> |
| 433 |
</div> |
| 434 |
|
| 435 |
<div class="method"> |
| 436 |
<code class="details" id="list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> |
| 437 |
<pre>Retrieves a list of accelerator types that are available to the specified |
| 438 |
project. |
| 439 |
|
| 440 |
Args: |
| 441 |
project: string, Project ID for this request. (required) |
| 442 |
zone: string, The name of the zone for this request. (required) |
| 443 |
filter: string, A filter expression that filters resources listed in the response. Most |
| 444 |
Compute resources support two types of filter expressions: |
| 445 |
expressions that support regular expressions and expressions that follow |
| 446 |
API improvement proposal AIP-160. |
| 447 |
These two types of filter expressions cannot be mixed in one request. |
| 448 |
|
| 449 |
If you want to use AIP-160, your expression must specify the field name, an |
| 450 |
operator, and the value that you want to use for filtering. The value |
| 451 |
must be a string, a number, or a boolean. The operator |
| 452 |
must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. |
| 453 |
|
| 454 |
For example, if you are filtering Compute Engine instances, you can |
| 455 |
exclude instances named `example-instance` by specifying |
| 456 |
`name != example-instance`. |
| 457 |
|
| 458 |
The `:*` comparison can be used to test whether a key has been defined. |
| 459 |
For example, to find all objects with `owner` label use: |
| 460 |
``` |
| 461 |
labels.owner:* |
| 462 |
``` |
| 463 |
|
| 464 |
You can also filter nested fields. For example, you could specify |
| 465 |
`scheduling.automaticRestart = false` to include instances only |
| 466 |
if they are not scheduled for automatic restarts. You can use filtering |
| 467 |
on nested fields to filter based onresource labels. |
| 468 |
|
| 469 |
To filter on multiple expressions, provide each separate expression within |
| 470 |
parentheses. For example: |
| 471 |
``` |
| 472 |
(scheduling.automaticRestart = true) |
| 473 |
(cpuPlatform = "Intel Skylake") |
| 474 |
``` |
| 475 |
By default, each expression is an `AND` expression. However, you |
| 476 |
can include `AND` and `OR` expressions explicitly. |
| 477 |
For example: |
| 478 |
``` |
| 479 |
(cpuPlatform = "Intel Skylake") OR |
| 480 |
(cpuPlatform = "Intel Broadwell") AND |
| 481 |
(scheduling.automaticRestart = true) |
| 482 |
``` |
| 483 |
|
| 484 |
If you want to use a regular expression, use the `eq` (equal) or `ne` |
| 485 |
(not equal) operator against a single un-parenthesized expression with or |
| 486 |
without quotes or against multiple parenthesized expressions. Examples: |
| 487 |
|
| 488 |
`fieldname eq unquoted literal` |
| 489 |
`fieldname eq 'single quoted literal'` |
| 490 |
`fieldname eq "double quoted literal"` |
| 491 |
`(fieldname1 eq literal) (fieldname2 ne "literal")` |
| 492 |
|
| 493 |
The literal value is interpreted as a regular expression using GoogleRE2 library syntax. |
| 494 |
The literal value must match the entire field. |
| 495 |
|
| 496 |
For example, to filter for instances that do not end with name "instance", |
| 497 |
you would use `name ne .*instance`. |
| 498 |
|
| 499 |
You cannot combine constraints on multiple fields using regular |
| 500 |
expressions. |
| 501 |
maxResults: integer, The maximum number of results per page that should be returned. |
| 502 |
If the number of available results is larger than `maxResults`, |
| 503 |
Compute Engine returns a `nextPageToken` that can be used to get |
| 504 |
the next page of results in subsequent list requests. Acceptable values are |
| 505 |
`0` to `500`, inclusive. (Default: `500`) |
| 506 |
orderBy: string, Sorts list results by a certain order. By default, results |
| 507 |
are returned in alphanumerical order based on the resource name. |
| 508 |
|
| 509 |
You can also sort results in descending order based on the creation |
| 510 |
timestamp using `orderBy="creationTimestamp desc"`. This sorts |
| 511 |
results based on the `creationTimestamp` field in |
| 512 |
reverse chronological order (newest result first). Use this to sort |
| 513 |
resources like operations so that the newest operation is returned first. |
| 514 |
|
| 515 |
Currently, only sorting by `name` or |
| 516 |
`creationTimestamp desc` is supported. |
| 517 |
pageToken: string, Specifies a page token to use. Set `pageToken` to the |
| 518 |
`nextPageToken` returned by a previous list request to get |
| 519 |
the next page of results. |
| 520 |
returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case |
| 521 |
of failure. The default value is false. |
| 522 |
|
| 523 |
For example, when partial success behavior is enabled, aggregatedList for a |
| 524 |
single zone scope either returns all resources in the zone or no resources, |
| 525 |
with an error code. |
| 526 |
x__xgafv: string, V1 error format. |
| 527 |
Allowed values |
| 528 |
1 - v1 error format |
| 529 |
2 - v2 error format |
| 530 |
|
| 531 |
Returns: |
| 532 |
An object of the form: |
| 533 |
|
| 534 |
{ # Contains a list of accelerator types. |
| 535 |
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. |
| 536 |
"items": [ # A list of AcceleratorType resources. |
| 537 |
{ # Represents an Accelerator Type resource. |
| 538 |
# |
| 539 |
# Google Cloud Platform provides graphics processing units (accelerators) that |
| 540 |
# you can add to VM instances to improve or accelerate performance when working |
| 541 |
# with intensive workloads. For more information, readGPUs on Compute Engine. |
| 542 |
"creationTimestamp": "A String", # [Output Only] Creation timestamp inRFC3339 text format. |
| 543 |
"deprecated": { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this accelerator type. |
| 544 |
"deleted": "A String", # An optional RFC3339 timestamp on or after which the state of this |
| 545 |
# resource is intended to change to DELETED. This is only |
| 546 |
# informational and the status will not change unless the client explicitly |
| 547 |
# changes it. |
| 548 |
"deprecated": "A String", # An optional RFC3339 timestamp on or after which the state of this |
| 549 |
# resource is intended to change to DEPRECATED. This is only |
| 550 |
# informational and the status will not change unless the client explicitly |
| 551 |
# changes it. |
| 552 |
"obsolete": "A String", # An optional RFC3339 timestamp on or after which the state of this |
| 553 |
# resource is intended to change to OBSOLETE. This is only |
| 554 |
# informational and the status will not change unless the client explicitly |
| 555 |
# changes it. |
| 556 |
"replacement": "A String", # The URL of the suggested replacement for a deprecated resource. |
| 557 |
# The suggested replacement resource must be the same kind of resource as the |
| 558 |
# deprecated resource. |
| 559 |
"state": "A String", # The deprecation state of this resource. This can be ACTIVE,DEPRECATED, OBSOLETE, or DELETED. |
| 560 |
# 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 |
| 561 |
# warning indicating the deprecated resource and recommending its |
| 562 |
# replacement. Operations which use OBSOLETE orDELETED resources will be rejected and result in an error. |
| 563 |
"stateOverride": { # A rollout policy configuration. # The rollout policy for this deprecation. This policy is only enforced by |
| 564 |
# image family views. The rollout policy restricts the zones where the |
| 565 |
# associated resource is considered in a deprecated state. When the rollout |
| 566 |
# policy does not include the user specified zone, or if the zone is rolled |
| 567 |
# out, the associated resource is considered in a deprecated state. |
| 568 |
# |
| 569 |
# The rollout policy for this deprecation is read-only, except for |
| 570 |
# allowlisted users. This field might not be configured. To view the latest |
| 571 |
# non-deprecated image in a specific zone, use theimageFamilyViews.get method. |
| 572 |
"defaultRolloutTime": "A String", # An optional RFC3339 timestamp on or after which the update is |
| 573 |
# considered rolled out to any zone that is not explicitly stated. |
| 574 |
"locationRolloutPolicies": { # Location based rollout policies to apply to the resource. |
| 575 |
# |
| 576 |
# Currently only zone names are supported and must be represented |
| 577 |
# as valid URLs, like: zones/us-central1-a. |
| 578 |
# |
| 579 |
# The value expects an RFC3339 timestamp on or after which the update is |
| 580 |
# considered rolled out to the specified location. |
| 581 |
"a_key": "A String", |
| 582 |
}, |
| 583 |
}, |
| 584 |
}, |
| 585 |
"description": "A String", # [Output Only] An optional textual description of the resource. |
| 586 |
"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is |
| 587 |
# defined by the server. |
| 588 |
"kind": "compute#acceleratorType", # Output only. [Output Only] The type of the resource. Alwayscompute#acceleratorType for accelerator types. |
| 589 |
"maximumCardsPerInstance": 42, # [Output Only] Maximum number of accelerator cards allowed per instance. |
| 590 |
"name": "A String", # [Output Only] Name of the resource. |
| 591 |
"selfLink": "A String", # Output only. [Output Only] Server-defined, fully qualified URL for this resource. |
| 592 |
"zone": "A String", # [Output Only] The name of the zone where the accelerator type resides, |
| 593 |
# such as us-central1-a. |
| 594 |
# You must specify this field as part of the HTTP request URL. It is |
| 595 |
# not settable as a field in the request body. |
| 596 |
}, |
| 597 |
], |
| 598 |
"kind": "compute#acceleratorTypeList", # Output only. [Output Only] Type of resource. Alwayscompute#acceleratorTypeList for lists of accelerator types. |
| 599 |
"nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for |
| 600 |
# list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for |
| 601 |
# the query parameter pageToken in the next list request. |
| 602 |
# Subsequent list requests will have their own nextPageToken to |
| 603 |
# continue paging through the results. |
| 604 |
"selfLink": "A String", # Output only. [Output Only] Server-defined URL for this resource. |
| 605 |
"warning": { # [Output Only] Informational warning message. |
| 606 |
"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute |
| 607 |
# Engine returns NO_RESULTS_ON_PAGE if there |
| 608 |
# are no results in the response. |
| 609 |
"data": [ # [Output Only] Metadata about this warning in key: |
| 610 |
# value format. For example: |
| 611 |
# |
| 612 |
# "data": [ |
| 613 |
# { |
| 614 |
# "key": "scope", |
| 615 |
# "value": "zones/us-east1-d" |
| 616 |
# } |
| 617 |
{ |
| 618 |
"key": "A String", # [Output Only] A key that provides more detail on the warning being |
| 619 |
# returned. For example, for warnings where there are no results in a list |
| 620 |
# request for a particular zone, this key might be scope and |
| 621 |
# the key value might be the zone name. Other examples might be a key |
| 622 |
# indicating a deprecated resource and a suggested replacement, or a |
| 623 |
# warning about invalid network settings (for example, if an instance |
| 624 |
# attempts to perform IP forwarding but is not enabled for IP forwarding). |
| 625 |
"value": "A String", # [Output Only] A warning data value corresponding to the key. |
| 626 |
}, |
| 627 |
], |
| 628 |
"message": "A String", # [Output Only] A human-readable description of the warning code. |
| 629 |
}, |
| 630 |
}</pre> |
| 631 |
</div> |
| 632 |
|
| 633 |
<div class="method"> |
| 634 |
<code class="details" id="list_next">list_next()</code> |
| 635 |
<pre>Retrieves the next page of results. |
| 636 |
|
| 637 |
Args: |
| 638 |
previous_request: The request for the previous page. (required) |
| 639 |
previous_response: The response from the request for the previous page. (required) |
| 640 |
|
| 641 |
Returns: |
| 642 |
A request object that you can call 'execute()' on to request the next |
| 643 |
page. Returns None if there are no more items in the collection. |
| 644 |
</pre> |
| 645 |
</div> |
| 646 |
|
| 647 |
</body></html> |