Debian Codegraph @

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