Debian Codegraph @

docs/dyn/compute_alpha.regions.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.regions.html">regions</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, region, x__xgafv=None)</a></code></p>
82 <p class="firstline">Returns the specified Region resource.</p>
83 <p class="toc_element">
84 <code><a href="#list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
85 <p class="firstline">Retrieves the list of region resources available to the specified project.</p>
86 <p class="toc_element">
87 <code><a href="#list_next">list_next()</a></code></p>
88 <p class="firstline">Retrieves the next page of results.</p>
89 <h3>Method Details</h3>
90 <div class="method">
91 <code class="details" id="close">close()</code>
92 <pre>Close httplib2 connections.</pre>
93 </div>
94
95 <div class="method">
96 <code class="details" id="get">get(project, region, x__xgafv=None)</code>
97 <pre>Returns the specified Region resource.
98
99 To decrease latency for this method, you can optionally omit any unneeded
100 information from the response by using a field mask. This practice is
101 especially recommended for unused quota information (the `quotas` field).
102 To exclude one or more fields, set your request&#x27;s `fields` query parameter
103 to only include the fields you need. For example, to only include the `id`
104 and `selfLink` fields, add the query parameter `?fields=id,selfLink` to
105 your request.
106
107 This method fails if the quota information is unavailable for the region
108 and if the organization policy constraint
109 compute.requireBasicQuotaInResponse is enforced. This
110 constraint, when enforced, disables the fail-open behaviour when quota
111 information (the `items.quotas` field) is unavailable for the region.
112 It is recommended to use the default setting
113 for the constraint unless your application requires the fail-closed
114 behaviour for this method.
115
116 Args:
117 project: string, Project ID for this request. (required)
118 region: string, Name of the region resource to return. (required)
119 x__xgafv: string, V1 error format.
120 Allowed values
121 1 - v1 error format
122 2 - v2 error format
123
124 Returns:
125 An object of the form:
126
127 { # Represents a Region resource.
128 #
129 # A region is a geographical area where a resource is located. For more
130 # information, readRegions
131 # and Zones.
132 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp inRFC3339
133 # text format.
134 &quot;deprecated&quot;: { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this region.
135 &quot;deleted&quot;: &quot;A String&quot;, # An optional RFC3339 timestamp on or after which the state of this
136 # resource is intended to change to DELETED. This is only
137 # informational and the status will not change unless the client explicitly
138 # changes it.
139 &quot;deprecated&quot;: &quot;A String&quot;, # An optional RFC3339 timestamp on or after which the state of this
140 # resource is intended to change to DEPRECATED. This is only
141 # informational and the status will not change unless the client explicitly
142 # changes it.
143 &quot;obsolete&quot;: &quot;A String&quot;, # An optional RFC3339 timestamp on or after which the state of this
144 # resource is intended to change to OBSOLETE. This is only
145 # informational and the status will not change unless the client explicitly
146 # changes it.
147 &quot;replacement&quot;: &quot;A String&quot;, # The URL of the suggested replacement for a deprecated resource.
148 # The suggested replacement resource must be the same kind of resource as the
149 # deprecated resource.
150 &quot;state&quot;: &quot;A String&quot;, # The deprecation state of this resource. This can be ACTIVE,DEPRECATED, OBSOLETE, or DELETED.
151 # 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
152 # warning indicating the deprecated resource and recommending its
153 # replacement. Operations which use OBSOLETE orDELETED resources will be rejected and result in an error.
154 &quot;stateOverride&quot;: { # A rollout policy configuration. # The rollout policy for this deprecation. This policy is only enforced by
155 # image family views. The rollout policy restricts the zones where the
156 # associated resource is considered in a deprecated state. When the rollout
157 # policy does not include the user specified zone, or if the zone is rolled
158 # out, the associated resource is considered in a deprecated state.
159 #
160 # The rollout policy for this deprecation is read-only, except for
161 # allowlisted users. This field might not be configured. To view the latest
162 # non-deprecated image in a specific zone, use theimageFamilyViews.get method.
163 &quot;defaultRolloutTime&quot;: &quot;A String&quot;, # An optional RFC3339 timestamp on or after which the update is
164 # considered rolled out to any zone that is not explicitly stated.
165 &quot;locationRolloutPolicies&quot;: { # Location based rollout policies to apply to the resource.
166 #
167 # Currently only zone names are supported and must be represented
168 # as valid URLs, like: zones/us-central1-a.
169 #
170 # The value expects an RFC3339 timestamp on or after which the update is
171 # considered rolled out to the specified location.
172 &quot;a_key&quot;: &quot;A String&quot;,
173 },
174 },
175 },
176 &quot;description&quot;: &quot;A String&quot;, # [Output Only] Textual description of the resource.
177 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
178 # defined by the server.
179 &quot;kind&quot;: &quot;compute#region&quot;, # Output only. [Output Only] Type of the resource. Always compute#region for
180 # regions.
181 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the resource.
182 &quot;quotaStatusWarning&quot;: { # Output only. [Output Only] Warning of fetching the `quotas` field for this region. This
183 # field is populated only if fetching of the `quotas` field fails.
184 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
185 # Engine returns NO_RESULTS_ON_PAGE if there
186 # are no results in the response.
187 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
188 # value format. For example:
189 #
190 # &quot;data&quot;: [
191 # {
192 # &quot;key&quot;: &quot;scope&quot;,
193 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
194 # }
195 {
196 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
197 # returned. For example, for warnings where there are no results in a list
198 # request for a particular zone, this key might be scope and
199 # the key value might be the zone name. Other examples might be a key
200 # indicating a deprecated resource and a suggested replacement, or a
201 # warning about invalid network settings (for example, if an instance
202 # attempts to perform IP forwarding but is not enabled for IP forwarding).
203 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
204 },
205 ],
206 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
207 },
208 &quot;quotas&quot;: [ # [Output Only] Quotas assigned to this region.
209 { # A quotas entry.
210 &quot;limit&quot;: 3.14, # [Output Only] Quota limit for this metric.
211 &quot;metric&quot;: &quot;A String&quot;, # [Output Only] Name of the quota metric.
212 &quot;owner&quot;: &quot;A String&quot;, # [Output Only] Owning resource. This is the resource on which this quota
213 # is applied.
214 &quot;usage&quot;: 3.14, # [Output Only] Current usage of this metric.
215 },
216 ],
217 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
218 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
219 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Status of the region, either UP orDOWN.
220 &quot;supportsPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
221 &quot;zones&quot;: [ # [Output Only] A list of zones available in this region, in the form of
222 # resource URLs.
223 &quot;A String&quot;,
224 ],
225 }</pre>
226 </div>
227
228 <div class="method">
229 <code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
230 <pre>Retrieves the list of region resources available to the specified project.
231
232 To decrease latency for this method, you can optionally omit any unneeded
233 information from the response by using a field mask. This practice is
234 especially recommended for unused quota information
235 (the `items.quotas` field).
236 To exclude one or more fields, set your request&#x27;s `fields` query parameter
237 to only include the fields you need. For example, to only include the `id`
238 and `selfLink` fields, add the query parameter `?fields=id,selfLink` to
239 your request.
240
241 This method fails if the quota information is unavailable for the region
242 and if the organization policy constraint
243 compute.requireBasicQuotaInResponse is enforced. This
244 constraint, when enforced, disables the fail-open behaviour when quota
245 information (the `items.quotas` field) is unavailable for the region.
246 It is recommended to use the default setting
247 for the constraint unless your application requires the fail-closed
248 behaviour for this method.
249
250 Args:
251 project: string, Project ID for this request. (required)
252 filter: string, A filter expression that filters resources listed in the response. Most
253 Compute resources support two types of filter expressions:
254 expressions that support regular expressions and expressions that follow
255 API improvement proposal AIP-160.
256 These two types of filter expressions cannot be mixed in one request.
257
258 If you want to use AIP-160, your expression must specify the field name, an
259 operator, and the value that you want to use for filtering. The value
260 must be a string, a number, or a boolean. The operator
261 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
262
263 For example, if you are filtering Compute Engine instances, you can
264 exclude instances named `example-instance` by specifying
265 `name != example-instance`.
266
267 The `:*` comparison can be used to test whether a key has been defined.
268 For example, to find all objects with `owner` label use:
269 ```
270 labels.owner:*
271 ```
272
273 You can also filter nested fields. For example, you could specify
274 `scheduling.automaticRestart = false` to include instances only
275 if they are not scheduled for automatic restarts. You can use filtering
276 on nested fields to filter based onresource labels.
277
278 To filter on multiple expressions, provide each separate expression within
279 parentheses. For example:
280 ```
281 (scheduling.automaticRestart = true)
282 (cpuPlatform = &quot;Intel Skylake&quot;)
283 ```
284 By default, each expression is an `AND` expression. However, you
285 can include `AND` and `OR` expressions explicitly.
286 For example:
287 ```
288 (cpuPlatform = &quot;Intel Skylake&quot;) OR
289 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
290 (scheduling.automaticRestart = true)
291 ```
292
293 If you want to use a regular expression, use the `eq` (equal) or `ne`
294 (not equal) operator against a single un-parenthesized expression with or
295 without quotes or against multiple parenthesized expressions. Examples:
296
297 `fieldname eq unquoted literal`
298 `fieldname eq &#x27;single quoted literal&#x27;`
299 `fieldname eq &quot;double quoted literal&quot;`
300 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
301
302 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
303 The literal value must match the entire field.
304
305 For example, to filter for instances that do not end with name &quot;instance&quot;,
306 you would use `name ne .*instance`.
307
308 You cannot combine constraints on multiple fields using regular
309 expressions.
310 maxResults: integer, The maximum number of results per page that should be returned.
311 If the number of available results is larger than `maxResults`,
312 Compute Engine returns a `nextPageToken` that can be used to get
313 the next page of results in subsequent list requests. Acceptable values are
314 `0` to `500`, inclusive. (Default: `500`)
315 orderBy: string, Sorts list results by a certain order. By default, results
316 are returned in alphanumerical order based on the resource name.
317
318 You can also sort results in descending order based on the creation
319 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
320 results based on the `creationTimestamp` field in
321 reverse chronological order (newest result first). Use this to sort
322 resources like operations so that the newest operation is returned first.
323
324 Currently, only sorting by `name` or
325 `creationTimestamp desc` is supported.
326 pageToken: string, Specifies a page token to use. Set `pageToken` to the
327 `nextPageToken` returned by a previous list request to get
328 the next page of results.
329 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
330 of failure. The default value is false.
331
332 For example, when partial success behavior is enabled, aggregatedList for a
333 single zone scope either returns all resources in the zone or no resources,
334 with an error code.
335 x__xgafv: string, V1 error format.
336 Allowed values
337 1 - v1 error format
338 2 - v2 error format
339
340 Returns:
341 An object of the form:
342
343 { # Contains a list of region resources.
344 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
345 &quot;items&quot;: [ # A list of Region resources.
346 { # Represents a Region resource.
347 #
348 # A region is a geographical area where a resource is located. For more
349 # information, readRegions
350 # and Zones.
351 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp inRFC3339
352 # text format.
353 &quot;deprecated&quot;: { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this region.
354 &quot;deleted&quot;: &quot;A String&quot;, # An optional RFC3339 timestamp on or after which the state of this
355 # resource is intended to change to DELETED. This is only
356 # informational and the status will not change unless the client explicitly
357 # changes it.
358 &quot;deprecated&quot;: &quot;A String&quot;, # An optional RFC3339 timestamp on or after which the state of this
359 # resource is intended to change to DEPRECATED. This is only
360 # informational and the status will not change unless the client explicitly
361 # changes it.
362 &quot;obsolete&quot;: &quot;A String&quot;, # An optional RFC3339 timestamp on or after which the state of this
363 # resource is intended to change to OBSOLETE. This is only
364 # informational and the status will not change unless the client explicitly
365 # changes it.
366 &quot;replacement&quot;: &quot;A String&quot;, # The URL of the suggested replacement for a deprecated resource.
367 # The suggested replacement resource must be the same kind of resource as the
368 # deprecated resource.
369 &quot;state&quot;: &quot;A String&quot;, # The deprecation state of this resource. This can be ACTIVE,DEPRECATED, OBSOLETE, or DELETED.
370 # 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
371 # warning indicating the deprecated resource and recommending its
372 # replacement. Operations which use OBSOLETE orDELETED resources will be rejected and result in an error.
373 &quot;stateOverride&quot;: { # A rollout policy configuration. # The rollout policy for this deprecation. This policy is only enforced by
374 # image family views. The rollout policy restricts the zones where the
375 # associated resource is considered in a deprecated state. When the rollout
376 # policy does not include the user specified zone, or if the zone is rolled
377 # out, the associated resource is considered in a deprecated state.
378 #
379 # The rollout policy for this deprecation is read-only, except for
380 # allowlisted users. This field might not be configured. To view the latest
381 # non-deprecated image in a specific zone, use theimageFamilyViews.get method.
382 &quot;defaultRolloutTime&quot;: &quot;A String&quot;, # An optional RFC3339 timestamp on or after which the update is
383 # considered rolled out to any zone that is not explicitly stated.
384 &quot;locationRolloutPolicies&quot;: { # Location based rollout policies to apply to the resource.
385 #
386 # Currently only zone names are supported and must be represented
387 # as valid URLs, like: zones/us-central1-a.
388 #
389 # The value expects an RFC3339 timestamp on or after which the update is
390 # considered rolled out to the specified location.
391 &quot;a_key&quot;: &quot;A String&quot;,
392 },
393 },
394 },
395 &quot;description&quot;: &quot;A String&quot;, # [Output Only] Textual description of the resource.
396 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
397 # defined by the server.
398 &quot;kind&quot;: &quot;compute#region&quot;, # Output only. [Output Only] Type of the resource. Always compute#region for
399 # regions.
400 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the resource.
401 &quot;quotaStatusWarning&quot;: { # Output only. [Output Only] Warning of fetching the `quotas` field for this region. This
402 # field is populated only if fetching of the `quotas` field fails.
403 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
404 # Engine returns NO_RESULTS_ON_PAGE if there
405 # are no results in the response.
406 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
407 # value format. For example:
408 #
409 # &quot;data&quot;: [
410 # {
411 # &quot;key&quot;: &quot;scope&quot;,
412 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
413 # }
414 {
415 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
416 # returned. For example, for warnings where there are no results in a list
417 # request for a particular zone, this key might be scope and
418 # the key value might be the zone name. Other examples might be a key
419 # indicating a deprecated resource and a suggested replacement, or a
420 # warning about invalid network settings (for example, if an instance
421 # attempts to perform IP forwarding but is not enabled for IP forwarding).
422 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
423 },
424 ],
425 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
426 },
427 &quot;quotas&quot;: [ # [Output Only] Quotas assigned to this region.
428 { # A quotas entry.
429 &quot;limit&quot;: 3.14, # [Output Only] Quota limit for this metric.
430 &quot;metric&quot;: &quot;A String&quot;, # [Output Only] Name of the quota metric.
431 &quot;owner&quot;: &quot;A String&quot;, # [Output Only] Owning resource. This is the resource on which this quota
432 # is applied.
433 &quot;usage&quot;: 3.14, # [Output Only] Current usage of this metric.
434 },
435 ],
436 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
437 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
438 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Status of the region, either UP orDOWN.
439 &quot;supportsPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
440 &quot;zones&quot;: [ # [Output Only] A list of zones available in this region, in the form of
441 # resource URLs.
442 &quot;A String&quot;,
443 ],
444 },
445 ],
446 &quot;kind&quot;: &quot;compute#regionList&quot;, # Output only. [Output Only] Type of resource. Always compute#regionList for
447 # lists of regions.
448 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
449 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
450 # the query parameter pageToken in the next list request.
451 # Subsequent list requests will have their own nextPageToken to
452 # continue paging through the results.
453 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
454 &quot;warning&quot;: { # [Output Only] Informational warning message.
455 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
456 # Engine returns NO_RESULTS_ON_PAGE if there
457 # are no results in the response.
458 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
459 # value format. For example:
460 #
461 # &quot;data&quot;: [
462 # {
463 # &quot;key&quot;: &quot;scope&quot;,
464 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
465 # }
466 {
467 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
468 # returned. For example, for warnings where there are no results in a list
469 # request for a particular zone, this key might be scope and
470 # the key value might be the zone name. Other examples might be a key
471 # indicating a deprecated resource and a suggested replacement, or a
472 # warning about invalid network settings (for example, if an instance
473 # attempts to perform IP forwarding but is not enabled for IP forwarding).
474 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
475 },
476 ],
477 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
478 },
479 }</pre>
480 </div>
481
482 <div class="method">
483 <code class="details" id="list_next">list_next()</code>
484 <pre>Retrieves the next page of results.
485
486 Args:
487 previous_request: The request for the previous page. (required)
488 previous_response: The response from the request for the previous page. (required)
489
490 Returns:
491 A request object that you can call &#x27;execute()&#x27; on to request the next
492 page. Returns None if there are no more items in the collection.
493 </pre>
494 </div>
495
496 </body></html>