Debian Codegraph @

docs/dyn/compute_alpha.regionDiskTypes.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.regionDiskTypes.html">regionDiskTypes</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, diskType, x__xgafv=None)</a></code></p>
82 <p class="firstline">Returns the specified regional disk type.</p>
83 <p class="toc_element">
84 <code><a href="#list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
85 <p class="firstline">Retrieves a list of regional disk types 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, diskType, x__xgafv=None)</code>
97 <pre>Returns the specified regional disk type.
98
99 Args:
100 project: string, Project ID for this request. (required)
101 region: string, The name of the region for this request. (required)
102 diskType: string, Name of the disk type to return. (required)
103 x__xgafv: string, V1 error format.
104 Allowed values
105 1 - v1 error format
106 2 - v2 error format
107
108 Returns:
109 An object of the form:
110
111 { # Represents a Disk Type resource.
112 #
113 # Google Compute Engine has two Disk Type resources:
114 #
115 # * [Regional](/compute/docs/reference/rest/alpha/regionDiskTypes)
116 # * [Zonal](/compute/docs/reference/rest/alpha/diskTypes)
117 #
118 # You can choose from a variety of disk types based on your needs.
119 # For more information, readStorage options.
120 #
121 # The diskTypes resource represents disk types for a zonal
122 # persistent disk.
123 # For more information, readZonal persistent disks.
124 #
125 # The regionDiskTypes resource represents disk types for a
126 # regional persistent disk. For more information, read Regional persistent disks.
127 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp inRFC3339
128 # text format.
129 &quot;defaultDiskSizeGb&quot;: &quot;A String&quot;, # [Output Only] Server-defined default disk size in GB.
130 &quot;deprecated&quot;: { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this disk type.
131 &quot;deleted&quot;: &quot;A String&quot;, # An optional RFC3339 timestamp on or after which the state of this
132 # resource is intended to change to DELETED. This is only
133 # informational and the status will not change unless the client explicitly
134 # changes it.
135 &quot;deprecated&quot;: &quot;A String&quot;, # An optional RFC3339 timestamp on or after which the state of this
136 # resource is intended to change to DEPRECATED. This is only
137 # informational and the status will not change unless the client explicitly
138 # changes it.
139 &quot;obsolete&quot;: &quot;A String&quot;, # An optional RFC3339 timestamp on or after which the state of this
140 # resource is intended to change to OBSOLETE. This is only
141 # informational and the status will not change unless the client explicitly
142 # changes it.
143 &quot;replacement&quot;: &quot;A String&quot;, # The URL of the suggested replacement for a deprecated resource.
144 # The suggested replacement resource must be the same kind of resource as the
145 # deprecated resource.
146 &quot;state&quot;: &quot;A String&quot;, # The deprecation state of this resource. This can be ACTIVE,DEPRECATED, OBSOLETE, or DELETED.
147 # 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
148 # warning indicating the deprecated resource and recommending its
149 # replacement. Operations which use OBSOLETE orDELETED resources will be rejected and result in an error.
150 &quot;stateOverride&quot;: { # A rollout policy configuration. # The rollout policy for this deprecation. This policy is only enforced by
151 # image family views. The rollout policy restricts the zones where the
152 # associated resource is considered in a deprecated state. When the rollout
153 # policy does not include the user specified zone, or if the zone is rolled
154 # out, the associated resource is considered in a deprecated state.
155 #
156 # The rollout policy for this deprecation is read-only, except for
157 # allowlisted users. This field might not be configured. To view the latest
158 # non-deprecated image in a specific zone, use theimageFamilyViews.get method.
159 &quot;defaultRolloutTime&quot;: &quot;A String&quot;, # An optional RFC3339 timestamp on or after which the update is
160 # considered rolled out to any zone that is not explicitly stated.
161 &quot;locationRolloutPolicies&quot;: { # Location based rollout policies to apply to the resource.
162 #
163 # Currently only zone names are supported and must be represented
164 # as valid URLs, like: zones/us-central1-a.
165 #
166 # The value expects an RFC3339 timestamp on or after which the update is
167 # considered rolled out to the specified location.
168 &quot;a_key&quot;: &quot;A String&quot;,
169 },
170 },
171 },
172 &quot;description&quot;: &quot;A String&quot;, # [Output Only] An optional description of this resource.
173 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
174 # defined by the server.
175 &quot;kind&quot;: &quot;compute#diskType&quot;, # Output only. [Output Only] Type of the resource. Always compute#diskType
176 # for disk types.
177 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the resource.
178 &quot;region&quot;: &quot;A String&quot;, # [Output Only] URL of the region where the disk type resides. Only
179 # applicable for regional resources.
180 # You must specify this field as part of the HTTP request URL. It is
181 # not settable as a field in the request body.
182 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
183 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
184 &quot;validDiskSize&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the valid disk size,
185 # such as &quot;10GB-10TB&quot;.
186 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] URL of the zone where the disk type resides.
187 # You must specify this field as part of the HTTP request URL. It is
188 # not settable as a field in the request body.
189 }</pre>
190 </div>
191
192 <div class="method">
193 <code class="details" id="list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
194 <pre>Retrieves a list of regional disk types available to the specified project.
195
196 Args:
197 project: string, Project ID for this request. (required)
198 region: string, The name of the region for this request. (required)
199 filter: string, A filter expression that filters resources listed in the response. Most
200 Compute resources support two types of filter expressions:
201 expressions that support regular expressions and expressions that follow
202 API improvement proposal AIP-160.
203 These two types of filter expressions cannot be mixed in one request.
204
205 If you want to use AIP-160, your expression must specify the field name, an
206 operator, and the value that you want to use for filtering. The value
207 must be a string, a number, or a boolean. The operator
208 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
209
210 For example, if you are filtering Compute Engine instances, you can
211 exclude instances named `example-instance` by specifying
212 `name != example-instance`.
213
214 The `:*` comparison can be used to test whether a key has been defined.
215 For example, to find all objects with `owner` label use:
216 ```
217 labels.owner:*
218 ```
219
220 You can also filter nested fields. For example, you could specify
221 `scheduling.automaticRestart = false` to include instances only
222 if they are not scheduled for automatic restarts. You can use filtering
223 on nested fields to filter based onresource labels.
224
225 To filter on multiple expressions, provide each separate expression within
226 parentheses. For example:
227 ```
228 (scheduling.automaticRestart = true)
229 (cpuPlatform = &quot;Intel Skylake&quot;)
230 ```
231 By default, each expression is an `AND` expression. However, you
232 can include `AND` and `OR` expressions explicitly.
233 For example:
234 ```
235 (cpuPlatform = &quot;Intel Skylake&quot;) OR
236 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
237 (scheduling.automaticRestart = true)
238 ```
239
240 If you want to use a regular expression, use the `eq` (equal) or `ne`
241 (not equal) operator against a single un-parenthesized expression with or
242 without quotes or against multiple parenthesized expressions. Examples:
243
244 `fieldname eq unquoted literal`
245 `fieldname eq &#x27;single quoted literal&#x27;`
246 `fieldname eq &quot;double quoted literal&quot;`
247 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
248
249 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
250 The literal value must match the entire field.
251
252 For example, to filter for instances that do not end with name &quot;instance&quot;,
253 you would use `name ne .*instance`.
254
255 You cannot combine constraints on multiple fields using regular
256 expressions.
257 maxResults: integer, The maximum number of results per page that should be returned.
258 If the number of available results is larger than `maxResults`,
259 Compute Engine returns a `nextPageToken` that can be used to get
260 the next page of results in subsequent list requests. Acceptable values are
261 `0` to `500`, inclusive. (Default: `500`)
262 orderBy: string, Sorts list results by a certain order. By default, results
263 are returned in alphanumerical order based on the resource name.
264
265 You can also sort results in descending order based on the creation
266 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
267 results based on the `creationTimestamp` field in
268 reverse chronological order (newest result first). Use this to sort
269 resources like operations so that the newest operation is returned first.
270
271 Currently, only sorting by `name` or
272 `creationTimestamp desc` is supported.
273 pageToken: string, Specifies a page token to use. Set `pageToken` to the
274 `nextPageToken` returned by a previous list request to get
275 the next page of results.
276 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
277 of failure. The default value is false.
278
279 For example, when partial success behavior is enabled, aggregatedList for a
280 single zone scope either returns all resources in the zone or no resources,
281 with an error code.
282 x__xgafv: string, V1 error format.
283 Allowed values
284 1 - v1 error format
285 2 - v2 error format
286
287 Returns:
288 An object of the form:
289
290 {
291 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
292 &quot;items&quot;: [ # A list of DiskType resources.
293 { # Represents a Disk Type resource.
294 #
295 # Google Compute Engine has two Disk Type resources:
296 #
297 # * [Regional](/compute/docs/reference/rest/alpha/regionDiskTypes)
298 # * [Zonal](/compute/docs/reference/rest/alpha/diskTypes)
299 #
300 # You can choose from a variety of disk types based on your needs.
301 # For more information, readStorage options.
302 #
303 # The diskTypes resource represents disk types for a zonal
304 # persistent disk.
305 # For more information, readZonal persistent disks.
306 #
307 # The regionDiskTypes resource represents disk types for a
308 # regional persistent disk. For more information, read Regional persistent disks.
309 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp inRFC3339
310 # text format.
311 &quot;defaultDiskSizeGb&quot;: &quot;A String&quot;, # [Output Only] Server-defined default disk size in GB.
312 &quot;deprecated&quot;: { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this disk type.
313 &quot;deleted&quot;: &quot;A String&quot;, # An optional RFC3339 timestamp on or after which the state of this
314 # resource is intended to change to DELETED. This is only
315 # informational and the status will not change unless the client explicitly
316 # changes it.
317 &quot;deprecated&quot;: &quot;A String&quot;, # An optional RFC3339 timestamp on or after which the state of this
318 # resource is intended to change to DEPRECATED. This is only
319 # informational and the status will not change unless the client explicitly
320 # changes it.
321 &quot;obsolete&quot;: &quot;A String&quot;, # An optional RFC3339 timestamp on or after which the state of this
322 # resource is intended to change to OBSOLETE. This is only
323 # informational and the status will not change unless the client explicitly
324 # changes it.
325 &quot;replacement&quot;: &quot;A String&quot;, # The URL of the suggested replacement for a deprecated resource.
326 # The suggested replacement resource must be the same kind of resource as the
327 # deprecated resource.
328 &quot;state&quot;: &quot;A String&quot;, # The deprecation state of this resource. This can be ACTIVE,DEPRECATED, OBSOLETE, or DELETED.
329 # 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
330 # warning indicating the deprecated resource and recommending its
331 # replacement. Operations which use OBSOLETE orDELETED resources will be rejected and result in an error.
332 &quot;stateOverride&quot;: { # A rollout policy configuration. # The rollout policy for this deprecation. This policy is only enforced by
333 # image family views. The rollout policy restricts the zones where the
334 # associated resource is considered in a deprecated state. When the rollout
335 # policy does not include the user specified zone, or if the zone is rolled
336 # out, the associated resource is considered in a deprecated state.
337 #
338 # The rollout policy for this deprecation is read-only, except for
339 # allowlisted users. This field might not be configured. To view the latest
340 # non-deprecated image in a specific zone, use theimageFamilyViews.get method.
341 &quot;defaultRolloutTime&quot;: &quot;A String&quot;, # An optional RFC3339 timestamp on or after which the update is
342 # considered rolled out to any zone that is not explicitly stated.
343 &quot;locationRolloutPolicies&quot;: { # Location based rollout policies to apply to the resource.
344 #
345 # Currently only zone names are supported and must be represented
346 # as valid URLs, like: zones/us-central1-a.
347 #
348 # The value expects an RFC3339 timestamp on or after which the update is
349 # considered rolled out to the specified location.
350 &quot;a_key&quot;: &quot;A String&quot;,
351 },
352 },
353 },
354 &quot;description&quot;: &quot;A String&quot;, # [Output Only] An optional description of this resource.
355 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
356 # defined by the server.
357 &quot;kind&quot;: &quot;compute#diskType&quot;, # Output only. [Output Only] Type of the resource. Always compute#diskType
358 # for disk types.
359 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the resource.
360 &quot;region&quot;: &quot;A String&quot;, # [Output Only] URL of the region where the disk type resides. Only
361 # applicable for regional resources.
362 # You must specify this field as part of the HTTP request URL. It is
363 # not settable as a field in the request body.
364 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
365 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
366 &quot;validDiskSize&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the valid disk size,
367 # such as &quot;10GB-10TB&quot;.
368 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] URL of the zone where the disk type resides.
369 # You must specify this field as part of the HTTP request URL. It is
370 # not settable as a field in the request body.
371 },
372 ],
373 &quot;kind&quot;: &quot;compute#regionDiskTypeList&quot;, # Output only. [Output Only] Type of resource. Alwayscompute#regionDiskTypeList for region disk types.
374 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
375 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
376 # the query parameter pageToken in the next list request.
377 # Subsequent list requests will have their own nextPageToken to
378 # continue paging through the results.
379 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
380 &quot;warning&quot;: { # [Output Only] Informational warning message.
381 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
382 # Engine returns NO_RESULTS_ON_PAGE if there
383 # are no results in the response.
384 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
385 # value format. For example:
386 #
387 # &quot;data&quot;: [
388 # {
389 # &quot;key&quot;: &quot;scope&quot;,
390 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
391 # }
392 {
393 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
394 # returned. For example, for warnings where there are no results in a list
395 # request for a particular zone, this key might be scope and
396 # the key value might be the zone name. Other examples might be a key
397 # indicating a deprecated resource and a suggested replacement, or a
398 # warning about invalid network settings (for example, if an instance
399 # attempts to perform IP forwarding but is not enabled for IP forwarding).
400 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
401 },
402 ],
403 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
404 },
405 }</pre>
406 </div>
407
408 <div class="method">
409 <code class="details" id="list_next">list_next()</code>
410 <pre>Retrieves the next page of results.
411
412 Args:
413 previous_request: The request for the previous page. (required)
414 previous_response: The response from the request for the previous page. (required)
415
416 Returns:
417 A request object that you can call &#x27;execute()&#x27; on to request the next
418 page. Returns None if there are no more items in the collection.
419 </pre>
420 </div>
421
422 </body></html>