Debian Codegraph @

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