Debian Codegraph @

docs/dyn/compute_alpha.regionInstanceGroups.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.regionInstanceGroups.html">regionInstanceGroups</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, instanceGroup, x__xgafv=None)</a></code></p>
82 <p class="firstline">Returns the specified instance group resource.</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 the list of instance group resources contained within</p>
86 <p class="toc_element">
87 <code><a href="#listInstances">listInstances(project, region, instanceGroup, body=None, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Lists the instances in the specified instance group and displays</p>
89 <p class="toc_element">
90 <code><a href="#listInstances_next">listInstances_next()</a></code></p>
91 <p class="firstline">Retrieves the next page of results.</p>
92 <p class="toc_element">
93 <code><a href="#list_next">list_next()</a></code></p>
94 <p class="firstline">Retrieves the next page of results.</p>
95 <p class="toc_element">
96 <code><a href="#setNamedPorts">setNamedPorts(project, region, instanceGroup, body=None, requestId=None, x__xgafv=None)</a></code></p>
97 <p class="firstline">Sets the named ports for the specified regional instance group.</p>
98 <p class="toc_element">
99 <code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body=None, x__xgafv=None)</a></code></p>
100 <p class="firstline">Returns permissions that a caller has on the specified resource.</p>
101 <h3>Method Details</h3>
102 <div class="method">
103 <code class="details" id="close">close()</code>
104 <pre>Close httplib2 connections.</pre>
105 </div>
106
107 <div class="method">
108 <code class="details" id="get">get(project, region, instanceGroup, x__xgafv=None)</code>
109 <pre>Returns the specified instance group resource.
110
111 Args:
112 project: string, Project ID for this request. (required)
113 region: string, Name of the region scoping this request. (required)
114 instanceGroup: string, Name of the instance group resource to return. (required)
115 x__xgafv: string, V1 error format.
116 Allowed values
117 1 - v1 error format
118 2 - v2 error format
119
120 Returns:
121 An object of the form:
122
123 { # Represents an Instance Group resource.
124 #
125 # Instance Groups can be used to configure a target forload
126 # balancing.
127 #
128 # Instance groups can either be managed or unmanaged.
129 #
130 # To create
131 # managed instance groups, use the instanceGroupManager orregionInstanceGroupManager resource instead.
132 #
133 # Use zonal unmanaged instance groups if you need to applyload
134 # balancing to groups of heterogeneous instances or if you need to manage
135 # the instances yourself. You cannot create regional unmanaged instance groups.
136 #
137 # For more information, readInstance
138 # groups.
139 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] The creation timestamp for this instance group inRFC3339
140 # text format.
141 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
142 # create the resource.
143 &quot;fingerprint&quot;: &quot;A String&quot;, # Output only. [Output Only] The fingerprint of the named ports. The system
144 # uses this fingerprint to detect conflicts when multiple users change the
145 # named ports concurrently.
146 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] A unique identifier for this instance group, generated
147 # by the server.
148 &quot;kind&quot;: &quot;compute#instanceGroup&quot;, # Output only. [Output Only] The resource type, which is alwayscompute#instanceGroup for instance groups.
149 &quot;name&quot;: &quot;A String&quot;, # The name of the instance group. The name must be 1-63 characters
150 # long, and comply withRFC1035.
151 &quot;namedPorts&quot;: [ # Optional. Assigns a name to a port number. For example:{name: &quot;http&quot;, port: 80}
152 #
153 # This
154 # allows the system to reference ports by the assigned name instead of a
155 # port number. Named ports can also contain multiple ports. For example:[{name: &quot;app1&quot;, port: 8080}, {name:
156 # &quot;app1&quot;, port: 8081}, {name: &quot;app2&quot;, port:
157 # 8082}]
158 #
159 # Named ports apply to all instances in this instance group.
160 { # The named port. For example: &lt;&quot;http&quot;, 80&gt;.
161 &quot;name&quot;: &quot;A String&quot;, # The name for this named port.
162 # The name must be 1-63 characters long, and comply withRFC1035.
163 &quot;port&quot;: 42, # The port number, which can be a value between 1 and 65535.
164 },
165 ],
166 &quot;network&quot;: &quot;A String&quot;, # [Output Only] The URL of the network to which all instances in the
167 # instance group belong. If your instance has multiple network interfaces,
168 # then the network and subnetwork fields only refer to the
169 # network and subnet used by your primary interface (nic0).
170 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL of theregion
171 # where the instance group is located (for regional resources).
172 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL for this instance group. The server generates
173 # this URL.
174 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
175 &quot;size&quot;: 42, # Output only. [Output Only] The total number of instances in the instance group.
176 &quot;subnetwork&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL of the subnetwork to which all instances in the
177 # instance group belong. If your instance has multiple network interfaces,
178 # then the network and subnetwork fields only refer to the
179 # network and subnet used by your primary interface (nic0).
180 &quot;zone&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL of thezone
181 # where the instance group is located (for zonal resources).
182 }</pre>
183 </div>
184
185 <div class="method">
186 <code class="details" id="list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
187 <pre>Retrieves the list of instance group resources contained within
188 the specified region.
189
190 Args:
191 project: string, Project ID for this request. (required)
192 region: string, Name of the region scoping this request. (required)
193 filter: string, A filter expression that filters resources listed in the response. Most
194 Compute resources support two types of filter expressions:
195 expressions that support regular expressions and expressions that follow
196 API improvement proposal AIP-160.
197 These two types of filter expressions cannot be mixed in one request.
198
199 If you want to use AIP-160, your expression must specify the field name, an
200 operator, and the value that you want to use for filtering. The value
201 must be a string, a number, or a boolean. The operator
202 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
203
204 For example, if you are filtering Compute Engine instances, you can
205 exclude instances named `example-instance` by specifying
206 `name != example-instance`.
207
208 The `:*` comparison can be used to test whether a key has been defined.
209 For example, to find all objects with `owner` label use:
210 ```
211 labels.owner:*
212 ```
213
214 You can also filter nested fields. For example, you could specify
215 `scheduling.automaticRestart = false` to include instances only
216 if they are not scheduled for automatic restarts. You can use filtering
217 on nested fields to filter based onresource labels.
218
219 To filter on multiple expressions, provide each separate expression within
220 parentheses. For example:
221 ```
222 (scheduling.automaticRestart = true)
223 (cpuPlatform = &quot;Intel Skylake&quot;)
224 ```
225 By default, each expression is an `AND` expression. However, you
226 can include `AND` and `OR` expressions explicitly.
227 For example:
228 ```
229 (cpuPlatform = &quot;Intel Skylake&quot;) OR
230 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
231 (scheduling.automaticRestart = true)
232 ```
233
234 If you want to use a regular expression, use the `eq` (equal) or `ne`
235 (not equal) operator against a single un-parenthesized expression with or
236 without quotes or against multiple parenthesized expressions. Examples:
237
238 `fieldname eq unquoted literal`
239 `fieldname eq &#x27;single quoted literal&#x27;`
240 `fieldname eq &quot;double quoted literal&quot;`
241 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
242
243 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
244 The literal value must match the entire field.
245
246 For example, to filter for instances that do not end with name &quot;instance&quot;,
247 you would use `name ne .*instance`.
248
249 You cannot combine constraints on multiple fields using regular
250 expressions.
251 maxResults: integer, The maximum number of results per page that should be returned.
252 If the number of available results is larger than `maxResults`,
253 Compute Engine returns a `nextPageToken` that can be used to get
254 the next page of results in subsequent list requests. Acceptable values are
255 `0` to `500`, inclusive. (Default: `500`)
256 orderBy: string, Sorts list results by a certain order. By default, results
257 are returned in alphanumerical order based on the resource name.
258
259 You can also sort results in descending order based on the creation
260 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
261 results based on the `creationTimestamp` field in
262 reverse chronological order (newest result first). Use this to sort
263 resources like operations so that the newest operation is returned first.
264
265 Currently, only sorting by `name` or
266 `creationTimestamp desc` is supported.
267 pageToken: string, Specifies a page token to use. Set `pageToken` to the
268 `nextPageToken` returned by a previous list request to get
269 the next page of results.
270 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
271 of failure. The default value is false.
272
273 For example, when partial success behavior is enabled, aggregatedList for a
274 single zone scope either returns all resources in the zone or no resources,
275 with an error code.
276 x__xgafv: string, V1 error format.
277 Allowed values
278 1 - v1 error format
279 2 - v2 error format
280
281 Returns:
282 An object of the form:
283
284 { # Contains a list of InstanceGroup resources.
285 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] Unique identifier for the resource; defined by the server.
286 &quot;items&quot;: [ # A list of InstanceGroup resources.
287 { # Represents an Instance Group resource.
288 #
289 # Instance Groups can be used to configure a target forload
290 # balancing.
291 #
292 # Instance groups can either be managed or unmanaged.
293 #
294 # To create
295 # managed instance groups, use the instanceGroupManager orregionInstanceGroupManager resource instead.
296 #
297 # Use zonal unmanaged instance groups if you need to applyload
298 # balancing to groups of heterogeneous instances or if you need to manage
299 # the instances yourself. You cannot create regional unmanaged instance groups.
300 #
301 # For more information, readInstance
302 # groups.
303 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] The creation timestamp for this instance group inRFC3339
304 # text format.
305 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
306 # create the resource.
307 &quot;fingerprint&quot;: &quot;A String&quot;, # Output only. [Output Only] The fingerprint of the named ports. The system
308 # uses this fingerprint to detect conflicts when multiple users change the
309 # named ports concurrently.
310 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] A unique identifier for this instance group, generated
311 # by the server.
312 &quot;kind&quot;: &quot;compute#instanceGroup&quot;, # Output only. [Output Only] The resource type, which is alwayscompute#instanceGroup for instance groups.
313 &quot;name&quot;: &quot;A String&quot;, # The name of the instance group. The name must be 1-63 characters
314 # long, and comply withRFC1035.
315 &quot;namedPorts&quot;: [ # Optional. Assigns a name to a port number. For example:{name: &quot;http&quot;, port: 80}
316 #
317 # This
318 # allows the system to reference ports by the assigned name instead of a
319 # port number. Named ports can also contain multiple ports. For example:[{name: &quot;app1&quot;, port: 8080}, {name:
320 # &quot;app1&quot;, port: 8081}, {name: &quot;app2&quot;, port:
321 # 8082}]
322 #
323 # Named ports apply to all instances in this instance group.
324 { # The named port. For example: &lt;&quot;http&quot;, 80&gt;.
325 &quot;name&quot;: &quot;A String&quot;, # The name for this named port.
326 # The name must be 1-63 characters long, and comply withRFC1035.
327 &quot;port&quot;: 42, # The port number, which can be a value between 1 and 65535.
328 },
329 ],
330 &quot;network&quot;: &quot;A String&quot;, # [Output Only] The URL of the network to which all instances in the
331 # instance group belong. If your instance has multiple network interfaces,
332 # then the network and subnetwork fields only refer to the
333 # network and subnet used by your primary interface (nic0).
334 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL of theregion
335 # where the instance group is located (for regional resources).
336 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL for this instance group. The server generates
337 # this URL.
338 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
339 &quot;size&quot;: 42, # Output only. [Output Only] The total number of instances in the instance group.
340 &quot;subnetwork&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL of the subnetwork to which all instances in the
341 # instance group belong. If your instance has multiple network interfaces,
342 # then the network and subnetwork fields only refer to the
343 # network and subnet used by your primary interface (nic0).
344 &quot;zone&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL of thezone
345 # where the instance group is located (for zonal resources).
346 },
347 ],
348 &quot;kind&quot;: &quot;compute#regionInstanceGroupList&quot;, # Output only. The resource type.
349 &quot;nextPageToken&quot;: &quot;A String&quot;, # Output only. [Output Only] This token allows you to get the next page of results for
350 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
351 # the query parameter pageToken in the next list request.
352 # Subsequent list requests will have their own nextPageToken to
353 # continue paging through the results.
354 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
355 &quot;warning&quot;: { # Output only. [Output Only] Informational warning message.
356 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
357 # Engine returns NO_RESULTS_ON_PAGE if there
358 # are no results in the response.
359 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
360 # value format. For example:
361 #
362 # &quot;data&quot;: [
363 # {
364 # &quot;key&quot;: &quot;scope&quot;,
365 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
366 # }
367 {
368 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
369 # returned. For example, for warnings where there are no results in a list
370 # request for a particular zone, this key might be scope and
371 # the key value might be the zone name. Other examples might be a key
372 # indicating a deprecated resource and a suggested replacement, or a
373 # warning about invalid network settings (for example, if an instance
374 # attempts to perform IP forwarding but is not enabled for IP forwarding).
375 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
376 },
377 ],
378 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
379 },
380 }</pre>
381 </div>
382
383 <div class="method">
384 <code class="details" id="listInstances">listInstances(project, region, instanceGroup, body=None, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
385 <pre>Lists the instances in the specified instance group and displays
386 information about the named ports. Depending on the specified options, this
387 method can list all instances or only the instances that are running.
388 The orderBy query parameter is not supported.
389
390 Args:
391 project: string, Project ID for this request. (required)
392 region: string, Name of the region scoping this request. (required)
393 instanceGroup: string, Name of the regional instance group for which we want to list the
394 instances. (required)
395 body: object, The request body.
396 The object takes the form of:
397
398 {
399 &quot;instanceState&quot;: &quot;A String&quot;, # Instances in which state should be returned. Valid options are:
400 # &#x27;ALL&#x27;, &#x27;RUNNING&#x27;. By default, it lists all instances.
401 &quot;portName&quot;: &quot;A String&quot;, # Name of port user is interested in. It is optional. If it is set, only
402 # information about this ports will be returned. If it is not set, all the
403 # named ports will be returned.
404 # Always lists all instances.
405 }
406
407 filter: string, A filter expression that filters resources listed in the response. Most
408 Compute resources support two types of filter expressions:
409 expressions that support regular expressions and expressions that follow
410 API improvement proposal AIP-160.
411 These two types of filter expressions cannot be mixed in one request.
412
413 If you want to use AIP-160, your expression must specify the field name, an
414 operator, and the value that you want to use for filtering. The value
415 must be a string, a number, or a boolean. The operator
416 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
417
418 For example, if you are filtering Compute Engine instances, you can
419 exclude instances named `example-instance` by specifying
420 `name != example-instance`.
421
422 The `:*` comparison can be used to test whether a key has been defined.
423 For example, to find all objects with `owner` label use:
424 ```
425 labels.owner:*
426 ```
427
428 You can also filter nested fields. For example, you could specify
429 `scheduling.automaticRestart = false` to include instances only
430 if they are not scheduled for automatic restarts. You can use filtering
431 on nested fields to filter based onresource labels.
432
433 To filter on multiple expressions, provide each separate expression within
434 parentheses. For example:
435 ```
436 (scheduling.automaticRestart = true)
437 (cpuPlatform = &quot;Intel Skylake&quot;)
438 ```
439 By default, each expression is an `AND` expression. However, you
440 can include `AND` and `OR` expressions explicitly.
441 For example:
442 ```
443 (cpuPlatform = &quot;Intel Skylake&quot;) OR
444 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
445 (scheduling.automaticRestart = true)
446 ```
447
448 If you want to use a regular expression, use the `eq` (equal) or `ne`
449 (not equal) operator against a single un-parenthesized expression with or
450 without quotes or against multiple parenthesized expressions. Examples:
451
452 `fieldname eq unquoted literal`
453 `fieldname eq &#x27;single quoted literal&#x27;`
454 `fieldname eq &quot;double quoted literal&quot;`
455 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
456
457 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
458 The literal value must match the entire field.
459
460 For example, to filter for instances that do not end with name &quot;instance&quot;,
461 you would use `name ne .*instance`.
462
463 You cannot combine constraints on multiple fields using regular
464 expressions.
465 maxResults: integer, The maximum number of results per page that should be returned.
466 If the number of available results is larger than `maxResults`,
467 Compute Engine returns a `nextPageToken` that can be used to get
468 the next page of results in subsequent list requests. Acceptable values are
469 `0` to `500`, inclusive. (Default: `500`)
470 orderBy: string, Sorts list results by a certain order. By default, results
471 are returned in alphanumerical order based on the resource name.
472
473 You can also sort results in descending order based on the creation
474 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
475 results based on the `creationTimestamp` field in
476 reverse chronological order (newest result first). Use this to sort
477 resources like operations so that the newest operation is returned first.
478
479 Currently, only sorting by `name` or
480 `creationTimestamp desc` is supported.
481 pageToken: string, Specifies a page token to use. Set `pageToken` to the
482 `nextPageToken` returned by a previous list request to get
483 the next page of results.
484 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
485 of failure. The default value is false.
486
487 For example, when partial success behavior is enabled, aggregatedList for a
488 single zone scope either returns all resources in the zone or no resources,
489 with an error code.
490 x__xgafv: string, V1 error format.
491 Allowed values
492 1 - v1 error format
493 2 - v2 error format
494
495 Returns:
496 An object of the form:
497
498 {
499 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] Unique identifier for the resource; defined by the server.
500 &quot;items&quot;: [ # A list of InstanceWithNamedPorts resources.
501 {
502 &quot;instance&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL of the instance.
503 &quot;namedPorts&quot;: [ # Output only. [Output Only] The named ports that belong to this instance group.
504 { # The named port. For example: &lt;&quot;http&quot;, 80&gt;.
505 &quot;name&quot;: &quot;A String&quot;, # The name for this named port.
506 # The name must be 1-63 characters long, and comply withRFC1035.
507 &quot;port&quot;: 42, # The port number, which can be a value between 1 and 65535.
508 },
509 ],
510 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only] The status of the instance.
511 },
512 ],
513 &quot;kind&quot;: &quot;compute#regionInstanceGroupsListInstances&quot;, # Output only. The resource type.
514 &quot;nextPageToken&quot;: &quot;A String&quot;, # Output only. [Output Only] This token allows you to get the next page of results for
515 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
516 # the query parameter pageToken in the next list request.
517 # Subsequent list requests will have their own nextPageToken to
518 # continue paging through the results.
519 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
520 &quot;warning&quot;: { # Output only. [Output Only] Informational warning message.
521 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
522 # Engine returns NO_RESULTS_ON_PAGE if there
523 # are no results in the response.
524 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
525 # value format. For example:
526 #
527 # &quot;data&quot;: [
528 # {
529 # &quot;key&quot;: &quot;scope&quot;,
530 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
531 # }
532 {
533 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
534 # returned. For example, for warnings where there are no results in a list
535 # request for a particular zone, this key might be scope and
536 # the key value might be the zone name. Other examples might be a key
537 # indicating a deprecated resource and a suggested replacement, or a
538 # warning about invalid network settings (for example, if an instance
539 # attempts to perform IP forwarding but is not enabled for IP forwarding).
540 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
541 },
542 ],
543 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
544 },
545 }</pre>
546 </div>
547
548 <div class="method">
549 <code class="details" id="listInstances_next">listInstances_next()</code>
550 <pre>Retrieves the next page of results.
551
552 Args:
553 previous_request: The request for the previous page. (required)
554 previous_response: The response from the request for the previous page. (required)
555
556 Returns:
557 A request object that you can call &#x27;execute()&#x27; on to request the next
558 page. Returns None if there are no more items in the collection.
559 </pre>
560 </div>
561
562 <div class="method">
563 <code class="details" id="list_next">list_next()</code>
564 <pre>Retrieves the next page of results.
565
566 Args:
567 previous_request: The request for the previous page. (required)
568 previous_response: The response from the request for the previous page. (required)
569
570 Returns:
571 A request object that you can call &#x27;execute()&#x27; on to request the next
572 page. Returns None if there are no more items in the collection.
573 </pre>
574 </div>
575
576 <div class="method">
577 <code class="details" id="setNamedPorts">setNamedPorts(project, region, instanceGroup, body=None, requestId=None, x__xgafv=None)</code>
578 <pre>Sets the named ports for the specified regional instance group.
579
580 Args:
581 project: string, Project ID for this request. (required)
582 region: string, Name of the region scoping this request. (required)
583 instanceGroup: string, The name of the regional instance group where the named ports are updated. (required)
584 body: object, The request body.
585 The object takes the form of:
586
587 {
588 &quot;fingerprint&quot;: &quot;A String&quot;, # The fingerprint of the named ports information for this instance group.
589 # Use this optional property to prevent conflicts when multiple users change
590 # the named ports settings concurrently. Obtain the fingerprint with theinstanceGroups.get
591 # method. Then, include the fingerprint in your request to ensure that you
592 # do not overwrite changes that were applied from another
593 # concurrent request.
594 &quot;namedPorts&quot;: [ # The list of named ports to set for this instance group.
595 { # The named port. For example: &lt;&quot;http&quot;, 80&gt;.
596 &quot;name&quot;: &quot;A String&quot;, # The name for this named port.
597 # The name must be 1-63 characters long, and comply withRFC1035.
598 &quot;port&quot;: 42, # The port number, which can be a value between 1 and 65535.
599 },
600 ],
601 }
602
603 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
604 that if you must retry your request, the server will know to ignore the
605 request if it has already been completed.
606
607 For example, consider a situation where you make an initial request and
608 the request times out. If you make the request again with the same
609 request ID, the server can check if original operation with the same
610 request ID was received, and if so, will ignore the second request. This
611 prevents clients from accidentally creating duplicate commitments.
612
613 The request ID must be
614 a valid UUID with the exception that zero UUID is not supported
615 (00000000-0000-0000-0000-000000000000).
616 x__xgafv: string, V1 error format.
617 Allowed values
618 1 - v1 error format
619 2 - v2 error format
620
621 Returns:
622 An object of the form:
623
624 { # Represents an Operation resource.
625 #
626 # Google Compute Engine has three Operation resources:
627 #
628 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
629 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
630 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
631 #
632 # You can use an operation resource to manage asynchronous API requests.
633 # For more information, readHandling
634 # API responses.
635 #
636 # Operations can be global, regional or zonal.
637 #
638 # - For global operations, use the `globalOperations`
639 # resource.
640 # - For regional operations, use the
641 # `regionOperations` resource.
642 # - For zonal operations, use
643 # the `zoneOperations` resource.
644 #
645 #
646 #
647 # For more information, read
648 # Global, Regional, and Zonal Resources.
649 #
650 # Note that completed Operation resources have a limited
651 # retention period.
652 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
653 # Not present otherwise.
654 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
655 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
656 # set when the operation is created.
657 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
658 # text format.
659 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
660 # this field will be populated.
661 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
662 # operation.
663 {
664 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
665 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
666 # details. There is a set of defined message types to use for providing
667 # details.The syntax depends on the error code. For example,
668 # QuotaExceededInfo will have details when the error code is
669 # QUOTA_EXCEEDED.
670 {
671 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
672 #
673 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
674 # is not enabled:
675 #
676 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
677 # &quot;domain&quot;: &quot;googleapis.com&quot;
678 # &quot;metadata&quot;: {
679 # &quot;resource&quot;: &quot;projects/123&quot;,
680 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
681 # }
682 # }
683 #
684 # This response indicates that the pubsub.googleapis.com API is not enabled.
685 #
686 # Example of an error that is returned when attempting to create a Spanner
687 # instance in a region that is out of stock:
688 #
689 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
690 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
691 # &quot;metadata&quot;: {
692 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
693 # }
694 # }
695 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
696 # is typically the registered service name of the tool or product that
697 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
698 # generated by some common infrastructure, the error domain must be a
699 # globally unique value that identifies the infrastructure. For Google API
700 # infrastructure, the error domain is &quot;googleapis.com&quot;.
701 &quot;metadatas&quot;: { # Additional structured details about this error.
702 #
703 # Keys must match a regular expression of `a-z+` but should
704 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
705 # length. When identifying the current value of an exceeded limit, the units
706 # should be contained in the key, not the value. For example, rather than
707 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
708 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
709 # instances that can be created in a single (batch) request.
710 &quot;a_key&quot;: &quot;A String&quot;,
711 },
712 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
713 # proximate cause of the error. Error reasons are unique within a particular
714 # domain of errors. This should be at most 63 characters and match a
715 # regular expression of `A-Z+[A-Z0-9]`, which represents
716 # UPPER_SNAKE_CASE.
717 },
718 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
719 #
720 # For example, if a quota check failed with an error indicating the calling
721 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
722 # directly to the right place in the developer console to flip the bit.
723 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
724 { # Describes a URL link.
725 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
726 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
727 },
728 ],
729 },
730 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
731 # which can be attached to an RPC error.
732 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
733 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
734 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
735 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
736 },
737 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
738 &quot;dimensions&quot;: { # The map holding related quota dimensions.
739 &quot;a_key&quot;: &quot;A String&quot;,
740 },
741 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
742 # type or metric.
743 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
744 # or metric.
745 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
746 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
747 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
748 },
749 },
750 ],
751 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
752 # This property is optional.
753 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
754 },
755 ],
756 },
757 &quot;getVersionOperationMetadata&quot;: {
758 &quot;inlineSbomInfo&quot;: {
759 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
760 # appropriate identifiers.
761 &quot;a_key&quot;: &quot;A String&quot;,
762 },
763 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
764 # identifiers.
765 &quot;a_key&quot;: &quot;A String&quot;,
766 },
767 },
768 },
769 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
770 # message that was returned, such as `NOT FOUND`.
771 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
772 # status code that was returned. For example, a `404` means the
773 # resource was not found.
774 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
775 # defined by the server.
776 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
777 # This value is inRFC3339
778 # text format.
779 &quot;instancesBulkInsertOperationMetadata&quot;: {
780 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
781 # Example key: zones/us-central1-a
782 &quot;a_key&quot;: {
783 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
784 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
785 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
786 # error.
787 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
788 # if the flow is rolling forward or rolling back.
789 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
790 },
791 },
792 },
793 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
794 # Operation resources.
795 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
796 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
797 # group of operations results from a `bulkInsert` API request.
798 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
799 # `update`, or `delete`, and so on.
800 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
801 # There is no requirement that this be linear or support any granularity of
802 # operations. This should not be used to guess when the operation will be
803 # complete. This number should monotonically increase as the operation
804 # progresses.
805 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
806 # applicable when performing regional operations.
807 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
808 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
809 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
810 # this field will contain information on all underlying zonal actions and
811 # their state.
812 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
813 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
814 # Example key: zones/us-central1-a
815 &quot;a_key&quot;: {
816 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
817 # populated.
818 # different programming environments, including REST APIs and RPC APIs. It is
819 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
820 # three pieces of data: error code, error message, and error details.
821 #
822 # You can find out more about this error model and how to work with it in the
823 # [API Design Guide](https://cloud.google.com/apis/design/errors).
824 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
825 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
826 # message types for APIs to use.
827 {
828 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
829 },
830 ],
831 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
832 # user-facing error message should be localized and sent in the
833 # google.rpc.Status.details field, or localized by the client.
834 },
835 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
836 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
837 },
838 },
839 },
840 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
841 # This value is inRFC3339
842 # text format.
843 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
844 # following:
845 # `PENDING`, `RUNNING`, or `DONE`.
846 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
847 # operation.
848 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
849 # of the target resource.
850 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
851 # operations related to creating a snapshot, this points to the disk
852 # that the snapshot was created from.
853 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
854 # `[email protected]` or
855 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
856 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
857 # operation, this field will be populated.
858 {
859 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
860 # Engine returns NO_RESULTS_ON_PAGE if there
861 # are no results in the response.
862 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
863 # value format. For example:
864 #
865 # &quot;data&quot;: [
866 # {
867 # &quot;key&quot;: &quot;scope&quot;,
868 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
869 # }
870 {
871 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
872 # returned. For example, for warnings where there are no results in a list
873 # request for a particular zone, this key might be scope and
874 # the key value might be the zone name. Other examples might be a key
875 # indicating a deprecated resource and a suggested replacement, or a
876 # warning about invalid network settings (for example, if an instance
877 # attempts to perform IP forwarding but is not enabled for IP forwarding).
878 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
879 },
880 ],
881 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
882 },
883 ],
884 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
885 # applicable when performing per-zone operations.
886 }</pre>
887 </div>
888
889 <div class="method">
890 <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body=None, x__xgafv=None)</code>
891 <pre>Returns permissions that a caller has on the specified resource.
892
893 Args:
894 project: string, Project ID for this request. (required)
895 region: string, The name of the region for this request. (required)
896 resource: string, Name or id of the resource for this request. (required)
897 body: object, The request body.
898 The object takes the form of:
899
900 {
901 &quot;permissions&quot;: [ # The set of permissions to check for the &#x27;resource&#x27;. Permissions with
902 # wildcards (such as &#x27;*&#x27; or &#x27;storage.*&#x27;) are not allowed.
903 &quot;A String&quot;,
904 ],
905 }
906
907 x__xgafv: string, V1 error format.
908 Allowed values
909 1 - v1 error format
910 2 - v2 error format
911
912 Returns:
913 An object of the form:
914
915 {
916 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is
917 # allowed.
918 &quot;A String&quot;,
919 ],
920 }</pre>
921 </div>
922
923 </body></html>