Debian Codegraph @

docs/dyn/compute_alpha.instanceGroups.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.instanceGroups.html">instanceGroups</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#addInstances">addInstances(project, zone, instanceGroup, body=None, requestId=None, x__xgafv=None)</a></code></p>
79 <p class="firstline">Adds a list of instances to the specified instance group. All of the</p>
80 <p class="toc_element">
81 <code><a href="#aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Retrieves the list of instance groups and sorts them by zone.</p>
83 <p class="toc_element">
84 <code><a href="#aggregatedList_next">aggregatedList_next()</a></code></p>
85 <p class="firstline">Retrieves the next page of results.</p>
86 <p class="toc_element">
87 <code><a href="#close">close()</a></code></p>
88 <p class="firstline">Close httplib2 connections.</p>
89 <p class="toc_element">
90 <code><a href="#delete">delete(project, zone, instanceGroup, requestId=None, x__xgafv=None)</a></code></p>
91 <p class="firstline">Deletes the specified instance group. The instances in the group are not</p>
92 <p class="toc_element">
93 <code><a href="#get">get(project, zone, instanceGroup, x__xgafv=None)</a></code></p>
94 <p class="firstline">Returns the specified zonal instance group. Get a list of available zonal</p>
95 <p class="toc_element">
96 <code><a href="#insert">insert(project, zone, body=None, requestId=None, x__xgafv=None)</a></code></p>
97 <p class="firstline">Creates an instance group in the specified project using the</p>
98 <p class="toc_element">
99 <code><a href="#list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
100 <p class="firstline">Retrieves the list of zonal instance group resources contained within the</p>
101 <p class="toc_element">
102 <code><a href="#listInstances">listInstances(project, zone, instanceGroup, body=None, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
103 <p class="firstline">Lists the instances in the specified instance group.</p>
104 <p class="toc_element">
105 <code><a href="#listInstances_next">listInstances_next()</a></code></p>
106 <p class="firstline">Retrieves the next page of results.</p>
107 <p class="toc_element">
108 <code><a href="#list_next">list_next()</a></code></p>
109 <p class="firstline">Retrieves the next page of results.</p>
110 <p class="toc_element">
111 <code><a href="#removeInstances">removeInstances(project, zone, instanceGroup, body=None, requestId=None, x__xgafv=None)</a></code></p>
112 <p class="firstline">Removes one or more instances from the specified instance group, but does</p>
113 <p class="toc_element">
114 <code><a href="#setNamedPorts">setNamedPorts(project, zone, instanceGroup, body=None, requestId=None, x__xgafv=None)</a></code></p>
115 <p class="firstline">Sets the named ports for the specified instance group.</p>
116 <p class="toc_element">
117 <code><a href="#testIamPermissions">testIamPermissions(project, zone, resource, body=None, x__xgafv=None)</a></code></p>
118 <p class="firstline">Returns permissions that a caller has on the specified resource.</p>
119 <h3>Method Details</h3>
120 <div class="method">
121 <code class="details" id="addInstances">addInstances(project, zone, instanceGroup, body=None, requestId=None, x__xgafv=None)</code>
122 <pre>Adds a list of instances to the specified instance group. All of the
123 instances in the instance group must be in the same network/subnetwork.
124 Read
125 Adding instances for more information.
126
127 Args:
128 project: string, Project ID for this request. (required)
129 zone: string, The name of the zone
130 where the instance group is located. (required)
131 instanceGroup: string, The name of the instance group where you are adding instances. (required)
132 body: object, The request body.
133 The object takes the form of:
134
135 {
136 &quot;instances&quot;: [ # The list of instances to add to the instance group.
137 {
138 &quot;instance&quot;: &quot;A String&quot;, # The URL for a specific instance.
139 # @required compute.instancegroups.addInstances/removeInstances
140 },
141 ],
142 }
143
144 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
145 that if you must retry your request, the server will know to ignore the
146 request if it has already been completed.
147
148 For example, consider a situation where you make an initial request and
149 the request times out. If you make the request again with the same
150 request ID, the server can check if original operation with the same
151 request ID was received, and if so, will ignore the second request. This
152 prevents clients from accidentally creating duplicate commitments.
153
154 The request ID must be
155 a valid UUID with the exception that zero UUID is not supported
156 (00000000-0000-0000-0000-000000000000).
157 x__xgafv: string, V1 error format.
158 Allowed values
159 1 - v1 error format
160 2 - v2 error format
161
162 Returns:
163 An object of the form:
164
165 { # Represents an Operation resource.
166 #
167 # Google Compute Engine has three Operation resources:
168 #
169 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
170 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
171 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
172 #
173 # You can use an operation resource to manage asynchronous API requests.
174 # For more information, readHandling
175 # API responses.
176 #
177 # Operations can be global, regional or zonal.
178 #
179 # - For global operations, use the `globalOperations`
180 # resource.
181 # - For regional operations, use the
182 # `regionOperations` resource.
183 # - For zonal operations, use
184 # the `zoneOperations` resource.
185 #
186 #
187 #
188 # For more information, read
189 # Global, Regional, and Zonal Resources.
190 #
191 # Note that completed Operation resources have a limited
192 # retention period.
193 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
194 # Not present otherwise.
195 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
196 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
197 # set when the operation is created.
198 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
199 # text format.
200 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
201 # this field will be populated.
202 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
203 # operation.
204 {
205 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
206 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
207 # details. There is a set of defined message types to use for providing
208 # details.The syntax depends on the error code. For example,
209 # QuotaExceededInfo will have details when the error code is
210 # QUOTA_EXCEEDED.
211 {
212 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
213 #
214 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
215 # is not enabled:
216 #
217 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
218 # &quot;domain&quot;: &quot;googleapis.com&quot;
219 # &quot;metadata&quot;: {
220 # &quot;resource&quot;: &quot;projects/123&quot;,
221 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
222 # }
223 # }
224 #
225 # This response indicates that the pubsub.googleapis.com API is not enabled.
226 #
227 # Example of an error that is returned when attempting to create a Spanner
228 # instance in a region that is out of stock:
229 #
230 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
231 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
232 # &quot;metadata&quot;: {
233 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
234 # }
235 # }
236 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
237 # is typically the registered service name of the tool or product that
238 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
239 # generated by some common infrastructure, the error domain must be a
240 # globally unique value that identifies the infrastructure. For Google API
241 # infrastructure, the error domain is &quot;googleapis.com&quot;.
242 &quot;metadatas&quot;: { # Additional structured details about this error.
243 #
244 # Keys must match a regular expression of `a-z+` but should
245 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
246 # length. When identifying the current value of an exceeded limit, the units
247 # should be contained in the key, not the value. For example, rather than
248 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
249 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
250 # instances that can be created in a single (batch) request.
251 &quot;a_key&quot;: &quot;A String&quot;,
252 },
253 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
254 # proximate cause of the error. Error reasons are unique within a particular
255 # domain of errors. This should be at most 63 characters and match a
256 # regular expression of `A-Z+[A-Z0-9]`, which represents
257 # UPPER_SNAKE_CASE.
258 },
259 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
260 #
261 # For example, if a quota check failed with an error indicating the calling
262 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
263 # directly to the right place in the developer console to flip the bit.
264 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
265 { # Describes a URL link.
266 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
267 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
268 },
269 ],
270 },
271 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
272 # which can be attached to an RPC error.
273 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
274 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
275 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
276 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
277 },
278 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
279 &quot;dimensions&quot;: { # The map holding related quota dimensions.
280 &quot;a_key&quot;: &quot;A String&quot;,
281 },
282 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
283 # type or metric.
284 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
285 # or metric.
286 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
287 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
288 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
289 },
290 },
291 ],
292 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
293 # This property is optional.
294 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
295 },
296 ],
297 },
298 &quot;getVersionOperationMetadata&quot;: {
299 &quot;inlineSbomInfo&quot;: {
300 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
301 # appropriate identifiers.
302 &quot;a_key&quot;: &quot;A String&quot;,
303 },
304 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
305 # identifiers.
306 &quot;a_key&quot;: &quot;A String&quot;,
307 },
308 },
309 },
310 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
311 # message that was returned, such as `NOT FOUND`.
312 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
313 # status code that was returned. For example, a `404` means the
314 # resource was not found.
315 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
316 # defined by the server.
317 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
318 # This value is inRFC3339
319 # text format.
320 &quot;instancesBulkInsertOperationMetadata&quot;: {
321 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
322 # Example key: zones/us-central1-a
323 &quot;a_key&quot;: {
324 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
325 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
326 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
327 # error.
328 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
329 # if the flow is rolling forward or rolling back.
330 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
331 },
332 },
333 },
334 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
335 # Operation resources.
336 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
337 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
338 # group of operations results from a `bulkInsert` API request.
339 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
340 # `update`, or `delete`, and so on.
341 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
342 # There is no requirement that this be linear or support any granularity of
343 # operations. This should not be used to guess when the operation will be
344 # complete. This number should monotonically increase as the operation
345 # progresses.
346 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
347 # applicable when performing regional operations.
348 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
349 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
350 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
351 # this field will contain information on all underlying zonal actions and
352 # their state.
353 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
354 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
355 # Example key: zones/us-central1-a
356 &quot;a_key&quot;: {
357 &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
358 # populated.
359 # different programming environments, including REST APIs and RPC APIs. It is
360 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
361 # three pieces of data: error code, error message, and error details.
362 #
363 # You can find out more about this error model and how to work with it in the
364 # [API Design Guide](https://cloud.google.com/apis/design/errors).
365 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
366 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
367 # message types for APIs to use.
368 {
369 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
370 },
371 ],
372 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
373 # user-facing error message should be localized and sent in the
374 # google.rpc.Status.details field, or localized by the client.
375 },
376 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
377 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
378 },
379 },
380 },
381 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
382 # This value is inRFC3339
383 # text format.
384 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
385 # following:
386 # `PENDING`, `RUNNING`, or `DONE`.
387 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
388 # operation.
389 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
390 # of the target resource.
391 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
392 # operations related to creating a snapshot, this points to the disk
393 # that the snapshot was created from.
394 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
395 # `[email protected]` or
396 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
397 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
398 # operation, this field will be populated.
399 {
400 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
401 # Engine returns NO_RESULTS_ON_PAGE if there
402 # are no results in the response.
403 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
404 # value format. For example:
405 #
406 # &quot;data&quot;: [
407 # {
408 # &quot;key&quot;: &quot;scope&quot;,
409 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
410 # }
411 {
412 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
413 # returned. For example, for warnings where there are no results in a list
414 # request for a particular zone, this key might be scope and
415 # the key value might be the zone name. Other examples might be a key
416 # indicating a deprecated resource and a suggested replacement, or a
417 # warning about invalid network settings (for example, if an instance
418 # attempts to perform IP forwarding but is not enabled for IP forwarding).
419 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
420 },
421 ],
422 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
423 },
424 ],
425 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
426 # applicable when performing per-zone operations.
427 }</pre>
428 </div>
429
430 <div class="method">
431 <code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)</code>
432 <pre>Retrieves the list of instance groups and sorts them by zone.
433
434 To prevent failure, Google recommends that you set the
435 `returnPartialSuccess` parameter to `true`.
436
437 Args:
438 project: string, Project ID for this request. (required)
439 filter: string, A filter expression that filters resources listed in the response. Most
440 Compute resources support two types of filter expressions:
441 expressions that support regular expressions and expressions that follow
442 API improvement proposal AIP-160.
443 These two types of filter expressions cannot be mixed in one request.
444
445 If you want to use AIP-160, your expression must specify the field name, an
446 operator, and the value that you want to use for filtering. The value
447 must be a string, a number, or a boolean. The operator
448 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
449
450 For example, if you are filtering Compute Engine instances, you can
451 exclude instances named `example-instance` by specifying
452 `name != example-instance`.
453
454 The `:*` comparison can be used to test whether a key has been defined.
455 For example, to find all objects with `owner` label use:
456 ```
457 labels.owner:*
458 ```
459
460 You can also filter nested fields. For example, you could specify
461 `scheduling.automaticRestart = false` to include instances only
462 if they are not scheduled for automatic restarts. You can use filtering
463 on nested fields to filter based onresource labels.
464
465 To filter on multiple expressions, provide each separate expression within
466 parentheses. For example:
467 ```
468 (scheduling.automaticRestart = true)
469 (cpuPlatform = &quot;Intel Skylake&quot;)
470 ```
471 By default, each expression is an `AND` expression. However, you
472 can include `AND` and `OR` expressions explicitly.
473 For example:
474 ```
475 (cpuPlatform = &quot;Intel Skylake&quot;) OR
476 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
477 (scheduling.automaticRestart = true)
478 ```
479
480 If you want to use a regular expression, use the `eq` (equal) or `ne`
481 (not equal) operator against a single un-parenthesized expression with or
482 without quotes or against multiple parenthesized expressions. Examples:
483
484 `fieldname eq unquoted literal`
485 `fieldname eq &#x27;single quoted literal&#x27;`
486 `fieldname eq &quot;double quoted literal&quot;`
487 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
488
489 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
490 The literal value must match the entire field.
491
492 For example, to filter for instances that do not end with name &quot;instance&quot;,
493 you would use `name ne .*instance`.
494
495 You cannot combine constraints on multiple fields using regular
496 expressions.
497 includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region,
498 global) should be included in the response. For new resource types added
499 after this field, the flag has no effect as new resource types will always
500 include every visible scope for each scope type in response. For resource
501 types which predate this field, if this flag is omitted or false, only
502 scopes of the scope types where the resource type is expected to be found
503 will be included.
504 maxResults: integer, The maximum number of results per page that should be returned.
505 If the number of available results is larger than `maxResults`,
506 Compute Engine returns a `nextPageToken` that can be used to get
507 the next page of results in subsequent list requests. Acceptable values are
508 `0` to `500`, inclusive. (Default: `500`)
509 orderBy: string, Sorts list results by a certain order. By default, results
510 are returned in alphanumerical order based on the resource name.
511
512 You can also sort results in descending order based on the creation
513 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
514 results based on the `creationTimestamp` field in
515 reverse chronological order (newest result first). Use this to sort
516 resources like operations so that the newest operation is returned first.
517
518 Currently, only sorting by `name` or
519 `creationTimestamp desc` is supported.
520 pageToken: string, Specifies a page token to use. Set `pageToken` to the
521 `nextPageToken` returned by a previous list request to get
522 the next page of results.
523 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
524 of failure. The default value is false.
525
526 For example, when partial success behavior is enabled, aggregatedList for a
527 single zone scope either returns all resources in the zone or no resources,
528 with an error code.
529 serviceProjectNumber: string, The Shared VPC service project id or service project number for which
530 aggregated list request is invoked for subnetworks list-usable api.
531 x__xgafv: string, V1 error format.
532 Allowed values
533 1 - v1 error format
534 2 - v2 error format
535
536 Returns:
537 An object of the form:
538
539 {
540 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] Unique identifier for the resource; defined by the server.
541 &quot;items&quot;: { # A list of InstanceGroupsScopedList resources.
542 &quot;a_key&quot;: { # The name of the scope that contains this set of instance groups.
543 &quot;instanceGroups&quot;: [ # Output only. [Output Only] The list ofinstance
544 # groups that are contained in this scope.
545 { # Represents an Instance Group resource.
546 #
547 # Instance Groups can be used to configure a target forload
548 # balancing.
549 #
550 # Instance groups can either be managed or unmanaged.
551 #
552 # To create
553 # managed instance groups, use the instanceGroupManager orregionInstanceGroupManager resource instead.
554 #
555 # Use zonal unmanaged instance groups if you need to applyload
556 # balancing to groups of heterogeneous instances or if you need to manage
557 # the instances yourself. You cannot create regional unmanaged instance groups.
558 #
559 # For more information, readInstance
560 # groups.
561 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] The creation timestamp for this instance group inRFC3339
562 # text format.
563 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
564 # create the resource.
565 &quot;fingerprint&quot;: &quot;A String&quot;, # Output only. [Output Only] The fingerprint of the named ports. The system
566 # uses this fingerprint to detect conflicts when multiple users change the
567 # named ports concurrently.
568 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] A unique identifier for this instance group, generated
569 # by the server.
570 &quot;kind&quot;: &quot;compute#instanceGroup&quot;, # Output only. [Output Only] The resource type, which is alwayscompute#instanceGroup for instance groups.
571 &quot;name&quot;: &quot;A String&quot;, # The name of the instance group. The name must be 1-63 characters
572 # long, and comply withRFC1035.
573 &quot;namedPorts&quot;: [ # Optional. Assigns a name to a port number. For example:{name: &quot;http&quot;, port: 80}
574 #
575 # This
576 # allows the system to reference ports by the assigned name instead of a
577 # port number. Named ports can also contain multiple ports. For example:[{name: &quot;app1&quot;, port: 8080}, {name:
578 # &quot;app1&quot;, port: 8081}, {name: &quot;app2&quot;, port:
579 # 8082}]
580 #
581 # Named ports apply to all instances in this instance group.
582 { # The named port. For example: &lt;&quot;http&quot;, 80&gt;.
583 &quot;name&quot;: &quot;A String&quot;, # The name for this named port.
584 # The name must be 1-63 characters long, and comply withRFC1035.
585 &quot;port&quot;: 42, # The port number, which can be a value between 1 and 65535.
586 },
587 ],
588 &quot;network&quot;: &quot;A String&quot;, # [Output Only] The URL of the network to which all instances in the
589 # instance group belong. If your instance has multiple network interfaces,
590 # then the network and subnetwork fields only refer to the
591 # network and subnet used by your primary interface (nic0).
592 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL of theregion
593 # where the instance group is located (for regional resources).
594 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL for this instance group. The server generates
595 # this URL.
596 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
597 &quot;size&quot;: 42, # Output only. [Output Only] The total number of instances in the instance group.
598 &quot;subnetwork&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL of the subnetwork to which all instances in the
599 # instance group belong. If your instance has multiple network interfaces,
600 # then the network and subnetwork fields only refer to the
601 # network and subnet used by your primary interface (nic0).
602 &quot;zone&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL of thezone
603 # where the instance group is located (for zonal resources).
604 },
605 ],
606 &quot;warning&quot;: { # Output only. [Output Only] An informational warning that replaces the list of
607 # instance groups when the list is empty.
608 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
609 # Engine returns NO_RESULTS_ON_PAGE if there
610 # are no results in the response.
611 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
612 # value format. For example:
613 #
614 # &quot;data&quot;: [
615 # {
616 # &quot;key&quot;: &quot;scope&quot;,
617 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
618 # }
619 {
620 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
621 # returned. For example, for warnings where there are no results in a list
622 # request for a particular zone, this key might be scope and
623 # the key value might be the zone name. Other examples might be a key
624 # indicating a deprecated resource and a suggested replacement, or a
625 # warning about invalid network settings (for example, if an instance
626 # attempts to perform IP forwarding but is not enabled for IP forwarding).
627 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
628 },
629 ],
630 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
631 },
632 },
633 },
634 &quot;kind&quot;: &quot;compute#instanceGroupAggregatedList&quot;, # Output only. [Output Only] The resource type, which is alwayscompute#instanceGroupAggregatedList for aggregated lists of
635 # instance groups.
636 &quot;nextPageToken&quot;: &quot;A String&quot;, # Output only. [Output Only] This token allows you to get the next page of results for
637 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
638 # the query parameter pageToken in the next list request.
639 # Subsequent list requests will have their own nextPageToken to
640 # continue paging through the results.
641 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
642 &quot;unreachables&quot;: [ # Output only. [Output Only] Unreachable resources.
643 &quot;A String&quot;,
644 ],
645 &quot;warning&quot;: { # Output only. [Output Only] Informational warning message.
646 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
647 # Engine returns NO_RESULTS_ON_PAGE if there
648 # are no results in the response.
649 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
650 # value format. For example:
651 #
652 # &quot;data&quot;: [
653 # {
654 # &quot;key&quot;: &quot;scope&quot;,
655 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
656 # }
657 {
658 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
659 # returned. For example, for warnings where there are no results in a list
660 # request for a particular zone, this key might be scope and
661 # the key value might be the zone name. Other examples might be a key
662 # indicating a deprecated resource and a suggested replacement, or a
663 # warning about invalid network settings (for example, if an instance
664 # attempts to perform IP forwarding but is not enabled for IP forwarding).
665 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
666 },
667 ],
668 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
669 },
670 }</pre>
671 </div>
672
673 <div class="method">
674 <code class="details" id="aggregatedList_next">aggregatedList_next()</code>
675 <pre>Retrieves the next page of results.
676
677 Args:
678 previous_request: The request for the previous page. (required)
679 previous_response: The response from the request for the previous page. (required)
680
681 Returns:
682 A request object that you can call &#x27;execute()&#x27; on to request the next
683 page. Returns None if there are no more items in the collection.
684 </pre>
685 </div>
686
687 <div class="method">
688 <code class="details" id="close">close()</code>
689 <pre>Close httplib2 connections.</pre>
690 </div>
691
692 <div class="method">
693 <code class="details" id="delete">delete(project, zone, instanceGroup, requestId=None, x__xgafv=None)</code>
694 <pre>Deletes the specified instance group. The instances in the group are not
695 deleted. Note that instance group must not belong to a backend service.
696 Read
697 Deleting an instance group for more information.
698
699 Args:
700 project: string, Project ID for this request. (required)
701 zone: string, The name of the zone
702 where the instance group is located. (required)
703 instanceGroup: string, The name of the instance group to delete. (required)
704 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
705 that if you must retry your request, the server will know to ignore the
706 request if it has already been completed.
707
708 For example, consider a situation where you make an initial request and
709 the request times out. If you make the request again with the same
710 request ID, the server can check if original operation with the same
711 request ID was received, and if so, will ignore the second request. This
712 prevents clients from accidentally creating duplicate commitments.
713
714 The request ID must be
715 a valid UUID with the exception that zero UUID is not supported
716 (00000000-0000-0000-0000-000000000000).
717 x__xgafv: string, V1 error format.
718 Allowed values
719 1 - v1 error format
720 2 - v2 error format
721
722 Returns:
723 An object of the form:
724
725 { # Represents an Operation resource.
726 #
727 # Google Compute Engine has three Operation resources:
728 #
729 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
730 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
731 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
732 #
733 # You can use an operation resource to manage asynchronous API requests.
734 # For more information, readHandling
735 # API responses.
736 #
737 # Operations can be global, regional or zonal.
738 #
739 # - For global operations, use the `globalOperations`
740 # resource.
741 # - For regional operations, use the
742 # `regionOperations` resource.
743 # - For zonal operations, use
744 # the `zoneOperations` resource.
745 #
746 #
747 #
748 # For more information, read
749 # Global, Regional, and Zonal Resources.
750 #
751 # Note that completed Operation resources have a limited
752 # retention period.
753 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
754 # Not present otherwise.
755 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
756 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
757 # set when the operation is created.
758 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
759 # text format.
760 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
761 # this field will be populated.
762 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
763 # operation.
764 {
765 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
766 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
767 # details. There is a set of defined message types to use for providing
768 # details.The syntax depends on the error code. For example,
769 # QuotaExceededInfo will have details when the error code is
770 # QUOTA_EXCEEDED.
771 {
772 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
773 #
774 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
775 # is not enabled:
776 #
777 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
778 # &quot;domain&quot;: &quot;googleapis.com&quot;
779 # &quot;metadata&quot;: {
780 # &quot;resource&quot;: &quot;projects/123&quot;,
781 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
782 # }
783 # }
784 #
785 # This response indicates that the pubsub.googleapis.com API is not enabled.
786 #
787 # Example of an error that is returned when attempting to create a Spanner
788 # instance in a region that is out of stock:
789 #
790 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
791 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
792 # &quot;metadata&quot;: {
793 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
794 # }
795 # }
796 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
797 # is typically the registered service name of the tool or product that
798 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
799 # generated by some common infrastructure, the error domain must be a
800 # globally unique value that identifies the infrastructure. For Google API
801 # infrastructure, the error domain is &quot;googleapis.com&quot;.
802 &quot;metadatas&quot;: { # Additional structured details about this error.
803 #
804 # Keys must match a regular expression of `a-z+` but should
805 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
806 # length. When identifying the current value of an exceeded limit, the units
807 # should be contained in the key, not the value. For example, rather than
808 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
809 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
810 # instances that can be created in a single (batch) request.
811 &quot;a_key&quot;: &quot;A String&quot;,
812 },
813 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
814 # proximate cause of the error. Error reasons are unique within a particular
815 # domain of errors. This should be at most 63 characters and match a
816 # regular expression of `A-Z+[A-Z0-9]`, which represents
817 # UPPER_SNAKE_CASE.
818 },
819 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
820 #
821 # For example, if a quota check failed with an error indicating the calling
822 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
823 # directly to the right place in the developer console to flip the bit.
824 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
825 { # Describes a URL link.
826 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
827 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
828 },
829 ],
830 },
831 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
832 # which can be attached to an RPC error.
833 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
834 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
835 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
836 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
837 },
838 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
839 &quot;dimensions&quot;: { # The map holding related quota dimensions.
840 &quot;a_key&quot;: &quot;A String&quot;,
841 },
842 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
843 # type or metric.
844 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
845 # or metric.
846 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
847 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
848 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
849 },
850 },
851 ],
852 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
853 # This property is optional.
854 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
855 },
856 ],
857 },
858 &quot;getVersionOperationMetadata&quot;: {
859 &quot;inlineSbomInfo&quot;: {
860 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
861 # appropriate identifiers.
862 &quot;a_key&quot;: &quot;A String&quot;,
863 },
864 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
865 # identifiers.
866 &quot;a_key&quot;: &quot;A String&quot;,
867 },
868 },
869 },
870 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
871 # message that was returned, such as `NOT FOUND`.
872 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
873 # status code that was returned. For example, a `404` means the
874 # resource was not found.
875 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
876 # defined by the server.
877 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
878 # This value is inRFC3339
879 # text format.
880 &quot;instancesBulkInsertOperationMetadata&quot;: {
881 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
882 # Example key: zones/us-central1-a
883 &quot;a_key&quot;: {
884 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
885 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
886 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
887 # error.
888 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
889 # if the flow is rolling forward or rolling back.
890 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
891 },
892 },
893 },
894 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
895 # Operation resources.
896 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
897 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
898 # group of operations results from a `bulkInsert` API request.
899 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
900 # `update`, or `delete`, and so on.
901 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
902 # There is no requirement that this be linear or support any granularity of
903 # operations. This should not be used to guess when the operation will be
904 # complete. This number should monotonically increase as the operation
905 # progresses.
906 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
907 # applicable when performing regional operations.
908 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
909 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
910 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
911 # this field will contain information on all underlying zonal actions and
912 # their state.
913 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
914 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
915 # Example key: zones/us-central1-a
916 &quot;a_key&quot;: {
917 &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
918 # populated.
919 # different programming environments, including REST APIs and RPC APIs. It is
920 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
921 # three pieces of data: error code, error message, and error details.
922 #
923 # You can find out more about this error model and how to work with it in the
924 # [API Design Guide](https://cloud.google.com/apis/design/errors).
925 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
926 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
927 # message types for APIs to use.
928 {
929 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
930 },
931 ],
932 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
933 # user-facing error message should be localized and sent in the
934 # google.rpc.Status.details field, or localized by the client.
935 },
936 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
937 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
938 },
939 },
940 },
941 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
942 # This value is inRFC3339
943 # text format.
944 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
945 # following:
946 # `PENDING`, `RUNNING`, or `DONE`.
947 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
948 # operation.
949 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
950 # of the target resource.
951 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
952 # operations related to creating a snapshot, this points to the disk
953 # that the snapshot was created from.
954 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
955 # `[email protected]` or
956 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
957 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
958 # operation, this field will be populated.
959 {
960 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
961 # Engine returns NO_RESULTS_ON_PAGE if there
962 # are no results in the response.
963 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
964 # value format. For example:
965 #
966 # &quot;data&quot;: [
967 # {
968 # &quot;key&quot;: &quot;scope&quot;,
969 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
970 # }
971 {
972 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
973 # returned. For example, for warnings where there are no results in a list
974 # request for a particular zone, this key might be scope and
975 # the key value might be the zone name. Other examples might be a key
976 # indicating a deprecated resource and a suggested replacement, or a
977 # warning about invalid network settings (for example, if an instance
978 # attempts to perform IP forwarding but is not enabled for IP forwarding).
979 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
980 },
981 ],
982 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
983 },
984 ],
985 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
986 # applicable when performing per-zone operations.
987 }</pre>
988 </div>
989
990 <div class="method">
991 <code class="details" id="get">get(project, zone, instanceGroup, x__xgafv=None)</code>
992 <pre>Returns the specified zonal instance group. Get a list of available zonal
993 instance groups by making a list() request.
994
995 For managed instance groups, use theinstanceGroupManagers
996 or regionInstanceGroupManagers
997 methods instead.
998
999 Args:
1000 project: string, Project ID for this request. (required)
1001 zone: string, The name of the zone
1002 where the instance group is located. (required)
1003 instanceGroup: string, The name of the instance group. (required)
1004 x__xgafv: string, V1 error format.
1005 Allowed values
1006 1 - v1 error format
1007 2 - v2 error format
1008
1009 Returns:
1010 An object of the form:
1011
1012 { # Represents an Instance Group resource.
1013 #
1014 # Instance Groups can be used to configure a target forload
1015 # balancing.
1016 #
1017 # Instance groups can either be managed or unmanaged.
1018 #
1019 # To create
1020 # managed instance groups, use the instanceGroupManager orregionInstanceGroupManager resource instead.
1021 #
1022 # Use zonal unmanaged instance groups if you need to applyload
1023 # balancing to groups of heterogeneous instances or if you need to manage
1024 # the instances yourself. You cannot create regional unmanaged instance groups.
1025 #
1026 # For more information, readInstance
1027 # groups.
1028 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] The creation timestamp for this instance group inRFC3339
1029 # text format.
1030 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
1031 # create the resource.
1032 &quot;fingerprint&quot;: &quot;A String&quot;, # Output only. [Output Only] The fingerprint of the named ports. The system
1033 # uses this fingerprint to detect conflicts when multiple users change the
1034 # named ports concurrently.
1035 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] A unique identifier for this instance group, generated
1036 # by the server.
1037 &quot;kind&quot;: &quot;compute#instanceGroup&quot;, # Output only. [Output Only] The resource type, which is alwayscompute#instanceGroup for instance groups.
1038 &quot;name&quot;: &quot;A String&quot;, # The name of the instance group. The name must be 1-63 characters
1039 # long, and comply withRFC1035.
1040 &quot;namedPorts&quot;: [ # Optional. Assigns a name to a port number. For example:{name: &quot;http&quot;, port: 80}
1041 #
1042 # This
1043 # allows the system to reference ports by the assigned name instead of a
1044 # port number. Named ports can also contain multiple ports. For example:[{name: &quot;app1&quot;, port: 8080}, {name:
1045 # &quot;app1&quot;, port: 8081}, {name: &quot;app2&quot;, port:
1046 # 8082}]
1047 #
1048 # Named ports apply to all instances in this instance group.
1049 { # The named port. For example: &lt;&quot;http&quot;, 80&gt;.
1050 &quot;name&quot;: &quot;A String&quot;, # The name for this named port.
1051 # The name must be 1-63 characters long, and comply withRFC1035.
1052 &quot;port&quot;: 42, # The port number, which can be a value between 1 and 65535.
1053 },
1054 ],
1055 &quot;network&quot;: &quot;A String&quot;, # [Output Only] The URL of the network to which all instances in the
1056 # instance group belong. If your instance has multiple network interfaces,
1057 # then the network and subnetwork fields only refer to the
1058 # network and subnet used by your primary interface (nic0).
1059 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL of theregion
1060 # where the instance group is located (for regional resources).
1061 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL for this instance group. The server generates
1062 # this URL.
1063 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
1064 &quot;size&quot;: 42, # Output only. [Output Only] The total number of instances in the instance group.
1065 &quot;subnetwork&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL of the subnetwork to which all instances in the
1066 # instance group belong. If your instance has multiple network interfaces,
1067 # then the network and subnetwork fields only refer to the
1068 # network and subnet used by your primary interface (nic0).
1069 &quot;zone&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL of thezone
1070 # where the instance group is located (for zonal resources).
1071 }</pre>
1072 </div>
1073
1074 <div class="method">
1075 <code class="details" id="insert">insert(project, zone, body=None, requestId=None, x__xgafv=None)</code>
1076 <pre>Creates an instance group in the specified project using the
1077 parameters that are included in the request.
1078
1079 Args:
1080 project: string, Project ID for this request. (required)
1081 zone: string, The name of the zone
1082 where you want to create the instance group. (required)
1083 body: object, The request body.
1084 The object takes the form of:
1085
1086 { # Represents an Instance Group resource.
1087 #
1088 # Instance Groups can be used to configure a target forload
1089 # balancing.
1090 #
1091 # Instance groups can either be managed or unmanaged.
1092 #
1093 # To create
1094 # managed instance groups, use the instanceGroupManager orregionInstanceGroupManager resource instead.
1095 #
1096 # Use zonal unmanaged instance groups if you need to applyload
1097 # balancing to groups of heterogeneous instances or if you need to manage
1098 # the instances yourself. You cannot create regional unmanaged instance groups.
1099 #
1100 # For more information, readInstance
1101 # groups.
1102 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] The creation timestamp for this instance group inRFC3339
1103 # text format.
1104 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
1105 # create the resource.
1106 &quot;fingerprint&quot;: &quot;A String&quot;, # Output only. [Output Only] The fingerprint of the named ports. The system
1107 # uses this fingerprint to detect conflicts when multiple users change the
1108 # named ports concurrently.
1109 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] A unique identifier for this instance group, generated
1110 # by the server.
1111 &quot;kind&quot;: &quot;compute#instanceGroup&quot;, # Output only. [Output Only] The resource type, which is alwayscompute#instanceGroup for instance groups.
1112 &quot;name&quot;: &quot;A String&quot;, # The name of the instance group. The name must be 1-63 characters
1113 # long, and comply withRFC1035.
1114 &quot;namedPorts&quot;: [ # Optional. Assigns a name to a port number. For example:{name: &quot;http&quot;, port: 80}
1115 #
1116 # This
1117 # allows the system to reference ports by the assigned name instead of a
1118 # port number. Named ports can also contain multiple ports. For example:[{name: &quot;app1&quot;, port: 8080}, {name:
1119 # &quot;app1&quot;, port: 8081}, {name: &quot;app2&quot;, port:
1120 # 8082}]
1121 #
1122 # Named ports apply to all instances in this instance group.
1123 { # The named port. For example: &lt;&quot;http&quot;, 80&gt;.
1124 &quot;name&quot;: &quot;A String&quot;, # The name for this named port.
1125 # The name must be 1-63 characters long, and comply withRFC1035.
1126 &quot;port&quot;: 42, # The port number, which can be a value between 1 and 65535.
1127 },
1128 ],
1129 &quot;network&quot;: &quot;A String&quot;, # [Output Only] The URL of the network to which all instances in the
1130 # instance group belong. If your instance has multiple network interfaces,
1131 # then the network and subnetwork fields only refer to the
1132 # network and subnet used by your primary interface (nic0).
1133 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL of theregion
1134 # where the instance group is located (for regional resources).
1135 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL for this instance group. The server generates
1136 # this URL.
1137 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
1138 &quot;size&quot;: 42, # Output only. [Output Only] The total number of instances in the instance group.
1139 &quot;subnetwork&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL of the subnetwork to which all instances in the
1140 # instance group belong. If your instance has multiple network interfaces,
1141 # then the network and subnetwork fields only refer to the
1142 # network and subnet used by your primary interface (nic0).
1143 &quot;zone&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL of thezone
1144 # where the instance group is located (for zonal resources).
1145 }
1146
1147 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
1148 that if you must retry your request, the server will know to ignore the
1149 request if it has already been completed.
1150
1151 For example, consider a situation where you make an initial request and
1152 the request times out. If you make the request again with the same
1153 request ID, the server can check if original operation with the same
1154 request ID was received, and if so, will ignore the second request. This
1155 prevents clients from accidentally creating duplicate commitments.
1156
1157 The request ID must be
1158 a valid UUID with the exception that zero UUID is not supported
1159 (00000000-0000-0000-0000-000000000000).
1160 x__xgafv: string, V1 error format.
1161 Allowed values
1162 1 - v1 error format
1163 2 - v2 error format
1164
1165 Returns:
1166 An object of the form:
1167
1168 { # Represents an Operation resource.
1169 #
1170 # Google Compute Engine has three Operation resources:
1171 #
1172 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
1173 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
1174 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
1175 #
1176 # You can use an operation resource to manage asynchronous API requests.
1177 # For more information, readHandling
1178 # API responses.
1179 #
1180 # Operations can be global, regional or zonal.
1181 #
1182 # - For global operations, use the `globalOperations`
1183 # resource.
1184 # - For regional operations, use the
1185 # `regionOperations` resource.
1186 # - For zonal operations, use
1187 # the `zoneOperations` resource.
1188 #
1189 #
1190 #
1191 # For more information, read
1192 # Global, Regional, and Zonal Resources.
1193 #
1194 # Note that completed Operation resources have a limited
1195 # retention period.
1196 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
1197 # Not present otherwise.
1198 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1199 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
1200 # set when the operation is created.
1201 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
1202 # text format.
1203 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
1204 # this field will be populated.
1205 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
1206 # operation.
1207 {
1208 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1209 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
1210 # details. There is a set of defined message types to use for providing
1211 # details.The syntax depends on the error code. For example,
1212 # QuotaExceededInfo will have details when the error code is
1213 # QUOTA_EXCEEDED.
1214 {
1215 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
1216 #
1217 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
1218 # is not enabled:
1219 #
1220 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
1221 # &quot;domain&quot;: &quot;googleapis.com&quot;
1222 # &quot;metadata&quot;: {
1223 # &quot;resource&quot;: &quot;projects/123&quot;,
1224 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
1225 # }
1226 # }
1227 #
1228 # This response indicates that the pubsub.googleapis.com API is not enabled.
1229 #
1230 # Example of an error that is returned when attempting to create a Spanner
1231 # instance in a region that is out of stock:
1232 #
1233 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
1234 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
1235 # &quot;metadata&quot;: {
1236 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
1237 # }
1238 # }
1239 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
1240 # is typically the registered service name of the tool or product that
1241 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
1242 # generated by some common infrastructure, the error domain must be a
1243 # globally unique value that identifies the infrastructure. For Google API
1244 # infrastructure, the error domain is &quot;googleapis.com&quot;.
1245 &quot;metadatas&quot;: { # Additional structured details about this error.
1246 #
1247 # Keys must match a regular expression of `a-z+` but should
1248 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
1249 # length. When identifying the current value of an exceeded limit, the units
1250 # should be contained in the key, not the value. For example, rather than
1251 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1252 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1253 # instances that can be created in a single (batch) request.
1254 &quot;a_key&quot;: &quot;A String&quot;,
1255 },
1256 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1257 # proximate cause of the error. Error reasons are unique within a particular
1258 # domain of errors. This should be at most 63 characters and match a
1259 # regular expression of `A-Z+[A-Z0-9]`, which represents
1260 # UPPER_SNAKE_CASE.
1261 },
1262 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1263 #
1264 # For example, if a quota check failed with an error indicating the calling
1265 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1266 # directly to the right place in the developer console to flip the bit.
1267 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1268 { # Describes a URL link.
1269 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1270 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1271 },
1272 ],
1273 },
1274 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1275 # which can be attached to an RPC error.
1276 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1277 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1278 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1279 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1280 },
1281 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1282 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1283 &quot;a_key&quot;: &quot;A String&quot;,
1284 },
1285 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1286 # type or metric.
1287 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1288 # or metric.
1289 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1290 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1291 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1292 },
1293 },
1294 ],
1295 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1296 # This property is optional.
1297 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1298 },
1299 ],
1300 },
1301 &quot;getVersionOperationMetadata&quot;: {
1302 &quot;inlineSbomInfo&quot;: {
1303 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1304 # appropriate identifiers.
1305 &quot;a_key&quot;: &quot;A String&quot;,
1306 },
1307 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
1308 # identifiers.
1309 &quot;a_key&quot;: &quot;A String&quot;,
1310 },
1311 },
1312 },
1313 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1314 # message that was returned, such as `NOT FOUND`.
1315 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1316 # status code that was returned. For example, a `404` means the
1317 # resource was not found.
1318 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1319 # defined by the server.
1320 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1321 # This value is inRFC3339
1322 # text format.
1323 &quot;instancesBulkInsertOperationMetadata&quot;: {
1324 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1325 # Example key: zones/us-central1-a
1326 &quot;a_key&quot;: {
1327 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1328 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1329 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1330 # error.
1331 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1332 # if the flow is rolling forward or rolling back.
1333 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1334 },
1335 },
1336 },
1337 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1338 # Operation resources.
1339 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1340 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1341 # group of operations results from a `bulkInsert` API request.
1342 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1343 # `update`, or `delete`, and so on.
1344 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1345 # There is no requirement that this be linear or support any granularity of
1346 # operations. This should not be used to guess when the operation will be
1347 # complete. This number should monotonically increase as the operation
1348 # progresses.
1349 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1350 # applicable when performing regional operations.
1351 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1352 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
1353 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1354 # this field will contain information on all underlying zonal actions and
1355 # their state.
1356 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1357 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1358 # Example key: zones/us-central1-a
1359 &quot;a_key&quot;: {
1360 &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
1361 # populated.
1362 # different programming environments, including REST APIs and RPC APIs. It is
1363 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1364 # three pieces of data: error code, error message, and error details.
1365 #
1366 # You can find out more about this error model and how to work with it in the
1367 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1368 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1369 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1370 # message types for APIs to use.
1371 {
1372 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1373 },
1374 ],
1375 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1376 # user-facing error message should be localized and sent in the
1377 # google.rpc.Status.details field, or localized by the client.
1378 },
1379 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1380 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1381 },
1382 },
1383 },
1384 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1385 # This value is inRFC3339
1386 # text format.
1387 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1388 # following:
1389 # `PENDING`, `RUNNING`, or `DONE`.
1390 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1391 # operation.
1392 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1393 # of the target resource.
1394 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1395 # operations related to creating a snapshot, this points to the disk
1396 # that the snapshot was created from.
1397 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1398 # `[email protected]` or
1399 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1400 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1401 # operation, this field will be populated.
1402 {
1403 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1404 # Engine returns NO_RESULTS_ON_PAGE if there
1405 # are no results in the response.
1406 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1407 # value format. For example:
1408 #
1409 # &quot;data&quot;: [
1410 # {
1411 # &quot;key&quot;: &quot;scope&quot;,
1412 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1413 # }
1414 {
1415 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1416 # returned. For example, for warnings where there are no results in a list
1417 # request for a particular zone, this key might be scope and
1418 # the key value might be the zone name. Other examples might be a key
1419 # indicating a deprecated resource and a suggested replacement, or a
1420 # warning about invalid network settings (for example, if an instance
1421 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1422 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1423 },
1424 ],
1425 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1426 },
1427 ],
1428 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1429 # applicable when performing per-zone operations.
1430 }</pre>
1431 </div>
1432
1433 <div class="method">
1434 <code class="details" id="list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
1435 <pre>Retrieves the list of zonal instance group resources contained within the
1436 specified zone.
1437
1438 For managed instance groups, use theinstanceGroupManagers
1439 or regionInstanceGroupManagers
1440 methods instead.
1441
1442 Args:
1443 project: string, Project ID for this request. (required)
1444 zone: string, The name of thezone
1445 where the instance group is located. (required)
1446 filter: string, A filter expression that filters resources listed in the response. Most
1447 Compute resources support two types of filter expressions:
1448 expressions that support regular expressions and expressions that follow
1449 API improvement proposal AIP-160.
1450 These two types of filter expressions cannot be mixed in one request.
1451
1452 If you want to use AIP-160, your expression must specify the field name, an
1453 operator, and the value that you want to use for filtering. The value
1454 must be a string, a number, or a boolean. The operator
1455 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
1456
1457 For example, if you are filtering Compute Engine instances, you can
1458 exclude instances named `example-instance` by specifying
1459 `name != example-instance`.
1460
1461 The `:*` comparison can be used to test whether a key has been defined.
1462 For example, to find all objects with `owner` label use:
1463 ```
1464 labels.owner:*
1465 ```
1466
1467 You can also filter nested fields. For example, you could specify
1468 `scheduling.automaticRestart = false` to include instances only
1469 if they are not scheduled for automatic restarts. You can use filtering
1470 on nested fields to filter based onresource labels.
1471
1472 To filter on multiple expressions, provide each separate expression within
1473 parentheses. For example:
1474 ```
1475 (scheduling.automaticRestart = true)
1476 (cpuPlatform = &quot;Intel Skylake&quot;)
1477 ```
1478 By default, each expression is an `AND` expression. However, you
1479 can include `AND` and `OR` expressions explicitly.
1480 For example:
1481 ```
1482 (cpuPlatform = &quot;Intel Skylake&quot;) OR
1483 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
1484 (scheduling.automaticRestart = true)
1485 ```
1486
1487 If you want to use a regular expression, use the `eq` (equal) or `ne`
1488 (not equal) operator against a single un-parenthesized expression with or
1489 without quotes or against multiple parenthesized expressions. Examples:
1490
1491 `fieldname eq unquoted literal`
1492 `fieldname eq &#x27;single quoted literal&#x27;`
1493 `fieldname eq &quot;double quoted literal&quot;`
1494 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
1495
1496 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
1497 The literal value must match the entire field.
1498
1499 For example, to filter for instances that do not end with name &quot;instance&quot;,
1500 you would use `name ne .*instance`.
1501
1502 You cannot combine constraints on multiple fields using regular
1503 expressions.
1504 maxResults: integer, The maximum number of results per page that should be returned.
1505 If the number of available results is larger than `maxResults`,
1506 Compute Engine returns a `nextPageToken` that can be used to get
1507 the next page of results in subsequent list requests. Acceptable values are
1508 `0` to `500`, inclusive. (Default: `500`)
1509 orderBy: string, Sorts list results by a certain order. By default, results
1510 are returned in alphanumerical order based on the resource name.
1511
1512 You can also sort results in descending order based on the creation
1513 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
1514 results based on the `creationTimestamp` field in
1515 reverse chronological order (newest result first). Use this to sort
1516 resources like operations so that the newest operation is returned first.
1517
1518 Currently, only sorting by `name` or
1519 `creationTimestamp desc` is supported.
1520 pageToken: string, Specifies a page token to use. Set `pageToken` to the
1521 `nextPageToken` returned by a previous list request to get
1522 the next page of results.
1523 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
1524 of failure. The default value is false.
1525
1526 For example, when partial success behavior is enabled, aggregatedList for a
1527 single zone scope either returns all resources in the zone or no resources,
1528 with an error code.
1529 x__xgafv: string, V1 error format.
1530 Allowed values
1531 1 - v1 error format
1532 2 - v2 error format
1533
1534 Returns:
1535 An object of the form:
1536
1537 { # A list of InstanceGroup resources.
1538 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] Unique identifier for the resource; defined by the server.
1539 &quot;items&quot;: [ # A list of InstanceGroup resources.
1540 { # Represents an Instance Group resource.
1541 #
1542 # Instance Groups can be used to configure a target forload
1543 # balancing.
1544 #
1545 # Instance groups can either be managed or unmanaged.
1546 #
1547 # To create
1548 # managed instance groups, use the instanceGroupManager orregionInstanceGroupManager resource instead.
1549 #
1550 # Use zonal unmanaged instance groups if you need to applyload
1551 # balancing to groups of heterogeneous instances or if you need to manage
1552 # the instances yourself. You cannot create regional unmanaged instance groups.
1553 #
1554 # For more information, readInstance
1555 # groups.
1556 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] The creation timestamp for this instance group inRFC3339
1557 # text format.
1558 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
1559 # create the resource.
1560 &quot;fingerprint&quot;: &quot;A String&quot;, # Output only. [Output Only] The fingerprint of the named ports. The system
1561 # uses this fingerprint to detect conflicts when multiple users change the
1562 # named ports concurrently.
1563 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] A unique identifier for this instance group, generated
1564 # by the server.
1565 &quot;kind&quot;: &quot;compute#instanceGroup&quot;, # Output only. [Output Only] The resource type, which is alwayscompute#instanceGroup for instance groups.
1566 &quot;name&quot;: &quot;A String&quot;, # The name of the instance group. The name must be 1-63 characters
1567 # long, and comply withRFC1035.
1568 &quot;namedPorts&quot;: [ # Optional. Assigns a name to a port number. For example:{name: &quot;http&quot;, port: 80}
1569 #
1570 # This
1571 # allows the system to reference ports by the assigned name instead of a
1572 # port number. Named ports can also contain multiple ports. For example:[{name: &quot;app1&quot;, port: 8080}, {name:
1573 # &quot;app1&quot;, port: 8081}, {name: &quot;app2&quot;, port:
1574 # 8082}]
1575 #
1576 # Named ports apply to all instances in this instance group.
1577 { # The named port. For example: &lt;&quot;http&quot;, 80&gt;.
1578 &quot;name&quot;: &quot;A String&quot;, # The name for this named port.
1579 # The name must be 1-63 characters long, and comply withRFC1035.
1580 &quot;port&quot;: 42, # The port number, which can be a value between 1 and 65535.
1581 },
1582 ],
1583 &quot;network&quot;: &quot;A String&quot;, # [Output Only] The URL of the network to which all instances in the
1584 # instance group belong. If your instance has multiple network interfaces,
1585 # then the network and subnetwork fields only refer to the
1586 # network and subnet used by your primary interface (nic0).
1587 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL of theregion
1588 # where the instance group is located (for regional resources).
1589 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL for this instance group. The server generates
1590 # this URL.
1591 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
1592 &quot;size&quot;: 42, # Output only. [Output Only] The total number of instances in the instance group.
1593 &quot;subnetwork&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL of the subnetwork to which all instances in the
1594 # instance group belong. If your instance has multiple network interfaces,
1595 # then the network and subnetwork fields only refer to the
1596 # network and subnet used by your primary interface (nic0).
1597 &quot;zone&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL of thezone
1598 # where the instance group is located (for zonal resources).
1599 },
1600 ],
1601 &quot;kind&quot;: &quot;compute#instanceGroupList&quot;, # Output only. [Output Only] The resource type, which is alwayscompute#instanceGroupList for instance group lists.
1602 &quot;nextPageToken&quot;: &quot;A String&quot;, # Output only. [Output Only] This token allows you to get the next page of results for
1603 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
1604 # the query parameter pageToken in the next list request.
1605 # Subsequent list requests will have their own nextPageToken to
1606 # continue paging through the results.
1607 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
1608 &quot;warning&quot;: { # Output only. [Output Only] Informational warning message.
1609 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1610 # Engine returns NO_RESULTS_ON_PAGE if there
1611 # are no results in the response.
1612 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1613 # value format. For example:
1614 #
1615 # &quot;data&quot;: [
1616 # {
1617 # &quot;key&quot;: &quot;scope&quot;,
1618 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1619 # }
1620 {
1621 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1622 # returned. For example, for warnings where there are no results in a list
1623 # request for a particular zone, this key might be scope and
1624 # the key value might be the zone name. Other examples might be a key
1625 # indicating a deprecated resource and a suggested replacement, or a
1626 # warning about invalid network settings (for example, if an instance
1627 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1628 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1629 },
1630 ],
1631 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1632 },
1633 }</pre>
1634 </div>
1635
1636 <div class="method">
1637 <code class="details" id="listInstances">listInstances(project, zone, instanceGroup, body=None, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
1638 <pre>Lists the instances in the specified instance group.
1639 The orderBy query parameter is not supported.
1640 The filter query parameter is supported, but only for
1641 expressions that use `eq` (equal) or `ne` (not equal) operators.
1642
1643 Args:
1644 project: string, Project ID for this request. (required)
1645 zone: string, The name of the zone
1646 where the instance group is located. (required)
1647 instanceGroup: string, The name of the instance group from which you want to generate a list
1648 of included instances. (required)
1649 body: object, The request body.
1650 The object takes the form of:
1651
1652 {
1653 &quot;instanceState&quot;: &quot;A String&quot;, # A filter for the state of the instances in the instance group. Valid
1654 # options are ALL or RUNNING. If you do not specify
1655 # this parameter the list includes all instances regardless of their state.
1656 }
1657
1658 filter: string, A filter expression that filters resources listed in the response. Most
1659 Compute resources support two types of filter expressions:
1660 expressions that support regular expressions and expressions that follow
1661 API improvement proposal AIP-160.
1662 These two types of filter expressions cannot be mixed in one request.
1663
1664 If you want to use AIP-160, your expression must specify the field name, an
1665 operator, and the value that you want to use for filtering. The value
1666 must be a string, a number, or a boolean. The operator
1667 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
1668
1669 For example, if you are filtering Compute Engine instances, you can
1670 exclude instances named `example-instance` by specifying
1671 `name != example-instance`.
1672
1673 The `:*` comparison can be used to test whether a key has been defined.
1674 For example, to find all objects with `owner` label use:
1675 ```
1676 labels.owner:*
1677 ```
1678
1679 You can also filter nested fields. For example, you could specify
1680 `scheduling.automaticRestart = false` to include instances only
1681 if they are not scheduled for automatic restarts. You can use filtering
1682 on nested fields to filter based onresource labels.
1683
1684 To filter on multiple expressions, provide each separate expression within
1685 parentheses. For example:
1686 ```
1687 (scheduling.automaticRestart = true)
1688 (cpuPlatform = &quot;Intel Skylake&quot;)
1689 ```
1690 By default, each expression is an `AND` expression. However, you
1691 can include `AND` and `OR` expressions explicitly.
1692 For example:
1693 ```
1694 (cpuPlatform = &quot;Intel Skylake&quot;) OR
1695 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
1696 (scheduling.automaticRestart = true)
1697 ```
1698
1699 If you want to use a regular expression, use the `eq` (equal) or `ne`
1700 (not equal) operator against a single un-parenthesized expression with or
1701 without quotes or against multiple parenthesized expressions. Examples:
1702
1703 `fieldname eq unquoted literal`
1704 `fieldname eq &#x27;single quoted literal&#x27;`
1705 `fieldname eq &quot;double quoted literal&quot;`
1706 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
1707
1708 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
1709 The literal value must match the entire field.
1710
1711 For example, to filter for instances that do not end with name &quot;instance&quot;,
1712 you would use `name ne .*instance`.
1713
1714 You cannot combine constraints on multiple fields using regular
1715 expressions.
1716 maxResults: integer, The maximum number of results per page that should be returned.
1717 If the number of available results is larger than `maxResults`,
1718 Compute Engine returns a `nextPageToken` that can be used to get
1719 the next page of results in subsequent list requests. Acceptable values are
1720 `0` to `500`, inclusive. (Default: `500`)
1721 orderBy: string, Sorts list results by a certain order. By default, results
1722 are returned in alphanumerical order based on the resource name.
1723
1724 You can also sort results in descending order based on the creation
1725 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
1726 results based on the `creationTimestamp` field in
1727 reverse chronological order (newest result first). Use this to sort
1728 resources like operations so that the newest operation is returned first.
1729
1730 Currently, only sorting by `name` or
1731 `creationTimestamp desc` is supported.
1732 pageToken: string, Specifies a page token to use. Set `pageToken` to the
1733 `nextPageToken` returned by a previous list request to get
1734 the next page of results.
1735 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
1736 of failure. The default value is false.
1737
1738 For example, when partial success behavior is enabled, aggregatedList for a
1739 single zone scope either returns all resources in the zone or no resources,
1740 with an error code.
1741 x__xgafv: string, V1 error format.
1742 Allowed values
1743 1 - v1 error format
1744 2 - v2 error format
1745
1746 Returns:
1747 An object of the form:
1748
1749 {
1750 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] Unique identifier for the resource; defined by the server.
1751 &quot;items&quot;: [ # A list of InstanceWithNamedPorts resources.
1752 {
1753 &quot;instance&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL of the instance.
1754 &quot;namedPorts&quot;: [ # Output only. [Output Only] The named ports that belong to this instance group.
1755 { # The named port. For example: &lt;&quot;http&quot;, 80&gt;.
1756 &quot;name&quot;: &quot;A String&quot;, # The name for this named port.
1757 # The name must be 1-63 characters long, and comply withRFC1035.
1758 &quot;port&quot;: 42, # The port number, which can be a value between 1 and 65535.
1759 },
1760 ],
1761 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only] The status of the instance.
1762 },
1763 ],
1764 &quot;kind&quot;: &quot;compute#instanceGroupsListInstances&quot;, # Output only. [Output Only] The resource type, which is alwayscompute#instanceGroupsListInstances for the list of instances
1765 # in the specified instance group.
1766 &quot;nextPageToken&quot;: &quot;A String&quot;, # Output only. [Output Only] This token allows you to get the next page of results for
1767 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
1768 # the query parameter pageToken in the next list request.
1769 # Subsequent list requests will have their own nextPageToken to
1770 # continue paging through the results.
1771 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
1772 &quot;warning&quot;: { # Output only. [Output Only] Informational warning message.
1773 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1774 # Engine returns NO_RESULTS_ON_PAGE if there
1775 # are no results in the response.
1776 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1777 # value format. For example:
1778 #
1779 # &quot;data&quot;: [
1780 # {
1781 # &quot;key&quot;: &quot;scope&quot;,
1782 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1783 # }
1784 {
1785 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1786 # returned. For example, for warnings where there are no results in a list
1787 # request for a particular zone, this key might be scope and
1788 # the key value might be the zone name. Other examples might be a key
1789 # indicating a deprecated resource and a suggested replacement, or a
1790 # warning about invalid network settings (for example, if an instance
1791 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1792 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1793 },
1794 ],
1795 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1796 },
1797 }</pre>
1798 </div>
1799
1800 <div class="method">
1801 <code class="details" id="listInstances_next">listInstances_next()</code>
1802 <pre>Retrieves the next page of results.
1803
1804 Args:
1805 previous_request: The request for the previous page. (required)
1806 previous_response: The response from the request for the previous page. (required)
1807
1808 Returns:
1809 A request object that you can call &#x27;execute()&#x27; on to request the next
1810 page. Returns None if there are no more items in the collection.
1811 </pre>
1812 </div>
1813
1814 <div class="method">
1815 <code class="details" id="list_next">list_next()</code>
1816 <pre>Retrieves the next page of results.
1817
1818 Args:
1819 previous_request: The request for the previous page. (required)
1820 previous_response: The response from the request for the previous page. (required)
1821
1822 Returns:
1823 A request object that you can call &#x27;execute()&#x27; on to request the next
1824 page. Returns None if there are no more items in the collection.
1825 </pre>
1826 </div>
1827
1828 <div class="method">
1829 <code class="details" id="removeInstances">removeInstances(project, zone, instanceGroup, body=None, requestId=None, x__xgafv=None)</code>
1830 <pre>Removes one or more instances from the specified instance group, but does
1831 not delete those instances.
1832
1833 If the group is part of a backend
1834 service that has enabled
1835 connection draining, it can take up to 60 seconds after the connection
1836 draining duration before the VM instance is removed or deleted.
1837
1838 Args:
1839 project: string, Project ID for this request. (required)
1840 zone: string, The name of the zone
1841 where the instance group is located. (required)
1842 instanceGroup: string, The name of the instance group where the specified instances will be
1843 removed. (required)
1844 body: object, The request body.
1845 The object takes the form of:
1846
1847 {
1848 &quot;instances&quot;: [ # The list of instances to remove from the instance group.
1849 {
1850 &quot;instance&quot;: &quot;A String&quot;, # The URL for a specific instance.
1851 # @required compute.instancegroups.addInstances/removeInstances
1852 },
1853 ],
1854 }
1855
1856 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
1857 that if you must retry your request, the server will know to ignore the
1858 request if it has already been completed.
1859
1860 For example, consider a situation where you make an initial request and
1861 the request times out. If you make the request again with the same
1862 request ID, the server can check if original operation with the same
1863 request ID was received, and if so, will ignore the second request. This
1864 prevents clients from accidentally creating duplicate commitments.
1865
1866 The request ID must be
1867 a valid UUID with the exception that zero UUID is not supported
1868 (00000000-0000-0000-0000-000000000000).
1869 x__xgafv: string, V1 error format.
1870 Allowed values
1871 1 - v1 error format
1872 2 - v2 error format
1873
1874 Returns:
1875 An object of the form:
1876
1877 { # Represents an Operation resource.
1878 #
1879 # Google Compute Engine has three Operation resources:
1880 #
1881 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
1882 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
1883 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
1884 #
1885 # You can use an operation resource to manage asynchronous API requests.
1886 # For more information, readHandling
1887 # API responses.
1888 #
1889 # Operations can be global, regional or zonal.
1890 #
1891 # - For global operations, use the `globalOperations`
1892 # resource.
1893 # - For regional operations, use the
1894 # `regionOperations` resource.
1895 # - For zonal operations, use
1896 # the `zoneOperations` resource.
1897 #
1898 #
1899 #
1900 # For more information, read
1901 # Global, Regional, and Zonal Resources.
1902 #
1903 # Note that completed Operation resources have a limited
1904 # retention period.
1905 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
1906 # Not present otherwise.
1907 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1908 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
1909 # set when the operation is created.
1910 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
1911 # text format.
1912 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
1913 # this field will be populated.
1914 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
1915 # operation.
1916 {
1917 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1918 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
1919 # details. There is a set of defined message types to use for providing
1920 # details.The syntax depends on the error code. For example,
1921 # QuotaExceededInfo will have details when the error code is
1922 # QUOTA_EXCEEDED.
1923 {
1924 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
1925 #
1926 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
1927 # is not enabled:
1928 #
1929 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
1930 # &quot;domain&quot;: &quot;googleapis.com&quot;
1931 # &quot;metadata&quot;: {
1932 # &quot;resource&quot;: &quot;projects/123&quot;,
1933 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
1934 # }
1935 # }
1936 #
1937 # This response indicates that the pubsub.googleapis.com API is not enabled.
1938 #
1939 # Example of an error that is returned when attempting to create a Spanner
1940 # instance in a region that is out of stock:
1941 #
1942 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
1943 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
1944 # &quot;metadata&quot;: {
1945 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
1946 # }
1947 # }
1948 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
1949 # is typically the registered service name of the tool or product that
1950 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
1951 # generated by some common infrastructure, the error domain must be a
1952 # globally unique value that identifies the infrastructure. For Google API
1953 # infrastructure, the error domain is &quot;googleapis.com&quot;.
1954 &quot;metadatas&quot;: { # Additional structured details about this error.
1955 #
1956 # Keys must match a regular expression of `a-z+` but should
1957 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
1958 # length. When identifying the current value of an exceeded limit, the units
1959 # should be contained in the key, not the value. For example, rather than
1960 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1961 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1962 # instances that can be created in a single (batch) request.
1963 &quot;a_key&quot;: &quot;A String&quot;,
1964 },
1965 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1966 # proximate cause of the error. Error reasons are unique within a particular
1967 # domain of errors. This should be at most 63 characters and match a
1968 # regular expression of `A-Z+[A-Z0-9]`, which represents
1969 # UPPER_SNAKE_CASE.
1970 },
1971 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1972 #
1973 # For example, if a quota check failed with an error indicating the calling
1974 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1975 # directly to the right place in the developer console to flip the bit.
1976 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1977 { # Describes a URL link.
1978 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1979 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1980 },
1981 ],
1982 },
1983 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1984 # which can be attached to an RPC error.
1985 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1986 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1987 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1988 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1989 },
1990 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1991 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1992 &quot;a_key&quot;: &quot;A String&quot;,
1993 },
1994 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1995 # type or metric.
1996 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1997 # or metric.
1998 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1999 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
2000 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
2001 },
2002 },
2003 ],
2004 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
2005 # This property is optional.
2006 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
2007 },
2008 ],
2009 },
2010 &quot;getVersionOperationMetadata&quot;: {
2011 &quot;inlineSbomInfo&quot;: {
2012 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
2013 # appropriate identifiers.
2014 &quot;a_key&quot;: &quot;A String&quot;,
2015 },
2016 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
2017 # identifiers.
2018 &quot;a_key&quot;: &quot;A String&quot;,
2019 },
2020 },
2021 },
2022 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
2023 # message that was returned, such as `NOT FOUND`.
2024 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
2025 # status code that was returned. For example, a `404` means the
2026 # resource was not found.
2027 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
2028 # defined by the server.
2029 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
2030 # This value is inRFC3339
2031 # text format.
2032 &quot;instancesBulkInsertOperationMetadata&quot;: {
2033 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
2034 # Example key: zones/us-central1-a
2035 &quot;a_key&quot;: {
2036 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
2037 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
2038 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
2039 # error.
2040 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
2041 # if the flow is rolling forward or rolling back.
2042 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
2043 },
2044 },
2045 },
2046 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
2047 # Operation resources.
2048 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
2049 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
2050 # group of operations results from a `bulkInsert` API request.
2051 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
2052 # `update`, or `delete`, and so on.
2053 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
2054 # There is no requirement that this be linear or support any granularity of
2055 # operations. This should not be used to guess when the operation will be
2056 # complete. This number should monotonically increase as the operation
2057 # progresses.
2058 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
2059 # applicable when performing regional operations.
2060 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
2061 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
2062 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
2063 # this field will contain information on all underlying zonal actions and
2064 # their state.
2065 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
2066 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
2067 # Example key: zones/us-central1-a
2068 &quot;a_key&quot;: {
2069 &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
2070 # populated.
2071 # different programming environments, including REST APIs and RPC APIs. It is
2072 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
2073 # three pieces of data: error code, error message, and error details.
2074 #
2075 # You can find out more about this error model and how to work with it in the
2076 # [API Design Guide](https://cloud.google.com/apis/design/errors).
2077 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
2078 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
2079 # message types for APIs to use.
2080 {
2081 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
2082 },
2083 ],
2084 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
2085 # user-facing error message should be localized and sent in the
2086 # google.rpc.Status.details field, or localized by the client.
2087 },
2088 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
2089 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
2090 },
2091 },
2092 },
2093 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
2094 # This value is inRFC3339
2095 # text format.
2096 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
2097 # following:
2098 # `PENDING`, `RUNNING`, or `DONE`.
2099 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
2100 # operation.
2101 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
2102 # of the target resource.
2103 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
2104 # operations related to creating a snapshot, this points to the disk
2105 # that the snapshot was created from.
2106 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
2107 # `[email protected]` or
2108 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
2109 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
2110 # operation, this field will be populated.
2111 {
2112 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2113 # Engine returns NO_RESULTS_ON_PAGE if there
2114 # are no results in the response.
2115 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2116 # value format. For example:
2117 #
2118 # &quot;data&quot;: [
2119 # {
2120 # &quot;key&quot;: &quot;scope&quot;,
2121 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2122 # }
2123 {
2124 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2125 # returned. For example, for warnings where there are no results in a list
2126 # request for a particular zone, this key might be scope and
2127 # the key value might be the zone name. Other examples might be a key
2128 # indicating a deprecated resource and a suggested replacement, or a
2129 # warning about invalid network settings (for example, if an instance
2130 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2131 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2132 },
2133 ],
2134 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2135 },
2136 ],
2137 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
2138 # applicable when performing per-zone operations.
2139 }</pre>
2140 </div>
2141
2142 <div class="method">
2143 <code class="details" id="setNamedPorts">setNamedPorts(project, zone, instanceGroup, body=None, requestId=None, x__xgafv=None)</code>
2144 <pre>Sets the named ports for the specified instance group.
2145
2146 Args:
2147 project: string, Project ID for this request. (required)
2148 zone: string, The name of the zone
2149 where the instance group is located. (required)
2150 instanceGroup: string, The name of the instance group where the named ports are updated. (required)
2151 body: object, The request body.
2152 The object takes the form of:
2153
2154 {
2155 &quot;fingerprint&quot;: &quot;A String&quot;, # The fingerprint of the named ports information for this instance group.
2156 # Use this optional property to prevent conflicts when multiple users change
2157 # the named ports settings concurrently. Obtain the fingerprint with theinstanceGroups.get
2158 # method. Then, include the fingerprint in your request to ensure that you
2159 # do not overwrite changes that were applied from another concurrent request.
2160 # A request with an incorrect fingerprint will fail with error412 conditionNotMet.
2161 &quot;namedPorts&quot;: [ # The list of named ports to set for this instance group.
2162 { # The named port. For example: &lt;&quot;http&quot;, 80&gt;.
2163 &quot;name&quot;: &quot;A String&quot;, # The name for this named port.
2164 # The name must be 1-63 characters long, and comply withRFC1035.
2165 &quot;port&quot;: 42, # The port number, which can be a value between 1 and 65535.
2166 },
2167 ],
2168 }
2169
2170 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
2171 that if you must retry your request, the server will know to ignore the
2172 request if it has already been completed.
2173
2174 For example, consider a situation where you make an initial request and
2175 the request times out. If you make the request again with the same
2176 request ID, the server can check if original operation with the same
2177 request ID was received, and if so, will ignore the second request. This
2178 prevents clients from accidentally creating duplicate commitments.
2179
2180 The request ID must be
2181 a valid UUID with the exception that zero UUID is not supported
2182 (00000000-0000-0000-0000-000000000000).
2183 x__xgafv: string, V1 error format.
2184 Allowed values
2185 1 - v1 error format
2186 2 - v2 error format
2187
2188 Returns:
2189 An object of the form:
2190
2191 { # Represents an Operation resource.
2192 #
2193 # Google Compute Engine has three Operation resources:
2194 #
2195 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
2196 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
2197 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
2198 #
2199 # You can use an operation resource to manage asynchronous API requests.
2200 # For more information, readHandling
2201 # API responses.
2202 #
2203 # Operations can be global, regional or zonal.
2204 #
2205 # - For global operations, use the `globalOperations`
2206 # resource.
2207 # - For regional operations, use the
2208 # `regionOperations` resource.
2209 # - For zonal operations, use
2210 # the `zoneOperations` resource.
2211 #
2212 #
2213 #
2214 # For more information, read
2215 # Global, Regional, and Zonal Resources.
2216 #
2217 # Note that completed Operation resources have a limited
2218 # retention period.
2219 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
2220 # Not present otherwise.
2221 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
2222 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
2223 # set when the operation is created.
2224 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
2225 # text format.
2226 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
2227 # this field will be populated.
2228 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
2229 # operation.
2230 {
2231 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
2232 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
2233 # details. There is a set of defined message types to use for providing
2234 # details.The syntax depends on the error code. For example,
2235 # QuotaExceededInfo will have details when the error code is
2236 # QUOTA_EXCEEDED.
2237 {
2238 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
2239 #
2240 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
2241 # is not enabled:
2242 #
2243 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
2244 # &quot;domain&quot;: &quot;googleapis.com&quot;
2245 # &quot;metadata&quot;: {
2246 # &quot;resource&quot;: &quot;projects/123&quot;,
2247 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
2248 # }
2249 # }
2250 #
2251 # This response indicates that the pubsub.googleapis.com API is not enabled.
2252 #
2253 # Example of an error that is returned when attempting to create a Spanner
2254 # instance in a region that is out of stock:
2255 #
2256 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
2257 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
2258 # &quot;metadata&quot;: {
2259 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
2260 # }
2261 # }
2262 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
2263 # is typically the registered service name of the tool or product that
2264 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
2265 # generated by some common infrastructure, the error domain must be a
2266 # globally unique value that identifies the infrastructure. For Google API
2267 # infrastructure, the error domain is &quot;googleapis.com&quot;.
2268 &quot;metadatas&quot;: { # Additional structured details about this error.
2269 #
2270 # Keys must match a regular expression of `a-z+` but should
2271 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
2272 # length. When identifying the current value of an exceeded limit, the units
2273 # should be contained in the key, not the value. For example, rather than
2274 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
2275 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
2276 # instances that can be created in a single (batch) request.
2277 &quot;a_key&quot;: &quot;A String&quot;,
2278 },
2279 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
2280 # proximate cause of the error. Error reasons are unique within a particular
2281 # domain of errors. This should be at most 63 characters and match a
2282 # regular expression of `A-Z+[A-Z0-9]`, which represents
2283 # UPPER_SNAKE_CASE.
2284 },
2285 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
2286 #
2287 # For example, if a quota check failed with an error indicating the calling
2288 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
2289 # directly to the right place in the developer console to flip the bit.
2290 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
2291 { # Describes a URL link.
2292 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
2293 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
2294 },
2295 ],
2296 },
2297 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
2298 # which can be attached to an RPC error.
2299 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
2300 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
2301 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
2302 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
2303 },
2304 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
2305 &quot;dimensions&quot;: { # The map holding related quota dimensions.
2306 &quot;a_key&quot;: &quot;A String&quot;,
2307 },
2308 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
2309 # type or metric.
2310 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
2311 # or metric.
2312 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
2313 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
2314 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
2315 },
2316 },
2317 ],
2318 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
2319 # This property is optional.
2320 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
2321 },
2322 ],
2323 },
2324 &quot;getVersionOperationMetadata&quot;: {
2325 &quot;inlineSbomInfo&quot;: {
2326 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
2327 # appropriate identifiers.
2328 &quot;a_key&quot;: &quot;A String&quot;,
2329 },
2330 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
2331 # identifiers.
2332 &quot;a_key&quot;: &quot;A String&quot;,
2333 },
2334 },
2335 },
2336 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
2337 # message that was returned, such as `NOT FOUND`.
2338 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
2339 # status code that was returned. For example, a `404` means the
2340 # resource was not found.
2341 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
2342 # defined by the server.
2343 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
2344 # This value is inRFC3339
2345 # text format.
2346 &quot;instancesBulkInsertOperationMetadata&quot;: {
2347 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
2348 # Example key: zones/us-central1-a
2349 &quot;a_key&quot;: {
2350 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
2351 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
2352 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
2353 # error.
2354 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
2355 # if the flow is rolling forward or rolling back.
2356 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
2357 },
2358 },
2359 },
2360 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
2361 # Operation resources.
2362 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
2363 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
2364 # group of operations results from a `bulkInsert` API request.
2365 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
2366 # `update`, or `delete`, and so on.
2367 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
2368 # There is no requirement that this be linear or support any granularity of
2369 # operations. This should not be used to guess when the operation will be
2370 # complete. This number should monotonically increase as the operation
2371 # progresses.
2372 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
2373 # applicable when performing regional operations.
2374 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
2375 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
2376 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
2377 # this field will contain information on all underlying zonal actions and
2378 # their state.
2379 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
2380 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
2381 # Example key: zones/us-central1-a
2382 &quot;a_key&quot;: {
2383 &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
2384 # populated.
2385 # different programming environments, including REST APIs and RPC APIs. It is
2386 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
2387 # three pieces of data: error code, error message, and error details.
2388 #
2389 # You can find out more about this error model and how to work with it in the
2390 # [API Design Guide](https://cloud.google.com/apis/design/errors).
2391 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
2392 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
2393 # message types for APIs to use.
2394 {
2395 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
2396 },
2397 ],
2398 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
2399 # user-facing error message should be localized and sent in the
2400 # google.rpc.Status.details field, or localized by the client.
2401 },
2402 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
2403 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
2404 },
2405 },
2406 },
2407 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
2408 # This value is inRFC3339
2409 # text format.
2410 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
2411 # following:
2412 # `PENDING`, `RUNNING`, or `DONE`.
2413 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
2414 # operation.
2415 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
2416 # of the target resource.
2417 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
2418 # operations related to creating a snapshot, this points to the disk
2419 # that the snapshot was created from.
2420 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
2421 # `[email protected]` or
2422 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
2423 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
2424 # operation, this field will be populated.
2425 {
2426 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2427 # Engine returns NO_RESULTS_ON_PAGE if there
2428 # are no results in the response.
2429 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2430 # value format. For example:
2431 #
2432 # &quot;data&quot;: [
2433 # {
2434 # &quot;key&quot;: &quot;scope&quot;,
2435 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2436 # }
2437 {
2438 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2439 # returned. For example, for warnings where there are no results in a list
2440 # request for a particular zone, this key might be scope and
2441 # the key value might be the zone name. Other examples might be a key
2442 # indicating a deprecated resource and a suggested replacement, or a
2443 # warning about invalid network settings (for example, if an instance
2444 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2445 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2446 },
2447 ],
2448 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2449 },
2450 ],
2451 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
2452 # applicable when performing per-zone operations.
2453 }</pre>
2454 </div>
2455
2456 <div class="method">
2457 <code class="details" id="testIamPermissions">testIamPermissions(project, zone, resource, body=None, x__xgafv=None)</code>
2458 <pre>Returns permissions that a caller has on the specified resource.
2459
2460 Args:
2461 project: string, Project ID for this request. (required)
2462 zone: string, The name of the zone for this request. (required)
2463 resource: string, Name or id of the resource for this request. (required)
2464 body: object, The request body.
2465 The object takes the form of:
2466
2467 {
2468 &quot;permissions&quot;: [ # The set of permissions to check for the &#x27;resource&#x27;. Permissions with
2469 # wildcards (such as &#x27;*&#x27; or &#x27;storage.*&#x27;) are not allowed.
2470 &quot;A String&quot;,
2471 ],
2472 }
2473
2474 x__xgafv: string, V1 error format.
2475 Allowed values
2476 1 - v1 error format
2477 2 - v2 error format
2478
2479 Returns:
2480 An object of the form:
2481
2482 {
2483 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is
2484 # allowed.
2485 &quot;A String&quot;,
2486 ],
2487 }</pre>
2488 </div>
2489
2490 </body></html>