Debian Codegraph @

docs/dyn/compute_beta.regionZones.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <h1><a href="compute_beta.html">Compute Engine API</a> . <a href="compute_beta.regionZones.html">regionZones</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="#list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Retrieves the list of Zone resources under the specific region available to</p>
83 <p class="toc_element">
84 <code><a href="#list_next">list_next()</a></code></p>
85 <p class="firstline">Retrieves the next page of results.</p>
86 <h3>Method Details</h3>
87 <div class="method">
88 <code class="details" id="close">close()</code>
89 <pre>Close httplib2 connections.</pre>
90 </div>
91
92 <div class="method">
93 <code class="details" id="list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
94 <pre>Retrieves the list of Zone resources under the specific region available to
95 the specified project.
96
97 Args:
98 project: string, Project ID for this request. (required)
99 region: string, Region for this request. (required)
100 filter: string, A filter expression that filters resources listed in the response. Most
101 Compute resources support two types of filter expressions:
102 expressions that support regular expressions and expressions that follow
103 API improvement proposal AIP-160.
104 These two types of filter expressions cannot be mixed in one request.
105
106 If you want to use AIP-160, your expression must specify the field name, an
107 operator, and the value that you want to use for filtering. The value
108 must be a string, a number, or a boolean. The operator
109 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
110
111 For example, if you are filtering Compute Engine instances, you can
112 exclude instances named `example-instance` by specifying
113 `name != example-instance`.
114
115 The `:*` comparison can be used to test whether a key has been defined.
116 For example, to find all objects with `owner` label use:
117 ```
118 labels.owner:*
119 ```
120
121 You can also filter nested fields. For example, you could specify
122 `scheduling.automaticRestart = false` to include instances only
123 if they are not scheduled for automatic restarts. You can use filtering
124 on nested fields to filter based onresource labels.
125
126 To filter on multiple expressions, provide each separate expression within
127 parentheses. For example:
128 ```
129 (scheduling.automaticRestart = true)
130 (cpuPlatform = &quot;Intel Skylake&quot;)
131 ```
132 By default, each expression is an `AND` expression. However, you
133 can include `AND` and `OR` expressions explicitly.
134 For example:
135 ```
136 (cpuPlatform = &quot;Intel Skylake&quot;) OR
137 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
138 (scheduling.automaticRestart = true)
139 ```
140
141 If you want to use a regular expression, use the `eq` (equal) or `ne`
142 (not equal) operator against a single un-parenthesized expression with or
143 without quotes or against multiple parenthesized expressions. Examples:
144
145 `fieldname eq unquoted literal`
146 `fieldname eq &#x27;single quoted literal&#x27;`
147 `fieldname eq &quot;double quoted literal&quot;`
148 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
149
150 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
151 The literal value must match the entire field.
152
153 For example, to filter for instances that do not end with name &quot;instance&quot;,
154 you would use `name ne .*instance`.
155
156 You cannot combine constraints on multiple fields using regular
157 expressions.
158 maxResults: integer, The maximum number of results per page that should be returned.
159 If the number of available results is larger than `maxResults`,
160 Compute Engine returns a `nextPageToken` that can be used to get
161 the next page of results in subsequent list requests. Acceptable values are
162 `0` to `500`, inclusive. (Default: `500`)
163 orderBy: string, Sorts list results by a certain order. By default, results
164 are returned in alphanumerical order based on the resource name.
165
166 You can also sort results in descending order based on the creation
167 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
168 results based on the `creationTimestamp` field in
169 reverse chronological order (newest result first). Use this to sort
170 resources like operations so that the newest operation is returned first.
171
172 Currently, only sorting by `name` or
173 `creationTimestamp desc` is supported.
174 pageToken: string, Specifies a page token to use. Set `pageToken` to the
175 `nextPageToken` returned by a previous list request to get
176 the next page of results.
177 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
178 of failure. The default value is false.
179
180 For example, when partial success behavior is enabled, aggregatedList for a
181 single zone scope either returns all resources in the zone or no resources,
182 with an error code.
183 x__xgafv: string, V1 error format.
184 Allowed values
185 1 - v1 error format
186 2 - v2 error format
187
188 Returns:
189 An object of the form:
190
191 { # Contains a list of zone resources.
192 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
193 &quot;items&quot;: [ # A list of Zone resources.
194 { # Represents a Zone resource.
195 #
196 # A zone is a deployment area. These deployment areas are subsets of a region.
197 # For example the zone us-east1-b is located in theus-east1 region. For more information, readRegions and
198 # Zones.
199 &quot;availableCpuPlatforms&quot;: [ # [Output Only] Available cpu/platform selections for the zone.
200 &quot;A String&quot;,
201 ],
202 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp inRFC3339
203 # text format.
204 &quot;deprecated&quot;: { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this zone.
205 &quot;deleted&quot;: &quot;A String&quot;, # An optional RFC3339 timestamp on or after which the state of this
206 # resource is intended to change to DELETED. This is only
207 # informational and the status will not change unless the client explicitly
208 # changes it.
209 &quot;deprecated&quot;: &quot;A String&quot;, # An optional RFC3339 timestamp on or after which the state of this
210 # resource is intended to change to DEPRECATED. This is only
211 # informational and the status will not change unless the client explicitly
212 # changes it.
213 &quot;obsolete&quot;: &quot;A String&quot;, # An optional RFC3339 timestamp on or after which the state of this
214 # resource is intended to change to OBSOLETE. This is only
215 # informational and the status will not change unless the client explicitly
216 # changes it.
217 &quot;replacement&quot;: &quot;A String&quot;, # The URL of the suggested replacement for a deprecated resource.
218 # The suggested replacement resource must be the same kind of resource as the
219 # deprecated resource.
220 &quot;state&quot;: &quot;A String&quot;, # The deprecation state of this resource. This can be ACTIVE,DEPRECATED, OBSOLETE, or DELETED.
221 # 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
222 # warning indicating the deprecated resource and recommending its
223 # replacement. Operations which use OBSOLETE orDELETED resources will be rejected and result in an error.
224 &quot;stateOverride&quot;: { # A rollout policy configuration. # The rollout policy for this deprecation. This policy is only enforced by
225 # image family views. The rollout policy restricts the zones where the
226 # associated resource is considered in a deprecated state. When the rollout
227 # policy does not include the user specified zone, or if the zone is rolled
228 # out, the associated resource is considered in a deprecated state.
229 #
230 # The rollout policy for this deprecation is read-only, except for
231 # allowlisted users. This field might not be configured. To view the latest
232 # non-deprecated image in a specific zone, use theimageFamilyViews.get method.
233 &quot;defaultRolloutTime&quot;: &quot;A String&quot;, # An optional RFC3339 timestamp on or after which the update is
234 # considered rolled out to any zone that is not explicitly stated.
235 &quot;locationRolloutPolicies&quot;: { # Location based rollout policies to apply to the resource.
236 #
237 # Currently only zone names are supported and must be represented
238 # as valid URLs, like: zones/us-central1-a.
239 #
240 # The value expects an RFC3339 timestamp on or after which the update is
241 # considered rolled out to the specified location.
242 &quot;a_key&quot;: &quot;A String&quot;,
243 },
244 },
245 },
246 &quot;description&quot;: &quot;A String&quot;, # [Output Only] Textual description of the resource.
247 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
248 # defined by the server.
249 &quot;kind&quot;: &quot;compute#zone&quot;, # Output only. [Output Only] Type of the resource. Always compute#zone for
250 # zones.
251 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the resource.
252 &quot;region&quot;: &quot;A String&quot;, # [Output Only] Full URL reference to the region which hosts the zone.
253 &quot;resourceStatus&quot;: {
254 &quot;upcomingMaintenances&quot;: [ # Output only. [Output Only] The upcoming maintenance schedule.
255 { # The periodic partial maintenance schedule includes 52 weeks worth of
256 # maintenance windows.
257 # LINT.IfChange(PeriodicPartialMaintenanceSchedule)
258 &quot;subType&quot;: &quot;A String&quot;, # The maintenance type in which the zone is during the given window.
259 &quot;targetResource&quot;: &quot;A String&quot;, # The target resource that the maintenance window is for.
260 # For example, &quot;projects/my-project/zones/us-central1-a&quot;.
261 &quot;type&quot;: &quot;A String&quot;,
262 &quot;windowEndTime&quot;: { # Represents civil time (or occasionally physical time). # The end civil timestamp of the window (not inclusive).
263 # This contains a time zone.
264 #
265 # This type can represent a civil time in one of a few possible ways:
266 #
267 # * When utc_offset is set and time_zone is unset: a civil time on a calendar
268 # day with a particular offset from UTC.
269 # * When time_zone is set and utc_offset is unset: a civil time on a calendar
270 # day in a particular time zone.
271 # * When neither time_zone nor utc_offset is set: a civil time on a calendar
272 # day in local time.
273 #
274 # The date is relative to the Proleptic Gregorian Calendar.
275 #
276 # If year, month, or day are 0, the DateTime is considered not to have a
277 # specific year, month, or day respectively.
278 #
279 # This type may also be used to represent a physical time if all the date and
280 # time fields are set and either case of the `time_offset` oneof is set.
281 # Consider using `Timestamp` message for physical time instead. If your use
282 # case also would like to store the user&#x27;s timezone, that can be done in
283 # another field.
284 #
285 # This type is more flexible than some applications may want. Make sure to
286 # document and validate your application&#x27;s limitations.
287 &quot;day&quot;: 42, # Optional. Day of month. Must be from 1 to 31 and valid for the year and
288 # month, or 0 if specifying a datetime without a day.
289 &quot;hours&quot;: 42, # Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults
290 # to 0 (midnight). An API may choose to allow the value &quot;24:00:00&quot; for
291 # scenarios like business closing time.
292 &quot;minutes&quot;: 42, # Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.
293 &quot;month&quot;: 42, # Optional. Month of year. Must be from 1 to 12, or 0 if specifying a
294 # datetime without a month.
295 &quot;nanos&quot;: 42, # Optional. Fractions of seconds in nanoseconds. Must be from 0 to
296 # 999,999,999, defaults to 0.
297 &quot;seconds&quot;: 42, # Optional. Seconds of minutes of the time. Must normally be from 0 to 59,
298 # defaults to 0. An API may allow the value 60 if it allows leap-seconds.
299 &quot;timeZone&quot;: { # Represents a time zone from the # Time zone.
300 # [IANA Time Zone Database](https://www.iana.org/time-zones).
301 &quot;id&quot;: &quot;A String&quot;, # IANA Time Zone Database time zone. For example &quot;America/New_York&quot;.
302 &quot;version&quot;: &quot;A String&quot;, # Optional. IANA Time Zone Database version number. For example &quot;2019a&quot;.
303 },
304 &quot;utcOffset&quot;: &quot;A String&quot;, # UTC offset. Must be whole seconds, between -18 hours and +18 hours.
305 # For example, a UTC offset of -4:00 would be represented as
306 # { seconds: -14400 }.
307 &quot;year&quot;: 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a
308 # datetime without a year.
309 },
310 &quot;windowStartTime&quot;: { # Represents civil time (or occasionally physical time). # The start civil timestamp of the window.
311 # This contains a time zone.
312 #
313 # This type can represent a civil time in one of a few possible ways:
314 #
315 # * When utc_offset is set and time_zone is unset: a civil time on a calendar
316 # day with a particular offset from UTC.
317 # * When time_zone is set and utc_offset is unset: a civil time on a calendar
318 # day in a particular time zone.
319 # * When neither time_zone nor utc_offset is set: a civil time on a calendar
320 # day in local time.
321 #
322 # The date is relative to the Proleptic Gregorian Calendar.
323 #
324 # If year, month, or day are 0, the DateTime is considered not to have a
325 # specific year, month, or day respectively.
326 #
327 # This type may also be used to represent a physical time if all the date and
328 # time fields are set and either case of the `time_offset` oneof is set.
329 # Consider using `Timestamp` message for physical time instead. If your use
330 # case also would like to store the user&#x27;s timezone, that can be done in
331 # another field.
332 #
333 # This type is more flexible than some applications may want. Make sure to
334 # document and validate your application&#x27;s limitations.
335 &quot;day&quot;: 42, # Optional. Day of month. Must be from 1 to 31 and valid for the year and
336 # month, or 0 if specifying a datetime without a day.
337 &quot;hours&quot;: 42, # Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults
338 # to 0 (midnight). An API may choose to allow the value &quot;24:00:00&quot; for
339 # scenarios like business closing time.
340 &quot;minutes&quot;: 42, # Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.
341 &quot;month&quot;: 42, # Optional. Month of year. Must be from 1 to 12, or 0 if specifying a
342 # datetime without a month.
343 &quot;nanos&quot;: 42, # Optional. Fractions of seconds in nanoseconds. Must be from 0 to
344 # 999,999,999, defaults to 0.
345 &quot;seconds&quot;: 42, # Optional. Seconds of minutes of the time. Must normally be from 0 to 59,
346 # defaults to 0. An API may allow the value 60 if it allows leap-seconds.
347 &quot;timeZone&quot;: { # Represents a time zone from the # Time zone.
348 # [IANA Time Zone Database](https://www.iana.org/time-zones).
349 &quot;id&quot;: &quot;A String&quot;, # IANA Time Zone Database time zone. For example &quot;America/New_York&quot;.
350 &quot;version&quot;: &quot;A String&quot;, # Optional. IANA Time Zone Database version number. For example &quot;2019a&quot;.
351 },
352 &quot;utcOffset&quot;: &quot;A String&quot;, # UTC offset. Must be whole seconds, between -18 hours and +18 hours.
353 # For example, a UTC offset of -4:00 would be represented as
354 # { seconds: -14400 }.
355 &quot;year&quot;: 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a
356 # datetime without a year.
357 },
358 },
359 ],
360 },
361 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
362 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Status of the zone, either UP orDOWN.
363 &quot;supportsPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
364 },
365 ],
366 &quot;kind&quot;: &quot;compute#zoneList&quot;, # Output only. Type of resource.
367 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
368 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
369 # the query parameter pageToken in the next list request.
370 # Subsequent list requests will have their own nextPageToken to
371 # continue paging through the results.
372 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
373 &quot;warning&quot;: { # [Output Only] Informational warning message.
374 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
375 # Engine returns NO_RESULTS_ON_PAGE if there
376 # are no results in the response.
377 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
378 # value format. For example:
379 #
380 # &quot;data&quot;: [
381 # {
382 # &quot;key&quot;: &quot;scope&quot;,
383 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
384 # }
385 {
386 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
387 # returned. For example, for warnings where there are no results in a list
388 # request for a particular zone, this key might be scope and
389 # the key value might be the zone name. Other examples might be a key
390 # indicating a deprecated resource and a suggested replacement, or a
391 # warning about invalid network settings (for example, if an instance
392 # attempts to perform IP forwarding but is not enabled for IP forwarding).
393 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
394 },
395 ],
396 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
397 },
398 }</pre>
399 </div>
400
401 <div class="method">
402 <code class="details" id="list_next">list_next()</code>
403 <pre>Retrieves the next page of results.
404
405 Args:
406 previous_request: The request for the previous page. (required)
407 previous_response: The response from the request for the previous page. (required)
408
409 Returns:
410 A request object that you can call &#x27;execute()&#x27; on to request the next
411 page. Returns None if there are no more items in the collection.
412 </pre>
413 </div>
414
415 </body></html>