Debian Codegraph @

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