Debian Codegraph @

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