Debian Codegraph @

docs/dyn/compute_v1.instanceGroupManagers.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.instanceGroupManagers.html">instanceGroupManagers</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#abandonInstances">abandonInstances(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p>
79 <p class="firstline">Flags the specified instances to be removed from 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 managed instance groups and groups 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="#applyUpdatesToInstances">applyUpdatesToInstances(project, zone, instanceGroupManager, body=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Applies changes to selected instances on the managed instance group.</p>
89 <p class="toc_element">
90 <code><a href="#close">close()</a></code></p>
91 <p class="firstline">Close httplib2 connections.</p>
92 <p class="toc_element">
93 <code><a href="#createInstances">createInstances(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p>
94 <p class="firstline">Creates instances with per-instance configurations in this managed instance</p>
95 <p class="toc_element">
96 <code><a href="#delete">delete(project, zone, instanceGroupManager, requestId=None, x__xgafv=None)</a></code></p>
97 <p class="firstline">Deletes the specified managed instance group and all of the instances</p>
98 <p class="toc_element">
99 <code><a href="#deleteInstances">deleteInstances(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p>
100 <p class="firstline">Flags the specified instances in the managed instance group for immediate</p>
101 <p class="toc_element">
102 <code><a href="#deletePerInstanceConfigs">deletePerInstanceConfigs(project, zone, instanceGroupManager, body=None, x__xgafv=None)</a></code></p>
103 <p class="firstline">Deletes selected per-instance configurations for the managed instance</p>
104 <p class="toc_element">
105 <code><a href="#get">get(project, zone, instanceGroupManager, x__xgafv=None)</a></code></p>
106 <p class="firstline">Returns all of the details about the specified managed instance group.</p>
107 <p class="toc_element">
108 <code><a href="#insert">insert(project, zone, body=None, requestId=None, x__xgafv=None)</a></code></p>
109 <p class="firstline">Creates a managed instance group using the information that you specify</p>
110 <p class="toc_element">
111 <code><a href="#list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
112 <p class="firstline">Retrieves a list of managed instance groups that are contained within the</p>
113 <p class="toc_element">
114 <code><a href="#listErrors">listErrors(project, zone, instanceGroupManager, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
115 <p class="firstline">Lists all errors thrown by actions on instances for a given managed</p>
116 <p class="toc_element">
117 <code><a href="#listErrors_next">listErrors_next()</a></code></p>
118 <p class="firstline">Retrieves the next page of results.</p>
119 <p class="toc_element">
120 <code><a href="#listManagedInstances">listManagedInstances(project, zone, instanceGroupManager, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
121 <p class="firstline">Lists all of the instances in the managed instance group. Each instance</p>
122 <p class="toc_element">
123 <code><a href="#listManagedInstances_next">listManagedInstances_next()</a></code></p>
124 <p class="firstline">Retrieves the next page of results.</p>
125 <p class="toc_element">
126 <code><a href="#listPerInstanceConfigs">listPerInstanceConfigs(project, zone, instanceGroupManager, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
127 <p class="firstline">Lists all of the per-instance configurations defined for the managed</p>
128 <p class="toc_element">
129 <code><a href="#listPerInstanceConfigs_next">listPerInstanceConfigs_next()</a></code></p>
130 <p class="firstline">Retrieves the next page of results.</p>
131 <p class="toc_element">
132 <code><a href="#list_next">list_next()</a></code></p>
133 <p class="firstline">Retrieves the next page of results.</p>
134 <p class="toc_element">
135 <code><a href="#patch">patch(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p>
136 <p class="firstline">Updates a managed instance group using the information that you specify</p>
137 <p class="toc_element">
138 <code><a href="#patchPerInstanceConfigs">patchPerInstanceConfigs(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p>
139 <p class="firstline">Inserts or patches per-instance configurations for the managed instance</p>
140 <p class="toc_element">
141 <code><a href="#recreateInstances">recreateInstances(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p>
142 <p class="firstline">Flags the specified VM instances in the managed instance group to be</p>
143 <p class="toc_element">
144 <code><a href="#resize">resize(project, zone, instanceGroupManager, size, requestId=None, x__xgafv=None)</a></code></p>
145 <p class="firstline">Resizes the managed instance group. If you increase the size, the group</p>
146 <p class="toc_element">
147 <code><a href="#resumeInstances">resumeInstances(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p>
148 <p class="firstline">Flags the specified instances in the managed instance group to be</p>
149 <p class="toc_element">
150 <code><a href="#setInstanceTemplate">setInstanceTemplate(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p>
151 <p class="firstline">Specifies the instance template to use when creating new instances in this</p>
152 <p class="toc_element">
153 <code><a href="#setTargetPools">setTargetPools(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p>
154 <p class="firstline">Modifies the target pools to which all instances in this managed instance</p>
155 <p class="toc_element">
156 <code><a href="#startInstances">startInstances(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p>
157 <p class="firstline">Flags the specified instances in the managed instance group to be</p>
158 <p class="toc_element">
159 <code><a href="#stopInstances">stopInstances(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p>
160 <p class="firstline">Flags the specified instances in the managed instance group to be</p>
161 <p class="toc_element">
162 <code><a href="#suspendInstances">suspendInstances(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p>
163 <p class="firstline">Flags the specified instances in the managed instance group to be</p>
164 <p class="toc_element">
165 <code><a href="#updatePerInstanceConfigs">updatePerInstanceConfigs(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p>
166 <p class="firstline">Inserts or updates per-instance configurations for the managed instance</p>
167 <h3>Method Details</h3>
168 <div class="method">
169 <code class="details" id="abandonInstances">abandonInstances(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
170 <pre>Flags the specified instances to be removed from the
171 managed instance group. Abandoning an instance does not delete the
172 instance, but it does remove the instance from any target pools that are
173 applied by the managed instance group. This method reduces thetargetSize of the managed instance group by the
174 number of instances that you abandon. This operation is marked asDONE when the action is scheduled even if the instances have
175 not yet been removed from the group. You must separately verify the
176 status of the abandoning action with thelistmanagedinstances
177 method.
178
179 If the group is part of a backend
180 service that has enabled
181 connection draining, it can take up to 60 seconds after the connection
182 draining duration has elapsed before the VM instance is removed or deleted.
183
184 You can specify a maximum of 1000 instances with this method per request.
185
186 Args:
187 project: string, Project ID for this request. (required)
188 zone: string, The name of thezone where the managed
189 instance group is located. (required)
190 instanceGroupManager: string, The name of the managed instance group. (required)
191 body: object, The request body.
192 The object takes the form of:
193
194 {
195 &quot;instances&quot;: [ # The URLs of one or more instances to abandon. This can be a full URL or
196 # a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].
197 &quot;A String&quot;,
198 ],
199 }
200
201 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
202 that if you must retry your request, the server will know to ignore the
203 request if it has already been completed.
204
205 For example, consider a situation where you make an initial request and
206 the request times out. If you make the request again with the same
207 request ID, the server can check if original operation with the same
208 request ID was received, and if so, will ignore the second request. This
209 prevents clients from accidentally creating duplicate commitments.
210
211 The request ID must be
212 a valid UUID with the exception that zero UUID is not supported
213 (00000000-0000-0000-0000-000000000000).
214 x__xgafv: string, V1 error format.
215 Allowed values
216 1 - v1 error format
217 2 - v2 error format
218
219 Returns:
220 An object of the form:
221
222 { # Represents an Operation resource.
223 #
224 # Google Compute Engine has three Operation resources:
225 #
226 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
227 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
228 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
229 #
230 # You can use an operation resource to manage asynchronous API requests.
231 # For more information, readHandling
232 # API responses.
233 #
234 # Operations can be global, regional or zonal.
235 #
236 # - For global operations, use the `globalOperations`
237 # resource.
238 # - For regional operations, use the
239 # `regionOperations` resource.
240 # - For zonal operations, use
241 # the `zoneOperations` resource.
242 #
243 #
244 #
245 # For more information, read
246 # Global, Regional, and Zonal Resources.
247 #
248 # Note that completed Operation resources have a limited
249 # retention period.
250 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
251 # Not present otherwise.
252 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
253 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
254 # set when the operation is created.
255 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
256 # text format.
257 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
258 # this field will be populated.
259 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
260 # operation.
261 {
262 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
263 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
264 # details. There is a set of defined message types to use for providing
265 # details.The syntax depends on the error code. For example,
266 # QuotaExceededInfo will have details when the error code is
267 # QUOTA_EXCEEDED.
268 {
269 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
270 #
271 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
272 # is not enabled:
273 #
274 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
275 # &quot;domain&quot;: &quot;googleapis.com&quot;
276 # &quot;metadata&quot;: {
277 # &quot;resource&quot;: &quot;projects/123&quot;,
278 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
279 # }
280 # }
281 #
282 # This response indicates that the pubsub.googleapis.com API is not enabled.
283 #
284 # Example of an error that is returned when attempting to create a Spanner
285 # instance in a region that is out of stock:
286 #
287 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
288 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
289 # &quot;metadata&quot;: {
290 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
291 # }
292 # }
293 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
294 # is typically the registered service name of the tool or product that
295 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
296 # generated by some common infrastructure, the error domain must be a
297 # globally unique value that identifies the infrastructure. For Google API
298 # infrastructure, the error domain is &quot;googleapis.com&quot;.
299 &quot;metadatas&quot;: { # Additional structured details about this error.
300 #
301 # Keys must match a regular expression of `a-z+` but should
302 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
303 # length. When identifying the current value of an exceeded limit, the units
304 # should be contained in the key, not the value. For example, rather than
305 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
306 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
307 # instances that can be created in a single (batch) request.
308 &quot;a_key&quot;: &quot;A String&quot;,
309 },
310 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
311 # proximate cause of the error. Error reasons are unique within a particular
312 # domain of errors. This should be at most 63 characters and match a
313 # regular expression of `A-Z+[A-Z0-9]`, which represents
314 # UPPER_SNAKE_CASE.
315 },
316 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
317 #
318 # For example, if a quota check failed with an error indicating the calling
319 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
320 # directly to the right place in the developer console to flip the bit.
321 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
322 { # Describes a URL link.
323 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
324 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
325 },
326 ],
327 },
328 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
329 # which can be attached to an RPC error.
330 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
331 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
332 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
333 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
334 },
335 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
336 &quot;dimensions&quot;: { # The map holding related quota dimensions.
337 &quot;a_key&quot;: &quot;A String&quot;,
338 },
339 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
340 # type or metric.
341 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
342 # or metric.
343 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
344 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
345 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
346 },
347 },
348 ],
349 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
350 # This property is optional.
351 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
352 },
353 ],
354 },
355 &quot;getVersionOperationMetadata&quot;: {
356 &quot;inlineSbomInfo&quot;: {
357 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
358 # appropriate identifiers.
359 &quot;a_key&quot;: &quot;A String&quot;,
360 },
361 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
362 # identifiers.
363 &quot;a_key&quot;: &quot;A String&quot;,
364 },
365 },
366 },
367 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
368 # message that was returned, such as `NOT FOUND`.
369 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
370 # status code that was returned. For example, a `404` means the
371 # resource was not found.
372 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
373 # defined by the server.
374 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
375 # This value is inRFC3339
376 # text format.
377 &quot;instancesBulkInsertOperationMetadata&quot;: {
378 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
379 # Example key: zones/us-central1-a
380 &quot;a_key&quot;: {
381 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
382 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
383 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
384 # error.
385 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
386 # if the flow is rolling forward or rolling back.
387 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
388 },
389 },
390 },
391 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
392 # Operation resources.
393 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
394 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
395 # group of operations results from a `bulkInsert` API request.
396 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
397 # `update`, or `delete`, and so on.
398 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
399 # There is no requirement that this be linear or support any granularity of
400 # operations. This should not be used to guess when the operation will be
401 # complete. This number should monotonically increase as the operation
402 # progresses.
403 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
404 # applicable when performing regional operations.
405 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
406 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
407 # this field will contain information on all underlying zonal actions and
408 # their state.
409 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
410 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
411 # Example key: zones/us-central1-a
412 &quot;a_key&quot;: {
413 &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
414 # populated.
415 # different programming environments, including REST APIs and RPC APIs. It is
416 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
417 # three pieces of data: error code, error message, and error details.
418 #
419 # You can find out more about this error model and how to work with it in the
420 # [API Design Guide](https://cloud.google.com/apis/design/errors).
421 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
422 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
423 # message types for APIs to use.
424 {
425 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
426 },
427 ],
428 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
429 # user-facing error message should be localized and sent in the
430 # google.rpc.Status.details field, or localized by the client.
431 },
432 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
433 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
434 },
435 },
436 },
437 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
438 # This value is inRFC3339
439 # text format.
440 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
441 # following:
442 # `PENDING`, `RUNNING`, or `DONE`.
443 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
444 # operation.
445 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
446 # of the target resource.
447 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
448 # operations related to creating a snapshot, this points to the disk
449 # that the snapshot was created from.
450 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
451 # `[email protected]` or
452 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
453 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
454 # operation, this field will be populated.
455 {
456 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
457 # Engine returns NO_RESULTS_ON_PAGE if there
458 # are no results in the response.
459 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
460 # value format. For example:
461 #
462 # &quot;data&quot;: [
463 # {
464 # &quot;key&quot;: &quot;scope&quot;,
465 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
466 # }
467 {
468 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
469 # returned. For example, for warnings where there are no results in a list
470 # request for a particular zone, this key might be scope and
471 # the key value might be the zone name. Other examples might be a key
472 # indicating a deprecated resource and a suggested replacement, or a
473 # warning about invalid network settings (for example, if an instance
474 # attempts to perform IP forwarding but is not enabled for IP forwarding).
475 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
476 },
477 ],
478 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
479 },
480 ],
481 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
482 # applicable when performing per-zone operations.
483 }</pre>
484 </div>
485
486 <div class="method">
487 <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>
488 <pre>Retrieves the list of managed instance groups and groups them by zone.
489
490 To prevent failure, Google recommends that you set the
491 `returnPartialSuccess` parameter to `true`.
492
493 Args:
494 project: string, Project ID for this request. (required)
495 filter: string, A filter expression that filters resources listed in the response. Most
496 Compute resources support two types of filter expressions:
497 expressions that support regular expressions and expressions that follow
498 API improvement proposal AIP-160.
499 These two types of filter expressions cannot be mixed in one request.
500
501 If you want to use AIP-160, your expression must specify the field name, an
502 operator, and the value that you want to use for filtering. The value
503 must be a string, a number, or a boolean. The operator
504 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
505
506 For example, if you are filtering Compute Engine instances, you can
507 exclude instances named `example-instance` by specifying
508 `name != example-instance`.
509
510 The `:*` comparison can be used to test whether a key has been defined.
511 For example, to find all objects with `owner` label use:
512 ```
513 labels.owner:*
514 ```
515
516 You can also filter nested fields. For example, you could specify
517 `scheduling.automaticRestart = false` to include instances only
518 if they are not scheduled for automatic restarts. You can use filtering
519 on nested fields to filter based onresource labels.
520
521 To filter on multiple expressions, provide each separate expression within
522 parentheses. For example:
523 ```
524 (scheduling.automaticRestart = true)
525 (cpuPlatform = &quot;Intel Skylake&quot;)
526 ```
527 By default, each expression is an `AND` expression. However, you
528 can include `AND` and `OR` expressions explicitly.
529 For example:
530 ```
531 (cpuPlatform = &quot;Intel Skylake&quot;) OR
532 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
533 (scheduling.automaticRestart = true)
534 ```
535
536 If you want to use a regular expression, use the `eq` (equal) or `ne`
537 (not equal) operator against a single un-parenthesized expression with or
538 without quotes or against multiple parenthesized expressions. Examples:
539
540 `fieldname eq unquoted literal`
541 `fieldname eq &#x27;single quoted literal&#x27;`
542 `fieldname eq &quot;double quoted literal&quot;`
543 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
544
545 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
546 The literal value must match the entire field.
547
548 For example, to filter for instances that do not end with name &quot;instance&quot;,
549 you would use `name ne .*instance`.
550
551 You cannot combine constraints on multiple fields using regular
552 expressions.
553 includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region,
554 global) should be included in the response. For new resource types added
555 after this field, the flag has no effect as new resource types will always
556 include every visible scope for each scope type in response. For resource
557 types which predate this field, if this flag is omitted or false, only
558 scopes of the scope types where the resource type is expected to be found
559 will be included.
560 maxResults: integer, The maximum number of results per page that should be returned.
561 If the number of available results is larger than `maxResults`,
562 Compute Engine returns a `nextPageToken` that can be used to get
563 the next page of results in subsequent list requests. Acceptable values are
564 `0` to `500`, inclusive. (Default: `500`)
565 orderBy: string, Sorts list results by a certain order. By default, results
566 are returned in alphanumerical order based on the resource name.
567
568 You can also sort results in descending order based on the creation
569 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
570 results based on the `creationTimestamp` field in
571 reverse chronological order (newest result first). Use this to sort
572 resources like operations so that the newest operation is returned first.
573
574 Currently, only sorting by `name` or
575 `creationTimestamp desc` is supported.
576 pageToken: string, Specifies a page token to use. Set `pageToken` to the
577 `nextPageToken` returned by a previous list request to get
578 the next page of results.
579 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
580 of failure. The default value is false.
581
582 For example, when partial success behavior is enabled, aggregatedList for a
583 single zone scope either returns all resources in the zone or no resources,
584 with an error code.
585 serviceProjectNumber: string, The Shared VPC service project id or service project number for which
586 aggregated list request is invoked for subnetworks list-usable api.
587 x__xgafv: string, V1 error format.
588 Allowed values
589 1 - v1 error format
590 2 - v2 error format
591
592 Returns:
593 An object of the form:
594
595 {
596 &quot;id&quot;: &quot;A String&quot;, # Output only. Unique identifier for the resource; defined by the server.
597 &quot;items&quot;: { # A list of InstanceGroupManagersScopedList resources.
598 &quot;a_key&quot;: { # Output only. The name of the scope that contains this set of managed instance groups.
599 &quot;instanceGroupManagers&quot;: [ # Output only. The list of managed instance groups that are contained in the specified
600 # project and zone.
601 { # Represents a Managed Instance Group resource.
602 #
603 # An instance group is a collection of VM instances that you can manage as a
604 # single entity. For more information, readInstance groups.
605 #
606 # For zonal Managed Instance Group, use the instanceGroupManagers
607 # resource.
608 #
609 # For regional Managed Instance Group, use theregionInstanceGroupManagers resource.
610 &quot;allInstancesConfig&quot;: { # Specifies configuration that overrides the instance template configuration
611 # for the group.
612 &quot;properties&quot;: { # Represents the change that you want to make to the instance properties. # Properties to set on all instances in the group.
613 #
614 # You can add or modify properties using theinstanceGroupManagers.patch orregionInstanceGroupManagers.patch. After settingallInstancesConfig on the group, you must update the group&#x27;s
615 # instances to apply the configuration. To apply the configuration, set the
616 # group&#x27;s updatePolicy.type field to use proactive updates or
617 # use the applyUpdatesToInstances method.
618 &quot;labels&quot;: { # The label key-value pairs that you want to patch onto the instance.
619 &quot;a_key&quot;: &quot;A String&quot;,
620 },
621 &quot;metadata&quot;: { # The metadata key-value pairs that you want to patch onto the instance. For
622 # more information, see Project and
623 # instance metadata.
624 &quot;a_key&quot;: &quot;A String&quot;,
625 },
626 },
627 },
628 &quot;autoHealingPolicies&quot;: [ # The autohealing policy for this managed instance group. You can specify
629 # only one value.
630 {
631 &quot;healthCheck&quot;: &quot;A String&quot;, # The URL for the health check that signals autohealing.
632 &quot;initialDelaySec&quot;: 42, # The initial delay is the number of seconds that a new VM takes to
633 # initialize and run its startup script. During a VM&#x27;s initial delay
634 # period, the MIG ignores unsuccessful health checks because the VM might
635 # be in the startup process. This prevents the MIG from prematurely
636 # recreating a VM. If the health check receives a healthy response during
637 # the initial delay, it indicates that the startup process is complete and
638 # the VM is ready. The value of initial delay must be between 0 and 3600
639 # seconds. The default value is 0.
640 },
641 ],
642 &quot;baseInstanceName&quot;: &quot;A String&quot;, # The base instance name is a prefix that you want to attach to the names of
643 # all VMs in a MIG. The maximum character length is 58 and the name must
644 # comply with RFC1035 format.
645 #
646 # When a VM is created in the group, the MIG appends a hyphen and a random
647 # four-character string to the base instance name. If you want the MIG to
648 # assign sequential numbers instead of a random string, then end the base
649 # instance name with a hyphen followed by one or more hash symbols. The hash
650 # symbols indicate the number of digits. For example, a base instance name of
651 # &quot;vm-###&quot; results in &quot;vm-001&quot; as a VM name.
652 # @pattern
653 # [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,51}-#{1,10}(\\[[0-9]{1,10}\\])?))
654 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. The creation timestamp for this managed instance group inRFC3339
655 # text format.
656 &quot;currentActions&quot;: { # Output only. The list of instance actions and the number of instances
657 # in this managed instance group that are scheduled for each of those
658 # actions.
659 &quot;abandoning&quot;: 42, # Output only. The total number of instances in the managed instance group
660 # that are scheduled to be abandoned. Abandoning an instance removes it
661 # from the managed instance group without deleting it.
662 &quot;creating&quot;: 42, # Output only. The number of instances in the managed instance group that
663 # are scheduled to be created or are currently being created. If the group
664 # fails to create any of these instances, it tries again until it creates
665 # the instance successfully.
666 #
667 # If you have disabled creation retries, this field will not be populated;
668 # instead, the creatingWithoutRetries field will be populated.
669 &quot;creatingWithoutRetries&quot;: 42, # Output only. The number of instances that the managed instance group
670 # will attempt to create. The group attempts to create each instance
671 # only once. If the group fails to create any of these instances, it
672 # decreases the group&#x27;s targetSize value accordingly.
673 &quot;deleting&quot;: 42, # Output only. The number of instances in the managed instance group that
674 # are scheduled to be deleted or are currently being deleted.
675 &quot;none&quot;: 42, # Output only. The number of instances in the managed instance group that
676 # are running and have no scheduled actions.
677 &quot;recreating&quot;: 42, # Output only. The number of instances in the managed instance group that
678 # are scheduled to be recreated or are currently being being recreated.
679 # Recreating an instance deletes the existing root persistent disk
680 # and creates a new disk from the image that is defined in the
681 # instance template.
682 &quot;refreshing&quot;: 42, # Output only. The number of instances in the managed instance group that
683 # are being reconfigured with properties that do not require a restart
684 # or a recreate action. For example, setting or removing target
685 # pools for the instance.
686 &quot;restarting&quot;: 42, # Output only. The number of instances in the managed instance group that
687 # are scheduled to be restarted or are currently being restarted.
688 &quot;resuming&quot;: 42, # Output only. The number of instances in the managed instance group that
689 # are scheduled to be resumed or are currently being resumed.
690 &quot;starting&quot;: 42, # Output only. The number of instances in the managed instance group that
691 # are scheduled to be started or are currently being started.
692 &quot;stopping&quot;: 42, # Output only. The number of instances in the managed instance group that
693 # are scheduled to be stopped or are currently being stopped.
694 &quot;suspending&quot;: 42, # Output only. The number of instances in the managed instance group that
695 # are scheduled to be suspended or are currently being suspended.
696 &quot;verifying&quot;: 42, # Output only. The number of instances in the managed instance group that
697 # are being verified. See the managedInstances[].currentAction
698 # property in the listManagedInstances method documentation.
699 },
700 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource.
701 &quot;distributionPolicy&quot;: { # Policy specifying the intended distribution of managed instances across
702 # zones in a regional managed instance group.
703 &quot;targetShape&quot;: &quot;A String&quot;, # The distribution shape to which the group converges either proactively or
704 # on resize events (depending on the value set inupdatePolicy.instanceRedistributionType).
705 &quot;zones&quot;: [ # Zones where the regional managed instance group will create and manage
706 # its instances.
707 # By default, a regional MIG doesn&#x27;t automatically select an AI zone to create
708 # instances, even if an AI zone is available in the specified region. To
709 # create instances in an AI zone in the selected region, you must explicitly
710 # specify it in the distribution policy together with the other preferred
711 # zones.
712 {
713 &quot;zone&quot;: &quot;A String&quot;, # The URL of thezone.
714 # The zone must exist in the region where the managed instance group is
715 # located.
716 },
717 ],
718 },
719 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. This field may be used in optimistic locking.
720 # It will be ignored when inserting an InstanceGroupManager. An up-to-date
721 # fingerprint must be provided in order to update the InstanceGroupManager,
722 # otherwise the request will fail with error412 conditionNotMet.
723 #
724 # To see the latest fingerprint, make a get() request to
725 # retrieve an InstanceGroupManager.
726 &quot;id&quot;: &quot;A String&quot;, # Output only. A unique identifier for this resource type. The server
727 # generates this identifier.
728 &quot;instanceFlexibilityPolicy&quot;: { # Instance flexibility allowing MIG to create VMs from multiple
729 # types of machines.
730 # Instance flexibility configuration on MIG overrides instance
731 # template configuration.
732 &quot;instanceSelections&quot;: { # Named instance selections configuring properties that the group will use
733 # when creating new VMs.
734 &quot;a_key&quot;: {
735 &quot;machineTypes&quot;: [ # Full machine-type names, e.g. &quot;n1-standard-16&quot;.
736 &quot;A String&quot;,
737 ],
738 &quot;rank&quot;: 42, # Preference of this instance selection. Lower number means higher
739 # preference. MIG will first try to create a VM based on the machine-type
740 # with lowest rank and fallback to next rank based on availability.
741 # Machine types and instance selections with the same rank have the same
742 # preference.
743 },
744 },
745 },
746 &quot;instanceGroup&quot;: &quot;A String&quot;, # Output only. The URL of the Instance Group resource.
747 &quot;instanceLifecyclePolicy&quot;: { # The repair policy for this managed instance group.
748 &quot;defaultActionOnFailure&quot;: &quot;A String&quot;, # The action that a MIG performs on a failed VM. If the value of the
749 # onFailedHealthCheck field is `DEFAULT_ACTION`, then the same action also
750 # applies to the VMs on which your application fails a health check.
751 # Valid values are
752 #
753 # - REPAIR (default): MIG automatically repairs a failed VM
754 # by recreating it. For more information, see About
755 # repairing VMs in a MIG.
756 # - DO_NOTHING: MIG does not repair a failed VM.
757 &quot;forceUpdateOnRepair&quot;: &quot;A String&quot;, # A bit indicating whether to forcefully apply the group&#x27;s latest
758 # configuration when repairing a VM. Valid options are:
759 #
760 #
761 #
762 # - NO (default): If configuration updates are available, they are not
763 # forcefully applied during repair. Instead, configuration updates are
764 # applied according to the group&#x27;s update policy.
765 #
766 # - YES: If configuration updates are available, they are applied
767 # during repair.
768 &quot;onFailedHealthCheck&quot;: &quot;A String&quot;, # The action that a MIG performs on an unhealthy VM. A VM is marked as
769 # unhealthy when the application running on that VM fails a health check.
770 # Valid values are:
771 #
772 # - DEFAULT_ACTION (default): MIG uses the same action
773 # configured for instanceLifecyclePolicy.defaultActionOnFailure field.
774 # - REPAIR: MIG automatically repairs an unhealthy VM by
775 # recreating it.
776 # - DO_NOTHING: MIG doesn&#x27;t repair an unhealthy VM.
777 # For more information, see
778 # About repairing VMs in a MIG.
779 &quot;onRepair&quot;: { # Configuration for VM repairs in the MIG. # Configuration for VM repairs in the MIG.
780 &quot;allowChangingZone&quot;: &quot;A String&quot;, # Specifies whether the MIG can change a VM&#x27;s zone during a repair.
781 # Valid values are:
782 #
783 # - NO (default): MIG cannot change a VM&#x27;s zone during a
784 # repair.
785 # - YES: MIG can select a different zone for the VM during
786 # a repair.
787 },
788 },
789 &quot;instanceTemplate&quot;: &quot;A String&quot;, # The URL of the instance template that is specified for this managed
790 # instance group. The group uses this template to create all new instances
791 # in the managed instance group. The templates for existing instances in the
792 # group do not change unless you run recreateInstances, runapplyUpdatesToInstances, or set the group&#x27;supdatePolicy.type to PROACTIVE.
793 &quot;kind&quot;: &quot;compute#instanceGroupManager&quot;, # Output only. The resource type, which is alwayscompute#instanceGroupManager for managed instance groups.
794 &quot;listManagedInstancesResults&quot;: &quot;A String&quot;, # Pagination behavior of the listManagedInstances API method for
795 # this managed instance group.
796 &quot;name&quot;: &quot;A String&quot;, # The name of the managed instance group. The name must be 1-63 characters
797 # long, and comply withRFC1035.
798 &quot;namedPorts&quot;: [ # [Output Only] Named ports configured on the Instance Groups complementary
799 # to this Instance Group Manager.
800 { # The named port. For example: &lt;&quot;http&quot;, 80&gt;.
801 &quot;name&quot;: &quot;A String&quot;, # The name for this named port.
802 # The name must be 1-63 characters long, and comply withRFC1035.
803 &quot;port&quot;: 42, # The port number, which can be a value between 1 and 65535.
804 },
805 ],
806 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL of theregion
807 # where the managed instance group resides (for regional resources).
808 &quot;resourcePolicies&quot;: { # Resource policies for this managed instance group.
809 &quot;workloadPolicy&quot;: &quot;A String&quot;, # The URL of the workload policy that is specified for this managed
810 # instance group.
811 # It can be a full or partial URL. For example, the following are
812 # all valid URLs to a workload policy:
813 #
814 #
815 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/resourcePolicies/resourcePolicy
816 # - projects/project/regions/region/resourcePolicies/resourcePolicy
817 # - regions/region/resourcePolicies/resourcePolicy
818 },
819 &quot;satisfiesPzi&quot;: True or False, # Output only. Reserved for future use.
820 &quot;satisfiesPzs&quot;: True or False, # Output only. Reserved for future use.
821 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. The URL for this managed instance group. The server defines
822 # this URL.
823 &quot;standbyPolicy&quot;: { # Standby policy for stopped and suspended instances.
824 &quot;initialDelaySec&quot;: 42, # Specifies the number of seconds that the MIG should wait to suspend or
825 # stop a VM after that VM was created. The initial delay gives the
826 # initialization script the time to prepare your VM for a quick scale out.
827 # The value of initial delay must be between 0 and 3600 seconds. The
828 # default value is 0.
829 &quot;mode&quot;: &quot;A String&quot;, # Defines how a MIG resumes or starts VMs from a standby pool when the
830 # group scales out. The default mode is `MANUAL`.
831 },
832 &quot;statefulPolicy&quot;: { # Stateful configuration for this Instanced Group Manager
833 &quot;preservedState&quot;: { # Configuration of preserved resources.
834 &quot;disks&quot;: { # Disks created on the instances that will be preserved on instance
835 # delete, update, etc. This map is keyed with the device names of
836 # the disks.
837 &quot;a_key&quot;: {
838 &quot;autoDelete&quot;: &quot;A String&quot;, # These stateful disks will never be deleted during autohealing,
839 # update or VM instance recreate operations.
840 # This flag is used to configure if the disk should be deleted after it
841 # is no longer used by the group, e.g. when the given instance or
842 # the whole group is deleted. Note: disks attached inREAD_ONLY mode cannot be auto-deleted.
843 },
844 },
845 &quot;externalIPs&quot;: { # External network IPs assigned to the instances that will be preserved on
846 # instance delete, update, etc. This map is keyed with the network
847 # interface name.
848 &quot;a_key&quot;: {
849 &quot;autoDelete&quot;: &quot;A String&quot;, # These stateful IPs will never be released during autohealing,
850 # update or VM instance recreate operations.
851 # This flag is used to configure if the IP reservation should be deleted
852 # after it is no longer used by the group, e.g. when the given instance
853 # or the whole group is deleted.
854 },
855 },
856 &quot;internalIPs&quot;: { # Internal network IPs assigned to the instances that will be preserved on
857 # instance delete, update, etc. This map is keyed with the network
858 # interface name.
859 &quot;a_key&quot;: {
860 &quot;autoDelete&quot;: &quot;A String&quot;, # These stateful IPs will never be released during autohealing,
861 # update or VM instance recreate operations.
862 # This flag is used to configure if the IP reservation should be deleted
863 # after it is no longer used by the group, e.g. when the given instance
864 # or the whole group is deleted.
865 },
866 },
867 },
868 },
869 &quot;status&quot;: { # Output only. The status of this managed instance group.
870 &quot;allInstancesConfig&quot;: { # Output only. Status of all-instances configuration on the group.
871 &quot;currentRevision&quot;: &quot;A String&quot;, # Output only. Current all-instances configuration revision.
872 # This value is in RFC3339 text format.
873 &quot;effective&quot;: True or False, # Output only. A bit indicating whether this configuration has
874 # been applied to all managed instances in the group.
875 },
876 &quot;appliedAcceleratorTopologies&quot;: [ # Output only. The accelerator topology applied to this MIG.
877 # Currently only one accelerator topology is supported.
878 {
879 &quot;acceleratorTopology&quot;: &quot;A String&quot;, # Output only. Topology in the format of: &quot;16x16&quot;, &quot;4x4x4&quot;, etc.
880 # The value is the same as configured in the WorkloadPolicy.
881 &quot;state&quot;: &quot;A String&quot;, # Output only. The state of the accelerator topology.
882 &quot;stateDetails&quot;: { # Output only. The result of the latest accelerator topology state
883 # check.
884 &quot;error&quot;: { # Output only. Encountered errors.
885 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
886 # operation.
887 {
888 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
889 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
890 # details. There is a set of defined message types to use for providing
891 # details.The syntax depends on the error code. For example,
892 # QuotaExceededInfo will have details when the error code is
893 # QUOTA_EXCEEDED.
894 {
895 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
896 #
897 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
898 # is not enabled:
899 #
900 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
901 # &quot;domain&quot;: &quot;googleapis.com&quot;
902 # &quot;metadata&quot;: {
903 # &quot;resource&quot;: &quot;projects/123&quot;,
904 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
905 # }
906 # }
907 #
908 # This response indicates that the pubsub.googleapis.com API is not enabled.
909 #
910 # Example of an error that is returned when attempting to create a Spanner
911 # instance in a region that is out of stock:
912 #
913 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
914 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
915 # &quot;metadata&quot;: {
916 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
917 # }
918 # }
919 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
920 # is typically the registered service name of the tool or product that
921 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
922 # generated by some common infrastructure, the error domain must be a
923 # globally unique value that identifies the infrastructure. For Google API
924 # infrastructure, the error domain is &quot;googleapis.com&quot;.
925 &quot;metadatas&quot;: { # Additional structured details about this error.
926 #
927 # Keys must match a regular expression of `a-z+` but should
928 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
929 # length. When identifying the current value of an exceeded limit, the units
930 # should be contained in the key, not the value. For example, rather than
931 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
932 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
933 # instances that can be created in a single (batch) request.
934 &quot;a_key&quot;: &quot;A String&quot;,
935 },
936 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
937 # proximate cause of the error. Error reasons are unique within a particular
938 # domain of errors. This should be at most 63 characters and match a
939 # regular expression of `A-Z+[A-Z0-9]`, which represents
940 # UPPER_SNAKE_CASE.
941 },
942 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
943 #
944 # For example, if a quota check failed with an error indicating the calling
945 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
946 # directly to the right place in the developer console to flip the bit.
947 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
948 { # Describes a URL link.
949 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
950 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
951 },
952 ],
953 },
954 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
955 # which can be attached to an RPC error.
956 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
957 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
958 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
959 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
960 },
961 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
962 &quot;dimensions&quot;: { # The map holding related quota dimensions.
963 &quot;a_key&quot;: &quot;A String&quot;,
964 },
965 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
966 # type or metric.
967 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
968 # or metric.
969 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
970 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
971 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
972 },
973 },
974 ],
975 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
976 # This property is optional.
977 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
978 },
979 ],
980 },
981 &quot;timestamp&quot;: &quot;A String&quot;, # Output only. Timestamp is shown only if there is an error. The field
982 # has // RFC3339 //
983 # text format.
984 },
985 },
986 ],
987 &quot;autoscaler&quot;: &quot;A String&quot;, # Output only. The URL of theAutoscaler
988 # that targets this instance group manager.
989 &quot;bulkInstanceOperation&quot;: { # Bulk instance operation is the creation of VMs in a MIG when the # Output only. The status of bulk instance operation.
990 # targetSizePolicy.mode is set to BULK.
991 &quot;inProgress&quot;: True or False, # Output only. Informs whether bulk instance operation is in progress.
992 &quot;lastProgressCheck&quot;: { # Output only. Information from the last progress check of bulk instance
993 # operation.
994 &quot;error&quot;: { # Output only. Errors encountered during bulk instance operation.
995 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
996 # operation.
997 {
998 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
999 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
1000 # details. There is a set of defined message types to use for providing
1001 # details.The syntax depends on the error code. For example,
1002 # QuotaExceededInfo will have details when the error code is
1003 # QUOTA_EXCEEDED.
1004 {
1005 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
1006 #
1007 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
1008 # is not enabled:
1009 #
1010 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
1011 # &quot;domain&quot;: &quot;googleapis.com&quot;
1012 # &quot;metadata&quot;: {
1013 # &quot;resource&quot;: &quot;projects/123&quot;,
1014 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
1015 # }
1016 # }
1017 #
1018 # This response indicates that the pubsub.googleapis.com API is not enabled.
1019 #
1020 # Example of an error that is returned when attempting to create a Spanner
1021 # instance in a region that is out of stock:
1022 #
1023 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
1024 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
1025 # &quot;metadata&quot;: {
1026 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
1027 # }
1028 # }
1029 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
1030 # is typically the registered service name of the tool or product that
1031 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
1032 # generated by some common infrastructure, the error domain must be a
1033 # globally unique value that identifies the infrastructure. For Google API
1034 # infrastructure, the error domain is &quot;googleapis.com&quot;.
1035 &quot;metadatas&quot;: { # Additional structured details about this error.
1036 #
1037 # Keys must match a regular expression of `a-z+` but should
1038 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
1039 # length. When identifying the current value of an exceeded limit, the units
1040 # should be contained in the key, not the value. For example, rather than
1041 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1042 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1043 # instances that can be created in a single (batch) request.
1044 &quot;a_key&quot;: &quot;A String&quot;,
1045 },
1046 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1047 # proximate cause of the error. Error reasons are unique within a particular
1048 # domain of errors. This should be at most 63 characters and match a
1049 # regular expression of `A-Z+[A-Z0-9]`, which represents
1050 # UPPER_SNAKE_CASE.
1051 },
1052 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1053 #
1054 # For example, if a quota check failed with an error indicating the calling
1055 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1056 # directly to the right place in the developer console to flip the bit.
1057 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1058 { # Describes a URL link.
1059 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1060 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1061 },
1062 ],
1063 },
1064 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1065 # which can be attached to an RPC error.
1066 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1067 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1068 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1069 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1070 },
1071 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1072 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1073 &quot;a_key&quot;: &quot;A String&quot;,
1074 },
1075 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1076 # type or metric.
1077 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1078 # or metric.
1079 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1080 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1081 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1082 },
1083 },
1084 ],
1085 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1086 # This property is optional.
1087 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1088 },
1089 ],
1090 },
1091 &quot;timestamp&quot;: &quot;A String&quot;, # Output only. Timestamp of the last progress check of bulk instance
1092 # operation. Timestamp is in RFC3339 text format.
1093 },
1094 },
1095 &quot;currentInstanceStatuses&quot;: { # The list of instance statuses and the number of instances in this managed # Output only. The list of instance statuses and the number of instances
1096 # in this managed instance group that have the status. Currently only shown
1097 # for TPU MIGs
1098 # instance group that have the status. For more information about how to
1099 # interpret each status check the instance lifecycle documentation.
1100 # Currently only shown for TPU MIGs.
1101 &quot;deprovisioning&quot;: 42, # Output only. The number of instances in the managed instance group
1102 # that have DEPROVISIONING status.
1103 &quot;nonExistent&quot;: 42, # Output only. The number of instances that have not been created yet or
1104 # have been deleted. Includes only instances that would be shown in the
1105 # listManagedInstances method and not all instances that have been
1106 # deleted in the lifetime of the MIG.
1107 # Does not include FlexStart instances that are waiting for the resources
1108 # availability, they are considered as &#x27;pending&#x27;.
1109 &quot;pending&quot;: 42, # Output only. The number of instances in the managed instance group
1110 # that have PENDING status, that is FlexStart instances that are waiting
1111 # for resources. Instances that do not exist because of the other reasons
1112 # are counted as &#x27;non_existent&#x27;.
1113 &quot;pendingStop&quot;: 42, # Output only. The number of instances in the managed instance group
1114 # that have PENDING_STOP status.
1115 &quot;provisioning&quot;: 42, # Output only. The number of instances in the managed instance group
1116 # that have PROVISIONING status.
1117 &quot;repairing&quot;: 42, # Output only. The number of instances in the managed instance group
1118 # that have REPAIRING status.
1119 &quot;running&quot;: 42, # Output only. The number of instances in the managed instance group
1120 # that have RUNNING status.
1121 &quot;staging&quot;: 42, # Output only. The number of instances in the managed instance group
1122 # that have STAGING status.
1123 &quot;stopped&quot;: 42, # Output only. The number of instances in the managed instance group
1124 # that have STOPPED status.
1125 &quot;stopping&quot;: 42, # Output only. The number of instances in the managed instance group
1126 # that have STOPPING status.
1127 &quot;suspended&quot;: 42, # Output only. The number of instances in the managed instance group
1128 # that have SUSPENDED status.
1129 &quot;suspending&quot;: 42, # Output only. The number of instances in the managed instance group
1130 # that have SUSPENDING status.
1131 &quot;terminated&quot;: 42, # Output only. The number of instances in the managed instance group
1132 # that have TERMINATED status.
1133 },
1134 &quot;isStable&quot;: True or False, # Output only. A bit indicating whether the managed instance group is in a
1135 # stable state. A stable state means that: none of the instances in the
1136 # managed instance group is currently undergoing any type of change (for
1137 # example, creation, restart, or deletion); no future changes are scheduled
1138 # for instances in the managed instance group; and the managed instance
1139 # group itself is not being modified.
1140 &quot;stateful&quot;: { # Output only. Stateful status of the given Instance Group Manager.
1141 &quot;hasStatefulConfig&quot;: True or False, # Output only. A bit indicating whether the managed instance group
1142 # has stateful configuration, that is, if you have configured any items
1143 # in a stateful policy or in per-instance configs.
1144 # The group might report that it has no stateful configuration even when
1145 # there is still some preserved state on a managed instance, for example,
1146 # if you have deleted all PICs but not yet applied those deletions.
1147 &quot;perInstanceConfigs&quot;: { # Output only. Status of per-instance configurations on the instances.
1148 &quot;allEffective&quot;: True or False, # Output only. A bit indicating if all of the group&#x27;s per-instance configurations
1149 # (listed in the output of a listPerInstanceConfigs API call) have
1150 # status EFFECTIVE or there are no per-instance-configs.
1151 },
1152 },
1153 &quot;versionTarget&quot;: { # Output only. A status of consistency of Instances&#x27; versions with their
1154 # target version specified by version field on Instance Group
1155 # Manager.
1156 &quot;isReached&quot;: True or False, # Output only. A bit indicating whether version target has been reached
1157 # in this managed instance group, i.e. all instances are in their target
1158 # version. Instances&#x27; target version are specified byversion field on Instance Group Manager.
1159 },
1160 },
1161 &quot;targetPools&quot;: [ # The URLs for all TargetPool resources to which instances in theinstanceGroup field are added. The target pools automatically
1162 # apply to all of the instances in the managed instance group.
1163 &quot;A String&quot;,
1164 ],
1165 &quot;targetSize&quot;: 42, # The target number of running instances for this managed instance group.
1166 # You can reduce this number by using the instanceGroupManager
1167 # deleteInstances or abandonInstances methods. Resizing the group also
1168 # changes this number.
1169 &quot;targetSizePolicy&quot;: { # The policy that specifies how the MIG creates its VMs to achieve the target
1170 # size.
1171 &quot;mode&quot;: &quot;A String&quot;, # The mode of target size policy based on which the MIG creates its VMs
1172 # individually or all at once.
1173 },
1174 &quot;targetStoppedSize&quot;: 42, # The target number of stopped instances for this managed instance group.
1175 # This number changes when you:
1176 #
1177 # - Stop instance using the stopInstances
1178 # method or start instances using the startInstances
1179 # method.
1180 # - Manually change the targetStoppedSize using the update
1181 # method.
1182 &quot;targetSuspendedSize&quot;: 42, # The target number of suspended instances for this managed instance group.
1183 # This number changes when you:
1184 #
1185 # - Suspend instance using the suspendInstances
1186 # method or resume instances using the resumeInstances
1187 # method.
1188 # - Manually change the targetSuspendedSize using the update
1189 # method.
1190 &quot;updatePolicy&quot;: { # The update policy for this managed instance group.
1191 &quot;instanceRedistributionType&quot;: &quot;A String&quot;, # The
1192 # instance redistribution policy for regional managed instance groups.
1193 # Valid values are:
1194 #
1195 # - PROACTIVE (default): The group attempts to maintain an
1196 # even distribution of VM instances across zones in the region.
1197 # - NONE: For non-autoscaled groups, proactive
1198 # redistribution is disabled.
1199 &quot;maxSurge&quot;: { # Encapsulates numeric value that can be either absolute or relative. # The maximum number of instances that can be created above the specifiedtargetSize during the update process. This value can be
1200 # either a fixed number or, if the group has 10 or more instances, a
1201 # percentage. If you set a percentage, the number of instances is rounded
1202 # if necessary. The default value for maxSurge is a fixed
1203 # value equal to the number of zones in which the managed instance group
1204 # operates.
1205 #
1206 # At least one of either maxSurge ormaxUnavailable must be greater than 0. Learn more about maxSurge.
1207 &quot;calculated&quot;: 42, # Output only. Absolute value of VM instances calculated based on the specific mode.
1208 #
1209 #
1210 #
1211 # - If the value is fixed, then the calculated
1212 # value is equal to the fixed value.
1213 # - If the value is a percent, then the
1214 # calculated
1215 # value is percent/100 * targetSize. For example,
1216 # the calculated value of a 80% of a managed instance group
1217 # with 150 instances would be (80/100 * 150) = 120 VM instances. If there
1218 # is a remainder, the number is rounded.
1219 &quot;fixed&quot;: 42, # Specifies a fixed number of VM instances. This must be a positive integer.
1220 &quot;percent&quot;: 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For
1221 # example, specify 80 for 80%.
1222 },
1223 &quot;maxUnavailable&quot;: { # Encapsulates numeric value that can be either absolute or relative. # The maximum number of instances that can be unavailable during the update
1224 # process. An instance is considered available if all of the following
1225 # conditions are satisfied:
1226 #
1227 #
1228 #
1229 # - The instance&#x27;s status is
1230 # RUNNING.
1231 # - If there is a health
1232 # check on the instance group, the instance&#x27;s health check status
1233 # must be HEALTHY at least once. If there is no health check
1234 # on the group, then the instance only needs to have a status of
1235 # RUNNING to be considered available.
1236 #
1237 #
1238 # This value can be either a fixed number or, if the group has 10 or more
1239 # instances, a percentage. If you set a percentage, the number of instances
1240 # is rounded if necessary. The default value formaxUnavailable is a fixed value equal to the number of zones
1241 # in which the managed instance group operates.
1242 #
1243 # At least one of either maxSurge ormaxUnavailable must be greater than 0. Learn more about maxUnavailable.
1244 &quot;calculated&quot;: 42, # Output only. Absolute value of VM instances calculated based on the specific mode.
1245 #
1246 #
1247 #
1248 # - If the value is fixed, then the calculated
1249 # value is equal to the fixed value.
1250 # - If the value is a percent, then the
1251 # calculated
1252 # value is percent/100 * targetSize. For example,
1253 # the calculated value of a 80% of a managed instance group
1254 # with 150 instances would be (80/100 * 150) = 120 VM instances. If there
1255 # is a remainder, the number is rounded.
1256 &quot;fixed&quot;: 42, # Specifies a fixed number of VM instances. This must be a positive integer.
1257 &quot;percent&quot;: 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For
1258 # example, specify 80 for 80%.
1259 },
1260 &quot;minimalAction&quot;: &quot;A String&quot;, # Minimal action to be taken on an instance. Use this option to minimize
1261 # disruption as much as possible or to apply a more disruptive action than
1262 # is necessary.
1263 #
1264 # - To limit disruption as much as possible, set the minimal action toREFRESH. If your update requires a more disruptive action,
1265 # Compute Engine performs the necessary action to execute the update.
1266 # - To apply a more disruptive action than is strictly necessary, set the
1267 # minimal action to RESTART or REPLACE. For
1268 # example, Compute Engine does not need to restart a VM to change its
1269 # metadata. But if your application reads instance metadata only when a VM
1270 # is restarted, you can set the minimal action to RESTART in
1271 # order to pick up metadata changes.
1272 &quot;mostDisruptiveAllowedAction&quot;: &quot;A String&quot;, # Most disruptive action that is allowed to be taken on an instance.
1273 # You can specify either NONE to forbid any actions,REFRESH to avoid restarting the VM and to limit disruption
1274 # as much as possible. RESTART to allow actions that can be
1275 # applied without instance replacing or REPLACE to allow all
1276 # possible actions. If the Updater determines that the minimal update
1277 # action needed is more disruptive than most disruptive allowed action you
1278 # specify it will not perform the update at all.
1279 &quot;replacementMethod&quot;: &quot;A String&quot;, # What action should be used to replace instances.
1280 # See minimal_action.REPLACE
1281 &quot;type&quot;: &quot;A String&quot;, # The type
1282 # of update process. You can specify either PROACTIVE so
1283 # that the MIG automatically updates VMs to the latest configurations orOPPORTUNISTIC so that you can select the VMs that you want
1284 # to update.
1285 },
1286 &quot;versions&quot;: [ # Specifies the instance templates used by this managed instance group to
1287 # create instances.
1288 #
1289 # Each version is defined by an instanceTemplate and aname. Every version can appear at most once per instance
1290 # group. This field overrides the top-level instanceTemplate
1291 # field. Read more about therelationships
1292 # between these fields. Exactly one version must leave thetargetSize field unset. That version will be applied to all
1293 # remaining instances. For more information, read aboutcanary
1294 # updates.
1295 {
1296 &quot;instanceTemplate&quot;: &quot;A String&quot;, # The URL of the instance template that is specified for this managed
1297 # instance group. The group uses this template to create new instances in
1298 # the managed instance group until the `targetSize` for this version is
1299 # reached. The templates for existing instances in the group do not change
1300 # unless you run recreateInstances, runapplyUpdatesToInstances, or set the group&#x27;supdatePolicy.type to PROACTIVE; in those cases,
1301 # existing instances are updated until the `targetSize` for this version is
1302 # reached.
1303 &quot;name&quot;: &quot;A String&quot;, # Name of the version. Unique among all versions in the scope of this
1304 # managed instance group.
1305 &quot;targetSize&quot;: { # Encapsulates numeric value that can be either absolute or relative. # Specifies the intended number of instances to be created from theinstanceTemplate. The final number of instances created
1306 # from the template will be equal to:
1307 #
1308 #
1309 # - If expressed as a fixed number, the minimum of either
1310 # targetSize.fixed or
1311 # instanceGroupManager.targetSize is used.
1312 # - if expressed as a percent, the targetSize
1313 # would be (targetSize.percent/100 *
1314 # InstanceGroupManager.targetSize) If there is a remainder, the
1315 # number is rounded.
1316 #
1317 # If unset, this version will update any remaining instances not
1318 # updated by another version. ReadStarting
1319 # a canary update for more information.
1320 &quot;calculated&quot;: 42, # Output only. Absolute value of VM instances calculated based on the specific mode.
1321 #
1322 #
1323 #
1324 # - If the value is fixed, then the calculated
1325 # value is equal to the fixed value.
1326 # - If the value is a percent, then the
1327 # calculated
1328 # value is percent/100 * targetSize. For example,
1329 # the calculated value of a 80% of a managed instance group
1330 # with 150 instances would be (80/100 * 150) = 120 VM instances. If there
1331 # is a remainder, the number is rounded.
1332 &quot;fixed&quot;: 42, # Specifies a fixed number of VM instances. This must be a positive integer.
1333 &quot;percent&quot;: 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For
1334 # example, specify 80 for 80%.
1335 },
1336 },
1337 ],
1338 &quot;zone&quot;: &quot;A String&quot;, # Output only. The URL of azone
1339 # where the managed instance group is located (for zonal resources).
1340 },
1341 ],
1342 &quot;warning&quot;: { # Output only. The warning that replaces the list of managed instance groups when the list
1343 # is empty.
1344 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1345 # Engine returns NO_RESULTS_ON_PAGE if there
1346 # are no results in the response.
1347 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1348 # value format. For example:
1349 #
1350 # &quot;data&quot;: [
1351 # {
1352 # &quot;key&quot;: &quot;scope&quot;,
1353 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1354 # }
1355 {
1356 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1357 # returned. For example, for warnings where there are no results in a list
1358 # request for a particular zone, this key might be scope and
1359 # the key value might be the zone name. Other examples might be a key
1360 # indicating a deprecated resource and a suggested replacement, or a
1361 # warning about invalid network settings (for example, if an instance
1362 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1363 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1364 },
1365 ],
1366 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1367 },
1368 },
1369 },
1370 &quot;kind&quot;: &quot;compute#instanceGroupManagerAggregatedList&quot;, # Output only. The resource type, which is alwayscompute#instanceGroupManagerAggregatedList for an aggregated
1371 # list of managed instance groups.
1372 &quot;nextPageToken&quot;: &quot;A String&quot;, # Output only. This token allows you to get the next page of results for
1373 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
1374 # the query parameter pageToken in the next list request.
1375 # Subsequent list requests will have their own nextPageToken to
1376 # continue paging through the results.
1377 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. Server-defined URL for this resource.
1378 &quot;unreachables&quot;: [ # Output only. Unreachable resources.
1379 &quot;A String&quot;,
1380 ],
1381 &quot;warning&quot;: { # Output only. Informational warning message.
1382 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1383 # Engine returns NO_RESULTS_ON_PAGE if there
1384 # are no results in the response.
1385 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1386 # value format. For example:
1387 #
1388 # &quot;data&quot;: [
1389 # {
1390 # &quot;key&quot;: &quot;scope&quot;,
1391 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1392 # }
1393 {
1394 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1395 # returned. For example, for warnings where there are no results in a list
1396 # request for a particular zone, this key might be scope and
1397 # the key value might be the zone name. Other examples might be a key
1398 # indicating a deprecated resource and a suggested replacement, or a
1399 # warning about invalid network settings (for example, if an instance
1400 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1401 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1402 },
1403 ],
1404 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1405 },
1406 }</pre>
1407 </div>
1408
1409 <div class="method">
1410 <code class="details" id="aggregatedList_next">aggregatedList_next()</code>
1411 <pre>Retrieves the next page of results.
1412
1413 Args:
1414 previous_request: The request for the previous page. (required)
1415 previous_response: The response from the request for the previous page. (required)
1416
1417 Returns:
1418 A request object that you can call &#x27;execute()&#x27; on to request the next
1419 page. Returns None if there are no more items in the collection.
1420 </pre>
1421 </div>
1422
1423 <div class="method">
1424 <code class="details" id="applyUpdatesToInstances">applyUpdatesToInstances(project, zone, instanceGroupManager, body=None, x__xgafv=None)</code>
1425 <pre>Applies changes to selected instances on the managed instance group.
1426 This method can be used to apply new overrides and/or new versions.
1427
1428 Args:
1429 project: string, Project ID for this request. (required)
1430 zone: string, The name of thezone
1431 where the managed instance group is located. Should conform to RFC1035. (required)
1432 instanceGroupManager: string, The name of the managed instance group, should conform to RFC1035. (required)
1433 body: object, The request body.
1434 The object takes the form of:
1435
1436 { # InstanceGroupManagers.applyUpdatesToInstances
1437 &quot;allInstances&quot;: True or False, # Flag to update all instances instead of specified list of “instances”.
1438 # If the flag is set to true then the instances may not be specified
1439 # in the request.
1440 &quot;instances&quot;: [ # The list of URLs of one or more instances for which you want to apply
1441 # updates. Each URL can be a full URL or a partial URL, such aszones/[ZONE]/instances/[INSTANCE_NAME].
1442 &quot;A String&quot;,
1443 ],
1444 &quot;minimalAction&quot;: &quot;A String&quot;, # The minimal action that you want to perform on each instance during the
1445 # update:
1446 #
1447 #
1448 # - REPLACE: At minimum, delete the instance and create it
1449 # again.
1450 # - RESTART: Stop the instance and start it
1451 # again.
1452 # - REFRESH: Do not stop the instance and limit
1453 # disruption as much as possible.
1454 # - NONE: Do not
1455 # disrupt the instance at all.
1456 #
1457 #
1458 # By default, the minimum action is NONE. If your update
1459 # requires a more disruptive action than you set with this flag, the
1460 # necessary action is performed to execute the update.
1461 &quot;mostDisruptiveAllowedAction&quot;: &quot;A String&quot;, # The most disruptive action that you want to perform on each instance during
1462 # the update:
1463 #
1464 #
1465 # - REPLACE: Delete the instance and create it again.
1466 # - RESTART: Stop the instance and start it again.
1467 # - REFRESH: Do not stop the instance and limit disruption
1468 # as much as possible.
1469 # - NONE: Do not disrupt the
1470 # instance at all.
1471 #
1472 #
1473 # By default, the most disruptive allowed action is REPLACE. If
1474 # your update requires a more disruptive action than you set with this flag,
1475 # the update request will fail.
1476 }
1477
1478 x__xgafv: string, V1 error format.
1479 Allowed values
1480 1 - v1 error format
1481 2 - v2 error format
1482
1483 Returns:
1484 An object of the form:
1485
1486 { # Represents an Operation resource.
1487 #
1488 # Google Compute Engine has three Operation resources:
1489 #
1490 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
1491 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
1492 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
1493 #
1494 # You can use an operation resource to manage asynchronous API requests.
1495 # For more information, readHandling
1496 # API responses.
1497 #
1498 # Operations can be global, regional or zonal.
1499 #
1500 # - For global operations, use the `globalOperations`
1501 # resource.
1502 # - For regional operations, use the
1503 # `regionOperations` resource.
1504 # - For zonal operations, use
1505 # the `zoneOperations` resource.
1506 #
1507 #
1508 #
1509 # For more information, read
1510 # Global, Regional, and Zonal Resources.
1511 #
1512 # Note that completed Operation resources have a limited
1513 # retention period.
1514 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
1515 # Not present otherwise.
1516 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1517 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
1518 # set when the operation is created.
1519 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
1520 # text format.
1521 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
1522 # this field will be populated.
1523 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
1524 # operation.
1525 {
1526 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1527 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
1528 # details. There is a set of defined message types to use for providing
1529 # details.The syntax depends on the error code. For example,
1530 # QuotaExceededInfo will have details when the error code is
1531 # QUOTA_EXCEEDED.
1532 {
1533 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
1534 #
1535 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
1536 # is not enabled:
1537 #
1538 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
1539 # &quot;domain&quot;: &quot;googleapis.com&quot;
1540 # &quot;metadata&quot;: {
1541 # &quot;resource&quot;: &quot;projects/123&quot;,
1542 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
1543 # }
1544 # }
1545 #
1546 # This response indicates that the pubsub.googleapis.com API is not enabled.
1547 #
1548 # Example of an error that is returned when attempting to create a Spanner
1549 # instance in a region that is out of stock:
1550 #
1551 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
1552 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
1553 # &quot;metadata&quot;: {
1554 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
1555 # }
1556 # }
1557 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
1558 # is typically the registered service name of the tool or product that
1559 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
1560 # generated by some common infrastructure, the error domain must be a
1561 # globally unique value that identifies the infrastructure. For Google API
1562 # infrastructure, the error domain is &quot;googleapis.com&quot;.
1563 &quot;metadatas&quot;: { # Additional structured details about this error.
1564 #
1565 # Keys must match a regular expression of `a-z+` but should
1566 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
1567 # length. When identifying the current value of an exceeded limit, the units
1568 # should be contained in the key, not the value. For example, rather than
1569 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1570 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1571 # instances that can be created in a single (batch) request.
1572 &quot;a_key&quot;: &quot;A String&quot;,
1573 },
1574 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1575 # proximate cause of the error. Error reasons are unique within a particular
1576 # domain of errors. This should be at most 63 characters and match a
1577 # regular expression of `A-Z+[A-Z0-9]`, which represents
1578 # UPPER_SNAKE_CASE.
1579 },
1580 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1581 #
1582 # For example, if a quota check failed with an error indicating the calling
1583 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1584 # directly to the right place in the developer console to flip the bit.
1585 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1586 { # Describes a URL link.
1587 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1588 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1589 },
1590 ],
1591 },
1592 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1593 # which can be attached to an RPC error.
1594 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1595 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1596 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1597 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1598 },
1599 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1600 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1601 &quot;a_key&quot;: &quot;A String&quot;,
1602 },
1603 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1604 # type or metric.
1605 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1606 # or metric.
1607 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1608 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1609 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1610 },
1611 },
1612 ],
1613 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1614 # This property is optional.
1615 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1616 },
1617 ],
1618 },
1619 &quot;getVersionOperationMetadata&quot;: {
1620 &quot;inlineSbomInfo&quot;: {
1621 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1622 # appropriate identifiers.
1623 &quot;a_key&quot;: &quot;A String&quot;,
1624 },
1625 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
1626 # identifiers.
1627 &quot;a_key&quot;: &quot;A String&quot;,
1628 },
1629 },
1630 },
1631 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1632 # message that was returned, such as `NOT FOUND`.
1633 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1634 # status code that was returned. For example, a `404` means the
1635 # resource was not found.
1636 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1637 # defined by the server.
1638 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1639 # This value is inRFC3339
1640 # text format.
1641 &quot;instancesBulkInsertOperationMetadata&quot;: {
1642 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1643 # Example key: zones/us-central1-a
1644 &quot;a_key&quot;: {
1645 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1646 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1647 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1648 # error.
1649 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1650 # if the flow is rolling forward or rolling back.
1651 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1652 },
1653 },
1654 },
1655 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1656 # Operation resources.
1657 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1658 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1659 # group of operations results from a `bulkInsert` API request.
1660 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1661 # `update`, or `delete`, and so on.
1662 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1663 # There is no requirement that this be linear or support any granularity of
1664 # operations. This should not be used to guess when the operation will be
1665 # complete. This number should monotonically increase as the operation
1666 # progresses.
1667 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1668 # applicable when performing regional operations.
1669 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1670 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1671 # this field will contain information on all underlying zonal actions and
1672 # their state.
1673 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1674 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1675 # Example key: zones/us-central1-a
1676 &quot;a_key&quot;: {
1677 &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
1678 # populated.
1679 # different programming environments, including REST APIs and RPC APIs. It is
1680 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1681 # three pieces of data: error code, error message, and error details.
1682 #
1683 # You can find out more about this error model and how to work with it in the
1684 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1685 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1686 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1687 # message types for APIs to use.
1688 {
1689 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1690 },
1691 ],
1692 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1693 # user-facing error message should be localized and sent in the
1694 # google.rpc.Status.details field, or localized by the client.
1695 },
1696 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1697 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1698 },
1699 },
1700 },
1701 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1702 # This value is inRFC3339
1703 # text format.
1704 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1705 # following:
1706 # `PENDING`, `RUNNING`, or `DONE`.
1707 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1708 # operation.
1709 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1710 # of the target resource.
1711 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1712 # operations related to creating a snapshot, this points to the disk
1713 # that the snapshot was created from.
1714 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1715 # `[email protected]` or
1716 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1717 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1718 # operation, this field will be populated.
1719 {
1720 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1721 # Engine returns NO_RESULTS_ON_PAGE if there
1722 # are no results in the response.
1723 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1724 # value format. For example:
1725 #
1726 # &quot;data&quot;: [
1727 # {
1728 # &quot;key&quot;: &quot;scope&quot;,
1729 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1730 # }
1731 {
1732 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1733 # returned. For example, for warnings where there are no results in a list
1734 # request for a particular zone, this key might be scope and
1735 # the key value might be the zone name. Other examples might be a key
1736 # indicating a deprecated resource and a suggested replacement, or a
1737 # warning about invalid network settings (for example, if an instance
1738 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1739 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1740 },
1741 ],
1742 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1743 },
1744 ],
1745 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1746 # applicable when performing per-zone operations.
1747 }</pre>
1748 </div>
1749
1750 <div class="method">
1751 <code class="details" id="close">close()</code>
1752 <pre>Close httplib2 connections.</pre>
1753 </div>
1754
1755 <div class="method">
1756 <code class="details" id="createInstances">createInstances(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
1757 <pre>Creates instances with per-instance configurations in this managed instance
1758 group. Instances are created using the current instance template. Thecreate instances operation is marked DONE if thecreateInstances request is successful. The underlying actions
1759 take additional time. You must separately verify the status of thecreating or actions with the listmanagedinstances
1760 method.
1761
1762 Args:
1763 project: string, Project ID for this request. (required)
1764 zone: string, The name of thezone
1765 where the managed instance group is located.
1766 It should conform to RFC1035. (required)
1767 instanceGroupManager: string, The name of the managed instance group.
1768 It should conform to RFC1035. (required)
1769 body: object, The request body.
1770 The object takes the form of:
1771
1772 { # InstanceGroupManagers.createInstances
1773 &quot;instances&quot;: [ # [Required] List of specifications of per-instance configs.
1774 {
1775 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this per-instance config. This field can be used in
1776 # optimistic locking. It is ignored when inserting a per-instance
1777 # config. An up-to-date fingerprint must be provided in order to update an
1778 # existing per-instance configuration or the field needs to be unset.
1779 &quot;name&quot;: &quot;A String&quot;, # The name of a per-instance configuration and its corresponding instance.
1780 # Serves as a merge key during UpdatePerInstanceConfigs
1781 # operations, that is, if a per-instance configuration with the same name
1782 # exists then it will be updated, otherwise a new one will be created for the
1783 # VM instance with the same name. An attempt to create a per-instance
1784 # configuration for a VM instance that either doesn&#x27;t exist or is not part
1785 # of the group will result in an error.
1786 &quot;preservedState&quot;: { # Preserved state for a given instance. # The intended preserved state for the given instance. Does not contain
1787 # preserved state generated from a stateful policy.
1788 &quot;disks&quot;: { # Preserved disks defined for this instance.
1789 # This map is keyed with the device names of the disks.
1790 &quot;a_key&quot;: {
1791 &quot;autoDelete&quot;: &quot;A String&quot;, # These stateful disks will never be deleted during autohealing,
1792 # update, instance recreate operations. This flag is used to configure
1793 # if the disk should be deleted after it is no longer used by the group,
1794 # e.g. when the given instance or the whole MIG is deleted.
1795 # Note: disks attached in READ_ONLY mode cannot be
1796 # auto-deleted.
1797 &quot;mode&quot;: &quot;A String&quot;, # The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the
1798 # disk in READ_WRITE mode.
1799 &quot;source&quot;: &quot;A String&quot;, # The URL of the disk resource that is stateful and should be attached
1800 # to the VM instance.
1801 },
1802 },
1803 &quot;externalIPs&quot;: { # Preserved external IPs defined for this instance.
1804 # This map is keyed with the name of the network interface.
1805 &quot;a_key&quot;: {
1806 &quot;autoDelete&quot;: &quot;A String&quot;, # These stateful IPs will never be released during autohealing,
1807 # update or VM instance recreate operations.
1808 # This flag is used to configure if the IP reservation should be deleted
1809 # after it is no longer used by the group, e.g. when the given instance
1810 # or the whole group is deleted.
1811 &quot;ipAddress&quot;: { # Ip address representation
1812 &quot;address&quot;: &quot;A String&quot;, # The URL of the reservation for this IP address.
1813 &quot;literal&quot;: &quot;A String&quot;, # An IPv4 internal network address to assign to the instance for this
1814 # network interface.
1815 },
1816 },
1817 },
1818 &quot;internalIPs&quot;: { # Preserved internal IPs defined for this instance.
1819 # This map is keyed with the name of the network interface.
1820 &quot;a_key&quot;: {
1821 &quot;autoDelete&quot;: &quot;A String&quot;, # These stateful IPs will never be released during autohealing,
1822 # update or VM instance recreate operations.
1823 # This flag is used to configure if the IP reservation should be deleted
1824 # after it is no longer used by the group, e.g. when the given instance
1825 # or the whole group is deleted.
1826 &quot;ipAddress&quot;: { # Ip address representation
1827 &quot;address&quot;: &quot;A String&quot;, # The URL of the reservation for this IP address.
1828 &quot;literal&quot;: &quot;A String&quot;, # An IPv4 internal network address to assign to the instance for this
1829 # network interface.
1830 },
1831 },
1832 },
1833 &quot;metadata&quot;: { # Preserved metadata defined for this instance.
1834 &quot;a_key&quot;: &quot;A String&quot;,
1835 },
1836 },
1837 &quot;status&quot;: &quot;A String&quot;, # The status of applying this per-instance configuration on the corresponding
1838 # managed instance.
1839 },
1840 ],
1841 }
1842
1843 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
1844 that if you must retry your request, the server will know to ignore the
1845 request if it has already been completed.
1846
1847 For example, consider a situation where you make an initial request and
1848 the request times out. If you make the request again with the same
1849 request ID, the server can check if original operation with the same
1850 request ID was received, and if so, will ignore the second request.
1851
1852 The request ID must be
1853 a valid UUID with the exception that zero UUID is not supported
1854 (00000000-0000-0000-0000-000000000000).
1855 x__xgafv: string, V1 error format.
1856 Allowed values
1857 1 - v1 error format
1858 2 - v2 error format
1859
1860 Returns:
1861 An object of the form:
1862
1863 { # Represents an Operation resource.
1864 #
1865 # Google Compute Engine has three Operation resources:
1866 #
1867 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
1868 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
1869 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
1870 #
1871 # You can use an operation resource to manage asynchronous API requests.
1872 # For more information, readHandling
1873 # API responses.
1874 #
1875 # Operations can be global, regional or zonal.
1876 #
1877 # - For global operations, use the `globalOperations`
1878 # resource.
1879 # - For regional operations, use the
1880 # `regionOperations` resource.
1881 # - For zonal operations, use
1882 # the `zoneOperations` resource.
1883 #
1884 #
1885 #
1886 # For more information, read
1887 # Global, Regional, and Zonal Resources.
1888 #
1889 # Note that completed Operation resources have a limited
1890 # retention period.
1891 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
1892 # Not present otherwise.
1893 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1894 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
1895 # set when the operation is created.
1896 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
1897 # text format.
1898 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
1899 # this field will be populated.
1900 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
1901 # operation.
1902 {
1903 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1904 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
1905 # details. There is a set of defined message types to use for providing
1906 # details.The syntax depends on the error code. For example,
1907 # QuotaExceededInfo will have details when the error code is
1908 # QUOTA_EXCEEDED.
1909 {
1910 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
1911 #
1912 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
1913 # is not enabled:
1914 #
1915 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
1916 # &quot;domain&quot;: &quot;googleapis.com&quot;
1917 # &quot;metadata&quot;: {
1918 # &quot;resource&quot;: &quot;projects/123&quot;,
1919 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
1920 # }
1921 # }
1922 #
1923 # This response indicates that the pubsub.googleapis.com API is not enabled.
1924 #
1925 # Example of an error that is returned when attempting to create a Spanner
1926 # instance in a region that is out of stock:
1927 #
1928 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
1929 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
1930 # &quot;metadata&quot;: {
1931 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
1932 # }
1933 # }
1934 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
1935 # is typically the registered service name of the tool or product that
1936 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
1937 # generated by some common infrastructure, the error domain must be a
1938 # globally unique value that identifies the infrastructure. For Google API
1939 # infrastructure, the error domain is &quot;googleapis.com&quot;.
1940 &quot;metadatas&quot;: { # Additional structured details about this error.
1941 #
1942 # Keys must match a regular expression of `a-z+` but should
1943 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
1944 # length. When identifying the current value of an exceeded limit, the units
1945 # should be contained in the key, not the value. For example, rather than
1946 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1947 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1948 # instances that can be created in a single (batch) request.
1949 &quot;a_key&quot;: &quot;A String&quot;,
1950 },
1951 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1952 # proximate cause of the error. Error reasons are unique within a particular
1953 # domain of errors. This should be at most 63 characters and match a
1954 # regular expression of `A-Z+[A-Z0-9]`, which represents
1955 # UPPER_SNAKE_CASE.
1956 },
1957 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1958 #
1959 # For example, if a quota check failed with an error indicating the calling
1960 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1961 # directly to the right place in the developer console to flip the bit.
1962 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1963 { # Describes a URL link.
1964 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1965 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1966 },
1967 ],
1968 },
1969 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1970 # which can be attached to an RPC error.
1971 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1972 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1973 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1974 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1975 },
1976 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1977 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1978 &quot;a_key&quot;: &quot;A String&quot;,
1979 },
1980 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1981 # type or metric.
1982 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1983 # or metric.
1984 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1985 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1986 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1987 },
1988 },
1989 ],
1990 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1991 # This property is optional.
1992 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1993 },
1994 ],
1995 },
1996 &quot;getVersionOperationMetadata&quot;: {
1997 &quot;inlineSbomInfo&quot;: {
1998 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1999 # appropriate identifiers.
2000 &quot;a_key&quot;: &quot;A String&quot;,
2001 },
2002 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
2003 # identifiers.
2004 &quot;a_key&quot;: &quot;A String&quot;,
2005 },
2006 },
2007 },
2008 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
2009 # message that was returned, such as `NOT FOUND`.
2010 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
2011 # status code that was returned. For example, a `404` means the
2012 # resource was not found.
2013 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
2014 # defined by the server.
2015 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
2016 # This value is inRFC3339
2017 # text format.
2018 &quot;instancesBulkInsertOperationMetadata&quot;: {
2019 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
2020 # Example key: zones/us-central1-a
2021 &quot;a_key&quot;: {
2022 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
2023 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
2024 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
2025 # error.
2026 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
2027 # if the flow is rolling forward or rolling back.
2028 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
2029 },
2030 },
2031 },
2032 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
2033 # Operation resources.
2034 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
2035 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
2036 # group of operations results from a `bulkInsert` API request.
2037 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
2038 # `update`, or `delete`, and so on.
2039 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
2040 # There is no requirement that this be linear or support any granularity of
2041 # operations. This should not be used to guess when the operation will be
2042 # complete. This number should monotonically increase as the operation
2043 # progresses.
2044 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
2045 # applicable when performing regional operations.
2046 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
2047 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
2048 # this field will contain information on all underlying zonal actions and
2049 # their state.
2050 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
2051 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
2052 # Example key: zones/us-central1-a
2053 &quot;a_key&quot;: {
2054 &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
2055 # populated.
2056 # different programming environments, including REST APIs and RPC APIs. It is
2057 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
2058 # three pieces of data: error code, error message, and error details.
2059 #
2060 # You can find out more about this error model and how to work with it in the
2061 # [API Design Guide](https://cloud.google.com/apis/design/errors).
2062 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
2063 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
2064 # message types for APIs to use.
2065 {
2066 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
2067 },
2068 ],
2069 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
2070 # user-facing error message should be localized and sent in the
2071 # google.rpc.Status.details field, or localized by the client.
2072 },
2073 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
2074 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
2075 },
2076 },
2077 },
2078 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
2079 # This value is inRFC3339
2080 # text format.
2081 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
2082 # following:
2083 # `PENDING`, `RUNNING`, or `DONE`.
2084 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
2085 # operation.
2086 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
2087 # of the target resource.
2088 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
2089 # operations related to creating a snapshot, this points to the disk
2090 # that the snapshot was created from.
2091 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
2092 # `[email protected]` or
2093 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
2094 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
2095 # operation, this field will be populated.
2096 {
2097 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2098 # Engine returns NO_RESULTS_ON_PAGE if there
2099 # are no results in the response.
2100 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2101 # value format. For example:
2102 #
2103 # &quot;data&quot;: [
2104 # {
2105 # &quot;key&quot;: &quot;scope&quot;,
2106 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2107 # }
2108 {
2109 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2110 # returned. For example, for warnings where there are no results in a list
2111 # request for a particular zone, this key might be scope and
2112 # the key value might be the zone name. Other examples might be a key
2113 # indicating a deprecated resource and a suggested replacement, or a
2114 # warning about invalid network settings (for example, if an instance
2115 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2116 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2117 },
2118 ],
2119 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2120 },
2121 ],
2122 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
2123 # applicable when performing per-zone operations.
2124 }</pre>
2125 </div>
2126
2127 <div class="method">
2128 <code class="details" id="delete">delete(project, zone, instanceGroupManager, requestId=None, x__xgafv=None)</code>
2129 <pre>Deletes the specified managed instance group and all of the instances
2130 in that group. Note that the instance group must not belong to a
2131 backend service. Read
2132 Deleting an instance group for more information.
2133
2134 Args:
2135 project: string, Project ID for this request. (required)
2136 zone: string, The name of thezone where the managed
2137 instance group is located. (required)
2138 instanceGroupManager: string, The name of the managed instance group to delete. (required)
2139 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
2140 that if you must retry your request, the server will know to ignore the
2141 request if it has already been completed.
2142
2143 For example, consider a situation where you make an initial request and
2144 the request times out. If you make the request again with the same
2145 request ID, the server can check if original operation with the same
2146 request ID was received, and if so, will ignore the second request. This
2147 prevents clients from accidentally creating duplicate commitments.
2148
2149 The request ID must be
2150 a valid UUID with the exception that zero UUID is not supported
2151 (00000000-0000-0000-0000-000000000000).
2152 x__xgafv: string, V1 error format.
2153 Allowed values
2154 1 - v1 error format
2155 2 - v2 error format
2156
2157 Returns:
2158 An object of the form:
2159
2160 { # Represents an Operation resource.
2161 #
2162 # Google Compute Engine has three Operation resources:
2163 #
2164 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
2165 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
2166 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
2167 #
2168 # You can use an operation resource to manage asynchronous API requests.
2169 # For more information, readHandling
2170 # API responses.
2171 #
2172 # Operations can be global, regional or zonal.
2173 #
2174 # - For global operations, use the `globalOperations`
2175 # resource.
2176 # - For regional operations, use the
2177 # `regionOperations` resource.
2178 # - For zonal operations, use
2179 # the `zoneOperations` resource.
2180 #
2181 #
2182 #
2183 # For more information, read
2184 # Global, Regional, and Zonal Resources.
2185 #
2186 # Note that completed Operation resources have a limited
2187 # retention period.
2188 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
2189 # Not present otherwise.
2190 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
2191 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
2192 # set when the operation is created.
2193 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
2194 # text format.
2195 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
2196 # this field will be populated.
2197 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
2198 # operation.
2199 {
2200 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
2201 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
2202 # details. There is a set of defined message types to use for providing
2203 # details.The syntax depends on the error code. For example,
2204 # QuotaExceededInfo will have details when the error code is
2205 # QUOTA_EXCEEDED.
2206 {
2207 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
2208 #
2209 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
2210 # is not enabled:
2211 #
2212 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
2213 # &quot;domain&quot;: &quot;googleapis.com&quot;
2214 # &quot;metadata&quot;: {
2215 # &quot;resource&quot;: &quot;projects/123&quot;,
2216 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
2217 # }
2218 # }
2219 #
2220 # This response indicates that the pubsub.googleapis.com API is not enabled.
2221 #
2222 # Example of an error that is returned when attempting to create a Spanner
2223 # instance in a region that is out of stock:
2224 #
2225 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
2226 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
2227 # &quot;metadata&quot;: {
2228 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
2229 # }
2230 # }
2231 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
2232 # is typically the registered service name of the tool or product that
2233 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
2234 # generated by some common infrastructure, the error domain must be a
2235 # globally unique value that identifies the infrastructure. For Google API
2236 # infrastructure, the error domain is &quot;googleapis.com&quot;.
2237 &quot;metadatas&quot;: { # Additional structured details about this error.
2238 #
2239 # Keys must match a regular expression of `a-z+` but should
2240 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
2241 # length. When identifying the current value of an exceeded limit, the units
2242 # should be contained in the key, not the value. For example, rather than
2243 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
2244 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
2245 # instances that can be created in a single (batch) request.
2246 &quot;a_key&quot;: &quot;A String&quot;,
2247 },
2248 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
2249 # proximate cause of the error. Error reasons are unique within a particular
2250 # domain of errors. This should be at most 63 characters and match a
2251 # regular expression of `A-Z+[A-Z0-9]`, which represents
2252 # UPPER_SNAKE_CASE.
2253 },
2254 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
2255 #
2256 # For example, if a quota check failed with an error indicating the calling
2257 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
2258 # directly to the right place in the developer console to flip the bit.
2259 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
2260 { # Describes a URL link.
2261 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
2262 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
2263 },
2264 ],
2265 },
2266 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
2267 # which can be attached to an RPC error.
2268 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
2269 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
2270 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
2271 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
2272 },
2273 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
2274 &quot;dimensions&quot;: { # The map holding related quota dimensions.
2275 &quot;a_key&quot;: &quot;A String&quot;,
2276 },
2277 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
2278 # type or metric.
2279 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
2280 # or metric.
2281 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
2282 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
2283 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
2284 },
2285 },
2286 ],
2287 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
2288 # This property is optional.
2289 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
2290 },
2291 ],
2292 },
2293 &quot;getVersionOperationMetadata&quot;: {
2294 &quot;inlineSbomInfo&quot;: {
2295 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
2296 # appropriate identifiers.
2297 &quot;a_key&quot;: &quot;A String&quot;,
2298 },
2299 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
2300 # identifiers.
2301 &quot;a_key&quot;: &quot;A String&quot;,
2302 },
2303 },
2304 },
2305 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
2306 # message that was returned, such as `NOT FOUND`.
2307 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
2308 # status code that was returned. For example, a `404` means the
2309 # resource was not found.
2310 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
2311 # defined by the server.
2312 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
2313 # This value is inRFC3339
2314 # text format.
2315 &quot;instancesBulkInsertOperationMetadata&quot;: {
2316 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
2317 # Example key: zones/us-central1-a
2318 &quot;a_key&quot;: {
2319 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
2320 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
2321 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
2322 # error.
2323 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
2324 # if the flow is rolling forward or rolling back.
2325 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
2326 },
2327 },
2328 },
2329 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
2330 # Operation resources.
2331 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
2332 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
2333 # group of operations results from a `bulkInsert` API request.
2334 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
2335 # `update`, or `delete`, and so on.
2336 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
2337 # There is no requirement that this be linear or support any granularity of
2338 # operations. This should not be used to guess when the operation will be
2339 # complete. This number should monotonically increase as the operation
2340 # progresses.
2341 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
2342 # applicable when performing regional operations.
2343 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
2344 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
2345 # this field will contain information on all underlying zonal actions and
2346 # their state.
2347 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
2348 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
2349 # Example key: zones/us-central1-a
2350 &quot;a_key&quot;: {
2351 &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
2352 # populated.
2353 # different programming environments, including REST APIs and RPC APIs. It is
2354 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
2355 # three pieces of data: error code, error message, and error details.
2356 #
2357 # You can find out more about this error model and how to work with it in the
2358 # [API Design Guide](https://cloud.google.com/apis/design/errors).
2359 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
2360 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
2361 # message types for APIs to use.
2362 {
2363 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
2364 },
2365 ],
2366 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
2367 # user-facing error message should be localized and sent in the
2368 # google.rpc.Status.details field, or localized by the client.
2369 },
2370 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
2371 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
2372 },
2373 },
2374 },
2375 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
2376 # This value is inRFC3339
2377 # text format.
2378 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
2379 # following:
2380 # `PENDING`, `RUNNING`, or `DONE`.
2381 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
2382 # operation.
2383 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
2384 # of the target resource.
2385 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
2386 # operations related to creating a snapshot, this points to the disk
2387 # that the snapshot was created from.
2388 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
2389 # `[email protected]` or
2390 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
2391 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
2392 # operation, this field will be populated.
2393 {
2394 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2395 # Engine returns NO_RESULTS_ON_PAGE if there
2396 # are no results in the response.
2397 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2398 # value format. For example:
2399 #
2400 # &quot;data&quot;: [
2401 # {
2402 # &quot;key&quot;: &quot;scope&quot;,
2403 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2404 # }
2405 {
2406 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2407 # returned. For example, for warnings where there are no results in a list
2408 # request for a particular zone, this key might be scope and
2409 # the key value might be the zone name. Other examples might be a key
2410 # indicating a deprecated resource and a suggested replacement, or a
2411 # warning about invalid network settings (for example, if an instance
2412 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2413 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2414 },
2415 ],
2416 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2417 },
2418 ],
2419 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
2420 # applicable when performing per-zone operations.
2421 }</pre>
2422 </div>
2423
2424 <div class="method">
2425 <code class="details" id="deleteInstances">deleteInstances(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
2426 <pre>Flags the specified instances in the managed instance group for immediate
2427 deletion. The instances are also removed from any target
2428 pools of which they were a member. This method reduces thetargetSize of the managed instance group by the number of
2429 instances that you delete. This operation is marked as DONE
2430 when the action is scheduled even if the instances are still being deleted.
2431 You must separately verify the status of the deleting action
2432 with thelistmanagedinstances
2433 method.
2434
2435 If the group is part of a backend
2436 service that has enabled
2437 connection draining, it can take up to 60 seconds after the connection
2438 draining duration has elapsed before the VM instance is removed or deleted.
2439
2440 You can specify a maximum of 1000 instances with this method per request.
2441
2442 Args:
2443 project: string, Project ID for this request. (required)
2444 zone: string, The name of thezone where the managed
2445 instance group is located. (required)
2446 instanceGroupManager: string, The name of the managed instance group. (required)
2447 body: object, The request body.
2448 The object takes the form of:
2449
2450 {
2451 &quot;instances&quot;: [ # The URLs of one or more instances to delete. This can be a full URL or
2452 # a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].
2453 # Queued instances do not have URL and can be deleted only by name.
2454 # One cannot specify both URLs and names in a single request.
2455 &quot;A String&quot;,
2456 ],
2457 &quot;skipInstancesOnValidationError&quot;: True or False, # Specifies whether the request should proceed despite the inclusion of
2458 # instances that are not members of the group or that are already in the
2459 # process of being deleted or abandoned. If this field is set to `false` and
2460 # such an instance is specified in the request, the operation fails. The
2461 # operation always fails if the request contains a malformed instance URL or
2462 # a reference to an instance that exists in a zone or region other than the
2463 # group&#x27;s zone or region.
2464 }
2465
2466 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
2467 that if you must retry your request, the server will know to ignore the
2468 request if it has already been completed.
2469
2470 For example, consider a situation where you make an initial request and
2471 the request times out. If you make the request again with the same
2472 request ID, the server can check if original operation with the same
2473 request ID was received, and if so, will ignore the second request. This
2474 prevents clients from accidentally creating duplicate commitments.
2475
2476 The request ID must be
2477 a valid UUID with the exception that zero UUID is not supported
2478 (00000000-0000-0000-0000-000000000000).
2479 x__xgafv: string, V1 error format.
2480 Allowed values
2481 1 - v1 error format
2482 2 - v2 error format
2483
2484 Returns:
2485 An object of the form:
2486
2487 { # Represents an Operation resource.
2488 #
2489 # Google Compute Engine has three Operation resources:
2490 #
2491 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
2492 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
2493 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
2494 #
2495 # You can use an operation resource to manage asynchronous API requests.
2496 # For more information, readHandling
2497 # API responses.
2498 #
2499 # Operations can be global, regional or zonal.
2500 #
2501 # - For global operations, use the `globalOperations`
2502 # resource.
2503 # - For regional operations, use the
2504 # `regionOperations` resource.
2505 # - For zonal operations, use
2506 # the `zoneOperations` resource.
2507 #
2508 #
2509 #
2510 # For more information, read
2511 # Global, Regional, and Zonal Resources.
2512 #
2513 # Note that completed Operation resources have a limited
2514 # retention period.
2515 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
2516 # Not present otherwise.
2517 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
2518 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
2519 # set when the operation is created.
2520 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
2521 # text format.
2522 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
2523 # this field will be populated.
2524 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
2525 # operation.
2526 {
2527 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
2528 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
2529 # details. There is a set of defined message types to use for providing
2530 # details.The syntax depends on the error code. For example,
2531 # QuotaExceededInfo will have details when the error code is
2532 # QUOTA_EXCEEDED.
2533 {
2534 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
2535 #
2536 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
2537 # is not enabled:
2538 #
2539 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
2540 # &quot;domain&quot;: &quot;googleapis.com&quot;
2541 # &quot;metadata&quot;: {
2542 # &quot;resource&quot;: &quot;projects/123&quot;,
2543 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
2544 # }
2545 # }
2546 #
2547 # This response indicates that the pubsub.googleapis.com API is not enabled.
2548 #
2549 # Example of an error that is returned when attempting to create a Spanner
2550 # instance in a region that is out of stock:
2551 #
2552 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
2553 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
2554 # &quot;metadata&quot;: {
2555 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
2556 # }
2557 # }
2558 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
2559 # is typically the registered service name of the tool or product that
2560 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
2561 # generated by some common infrastructure, the error domain must be a
2562 # globally unique value that identifies the infrastructure. For Google API
2563 # infrastructure, the error domain is &quot;googleapis.com&quot;.
2564 &quot;metadatas&quot;: { # Additional structured details about this error.
2565 #
2566 # Keys must match a regular expression of `a-z+` but should
2567 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
2568 # length. When identifying the current value of an exceeded limit, the units
2569 # should be contained in the key, not the value. For example, rather than
2570 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
2571 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
2572 # instances that can be created in a single (batch) request.
2573 &quot;a_key&quot;: &quot;A String&quot;,
2574 },
2575 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
2576 # proximate cause of the error. Error reasons are unique within a particular
2577 # domain of errors. This should be at most 63 characters and match a
2578 # regular expression of `A-Z+[A-Z0-9]`, which represents
2579 # UPPER_SNAKE_CASE.
2580 },
2581 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
2582 #
2583 # For example, if a quota check failed with an error indicating the calling
2584 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
2585 # directly to the right place in the developer console to flip the bit.
2586 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
2587 { # Describes a URL link.
2588 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
2589 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
2590 },
2591 ],
2592 },
2593 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
2594 # which can be attached to an RPC error.
2595 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
2596 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
2597 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
2598 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
2599 },
2600 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
2601 &quot;dimensions&quot;: { # The map holding related quota dimensions.
2602 &quot;a_key&quot;: &quot;A String&quot;,
2603 },
2604 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
2605 # type or metric.
2606 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
2607 # or metric.
2608 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
2609 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
2610 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
2611 },
2612 },
2613 ],
2614 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
2615 # This property is optional.
2616 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
2617 },
2618 ],
2619 },
2620 &quot;getVersionOperationMetadata&quot;: {
2621 &quot;inlineSbomInfo&quot;: {
2622 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
2623 # appropriate identifiers.
2624 &quot;a_key&quot;: &quot;A String&quot;,
2625 },
2626 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
2627 # identifiers.
2628 &quot;a_key&quot;: &quot;A String&quot;,
2629 },
2630 },
2631 },
2632 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
2633 # message that was returned, such as `NOT FOUND`.
2634 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
2635 # status code that was returned. For example, a `404` means the
2636 # resource was not found.
2637 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
2638 # defined by the server.
2639 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
2640 # This value is inRFC3339
2641 # text format.
2642 &quot;instancesBulkInsertOperationMetadata&quot;: {
2643 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
2644 # Example key: zones/us-central1-a
2645 &quot;a_key&quot;: {
2646 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
2647 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
2648 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
2649 # error.
2650 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
2651 # if the flow is rolling forward or rolling back.
2652 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
2653 },
2654 },
2655 },
2656 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
2657 # Operation resources.
2658 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
2659 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
2660 # group of operations results from a `bulkInsert` API request.
2661 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
2662 # `update`, or `delete`, and so on.
2663 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
2664 # There is no requirement that this be linear or support any granularity of
2665 # operations. This should not be used to guess when the operation will be
2666 # complete. This number should monotonically increase as the operation
2667 # progresses.
2668 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
2669 # applicable when performing regional operations.
2670 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
2671 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
2672 # this field will contain information on all underlying zonal actions and
2673 # their state.
2674 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
2675 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
2676 # Example key: zones/us-central1-a
2677 &quot;a_key&quot;: {
2678 &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
2679 # populated.
2680 # different programming environments, including REST APIs and RPC APIs. It is
2681 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
2682 # three pieces of data: error code, error message, and error details.
2683 #
2684 # You can find out more about this error model and how to work with it in the
2685 # [API Design Guide](https://cloud.google.com/apis/design/errors).
2686 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
2687 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
2688 # message types for APIs to use.
2689 {
2690 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
2691 },
2692 ],
2693 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
2694 # user-facing error message should be localized and sent in the
2695 # google.rpc.Status.details field, or localized by the client.
2696 },
2697 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
2698 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
2699 },
2700 },
2701 },
2702 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
2703 # This value is inRFC3339
2704 # text format.
2705 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
2706 # following:
2707 # `PENDING`, `RUNNING`, or `DONE`.
2708 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
2709 # operation.
2710 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
2711 # of the target resource.
2712 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
2713 # operations related to creating a snapshot, this points to the disk
2714 # that the snapshot was created from.
2715 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
2716 # `[email protected]` or
2717 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
2718 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
2719 # operation, this field will be populated.
2720 {
2721 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2722 # Engine returns NO_RESULTS_ON_PAGE if there
2723 # are no results in the response.
2724 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2725 # value format. For example:
2726 #
2727 # &quot;data&quot;: [
2728 # {
2729 # &quot;key&quot;: &quot;scope&quot;,
2730 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2731 # }
2732 {
2733 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2734 # returned. For example, for warnings where there are no results in a list
2735 # request for a particular zone, this key might be scope and
2736 # the key value might be the zone name. Other examples might be a key
2737 # indicating a deprecated resource and a suggested replacement, or a
2738 # warning about invalid network settings (for example, if an instance
2739 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2740 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2741 },
2742 ],
2743 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2744 },
2745 ],
2746 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
2747 # applicable when performing per-zone operations.
2748 }</pre>
2749 </div>
2750
2751 <div class="method">
2752 <code class="details" id="deletePerInstanceConfigs">deletePerInstanceConfigs(project, zone, instanceGroupManager, body=None, x__xgafv=None)</code>
2753 <pre>Deletes selected per-instance configurations for the managed instance
2754 group.
2755
2756 Args:
2757 project: string, Project ID for this request. (required)
2758 zone: string, The name of thezone
2759 where the managed instance
2760 group is located.
2761 It should conform to RFC1035. (required)
2762 instanceGroupManager: string, The name of the managed instance group.
2763 It should conform to RFC1035. (required)
2764 body: object, The request body.
2765 The object takes the form of:
2766
2767 { # InstanceGroupManagers.deletePerInstanceConfigs
2768 &quot;names&quot;: [ # The list of instance names for which we want to delete per-instance configs
2769 # on this managed instance group.
2770 &quot;A String&quot;,
2771 ],
2772 }
2773
2774 x__xgafv: string, V1 error format.
2775 Allowed values
2776 1 - v1 error format
2777 2 - v2 error format
2778
2779 Returns:
2780 An object of the form:
2781
2782 { # Represents an Operation resource.
2783 #
2784 # Google Compute Engine has three Operation resources:
2785 #
2786 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
2787 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
2788 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
2789 #
2790 # You can use an operation resource to manage asynchronous API requests.
2791 # For more information, readHandling
2792 # API responses.
2793 #
2794 # Operations can be global, regional or zonal.
2795 #
2796 # - For global operations, use the `globalOperations`
2797 # resource.
2798 # - For regional operations, use the
2799 # `regionOperations` resource.
2800 # - For zonal operations, use
2801 # the `zoneOperations` resource.
2802 #
2803 #
2804 #
2805 # For more information, read
2806 # Global, Regional, and Zonal Resources.
2807 #
2808 # Note that completed Operation resources have a limited
2809 # retention period.
2810 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
2811 # Not present otherwise.
2812 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
2813 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
2814 # set when the operation is created.
2815 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
2816 # text format.
2817 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
2818 # this field will be populated.
2819 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
2820 # operation.
2821 {
2822 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
2823 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
2824 # details. There is a set of defined message types to use for providing
2825 # details.The syntax depends on the error code. For example,
2826 # QuotaExceededInfo will have details when the error code is
2827 # QUOTA_EXCEEDED.
2828 {
2829 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
2830 #
2831 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
2832 # is not enabled:
2833 #
2834 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
2835 # &quot;domain&quot;: &quot;googleapis.com&quot;
2836 # &quot;metadata&quot;: {
2837 # &quot;resource&quot;: &quot;projects/123&quot;,
2838 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
2839 # }
2840 # }
2841 #
2842 # This response indicates that the pubsub.googleapis.com API is not enabled.
2843 #
2844 # Example of an error that is returned when attempting to create a Spanner
2845 # instance in a region that is out of stock:
2846 #
2847 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
2848 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
2849 # &quot;metadata&quot;: {
2850 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
2851 # }
2852 # }
2853 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
2854 # is typically the registered service name of the tool or product that
2855 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
2856 # generated by some common infrastructure, the error domain must be a
2857 # globally unique value that identifies the infrastructure. For Google API
2858 # infrastructure, the error domain is &quot;googleapis.com&quot;.
2859 &quot;metadatas&quot;: { # Additional structured details about this error.
2860 #
2861 # Keys must match a regular expression of `a-z+` but should
2862 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
2863 # length. When identifying the current value of an exceeded limit, the units
2864 # should be contained in the key, not the value. For example, rather than
2865 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
2866 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
2867 # instances that can be created in a single (batch) request.
2868 &quot;a_key&quot;: &quot;A String&quot;,
2869 },
2870 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
2871 # proximate cause of the error. Error reasons are unique within a particular
2872 # domain of errors. This should be at most 63 characters and match a
2873 # regular expression of `A-Z+[A-Z0-9]`, which represents
2874 # UPPER_SNAKE_CASE.
2875 },
2876 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
2877 #
2878 # For example, if a quota check failed with an error indicating the calling
2879 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
2880 # directly to the right place in the developer console to flip the bit.
2881 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
2882 { # Describes a URL link.
2883 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
2884 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
2885 },
2886 ],
2887 },
2888 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
2889 # which can be attached to an RPC error.
2890 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
2891 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
2892 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
2893 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
2894 },
2895 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
2896 &quot;dimensions&quot;: { # The map holding related quota dimensions.
2897 &quot;a_key&quot;: &quot;A String&quot;,
2898 },
2899 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
2900 # type or metric.
2901 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
2902 # or metric.
2903 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
2904 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
2905 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
2906 },
2907 },
2908 ],
2909 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
2910 # This property is optional.
2911 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
2912 },
2913 ],
2914 },
2915 &quot;getVersionOperationMetadata&quot;: {
2916 &quot;inlineSbomInfo&quot;: {
2917 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
2918 # appropriate identifiers.
2919 &quot;a_key&quot;: &quot;A String&quot;,
2920 },
2921 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
2922 # identifiers.
2923 &quot;a_key&quot;: &quot;A String&quot;,
2924 },
2925 },
2926 },
2927 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
2928 # message that was returned, such as `NOT FOUND`.
2929 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
2930 # status code that was returned. For example, a `404` means the
2931 # resource was not found.
2932 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
2933 # defined by the server.
2934 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
2935 # This value is inRFC3339
2936 # text format.
2937 &quot;instancesBulkInsertOperationMetadata&quot;: {
2938 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
2939 # Example key: zones/us-central1-a
2940 &quot;a_key&quot;: {
2941 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
2942 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
2943 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
2944 # error.
2945 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
2946 # if the flow is rolling forward or rolling back.
2947 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
2948 },
2949 },
2950 },
2951 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
2952 # Operation resources.
2953 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
2954 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
2955 # group of operations results from a `bulkInsert` API request.
2956 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
2957 # `update`, or `delete`, and so on.
2958 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
2959 # There is no requirement that this be linear or support any granularity of
2960 # operations. This should not be used to guess when the operation will be
2961 # complete. This number should monotonically increase as the operation
2962 # progresses.
2963 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
2964 # applicable when performing regional operations.
2965 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
2966 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
2967 # this field will contain information on all underlying zonal actions and
2968 # their state.
2969 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
2970 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
2971 # Example key: zones/us-central1-a
2972 &quot;a_key&quot;: {
2973 &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
2974 # populated.
2975 # different programming environments, including REST APIs and RPC APIs. It is
2976 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
2977 # three pieces of data: error code, error message, and error details.
2978 #
2979 # You can find out more about this error model and how to work with it in the
2980 # [API Design Guide](https://cloud.google.com/apis/design/errors).
2981 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
2982 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
2983 # message types for APIs to use.
2984 {
2985 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
2986 },
2987 ],
2988 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
2989 # user-facing error message should be localized and sent in the
2990 # google.rpc.Status.details field, or localized by the client.
2991 },
2992 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
2993 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
2994 },
2995 },
2996 },
2997 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
2998 # This value is inRFC3339
2999 # text format.
3000 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
3001 # following:
3002 # `PENDING`, `RUNNING`, or `DONE`.
3003 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
3004 # operation.
3005 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
3006 # of the target resource.
3007 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
3008 # operations related to creating a snapshot, this points to the disk
3009 # that the snapshot was created from.
3010 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
3011 # `[email protected]` or
3012 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
3013 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
3014 # operation, this field will be populated.
3015 {
3016 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
3017 # Engine returns NO_RESULTS_ON_PAGE if there
3018 # are no results in the response.
3019 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
3020 # value format. For example:
3021 #
3022 # &quot;data&quot;: [
3023 # {
3024 # &quot;key&quot;: &quot;scope&quot;,
3025 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
3026 # }
3027 {
3028 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
3029 # returned. For example, for warnings where there are no results in a list
3030 # request for a particular zone, this key might be scope and
3031 # the key value might be the zone name. Other examples might be a key
3032 # indicating a deprecated resource and a suggested replacement, or a
3033 # warning about invalid network settings (for example, if an instance
3034 # attempts to perform IP forwarding but is not enabled for IP forwarding).
3035 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
3036 },
3037 ],
3038 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
3039 },
3040 ],
3041 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
3042 # applicable when performing per-zone operations.
3043 }</pre>
3044 </div>
3045
3046 <div class="method">
3047 <code class="details" id="get">get(project, zone, instanceGroupManager, x__xgafv=None)</code>
3048 <pre>Returns all of the details about the specified managed instance group.
3049
3050 Args:
3051 project: string, Project ID for this request. (required)
3052 zone: string, The name of thezone where the managed
3053 instance group is located. (required)
3054 instanceGroupManager: string, The name of the managed instance group. (required)
3055 x__xgafv: string, V1 error format.
3056 Allowed values
3057 1 - v1 error format
3058 2 - v2 error format
3059
3060 Returns:
3061 An object of the form:
3062
3063 { # Represents a Managed Instance Group resource.
3064 #
3065 # An instance group is a collection of VM instances that you can manage as a
3066 # single entity. For more information, readInstance groups.
3067 #
3068 # For zonal Managed Instance Group, use the instanceGroupManagers
3069 # resource.
3070 #
3071 # For regional Managed Instance Group, use theregionInstanceGroupManagers resource.
3072 &quot;allInstancesConfig&quot;: { # Specifies configuration that overrides the instance template configuration
3073 # for the group.
3074 &quot;properties&quot;: { # Represents the change that you want to make to the instance properties. # Properties to set on all instances in the group.
3075 #
3076 # You can add or modify properties using theinstanceGroupManagers.patch orregionInstanceGroupManagers.patch. After settingallInstancesConfig on the group, you must update the group&#x27;s
3077 # instances to apply the configuration. To apply the configuration, set the
3078 # group&#x27;s updatePolicy.type field to use proactive updates or
3079 # use the applyUpdatesToInstances method.
3080 &quot;labels&quot;: { # The label key-value pairs that you want to patch onto the instance.
3081 &quot;a_key&quot;: &quot;A String&quot;,
3082 },
3083 &quot;metadata&quot;: { # The metadata key-value pairs that you want to patch onto the instance. For
3084 # more information, see Project and
3085 # instance metadata.
3086 &quot;a_key&quot;: &quot;A String&quot;,
3087 },
3088 },
3089 },
3090 &quot;autoHealingPolicies&quot;: [ # The autohealing policy for this managed instance group. You can specify
3091 # only one value.
3092 {
3093 &quot;healthCheck&quot;: &quot;A String&quot;, # The URL for the health check that signals autohealing.
3094 &quot;initialDelaySec&quot;: 42, # The initial delay is the number of seconds that a new VM takes to
3095 # initialize and run its startup script. During a VM&#x27;s initial delay
3096 # period, the MIG ignores unsuccessful health checks because the VM might
3097 # be in the startup process. This prevents the MIG from prematurely
3098 # recreating a VM. If the health check receives a healthy response during
3099 # the initial delay, it indicates that the startup process is complete and
3100 # the VM is ready. The value of initial delay must be between 0 and 3600
3101 # seconds. The default value is 0.
3102 },
3103 ],
3104 &quot;baseInstanceName&quot;: &quot;A String&quot;, # The base instance name is a prefix that you want to attach to the names of
3105 # all VMs in a MIG. The maximum character length is 58 and the name must
3106 # comply with RFC1035 format.
3107 #
3108 # When a VM is created in the group, the MIG appends a hyphen and a random
3109 # four-character string to the base instance name. If you want the MIG to
3110 # assign sequential numbers instead of a random string, then end the base
3111 # instance name with a hyphen followed by one or more hash symbols. The hash
3112 # symbols indicate the number of digits. For example, a base instance name of
3113 # &quot;vm-###&quot; results in &quot;vm-001&quot; as a VM name.
3114 # @pattern
3115 # [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,51}-#{1,10}(\\[[0-9]{1,10}\\])?))
3116 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. The creation timestamp for this managed instance group inRFC3339
3117 # text format.
3118 &quot;currentActions&quot;: { # Output only. The list of instance actions and the number of instances
3119 # in this managed instance group that are scheduled for each of those
3120 # actions.
3121 &quot;abandoning&quot;: 42, # Output only. The total number of instances in the managed instance group
3122 # that are scheduled to be abandoned. Abandoning an instance removes it
3123 # from the managed instance group without deleting it.
3124 &quot;creating&quot;: 42, # Output only. The number of instances in the managed instance group that
3125 # are scheduled to be created or are currently being created. If the group
3126 # fails to create any of these instances, it tries again until it creates
3127 # the instance successfully.
3128 #
3129 # If you have disabled creation retries, this field will not be populated;
3130 # instead, the creatingWithoutRetries field will be populated.
3131 &quot;creatingWithoutRetries&quot;: 42, # Output only. The number of instances that the managed instance group
3132 # will attempt to create. The group attempts to create each instance
3133 # only once. If the group fails to create any of these instances, it
3134 # decreases the group&#x27;s targetSize value accordingly.
3135 &quot;deleting&quot;: 42, # Output only. The number of instances in the managed instance group that
3136 # are scheduled to be deleted or are currently being deleted.
3137 &quot;none&quot;: 42, # Output only. The number of instances in the managed instance group that
3138 # are running and have no scheduled actions.
3139 &quot;recreating&quot;: 42, # Output only. The number of instances in the managed instance group that
3140 # are scheduled to be recreated or are currently being being recreated.
3141 # Recreating an instance deletes the existing root persistent disk
3142 # and creates a new disk from the image that is defined in the
3143 # instance template.
3144 &quot;refreshing&quot;: 42, # Output only. The number of instances in the managed instance group that
3145 # are being reconfigured with properties that do not require a restart
3146 # or a recreate action. For example, setting or removing target
3147 # pools for the instance.
3148 &quot;restarting&quot;: 42, # Output only. The number of instances in the managed instance group that
3149 # are scheduled to be restarted or are currently being restarted.
3150 &quot;resuming&quot;: 42, # Output only. The number of instances in the managed instance group that
3151 # are scheduled to be resumed or are currently being resumed.
3152 &quot;starting&quot;: 42, # Output only. The number of instances in the managed instance group that
3153 # are scheduled to be started or are currently being started.
3154 &quot;stopping&quot;: 42, # Output only. The number of instances in the managed instance group that
3155 # are scheduled to be stopped or are currently being stopped.
3156 &quot;suspending&quot;: 42, # Output only. The number of instances in the managed instance group that
3157 # are scheduled to be suspended or are currently being suspended.
3158 &quot;verifying&quot;: 42, # Output only. The number of instances in the managed instance group that
3159 # are being verified. See the managedInstances[].currentAction
3160 # property in the listManagedInstances method documentation.
3161 },
3162 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource.
3163 &quot;distributionPolicy&quot;: { # Policy specifying the intended distribution of managed instances across
3164 # zones in a regional managed instance group.
3165 &quot;targetShape&quot;: &quot;A String&quot;, # The distribution shape to which the group converges either proactively or
3166 # on resize events (depending on the value set inupdatePolicy.instanceRedistributionType).
3167 &quot;zones&quot;: [ # Zones where the regional managed instance group will create and manage
3168 # its instances.
3169 # By default, a regional MIG doesn&#x27;t automatically select an AI zone to create
3170 # instances, even if an AI zone is available in the specified region. To
3171 # create instances in an AI zone in the selected region, you must explicitly
3172 # specify it in the distribution policy together with the other preferred
3173 # zones.
3174 {
3175 &quot;zone&quot;: &quot;A String&quot;, # The URL of thezone.
3176 # The zone must exist in the region where the managed instance group is
3177 # located.
3178 },
3179 ],
3180 },
3181 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. This field may be used in optimistic locking.
3182 # It will be ignored when inserting an InstanceGroupManager. An up-to-date
3183 # fingerprint must be provided in order to update the InstanceGroupManager,
3184 # otherwise the request will fail with error412 conditionNotMet.
3185 #
3186 # To see the latest fingerprint, make a get() request to
3187 # retrieve an InstanceGroupManager.
3188 &quot;id&quot;: &quot;A String&quot;, # Output only. A unique identifier for this resource type. The server
3189 # generates this identifier.
3190 &quot;instanceFlexibilityPolicy&quot;: { # Instance flexibility allowing MIG to create VMs from multiple
3191 # types of machines.
3192 # Instance flexibility configuration on MIG overrides instance
3193 # template configuration.
3194 &quot;instanceSelections&quot;: { # Named instance selections configuring properties that the group will use
3195 # when creating new VMs.
3196 &quot;a_key&quot;: {
3197 &quot;machineTypes&quot;: [ # Full machine-type names, e.g. &quot;n1-standard-16&quot;.
3198 &quot;A String&quot;,
3199 ],
3200 &quot;rank&quot;: 42, # Preference of this instance selection. Lower number means higher
3201 # preference. MIG will first try to create a VM based on the machine-type
3202 # with lowest rank and fallback to next rank based on availability.
3203 # Machine types and instance selections with the same rank have the same
3204 # preference.
3205 },
3206 },
3207 },
3208 &quot;instanceGroup&quot;: &quot;A String&quot;, # Output only. The URL of the Instance Group resource.
3209 &quot;instanceLifecyclePolicy&quot;: { # The repair policy for this managed instance group.
3210 &quot;defaultActionOnFailure&quot;: &quot;A String&quot;, # The action that a MIG performs on a failed VM. If the value of the
3211 # onFailedHealthCheck field is `DEFAULT_ACTION`, then the same action also
3212 # applies to the VMs on which your application fails a health check.
3213 # Valid values are
3214 #
3215 # - REPAIR (default): MIG automatically repairs a failed VM
3216 # by recreating it. For more information, see About
3217 # repairing VMs in a MIG.
3218 # - DO_NOTHING: MIG does not repair a failed VM.
3219 &quot;forceUpdateOnRepair&quot;: &quot;A String&quot;, # A bit indicating whether to forcefully apply the group&#x27;s latest
3220 # configuration when repairing a VM. Valid options are:
3221 #
3222 #
3223 #
3224 # - NO (default): If configuration updates are available, they are not
3225 # forcefully applied during repair. Instead, configuration updates are
3226 # applied according to the group&#x27;s update policy.
3227 #
3228 # - YES: If configuration updates are available, they are applied
3229 # during repair.
3230 &quot;onFailedHealthCheck&quot;: &quot;A String&quot;, # The action that a MIG performs on an unhealthy VM. A VM is marked as
3231 # unhealthy when the application running on that VM fails a health check.
3232 # Valid values are:
3233 #
3234 # - DEFAULT_ACTION (default): MIG uses the same action
3235 # configured for instanceLifecyclePolicy.defaultActionOnFailure field.
3236 # - REPAIR: MIG automatically repairs an unhealthy VM by
3237 # recreating it.
3238 # - DO_NOTHING: MIG doesn&#x27;t repair an unhealthy VM.
3239 # For more information, see
3240 # About repairing VMs in a MIG.
3241 &quot;onRepair&quot;: { # Configuration for VM repairs in the MIG. # Configuration for VM repairs in the MIG.
3242 &quot;allowChangingZone&quot;: &quot;A String&quot;, # Specifies whether the MIG can change a VM&#x27;s zone during a repair.
3243 # Valid values are:
3244 #
3245 # - NO (default): MIG cannot change a VM&#x27;s zone during a
3246 # repair.
3247 # - YES: MIG can select a different zone for the VM during
3248 # a repair.
3249 },
3250 },
3251 &quot;instanceTemplate&quot;: &quot;A String&quot;, # The URL of the instance template that is specified for this managed
3252 # instance group. The group uses this template to create all new instances
3253 # in the managed instance group. The templates for existing instances in the
3254 # group do not change unless you run recreateInstances, runapplyUpdatesToInstances, or set the group&#x27;supdatePolicy.type to PROACTIVE.
3255 &quot;kind&quot;: &quot;compute#instanceGroupManager&quot;, # Output only. The resource type, which is alwayscompute#instanceGroupManager for managed instance groups.
3256 &quot;listManagedInstancesResults&quot;: &quot;A String&quot;, # Pagination behavior of the listManagedInstances API method for
3257 # this managed instance group.
3258 &quot;name&quot;: &quot;A String&quot;, # The name of the managed instance group. The name must be 1-63 characters
3259 # long, and comply withRFC1035.
3260 &quot;namedPorts&quot;: [ # [Output Only] Named ports configured on the Instance Groups complementary
3261 # to this Instance Group Manager.
3262 { # The named port. For example: &lt;&quot;http&quot;, 80&gt;.
3263 &quot;name&quot;: &quot;A String&quot;, # The name for this named port.
3264 # The name must be 1-63 characters long, and comply withRFC1035.
3265 &quot;port&quot;: 42, # The port number, which can be a value between 1 and 65535.
3266 },
3267 ],
3268 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL of theregion
3269 # where the managed instance group resides (for regional resources).
3270 &quot;resourcePolicies&quot;: { # Resource policies for this managed instance group.
3271 &quot;workloadPolicy&quot;: &quot;A String&quot;, # The URL of the workload policy that is specified for this managed
3272 # instance group.
3273 # It can be a full or partial URL. For example, the following are
3274 # all valid URLs to a workload policy:
3275 #
3276 #
3277 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/resourcePolicies/resourcePolicy
3278 # - projects/project/regions/region/resourcePolicies/resourcePolicy
3279 # - regions/region/resourcePolicies/resourcePolicy
3280 },
3281 &quot;satisfiesPzi&quot;: True or False, # Output only. Reserved for future use.
3282 &quot;satisfiesPzs&quot;: True or False, # Output only. Reserved for future use.
3283 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. The URL for this managed instance group. The server defines
3284 # this URL.
3285 &quot;standbyPolicy&quot;: { # Standby policy for stopped and suspended instances.
3286 &quot;initialDelaySec&quot;: 42, # Specifies the number of seconds that the MIG should wait to suspend or
3287 # stop a VM after that VM was created. The initial delay gives the
3288 # initialization script the time to prepare your VM for a quick scale out.
3289 # The value of initial delay must be between 0 and 3600 seconds. The
3290 # default value is 0.
3291 &quot;mode&quot;: &quot;A String&quot;, # Defines how a MIG resumes or starts VMs from a standby pool when the
3292 # group scales out. The default mode is `MANUAL`.
3293 },
3294 &quot;statefulPolicy&quot;: { # Stateful configuration for this Instanced Group Manager
3295 &quot;preservedState&quot;: { # Configuration of preserved resources.
3296 &quot;disks&quot;: { # Disks created on the instances that will be preserved on instance
3297 # delete, update, etc. This map is keyed with the device names of
3298 # the disks.
3299 &quot;a_key&quot;: {
3300 &quot;autoDelete&quot;: &quot;A String&quot;, # These stateful disks will never be deleted during autohealing,
3301 # update or VM instance recreate operations.
3302 # This flag is used to configure if the disk should be deleted after it
3303 # is no longer used by the group, e.g. when the given instance or
3304 # the whole group is deleted. Note: disks attached inREAD_ONLY mode cannot be auto-deleted.
3305 },
3306 },
3307 &quot;externalIPs&quot;: { # External network IPs assigned to the instances that will be preserved on
3308 # instance delete, update, etc. This map is keyed with the network
3309 # interface name.
3310 &quot;a_key&quot;: {
3311 &quot;autoDelete&quot;: &quot;A String&quot;, # These stateful IPs will never be released during autohealing,
3312 # update or VM instance recreate operations.
3313 # This flag is used to configure if the IP reservation should be deleted
3314 # after it is no longer used by the group, e.g. when the given instance
3315 # or the whole group is deleted.
3316 },
3317 },
3318 &quot;internalIPs&quot;: { # Internal network IPs assigned to the instances that will be preserved on
3319 # instance delete, update, etc. This map is keyed with the network
3320 # interface name.
3321 &quot;a_key&quot;: {
3322 &quot;autoDelete&quot;: &quot;A String&quot;, # These stateful IPs will never be released during autohealing,
3323 # update or VM instance recreate operations.
3324 # This flag is used to configure if the IP reservation should be deleted
3325 # after it is no longer used by the group, e.g. when the given instance
3326 # or the whole group is deleted.
3327 },
3328 },
3329 },
3330 },
3331 &quot;status&quot;: { # Output only. The status of this managed instance group.
3332 &quot;allInstancesConfig&quot;: { # Output only. Status of all-instances configuration on the group.
3333 &quot;currentRevision&quot;: &quot;A String&quot;, # Output only. Current all-instances configuration revision.
3334 # This value is in RFC3339 text format.
3335 &quot;effective&quot;: True or False, # Output only. A bit indicating whether this configuration has
3336 # been applied to all managed instances in the group.
3337 },
3338 &quot;appliedAcceleratorTopologies&quot;: [ # Output only. The accelerator topology applied to this MIG.
3339 # Currently only one accelerator topology is supported.
3340 {
3341 &quot;acceleratorTopology&quot;: &quot;A String&quot;, # Output only. Topology in the format of: &quot;16x16&quot;, &quot;4x4x4&quot;, etc.
3342 # The value is the same as configured in the WorkloadPolicy.
3343 &quot;state&quot;: &quot;A String&quot;, # Output only. The state of the accelerator topology.
3344 &quot;stateDetails&quot;: { # Output only. The result of the latest accelerator topology state
3345 # check.
3346 &quot;error&quot;: { # Output only. Encountered errors.
3347 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
3348 # operation.
3349 {
3350 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
3351 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
3352 # details. There is a set of defined message types to use for providing
3353 # details.The syntax depends on the error code. For example,
3354 # QuotaExceededInfo will have details when the error code is
3355 # QUOTA_EXCEEDED.
3356 {
3357 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
3358 #
3359 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
3360 # is not enabled:
3361 #
3362 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
3363 # &quot;domain&quot;: &quot;googleapis.com&quot;
3364 # &quot;metadata&quot;: {
3365 # &quot;resource&quot;: &quot;projects/123&quot;,
3366 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
3367 # }
3368 # }
3369 #
3370 # This response indicates that the pubsub.googleapis.com API is not enabled.
3371 #
3372 # Example of an error that is returned when attempting to create a Spanner
3373 # instance in a region that is out of stock:
3374 #
3375 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
3376 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
3377 # &quot;metadata&quot;: {
3378 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
3379 # }
3380 # }
3381 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
3382 # is typically the registered service name of the tool or product that
3383 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
3384 # generated by some common infrastructure, the error domain must be a
3385 # globally unique value that identifies the infrastructure. For Google API
3386 # infrastructure, the error domain is &quot;googleapis.com&quot;.
3387 &quot;metadatas&quot;: { # Additional structured details about this error.
3388 #
3389 # Keys must match a regular expression of `a-z+` but should
3390 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
3391 # length. When identifying the current value of an exceeded limit, the units
3392 # should be contained in the key, not the value. For example, rather than
3393 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
3394 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
3395 # instances that can be created in a single (batch) request.
3396 &quot;a_key&quot;: &quot;A String&quot;,
3397 },
3398 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
3399 # proximate cause of the error. Error reasons are unique within a particular
3400 # domain of errors. This should be at most 63 characters and match a
3401 # regular expression of `A-Z+[A-Z0-9]`, which represents
3402 # UPPER_SNAKE_CASE.
3403 },
3404 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
3405 #
3406 # For example, if a quota check failed with an error indicating the calling
3407 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
3408 # directly to the right place in the developer console to flip the bit.
3409 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
3410 { # Describes a URL link.
3411 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
3412 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
3413 },
3414 ],
3415 },
3416 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
3417 # which can be attached to an RPC error.
3418 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
3419 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
3420 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
3421 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
3422 },
3423 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
3424 &quot;dimensions&quot;: { # The map holding related quota dimensions.
3425 &quot;a_key&quot;: &quot;A String&quot;,
3426 },
3427 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
3428 # type or metric.
3429 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
3430 # or metric.
3431 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
3432 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
3433 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
3434 },
3435 },
3436 ],
3437 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
3438 # This property is optional.
3439 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
3440 },
3441 ],
3442 },
3443 &quot;timestamp&quot;: &quot;A String&quot;, # Output only. Timestamp is shown only if there is an error. The field
3444 # has // RFC3339 //
3445 # text format.
3446 },
3447 },
3448 ],
3449 &quot;autoscaler&quot;: &quot;A String&quot;, # Output only. The URL of theAutoscaler
3450 # that targets this instance group manager.
3451 &quot;bulkInstanceOperation&quot;: { # Bulk instance operation is the creation of VMs in a MIG when the # Output only. The status of bulk instance operation.
3452 # targetSizePolicy.mode is set to BULK.
3453 &quot;inProgress&quot;: True or False, # Output only. Informs whether bulk instance operation is in progress.
3454 &quot;lastProgressCheck&quot;: { # Output only. Information from the last progress check of bulk instance
3455 # operation.
3456 &quot;error&quot;: { # Output only. Errors encountered during bulk instance operation.
3457 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
3458 # operation.
3459 {
3460 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
3461 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
3462 # details. There is a set of defined message types to use for providing
3463 # details.The syntax depends on the error code. For example,
3464 # QuotaExceededInfo will have details when the error code is
3465 # QUOTA_EXCEEDED.
3466 {
3467 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
3468 #
3469 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
3470 # is not enabled:
3471 #
3472 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
3473 # &quot;domain&quot;: &quot;googleapis.com&quot;
3474 # &quot;metadata&quot;: {
3475 # &quot;resource&quot;: &quot;projects/123&quot;,
3476 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
3477 # }
3478 # }
3479 #
3480 # This response indicates that the pubsub.googleapis.com API is not enabled.
3481 #
3482 # Example of an error that is returned when attempting to create a Spanner
3483 # instance in a region that is out of stock:
3484 #
3485 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
3486 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
3487 # &quot;metadata&quot;: {
3488 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
3489 # }
3490 # }
3491 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
3492 # is typically the registered service name of the tool or product that
3493 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
3494 # generated by some common infrastructure, the error domain must be a
3495 # globally unique value that identifies the infrastructure. For Google API
3496 # infrastructure, the error domain is &quot;googleapis.com&quot;.
3497 &quot;metadatas&quot;: { # Additional structured details about this error.
3498 #
3499 # Keys must match a regular expression of `a-z+` but should
3500 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
3501 # length. When identifying the current value of an exceeded limit, the units
3502 # should be contained in the key, not the value. For example, rather than
3503 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
3504 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
3505 # instances that can be created in a single (batch) request.
3506 &quot;a_key&quot;: &quot;A String&quot;,
3507 },
3508 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
3509 # proximate cause of the error. Error reasons are unique within a particular
3510 # domain of errors. This should be at most 63 characters and match a
3511 # regular expression of `A-Z+[A-Z0-9]`, which represents
3512 # UPPER_SNAKE_CASE.
3513 },
3514 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
3515 #
3516 # For example, if a quota check failed with an error indicating the calling
3517 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
3518 # directly to the right place in the developer console to flip the bit.
3519 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
3520 { # Describes a URL link.
3521 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
3522 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
3523 },
3524 ],
3525 },
3526 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
3527 # which can be attached to an RPC error.
3528 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
3529 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
3530 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
3531 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
3532 },
3533 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
3534 &quot;dimensions&quot;: { # The map holding related quota dimensions.
3535 &quot;a_key&quot;: &quot;A String&quot;,
3536 },
3537 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
3538 # type or metric.
3539 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
3540 # or metric.
3541 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
3542 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
3543 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
3544 },
3545 },
3546 ],
3547 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
3548 # This property is optional.
3549 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
3550 },
3551 ],
3552 },
3553 &quot;timestamp&quot;: &quot;A String&quot;, # Output only. Timestamp of the last progress check of bulk instance
3554 # operation. Timestamp is in RFC3339 text format.
3555 },
3556 },
3557 &quot;currentInstanceStatuses&quot;: { # The list of instance statuses and the number of instances in this managed # Output only. The list of instance statuses and the number of instances
3558 # in this managed instance group that have the status. Currently only shown
3559 # for TPU MIGs
3560 # instance group that have the status. For more information about how to
3561 # interpret each status check the instance lifecycle documentation.
3562 # Currently only shown for TPU MIGs.
3563 &quot;deprovisioning&quot;: 42, # Output only. The number of instances in the managed instance group
3564 # that have DEPROVISIONING status.
3565 &quot;nonExistent&quot;: 42, # Output only. The number of instances that have not been created yet or
3566 # have been deleted. Includes only instances that would be shown in the
3567 # listManagedInstances method and not all instances that have been
3568 # deleted in the lifetime of the MIG.
3569 # Does not include FlexStart instances that are waiting for the resources
3570 # availability, they are considered as &#x27;pending&#x27;.
3571 &quot;pending&quot;: 42, # Output only. The number of instances in the managed instance group
3572 # that have PENDING status, that is FlexStart instances that are waiting
3573 # for resources. Instances that do not exist because of the other reasons
3574 # are counted as &#x27;non_existent&#x27;.
3575 &quot;pendingStop&quot;: 42, # Output only. The number of instances in the managed instance group
3576 # that have PENDING_STOP status.
3577 &quot;provisioning&quot;: 42, # Output only. The number of instances in the managed instance group
3578 # that have PROVISIONING status.
3579 &quot;repairing&quot;: 42, # Output only. The number of instances in the managed instance group
3580 # that have REPAIRING status.
3581 &quot;running&quot;: 42, # Output only. The number of instances in the managed instance group
3582 # that have RUNNING status.
3583 &quot;staging&quot;: 42, # Output only. The number of instances in the managed instance group
3584 # that have STAGING status.
3585 &quot;stopped&quot;: 42, # Output only. The number of instances in the managed instance group
3586 # that have STOPPED status.
3587 &quot;stopping&quot;: 42, # Output only. The number of instances in the managed instance group
3588 # that have STOPPING status.
3589 &quot;suspended&quot;: 42, # Output only. The number of instances in the managed instance group
3590 # that have SUSPENDED status.
3591 &quot;suspending&quot;: 42, # Output only. The number of instances in the managed instance group
3592 # that have SUSPENDING status.
3593 &quot;terminated&quot;: 42, # Output only. The number of instances in the managed instance group
3594 # that have TERMINATED status.
3595 },
3596 &quot;isStable&quot;: True or False, # Output only. A bit indicating whether the managed instance group is in a
3597 # stable state. A stable state means that: none of the instances in the
3598 # managed instance group is currently undergoing any type of change (for
3599 # example, creation, restart, or deletion); no future changes are scheduled
3600 # for instances in the managed instance group; and the managed instance
3601 # group itself is not being modified.
3602 &quot;stateful&quot;: { # Output only. Stateful status of the given Instance Group Manager.
3603 &quot;hasStatefulConfig&quot;: True or False, # Output only. A bit indicating whether the managed instance group
3604 # has stateful configuration, that is, if you have configured any items
3605 # in a stateful policy or in per-instance configs.
3606 # The group might report that it has no stateful configuration even when
3607 # there is still some preserved state on a managed instance, for example,
3608 # if you have deleted all PICs but not yet applied those deletions.
3609 &quot;perInstanceConfigs&quot;: { # Output only. Status of per-instance configurations on the instances.
3610 &quot;allEffective&quot;: True or False, # Output only. A bit indicating if all of the group&#x27;s per-instance configurations
3611 # (listed in the output of a listPerInstanceConfigs API call) have
3612 # status EFFECTIVE or there are no per-instance-configs.
3613 },
3614 },
3615 &quot;versionTarget&quot;: { # Output only. A status of consistency of Instances&#x27; versions with their
3616 # target version specified by version field on Instance Group
3617 # Manager.
3618 &quot;isReached&quot;: True or False, # Output only. A bit indicating whether version target has been reached
3619 # in this managed instance group, i.e. all instances are in their target
3620 # version. Instances&#x27; target version are specified byversion field on Instance Group Manager.
3621 },
3622 },
3623 &quot;targetPools&quot;: [ # The URLs for all TargetPool resources to which instances in theinstanceGroup field are added. The target pools automatically
3624 # apply to all of the instances in the managed instance group.
3625 &quot;A String&quot;,
3626 ],
3627 &quot;targetSize&quot;: 42, # The target number of running instances for this managed instance group.
3628 # You can reduce this number by using the instanceGroupManager
3629 # deleteInstances or abandonInstances methods. Resizing the group also
3630 # changes this number.
3631 &quot;targetSizePolicy&quot;: { # The policy that specifies how the MIG creates its VMs to achieve the target
3632 # size.
3633 &quot;mode&quot;: &quot;A String&quot;, # The mode of target size policy based on which the MIG creates its VMs
3634 # individually or all at once.
3635 },
3636 &quot;targetStoppedSize&quot;: 42, # The target number of stopped instances for this managed instance group.
3637 # This number changes when you:
3638 #
3639 # - Stop instance using the stopInstances
3640 # method or start instances using the startInstances
3641 # method.
3642 # - Manually change the targetStoppedSize using the update
3643 # method.
3644 &quot;targetSuspendedSize&quot;: 42, # The target number of suspended instances for this managed instance group.
3645 # This number changes when you:
3646 #
3647 # - Suspend instance using the suspendInstances
3648 # method or resume instances using the resumeInstances
3649 # method.
3650 # - Manually change the targetSuspendedSize using the update
3651 # method.
3652 &quot;updatePolicy&quot;: { # The update policy for this managed instance group.
3653 &quot;instanceRedistributionType&quot;: &quot;A String&quot;, # The
3654 # instance redistribution policy for regional managed instance groups.
3655 # Valid values are:
3656 #
3657 # - PROACTIVE (default): The group attempts to maintain an
3658 # even distribution of VM instances across zones in the region.
3659 # - NONE: For non-autoscaled groups, proactive
3660 # redistribution is disabled.
3661 &quot;maxSurge&quot;: { # Encapsulates numeric value that can be either absolute or relative. # The maximum number of instances that can be created above the specifiedtargetSize during the update process. This value can be
3662 # either a fixed number or, if the group has 10 or more instances, a
3663 # percentage. If you set a percentage, the number of instances is rounded
3664 # if necessary. The default value for maxSurge is a fixed
3665 # value equal to the number of zones in which the managed instance group
3666 # operates.
3667 #
3668 # At least one of either maxSurge ormaxUnavailable must be greater than 0. Learn more about maxSurge.
3669 &quot;calculated&quot;: 42, # Output only. Absolute value of VM instances calculated based on the specific mode.
3670 #
3671 #
3672 #
3673 # - If the value is fixed, then the calculated
3674 # value is equal to the fixed value.
3675 # - If the value is a percent, then the
3676 # calculated
3677 # value is percent/100 * targetSize. For example,
3678 # the calculated value of a 80% of a managed instance group
3679 # with 150 instances would be (80/100 * 150) = 120 VM instances. If there
3680 # is a remainder, the number is rounded.
3681 &quot;fixed&quot;: 42, # Specifies a fixed number of VM instances. This must be a positive integer.
3682 &quot;percent&quot;: 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For
3683 # example, specify 80 for 80%.
3684 },
3685 &quot;maxUnavailable&quot;: { # Encapsulates numeric value that can be either absolute or relative. # The maximum number of instances that can be unavailable during the update
3686 # process. An instance is considered available if all of the following
3687 # conditions are satisfied:
3688 #
3689 #
3690 #
3691 # - The instance&#x27;s status is
3692 # RUNNING.
3693 # - If there is a health
3694 # check on the instance group, the instance&#x27;s health check status
3695 # must be HEALTHY at least once. If there is no health check
3696 # on the group, then the instance only needs to have a status of
3697 # RUNNING to be considered available.
3698 #
3699 #
3700 # This value can be either a fixed number or, if the group has 10 or more
3701 # instances, a percentage. If you set a percentage, the number of instances
3702 # is rounded if necessary. The default value formaxUnavailable is a fixed value equal to the number of zones
3703 # in which the managed instance group operates.
3704 #
3705 # At least one of either maxSurge ormaxUnavailable must be greater than 0. Learn more about maxUnavailable.
3706 &quot;calculated&quot;: 42, # Output only. Absolute value of VM instances calculated based on the specific mode.
3707 #
3708 #
3709 #
3710 # - If the value is fixed, then the calculated
3711 # value is equal to the fixed value.
3712 # - If the value is a percent, then the
3713 # calculated
3714 # value is percent/100 * targetSize. For example,
3715 # the calculated value of a 80% of a managed instance group
3716 # with 150 instances would be (80/100 * 150) = 120 VM instances. If there
3717 # is a remainder, the number is rounded.
3718 &quot;fixed&quot;: 42, # Specifies a fixed number of VM instances. This must be a positive integer.
3719 &quot;percent&quot;: 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For
3720 # example, specify 80 for 80%.
3721 },
3722 &quot;minimalAction&quot;: &quot;A String&quot;, # Minimal action to be taken on an instance. Use this option to minimize
3723 # disruption as much as possible or to apply a more disruptive action than
3724 # is necessary.
3725 #
3726 # - To limit disruption as much as possible, set the minimal action toREFRESH. If your update requires a more disruptive action,
3727 # Compute Engine performs the necessary action to execute the update.
3728 # - To apply a more disruptive action than is strictly necessary, set the
3729 # minimal action to RESTART or REPLACE. For
3730 # example, Compute Engine does not need to restart a VM to change its
3731 # metadata. But if your application reads instance metadata only when a VM
3732 # is restarted, you can set the minimal action to RESTART in
3733 # order to pick up metadata changes.
3734 &quot;mostDisruptiveAllowedAction&quot;: &quot;A String&quot;, # Most disruptive action that is allowed to be taken on an instance.
3735 # You can specify either NONE to forbid any actions,REFRESH to avoid restarting the VM and to limit disruption
3736 # as much as possible. RESTART to allow actions that can be
3737 # applied without instance replacing or REPLACE to allow all
3738 # possible actions. If the Updater determines that the minimal update
3739 # action needed is more disruptive than most disruptive allowed action you
3740 # specify it will not perform the update at all.
3741 &quot;replacementMethod&quot;: &quot;A String&quot;, # What action should be used to replace instances.
3742 # See minimal_action.REPLACE
3743 &quot;type&quot;: &quot;A String&quot;, # The type
3744 # of update process. You can specify either PROACTIVE so
3745 # that the MIG automatically updates VMs to the latest configurations orOPPORTUNISTIC so that you can select the VMs that you want
3746 # to update.
3747 },
3748 &quot;versions&quot;: [ # Specifies the instance templates used by this managed instance group to
3749 # create instances.
3750 #
3751 # Each version is defined by an instanceTemplate and aname. Every version can appear at most once per instance
3752 # group. This field overrides the top-level instanceTemplate
3753 # field. Read more about therelationships
3754 # between these fields. Exactly one version must leave thetargetSize field unset. That version will be applied to all
3755 # remaining instances. For more information, read aboutcanary
3756 # updates.
3757 {
3758 &quot;instanceTemplate&quot;: &quot;A String&quot;, # The URL of the instance template that is specified for this managed
3759 # instance group. The group uses this template to create new instances in
3760 # the managed instance group until the `targetSize` for this version is
3761 # reached. The templates for existing instances in the group do not change
3762 # unless you run recreateInstances, runapplyUpdatesToInstances, or set the group&#x27;supdatePolicy.type to PROACTIVE; in those cases,
3763 # existing instances are updated until the `targetSize` for this version is
3764 # reached.
3765 &quot;name&quot;: &quot;A String&quot;, # Name of the version. Unique among all versions in the scope of this
3766 # managed instance group.
3767 &quot;targetSize&quot;: { # Encapsulates numeric value that can be either absolute or relative. # Specifies the intended number of instances to be created from theinstanceTemplate. The final number of instances created
3768 # from the template will be equal to:
3769 #
3770 #
3771 # - If expressed as a fixed number, the minimum of either
3772 # targetSize.fixed or
3773 # instanceGroupManager.targetSize is used.
3774 # - if expressed as a percent, the targetSize
3775 # would be (targetSize.percent/100 *
3776 # InstanceGroupManager.targetSize) If there is a remainder, the
3777 # number is rounded.
3778 #
3779 # If unset, this version will update any remaining instances not
3780 # updated by another version. ReadStarting
3781 # a canary update for more information.
3782 &quot;calculated&quot;: 42, # Output only. Absolute value of VM instances calculated based on the specific mode.
3783 #
3784 #
3785 #
3786 # - If the value is fixed, then the calculated
3787 # value is equal to the fixed value.
3788 # - If the value is a percent, then the
3789 # calculated
3790 # value is percent/100 * targetSize. For example,
3791 # the calculated value of a 80% of a managed instance group
3792 # with 150 instances would be (80/100 * 150) = 120 VM instances. If there
3793 # is a remainder, the number is rounded.
3794 &quot;fixed&quot;: 42, # Specifies a fixed number of VM instances. This must be a positive integer.
3795 &quot;percent&quot;: 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For
3796 # example, specify 80 for 80%.
3797 },
3798 },
3799 ],
3800 &quot;zone&quot;: &quot;A String&quot;, # Output only. The URL of azone
3801 # where the managed instance group is located (for zonal resources).
3802 }</pre>
3803 </div>
3804
3805 <div class="method">
3806 <code class="details" id="insert">insert(project, zone, body=None, requestId=None, x__xgafv=None)</code>
3807 <pre>Creates a managed instance group using the information that you specify
3808 in the request. After the group is created, instances in the group are
3809 created using the specified instance template.
3810 This operation is marked as DONE when the group is created
3811 even if the instances in the group have not yet been created. You
3812 must separately verify the status of the individual instances with thelistmanagedinstances
3813 method.
3814
3815 A managed instance group can have up to 1000 VM instances per group. Please
3816 contact Cloud Support if you need an increase in
3817 this limit.
3818
3819 Args:
3820 project: string, Project ID for this request. (required)
3821 zone: string, The name of the zone
3822 where you want to create the managed instance group. (required)
3823 body: object, The request body.
3824 The object takes the form of:
3825
3826 { # Represents a Managed Instance Group resource.
3827 #
3828 # An instance group is a collection of VM instances that you can manage as a
3829 # single entity. For more information, readInstance groups.
3830 #
3831 # For zonal Managed Instance Group, use the instanceGroupManagers
3832 # resource.
3833 #
3834 # For regional Managed Instance Group, use theregionInstanceGroupManagers resource.
3835 &quot;allInstancesConfig&quot;: { # Specifies configuration that overrides the instance template configuration
3836 # for the group.
3837 &quot;properties&quot;: { # Represents the change that you want to make to the instance properties. # Properties to set on all instances in the group.
3838 #
3839 # You can add or modify properties using theinstanceGroupManagers.patch orregionInstanceGroupManagers.patch. After settingallInstancesConfig on the group, you must update the group&#x27;s
3840 # instances to apply the configuration. To apply the configuration, set the
3841 # group&#x27;s updatePolicy.type field to use proactive updates or
3842 # use the applyUpdatesToInstances method.
3843 &quot;labels&quot;: { # The label key-value pairs that you want to patch onto the instance.
3844 &quot;a_key&quot;: &quot;A String&quot;,
3845 },
3846 &quot;metadata&quot;: { # The metadata key-value pairs that you want to patch onto the instance. For
3847 # more information, see Project and
3848 # instance metadata.
3849 &quot;a_key&quot;: &quot;A String&quot;,
3850 },
3851 },
3852 },
3853 &quot;autoHealingPolicies&quot;: [ # The autohealing policy for this managed instance group. You can specify
3854 # only one value.
3855 {
3856 &quot;healthCheck&quot;: &quot;A String&quot;, # The URL for the health check that signals autohealing.
3857 &quot;initialDelaySec&quot;: 42, # The initial delay is the number of seconds that a new VM takes to
3858 # initialize and run its startup script. During a VM&#x27;s initial delay
3859 # period, the MIG ignores unsuccessful health checks because the VM might
3860 # be in the startup process. This prevents the MIG from prematurely
3861 # recreating a VM. If the health check receives a healthy response during
3862 # the initial delay, it indicates that the startup process is complete and
3863 # the VM is ready. The value of initial delay must be between 0 and 3600
3864 # seconds. The default value is 0.
3865 },
3866 ],
3867 &quot;baseInstanceName&quot;: &quot;A String&quot;, # The base instance name is a prefix that you want to attach to the names of
3868 # all VMs in a MIG. The maximum character length is 58 and the name must
3869 # comply with RFC1035 format.
3870 #
3871 # When a VM is created in the group, the MIG appends a hyphen and a random
3872 # four-character string to the base instance name. If you want the MIG to
3873 # assign sequential numbers instead of a random string, then end the base
3874 # instance name with a hyphen followed by one or more hash symbols. The hash
3875 # symbols indicate the number of digits. For example, a base instance name of
3876 # &quot;vm-###&quot; results in &quot;vm-001&quot; as a VM name.
3877 # @pattern
3878 # [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,51}-#{1,10}(\\[[0-9]{1,10}\\])?))
3879 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. The creation timestamp for this managed instance group inRFC3339
3880 # text format.
3881 &quot;currentActions&quot;: { # Output only. The list of instance actions and the number of instances
3882 # in this managed instance group that are scheduled for each of those
3883 # actions.
3884 &quot;abandoning&quot;: 42, # Output only. The total number of instances in the managed instance group
3885 # that are scheduled to be abandoned. Abandoning an instance removes it
3886 # from the managed instance group without deleting it.
3887 &quot;creating&quot;: 42, # Output only. The number of instances in the managed instance group that
3888 # are scheduled to be created or are currently being created. If the group
3889 # fails to create any of these instances, it tries again until it creates
3890 # the instance successfully.
3891 #
3892 # If you have disabled creation retries, this field will not be populated;
3893 # instead, the creatingWithoutRetries field will be populated.
3894 &quot;creatingWithoutRetries&quot;: 42, # Output only. The number of instances that the managed instance group
3895 # will attempt to create. The group attempts to create each instance
3896 # only once. If the group fails to create any of these instances, it
3897 # decreases the group&#x27;s targetSize value accordingly.
3898 &quot;deleting&quot;: 42, # Output only. The number of instances in the managed instance group that
3899 # are scheduled to be deleted or are currently being deleted.
3900 &quot;none&quot;: 42, # Output only. The number of instances in the managed instance group that
3901 # are running and have no scheduled actions.
3902 &quot;recreating&quot;: 42, # Output only. The number of instances in the managed instance group that
3903 # are scheduled to be recreated or are currently being being recreated.
3904 # Recreating an instance deletes the existing root persistent disk
3905 # and creates a new disk from the image that is defined in the
3906 # instance template.
3907 &quot;refreshing&quot;: 42, # Output only. The number of instances in the managed instance group that
3908 # are being reconfigured with properties that do not require a restart
3909 # or a recreate action. For example, setting or removing target
3910 # pools for the instance.
3911 &quot;restarting&quot;: 42, # Output only. The number of instances in the managed instance group that
3912 # are scheduled to be restarted or are currently being restarted.
3913 &quot;resuming&quot;: 42, # Output only. The number of instances in the managed instance group that
3914 # are scheduled to be resumed or are currently being resumed.
3915 &quot;starting&quot;: 42, # Output only. The number of instances in the managed instance group that
3916 # are scheduled to be started or are currently being started.
3917 &quot;stopping&quot;: 42, # Output only. The number of instances in the managed instance group that
3918 # are scheduled to be stopped or are currently being stopped.
3919 &quot;suspending&quot;: 42, # Output only. The number of instances in the managed instance group that
3920 # are scheduled to be suspended or are currently being suspended.
3921 &quot;verifying&quot;: 42, # Output only. The number of instances in the managed instance group that
3922 # are being verified. See the managedInstances[].currentAction
3923 # property in the listManagedInstances method documentation.
3924 },
3925 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource.
3926 &quot;distributionPolicy&quot;: { # Policy specifying the intended distribution of managed instances across
3927 # zones in a regional managed instance group.
3928 &quot;targetShape&quot;: &quot;A String&quot;, # The distribution shape to which the group converges either proactively or
3929 # on resize events (depending on the value set inupdatePolicy.instanceRedistributionType).
3930 &quot;zones&quot;: [ # Zones where the regional managed instance group will create and manage
3931 # its instances.
3932 # By default, a regional MIG doesn&#x27;t automatically select an AI zone to create
3933 # instances, even if an AI zone is available in the specified region. To
3934 # create instances in an AI zone in the selected region, you must explicitly
3935 # specify it in the distribution policy together with the other preferred
3936 # zones.
3937 {
3938 &quot;zone&quot;: &quot;A String&quot;, # The URL of thezone.
3939 # The zone must exist in the region where the managed instance group is
3940 # located.
3941 },
3942 ],
3943 },
3944 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. This field may be used in optimistic locking.
3945 # It will be ignored when inserting an InstanceGroupManager. An up-to-date
3946 # fingerprint must be provided in order to update the InstanceGroupManager,
3947 # otherwise the request will fail with error412 conditionNotMet.
3948 #
3949 # To see the latest fingerprint, make a get() request to
3950 # retrieve an InstanceGroupManager.
3951 &quot;id&quot;: &quot;A String&quot;, # Output only. A unique identifier for this resource type. The server
3952 # generates this identifier.
3953 &quot;instanceFlexibilityPolicy&quot;: { # Instance flexibility allowing MIG to create VMs from multiple
3954 # types of machines.
3955 # Instance flexibility configuration on MIG overrides instance
3956 # template configuration.
3957 &quot;instanceSelections&quot;: { # Named instance selections configuring properties that the group will use
3958 # when creating new VMs.
3959 &quot;a_key&quot;: {
3960 &quot;machineTypes&quot;: [ # Full machine-type names, e.g. &quot;n1-standard-16&quot;.
3961 &quot;A String&quot;,
3962 ],
3963 &quot;rank&quot;: 42, # Preference of this instance selection. Lower number means higher
3964 # preference. MIG will first try to create a VM based on the machine-type
3965 # with lowest rank and fallback to next rank based on availability.
3966 # Machine types and instance selections with the same rank have the same
3967 # preference.
3968 },
3969 },
3970 },
3971 &quot;instanceGroup&quot;: &quot;A String&quot;, # Output only. The URL of the Instance Group resource.
3972 &quot;instanceLifecyclePolicy&quot;: { # The repair policy for this managed instance group.
3973 &quot;defaultActionOnFailure&quot;: &quot;A String&quot;, # The action that a MIG performs on a failed VM. If the value of the
3974 # onFailedHealthCheck field is `DEFAULT_ACTION`, then the same action also
3975 # applies to the VMs on which your application fails a health check.
3976 # Valid values are
3977 #
3978 # - REPAIR (default): MIG automatically repairs a failed VM
3979 # by recreating it. For more information, see About
3980 # repairing VMs in a MIG.
3981 # - DO_NOTHING: MIG does not repair a failed VM.
3982 &quot;forceUpdateOnRepair&quot;: &quot;A String&quot;, # A bit indicating whether to forcefully apply the group&#x27;s latest
3983 # configuration when repairing a VM. Valid options are:
3984 #
3985 #
3986 #
3987 # - NO (default): If configuration updates are available, they are not
3988 # forcefully applied during repair. Instead, configuration updates are
3989 # applied according to the group&#x27;s update policy.
3990 #
3991 # - YES: If configuration updates are available, they are applied
3992 # during repair.
3993 &quot;onFailedHealthCheck&quot;: &quot;A String&quot;, # The action that a MIG performs on an unhealthy VM. A VM is marked as
3994 # unhealthy when the application running on that VM fails a health check.
3995 # Valid values are:
3996 #
3997 # - DEFAULT_ACTION (default): MIG uses the same action
3998 # configured for instanceLifecyclePolicy.defaultActionOnFailure field.
3999 # - REPAIR: MIG automatically repairs an unhealthy VM by
4000 # recreating it.
4001 # - DO_NOTHING: MIG doesn&#x27;t repair an unhealthy VM.
4002 # For more information, see
4003 # About repairing VMs in a MIG.
4004 &quot;onRepair&quot;: { # Configuration for VM repairs in the MIG. # Configuration for VM repairs in the MIG.
4005 &quot;allowChangingZone&quot;: &quot;A String&quot;, # Specifies whether the MIG can change a VM&#x27;s zone during a repair.
4006 # Valid values are:
4007 #
4008 # - NO (default): MIG cannot change a VM&#x27;s zone during a
4009 # repair.
4010 # - YES: MIG can select a different zone for the VM during
4011 # a repair.
4012 },
4013 },
4014 &quot;instanceTemplate&quot;: &quot;A String&quot;, # The URL of the instance template that is specified for this managed
4015 # instance group. The group uses this template to create all new instances
4016 # in the managed instance group. The templates for existing instances in the
4017 # group do not change unless you run recreateInstances, runapplyUpdatesToInstances, or set the group&#x27;supdatePolicy.type to PROACTIVE.
4018 &quot;kind&quot;: &quot;compute#instanceGroupManager&quot;, # Output only. The resource type, which is alwayscompute#instanceGroupManager for managed instance groups.
4019 &quot;listManagedInstancesResults&quot;: &quot;A String&quot;, # Pagination behavior of the listManagedInstances API method for
4020 # this managed instance group.
4021 &quot;name&quot;: &quot;A String&quot;, # The name of the managed instance group. The name must be 1-63 characters
4022 # long, and comply withRFC1035.
4023 &quot;namedPorts&quot;: [ # [Output Only] Named ports configured on the Instance Groups complementary
4024 # to this Instance Group Manager.
4025 { # The named port. For example: &lt;&quot;http&quot;, 80&gt;.
4026 &quot;name&quot;: &quot;A String&quot;, # The name for this named port.
4027 # The name must be 1-63 characters long, and comply withRFC1035.
4028 &quot;port&quot;: 42, # The port number, which can be a value between 1 and 65535.
4029 },
4030 ],
4031 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL of theregion
4032 # where the managed instance group resides (for regional resources).
4033 &quot;resourcePolicies&quot;: { # Resource policies for this managed instance group.
4034 &quot;workloadPolicy&quot;: &quot;A String&quot;, # The URL of the workload policy that is specified for this managed
4035 # instance group.
4036 # It can be a full or partial URL. For example, the following are
4037 # all valid URLs to a workload policy:
4038 #
4039 #
4040 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/resourcePolicies/resourcePolicy
4041 # - projects/project/regions/region/resourcePolicies/resourcePolicy
4042 # - regions/region/resourcePolicies/resourcePolicy
4043 },
4044 &quot;satisfiesPzi&quot;: True or False, # Output only. Reserved for future use.
4045 &quot;satisfiesPzs&quot;: True or False, # Output only. Reserved for future use.
4046 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. The URL for this managed instance group. The server defines
4047 # this URL.
4048 &quot;standbyPolicy&quot;: { # Standby policy for stopped and suspended instances.
4049 &quot;initialDelaySec&quot;: 42, # Specifies the number of seconds that the MIG should wait to suspend or
4050 # stop a VM after that VM was created. The initial delay gives the
4051 # initialization script the time to prepare your VM for a quick scale out.
4052 # The value of initial delay must be between 0 and 3600 seconds. The
4053 # default value is 0.
4054 &quot;mode&quot;: &quot;A String&quot;, # Defines how a MIG resumes or starts VMs from a standby pool when the
4055 # group scales out. The default mode is `MANUAL`.
4056 },
4057 &quot;statefulPolicy&quot;: { # Stateful configuration for this Instanced Group Manager
4058 &quot;preservedState&quot;: { # Configuration of preserved resources.
4059 &quot;disks&quot;: { # Disks created on the instances that will be preserved on instance
4060 # delete, update, etc. This map is keyed with the device names of
4061 # the disks.
4062 &quot;a_key&quot;: {
4063 &quot;autoDelete&quot;: &quot;A String&quot;, # These stateful disks will never be deleted during autohealing,
4064 # update or VM instance recreate operations.
4065 # This flag is used to configure if the disk should be deleted after it
4066 # is no longer used by the group, e.g. when the given instance or
4067 # the whole group is deleted. Note: disks attached inREAD_ONLY mode cannot be auto-deleted.
4068 },
4069 },
4070 &quot;externalIPs&quot;: { # External network IPs assigned to the instances that will be preserved on
4071 # instance delete, update, etc. This map is keyed with the network
4072 # interface name.
4073 &quot;a_key&quot;: {
4074 &quot;autoDelete&quot;: &quot;A String&quot;, # These stateful IPs will never be released during autohealing,
4075 # update or VM instance recreate operations.
4076 # This flag is used to configure if the IP reservation should be deleted
4077 # after it is no longer used by the group, e.g. when the given instance
4078 # or the whole group is deleted.
4079 },
4080 },
4081 &quot;internalIPs&quot;: { # Internal network IPs assigned to the instances that will be preserved on
4082 # instance delete, update, etc. This map is keyed with the network
4083 # interface name.
4084 &quot;a_key&quot;: {
4085 &quot;autoDelete&quot;: &quot;A String&quot;, # These stateful IPs will never be released during autohealing,
4086 # update or VM instance recreate operations.
4087 # This flag is used to configure if the IP reservation should be deleted
4088 # after it is no longer used by the group, e.g. when the given instance
4089 # or the whole group is deleted.
4090 },
4091 },
4092 },
4093 },
4094 &quot;status&quot;: { # Output only. The status of this managed instance group.
4095 &quot;allInstancesConfig&quot;: { # Output only. Status of all-instances configuration on the group.
4096 &quot;currentRevision&quot;: &quot;A String&quot;, # Output only. Current all-instances configuration revision.
4097 # This value is in RFC3339 text format.
4098 &quot;effective&quot;: True or False, # Output only. A bit indicating whether this configuration has
4099 # been applied to all managed instances in the group.
4100 },
4101 &quot;appliedAcceleratorTopologies&quot;: [ # Output only. The accelerator topology applied to this MIG.
4102 # Currently only one accelerator topology is supported.
4103 {
4104 &quot;acceleratorTopology&quot;: &quot;A String&quot;, # Output only. Topology in the format of: &quot;16x16&quot;, &quot;4x4x4&quot;, etc.
4105 # The value is the same as configured in the WorkloadPolicy.
4106 &quot;state&quot;: &quot;A String&quot;, # Output only. The state of the accelerator topology.
4107 &quot;stateDetails&quot;: { # Output only. The result of the latest accelerator topology state
4108 # check.
4109 &quot;error&quot;: { # Output only. Encountered errors.
4110 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
4111 # operation.
4112 {
4113 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
4114 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
4115 # details. There is a set of defined message types to use for providing
4116 # details.The syntax depends on the error code. For example,
4117 # QuotaExceededInfo will have details when the error code is
4118 # QUOTA_EXCEEDED.
4119 {
4120 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
4121 #
4122 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
4123 # is not enabled:
4124 #
4125 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
4126 # &quot;domain&quot;: &quot;googleapis.com&quot;
4127 # &quot;metadata&quot;: {
4128 # &quot;resource&quot;: &quot;projects/123&quot;,
4129 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
4130 # }
4131 # }
4132 #
4133 # This response indicates that the pubsub.googleapis.com API is not enabled.
4134 #
4135 # Example of an error that is returned when attempting to create a Spanner
4136 # instance in a region that is out of stock:
4137 #
4138 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
4139 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
4140 # &quot;metadata&quot;: {
4141 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
4142 # }
4143 # }
4144 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
4145 # is typically the registered service name of the tool or product that
4146 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
4147 # generated by some common infrastructure, the error domain must be a
4148 # globally unique value that identifies the infrastructure. For Google API
4149 # infrastructure, the error domain is &quot;googleapis.com&quot;.
4150 &quot;metadatas&quot;: { # Additional structured details about this error.
4151 #
4152 # Keys must match a regular expression of `a-z+` but should
4153 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
4154 # length. When identifying the current value of an exceeded limit, the units
4155 # should be contained in the key, not the value. For example, rather than
4156 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
4157 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
4158 # instances that can be created in a single (batch) request.
4159 &quot;a_key&quot;: &quot;A String&quot;,
4160 },
4161 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
4162 # proximate cause of the error. Error reasons are unique within a particular
4163 # domain of errors. This should be at most 63 characters and match a
4164 # regular expression of `A-Z+[A-Z0-9]`, which represents
4165 # UPPER_SNAKE_CASE.
4166 },
4167 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
4168 #
4169 # For example, if a quota check failed with an error indicating the calling
4170 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
4171 # directly to the right place in the developer console to flip the bit.
4172 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
4173 { # Describes a URL link.
4174 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
4175 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
4176 },
4177 ],
4178 },
4179 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
4180 # which can be attached to an RPC error.
4181 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
4182 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
4183 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
4184 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
4185 },
4186 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
4187 &quot;dimensions&quot;: { # The map holding related quota dimensions.
4188 &quot;a_key&quot;: &quot;A String&quot;,
4189 },
4190 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
4191 # type or metric.
4192 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
4193 # or metric.
4194 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
4195 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
4196 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
4197 },
4198 },
4199 ],
4200 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
4201 # This property is optional.
4202 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
4203 },
4204 ],
4205 },
4206 &quot;timestamp&quot;: &quot;A String&quot;, # Output only. Timestamp is shown only if there is an error. The field
4207 # has // RFC3339 //
4208 # text format.
4209 },
4210 },
4211 ],
4212 &quot;autoscaler&quot;: &quot;A String&quot;, # Output only. The URL of theAutoscaler
4213 # that targets this instance group manager.
4214 &quot;bulkInstanceOperation&quot;: { # Bulk instance operation is the creation of VMs in a MIG when the # Output only. The status of bulk instance operation.
4215 # targetSizePolicy.mode is set to BULK.
4216 &quot;inProgress&quot;: True or False, # Output only. Informs whether bulk instance operation is in progress.
4217 &quot;lastProgressCheck&quot;: { # Output only. Information from the last progress check of bulk instance
4218 # operation.
4219 &quot;error&quot;: { # Output only. Errors encountered during bulk instance operation.
4220 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
4221 # operation.
4222 {
4223 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
4224 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
4225 # details. There is a set of defined message types to use for providing
4226 # details.The syntax depends on the error code. For example,
4227 # QuotaExceededInfo will have details when the error code is
4228 # QUOTA_EXCEEDED.
4229 {
4230 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
4231 #
4232 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
4233 # is not enabled:
4234 #
4235 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
4236 # &quot;domain&quot;: &quot;googleapis.com&quot;
4237 # &quot;metadata&quot;: {
4238 # &quot;resource&quot;: &quot;projects/123&quot;,
4239 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
4240 # }
4241 # }
4242 #
4243 # This response indicates that the pubsub.googleapis.com API is not enabled.
4244 #
4245 # Example of an error that is returned when attempting to create a Spanner
4246 # instance in a region that is out of stock:
4247 #
4248 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
4249 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
4250 # &quot;metadata&quot;: {
4251 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
4252 # }
4253 # }
4254 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
4255 # is typically the registered service name of the tool or product that
4256 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
4257 # generated by some common infrastructure, the error domain must be a
4258 # globally unique value that identifies the infrastructure. For Google API
4259 # infrastructure, the error domain is &quot;googleapis.com&quot;.
4260 &quot;metadatas&quot;: { # Additional structured details about this error.
4261 #
4262 # Keys must match a regular expression of `a-z+` but should
4263 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
4264 # length. When identifying the current value of an exceeded limit, the units
4265 # should be contained in the key, not the value. For example, rather than
4266 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
4267 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
4268 # instances that can be created in a single (batch) request.
4269 &quot;a_key&quot;: &quot;A String&quot;,
4270 },
4271 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
4272 # proximate cause of the error. Error reasons are unique within a particular
4273 # domain of errors. This should be at most 63 characters and match a
4274 # regular expression of `A-Z+[A-Z0-9]`, which represents
4275 # UPPER_SNAKE_CASE.
4276 },
4277 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
4278 #
4279 # For example, if a quota check failed with an error indicating the calling
4280 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
4281 # directly to the right place in the developer console to flip the bit.
4282 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
4283 { # Describes a URL link.
4284 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
4285 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
4286 },
4287 ],
4288 },
4289 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
4290 # which can be attached to an RPC error.
4291 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
4292 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
4293 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
4294 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
4295 },
4296 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
4297 &quot;dimensions&quot;: { # The map holding related quota dimensions.
4298 &quot;a_key&quot;: &quot;A String&quot;,
4299 },
4300 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
4301 # type or metric.
4302 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
4303 # or metric.
4304 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
4305 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
4306 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
4307 },
4308 },
4309 ],
4310 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
4311 # This property is optional.
4312 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
4313 },
4314 ],
4315 },
4316 &quot;timestamp&quot;: &quot;A String&quot;, # Output only. Timestamp of the last progress check of bulk instance
4317 # operation. Timestamp is in RFC3339 text format.
4318 },
4319 },
4320 &quot;currentInstanceStatuses&quot;: { # The list of instance statuses and the number of instances in this managed # Output only. The list of instance statuses and the number of instances
4321 # in this managed instance group that have the status. Currently only shown
4322 # for TPU MIGs
4323 # instance group that have the status. For more information about how to
4324 # interpret each status check the instance lifecycle documentation.
4325 # Currently only shown for TPU MIGs.
4326 &quot;deprovisioning&quot;: 42, # Output only. The number of instances in the managed instance group
4327 # that have DEPROVISIONING status.
4328 &quot;nonExistent&quot;: 42, # Output only. The number of instances that have not been created yet or
4329 # have been deleted. Includes only instances that would be shown in the
4330 # listManagedInstances method and not all instances that have been
4331 # deleted in the lifetime of the MIG.
4332 # Does not include FlexStart instances that are waiting for the resources
4333 # availability, they are considered as &#x27;pending&#x27;.
4334 &quot;pending&quot;: 42, # Output only. The number of instances in the managed instance group
4335 # that have PENDING status, that is FlexStart instances that are waiting
4336 # for resources. Instances that do not exist because of the other reasons
4337 # are counted as &#x27;non_existent&#x27;.
4338 &quot;pendingStop&quot;: 42, # Output only. The number of instances in the managed instance group
4339 # that have PENDING_STOP status.
4340 &quot;provisioning&quot;: 42, # Output only. The number of instances in the managed instance group
4341 # that have PROVISIONING status.
4342 &quot;repairing&quot;: 42, # Output only. The number of instances in the managed instance group
4343 # that have REPAIRING status.
4344 &quot;running&quot;: 42, # Output only. The number of instances in the managed instance group
4345 # that have RUNNING status.
4346 &quot;staging&quot;: 42, # Output only. The number of instances in the managed instance group
4347 # that have STAGING status.
4348 &quot;stopped&quot;: 42, # Output only. The number of instances in the managed instance group
4349 # that have STOPPED status.
4350 &quot;stopping&quot;: 42, # Output only. The number of instances in the managed instance group
4351 # that have STOPPING status.
4352 &quot;suspended&quot;: 42, # Output only. The number of instances in the managed instance group
4353 # that have SUSPENDED status.
4354 &quot;suspending&quot;: 42, # Output only. The number of instances in the managed instance group
4355 # that have SUSPENDING status.
4356 &quot;terminated&quot;: 42, # Output only. The number of instances in the managed instance group
4357 # that have TERMINATED status.
4358 },
4359 &quot;isStable&quot;: True or False, # Output only. A bit indicating whether the managed instance group is in a
4360 # stable state. A stable state means that: none of the instances in the
4361 # managed instance group is currently undergoing any type of change (for
4362 # example, creation, restart, or deletion); no future changes are scheduled
4363 # for instances in the managed instance group; and the managed instance
4364 # group itself is not being modified.
4365 &quot;stateful&quot;: { # Output only. Stateful status of the given Instance Group Manager.
4366 &quot;hasStatefulConfig&quot;: True or False, # Output only. A bit indicating whether the managed instance group
4367 # has stateful configuration, that is, if you have configured any items
4368 # in a stateful policy or in per-instance configs.
4369 # The group might report that it has no stateful configuration even when
4370 # there is still some preserved state on a managed instance, for example,
4371 # if you have deleted all PICs but not yet applied those deletions.
4372 &quot;perInstanceConfigs&quot;: { # Output only. Status of per-instance configurations on the instances.
4373 &quot;allEffective&quot;: True or False, # Output only. A bit indicating if all of the group&#x27;s per-instance configurations
4374 # (listed in the output of a listPerInstanceConfigs API call) have
4375 # status EFFECTIVE or there are no per-instance-configs.
4376 },
4377 },
4378 &quot;versionTarget&quot;: { # Output only. A status of consistency of Instances&#x27; versions with their
4379 # target version specified by version field on Instance Group
4380 # Manager.
4381 &quot;isReached&quot;: True or False, # Output only. A bit indicating whether version target has been reached
4382 # in this managed instance group, i.e. all instances are in their target
4383 # version. Instances&#x27; target version are specified byversion field on Instance Group Manager.
4384 },
4385 },
4386 &quot;targetPools&quot;: [ # The URLs for all TargetPool resources to which instances in theinstanceGroup field are added. The target pools automatically
4387 # apply to all of the instances in the managed instance group.
4388 &quot;A String&quot;,
4389 ],
4390 &quot;targetSize&quot;: 42, # The target number of running instances for this managed instance group.
4391 # You can reduce this number by using the instanceGroupManager
4392 # deleteInstances or abandonInstances methods. Resizing the group also
4393 # changes this number.
4394 &quot;targetSizePolicy&quot;: { # The policy that specifies how the MIG creates its VMs to achieve the target
4395 # size.
4396 &quot;mode&quot;: &quot;A String&quot;, # The mode of target size policy based on which the MIG creates its VMs
4397 # individually or all at once.
4398 },
4399 &quot;targetStoppedSize&quot;: 42, # The target number of stopped instances for this managed instance group.
4400 # This number changes when you:
4401 #
4402 # - Stop instance using the stopInstances
4403 # method or start instances using the startInstances
4404 # method.
4405 # - Manually change the targetStoppedSize using the update
4406 # method.
4407 &quot;targetSuspendedSize&quot;: 42, # The target number of suspended instances for this managed instance group.
4408 # This number changes when you:
4409 #
4410 # - Suspend instance using the suspendInstances
4411 # method or resume instances using the resumeInstances
4412 # method.
4413 # - Manually change the targetSuspendedSize using the update
4414 # method.
4415 &quot;updatePolicy&quot;: { # The update policy for this managed instance group.
4416 &quot;instanceRedistributionType&quot;: &quot;A String&quot;, # The
4417 # instance redistribution policy for regional managed instance groups.
4418 # Valid values are:
4419 #
4420 # - PROACTIVE (default): The group attempts to maintain an
4421 # even distribution of VM instances across zones in the region.
4422 # - NONE: For non-autoscaled groups, proactive
4423 # redistribution is disabled.
4424 &quot;maxSurge&quot;: { # Encapsulates numeric value that can be either absolute or relative. # The maximum number of instances that can be created above the specifiedtargetSize during the update process. This value can be
4425 # either a fixed number or, if the group has 10 or more instances, a
4426 # percentage. If you set a percentage, the number of instances is rounded
4427 # if necessary. The default value for maxSurge is a fixed
4428 # value equal to the number of zones in which the managed instance group
4429 # operates.
4430 #
4431 # At least one of either maxSurge ormaxUnavailable must be greater than 0. Learn more about maxSurge.
4432 &quot;calculated&quot;: 42, # Output only. Absolute value of VM instances calculated based on the specific mode.
4433 #
4434 #
4435 #
4436 # - If the value is fixed, then the calculated
4437 # value is equal to the fixed value.
4438 # - If the value is a percent, then the
4439 # calculated
4440 # value is percent/100 * targetSize. For example,
4441 # the calculated value of a 80% of a managed instance group
4442 # with 150 instances would be (80/100 * 150) = 120 VM instances. If there
4443 # is a remainder, the number is rounded.
4444 &quot;fixed&quot;: 42, # Specifies a fixed number of VM instances. This must be a positive integer.
4445 &quot;percent&quot;: 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For
4446 # example, specify 80 for 80%.
4447 },
4448 &quot;maxUnavailable&quot;: { # Encapsulates numeric value that can be either absolute or relative. # The maximum number of instances that can be unavailable during the update
4449 # process. An instance is considered available if all of the following
4450 # conditions are satisfied:
4451 #
4452 #
4453 #
4454 # - The instance&#x27;s status is
4455 # RUNNING.
4456 # - If there is a health
4457 # check on the instance group, the instance&#x27;s health check status
4458 # must be HEALTHY at least once. If there is no health check
4459 # on the group, then the instance only needs to have a status of
4460 # RUNNING to be considered available.
4461 #
4462 #
4463 # This value can be either a fixed number or, if the group has 10 or more
4464 # instances, a percentage. If you set a percentage, the number of instances
4465 # is rounded if necessary. The default value formaxUnavailable is a fixed value equal to the number of zones
4466 # in which the managed instance group operates.
4467 #
4468 # At least one of either maxSurge ormaxUnavailable must be greater than 0. Learn more about maxUnavailable.
4469 &quot;calculated&quot;: 42, # Output only. Absolute value of VM instances calculated based on the specific mode.
4470 #
4471 #
4472 #
4473 # - If the value is fixed, then the calculated
4474 # value is equal to the fixed value.
4475 # - If the value is a percent, then the
4476 # calculated
4477 # value is percent/100 * targetSize. For example,
4478 # the calculated value of a 80% of a managed instance group
4479 # with 150 instances would be (80/100 * 150) = 120 VM instances. If there
4480 # is a remainder, the number is rounded.
4481 &quot;fixed&quot;: 42, # Specifies a fixed number of VM instances. This must be a positive integer.
4482 &quot;percent&quot;: 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For
4483 # example, specify 80 for 80%.
4484 },
4485 &quot;minimalAction&quot;: &quot;A String&quot;, # Minimal action to be taken on an instance. Use this option to minimize
4486 # disruption as much as possible or to apply a more disruptive action than
4487 # is necessary.
4488 #
4489 # - To limit disruption as much as possible, set the minimal action toREFRESH. If your update requires a more disruptive action,
4490 # Compute Engine performs the necessary action to execute the update.
4491 # - To apply a more disruptive action than is strictly necessary, set the
4492 # minimal action to RESTART or REPLACE. For
4493 # example, Compute Engine does not need to restart a VM to change its
4494 # metadata. But if your application reads instance metadata only when a VM
4495 # is restarted, you can set the minimal action to RESTART in
4496 # order to pick up metadata changes.
4497 &quot;mostDisruptiveAllowedAction&quot;: &quot;A String&quot;, # Most disruptive action that is allowed to be taken on an instance.
4498 # You can specify either NONE to forbid any actions,REFRESH to avoid restarting the VM and to limit disruption
4499 # as much as possible. RESTART to allow actions that can be
4500 # applied without instance replacing or REPLACE to allow all
4501 # possible actions. If the Updater determines that the minimal update
4502 # action needed is more disruptive than most disruptive allowed action you
4503 # specify it will not perform the update at all.
4504 &quot;replacementMethod&quot;: &quot;A String&quot;, # What action should be used to replace instances.
4505 # See minimal_action.REPLACE
4506 &quot;type&quot;: &quot;A String&quot;, # The type
4507 # of update process. You can specify either PROACTIVE so
4508 # that the MIG automatically updates VMs to the latest configurations orOPPORTUNISTIC so that you can select the VMs that you want
4509 # to update.
4510 },
4511 &quot;versions&quot;: [ # Specifies the instance templates used by this managed instance group to
4512 # create instances.
4513 #
4514 # Each version is defined by an instanceTemplate and aname. Every version can appear at most once per instance
4515 # group. This field overrides the top-level instanceTemplate
4516 # field. Read more about therelationships
4517 # between these fields. Exactly one version must leave thetargetSize field unset. That version will be applied to all
4518 # remaining instances. For more information, read aboutcanary
4519 # updates.
4520 {
4521 &quot;instanceTemplate&quot;: &quot;A String&quot;, # The URL of the instance template that is specified for this managed
4522 # instance group. The group uses this template to create new instances in
4523 # the managed instance group until the `targetSize` for this version is
4524 # reached. The templates for existing instances in the group do not change
4525 # unless you run recreateInstances, runapplyUpdatesToInstances, or set the group&#x27;supdatePolicy.type to PROACTIVE; in those cases,
4526 # existing instances are updated until the `targetSize` for this version is
4527 # reached.
4528 &quot;name&quot;: &quot;A String&quot;, # Name of the version. Unique among all versions in the scope of this
4529 # managed instance group.
4530 &quot;targetSize&quot;: { # Encapsulates numeric value that can be either absolute or relative. # Specifies the intended number of instances to be created from theinstanceTemplate. The final number of instances created
4531 # from the template will be equal to:
4532 #
4533 #
4534 # - If expressed as a fixed number, the minimum of either
4535 # targetSize.fixed or
4536 # instanceGroupManager.targetSize is used.
4537 # - if expressed as a percent, the targetSize
4538 # would be (targetSize.percent/100 *
4539 # InstanceGroupManager.targetSize) If there is a remainder, the
4540 # number is rounded.
4541 #
4542 # If unset, this version will update any remaining instances not
4543 # updated by another version. ReadStarting
4544 # a canary update for more information.
4545 &quot;calculated&quot;: 42, # Output only. Absolute value of VM instances calculated based on the specific mode.
4546 #
4547 #
4548 #
4549 # - If the value is fixed, then the calculated
4550 # value is equal to the fixed value.
4551 # - If the value is a percent, then the
4552 # calculated
4553 # value is percent/100 * targetSize. For example,
4554 # the calculated value of a 80% of a managed instance group
4555 # with 150 instances would be (80/100 * 150) = 120 VM instances. If there
4556 # is a remainder, the number is rounded.
4557 &quot;fixed&quot;: 42, # Specifies a fixed number of VM instances. This must be a positive integer.
4558 &quot;percent&quot;: 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For
4559 # example, specify 80 for 80%.
4560 },
4561 },
4562 ],
4563 &quot;zone&quot;: &quot;A String&quot;, # Output only. The URL of azone
4564 # where the managed instance group is located (for zonal resources).
4565 }
4566
4567 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
4568 that if you must retry your request, the server will know to ignore the
4569 request if it has already been completed.
4570
4571 For example, consider a situation where you make an initial request and
4572 the request times out. If you make the request again with the same
4573 request ID, the server can check if original operation with the same
4574 request ID was received, and if so, will ignore the second request. This
4575 prevents clients from accidentally creating duplicate commitments.
4576
4577 The request ID must be
4578 a valid UUID with the exception that zero UUID is not supported
4579 (00000000-0000-0000-0000-000000000000).
4580 x__xgafv: string, V1 error format.
4581 Allowed values
4582 1 - v1 error format
4583 2 - v2 error format
4584
4585 Returns:
4586 An object of the form:
4587
4588 { # Represents an Operation resource.
4589 #
4590 # Google Compute Engine has three Operation resources:
4591 #
4592 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
4593 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
4594 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
4595 #
4596 # You can use an operation resource to manage asynchronous API requests.
4597 # For more information, readHandling
4598 # API responses.
4599 #
4600 # Operations can be global, regional or zonal.
4601 #
4602 # - For global operations, use the `globalOperations`
4603 # resource.
4604 # - For regional operations, use the
4605 # `regionOperations` resource.
4606 # - For zonal operations, use
4607 # the `zoneOperations` resource.
4608 #
4609 #
4610 #
4611 # For more information, read
4612 # Global, Regional, and Zonal Resources.
4613 #
4614 # Note that completed Operation resources have a limited
4615 # retention period.
4616 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
4617 # Not present otherwise.
4618 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
4619 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
4620 # set when the operation is created.
4621 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
4622 # text format.
4623 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
4624 # this field will be populated.
4625 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
4626 # operation.
4627 {
4628 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
4629 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
4630 # details. There is a set of defined message types to use for providing
4631 # details.The syntax depends on the error code. For example,
4632 # QuotaExceededInfo will have details when the error code is
4633 # QUOTA_EXCEEDED.
4634 {
4635 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
4636 #
4637 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
4638 # is not enabled:
4639 #
4640 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
4641 # &quot;domain&quot;: &quot;googleapis.com&quot;
4642 # &quot;metadata&quot;: {
4643 # &quot;resource&quot;: &quot;projects/123&quot;,
4644 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
4645 # }
4646 # }
4647 #
4648 # This response indicates that the pubsub.googleapis.com API is not enabled.
4649 #
4650 # Example of an error that is returned when attempting to create a Spanner
4651 # instance in a region that is out of stock:
4652 #
4653 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
4654 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
4655 # &quot;metadata&quot;: {
4656 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
4657 # }
4658 # }
4659 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
4660 # is typically the registered service name of the tool or product that
4661 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
4662 # generated by some common infrastructure, the error domain must be a
4663 # globally unique value that identifies the infrastructure. For Google API
4664 # infrastructure, the error domain is &quot;googleapis.com&quot;.
4665 &quot;metadatas&quot;: { # Additional structured details about this error.
4666 #
4667 # Keys must match a regular expression of `a-z+` but should
4668 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
4669 # length. When identifying the current value of an exceeded limit, the units
4670 # should be contained in the key, not the value. For example, rather than
4671 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
4672 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
4673 # instances that can be created in a single (batch) request.
4674 &quot;a_key&quot;: &quot;A String&quot;,
4675 },
4676 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
4677 # proximate cause of the error. Error reasons are unique within a particular
4678 # domain of errors. This should be at most 63 characters and match a
4679 # regular expression of `A-Z+[A-Z0-9]`, which represents
4680 # UPPER_SNAKE_CASE.
4681 },
4682 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
4683 #
4684 # For example, if a quota check failed with an error indicating the calling
4685 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
4686 # directly to the right place in the developer console to flip the bit.
4687 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
4688 { # Describes a URL link.
4689 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
4690 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
4691 },
4692 ],
4693 },
4694 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
4695 # which can be attached to an RPC error.
4696 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
4697 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
4698 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
4699 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
4700 },
4701 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
4702 &quot;dimensions&quot;: { # The map holding related quota dimensions.
4703 &quot;a_key&quot;: &quot;A String&quot;,
4704 },
4705 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
4706 # type or metric.
4707 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
4708 # or metric.
4709 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
4710 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
4711 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
4712 },
4713 },
4714 ],
4715 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
4716 # This property is optional.
4717 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
4718 },
4719 ],
4720 },
4721 &quot;getVersionOperationMetadata&quot;: {
4722 &quot;inlineSbomInfo&quot;: {
4723 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
4724 # appropriate identifiers.
4725 &quot;a_key&quot;: &quot;A String&quot;,
4726 },
4727 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
4728 # identifiers.
4729 &quot;a_key&quot;: &quot;A String&quot;,
4730 },
4731 },
4732 },
4733 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
4734 # message that was returned, such as `NOT FOUND`.
4735 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
4736 # status code that was returned. For example, a `404` means the
4737 # resource was not found.
4738 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
4739 # defined by the server.
4740 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
4741 # This value is inRFC3339
4742 # text format.
4743 &quot;instancesBulkInsertOperationMetadata&quot;: {
4744 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
4745 # Example key: zones/us-central1-a
4746 &quot;a_key&quot;: {
4747 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
4748 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
4749 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
4750 # error.
4751 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
4752 # if the flow is rolling forward or rolling back.
4753 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
4754 },
4755 },
4756 },
4757 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
4758 # Operation resources.
4759 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
4760 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
4761 # group of operations results from a `bulkInsert` API request.
4762 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
4763 # `update`, or `delete`, and so on.
4764 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
4765 # There is no requirement that this be linear or support any granularity of
4766 # operations. This should not be used to guess when the operation will be
4767 # complete. This number should monotonically increase as the operation
4768 # progresses.
4769 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
4770 # applicable when performing regional operations.
4771 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
4772 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
4773 # this field will contain information on all underlying zonal actions and
4774 # their state.
4775 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
4776 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
4777 # Example key: zones/us-central1-a
4778 &quot;a_key&quot;: {
4779 &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
4780 # populated.
4781 # different programming environments, including REST APIs and RPC APIs. It is
4782 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
4783 # three pieces of data: error code, error message, and error details.
4784 #
4785 # You can find out more about this error model and how to work with it in the
4786 # [API Design Guide](https://cloud.google.com/apis/design/errors).
4787 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
4788 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
4789 # message types for APIs to use.
4790 {
4791 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
4792 },
4793 ],
4794 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
4795 # user-facing error message should be localized and sent in the
4796 # google.rpc.Status.details field, or localized by the client.
4797 },
4798 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
4799 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
4800 },
4801 },
4802 },
4803 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
4804 # This value is inRFC3339
4805 # text format.
4806 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
4807 # following:
4808 # `PENDING`, `RUNNING`, or `DONE`.
4809 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
4810 # operation.
4811 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
4812 # of the target resource.
4813 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
4814 # operations related to creating a snapshot, this points to the disk
4815 # that the snapshot was created from.
4816 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
4817 # `[email protected]` or
4818 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
4819 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
4820 # operation, this field will be populated.
4821 {
4822 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
4823 # Engine returns NO_RESULTS_ON_PAGE if there
4824 # are no results in the response.
4825 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
4826 # value format. For example:
4827 #
4828 # &quot;data&quot;: [
4829 # {
4830 # &quot;key&quot;: &quot;scope&quot;,
4831 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
4832 # }
4833 {
4834 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
4835 # returned. For example, for warnings where there are no results in a list
4836 # request for a particular zone, this key might be scope and
4837 # the key value might be the zone name. Other examples might be a key
4838 # indicating a deprecated resource and a suggested replacement, or a
4839 # warning about invalid network settings (for example, if an instance
4840 # attempts to perform IP forwarding but is not enabled for IP forwarding).
4841 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
4842 },
4843 ],
4844 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
4845 },
4846 ],
4847 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
4848 # applicable when performing per-zone operations.
4849 }</pre>
4850 </div>
4851
4852 <div class="method">
4853 <code class="details" id="list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
4854 <pre>Retrieves a list of managed instance groups that are contained within the
4855 specified project and zone.
4856
4857 Args:
4858 project: string, Project ID for this request. (required)
4859 zone: string, The name of thezone where the managed
4860 instance group is located. (required)
4861 filter: string, A filter expression that filters resources listed in the response. Most
4862 Compute resources support two types of filter expressions:
4863 expressions that support regular expressions and expressions that follow
4864 API improvement proposal AIP-160.
4865 These two types of filter expressions cannot be mixed in one request.
4866
4867 If you want to use AIP-160, your expression must specify the field name, an
4868 operator, and the value that you want to use for filtering. The value
4869 must be a string, a number, or a boolean. The operator
4870 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
4871
4872 For example, if you are filtering Compute Engine instances, you can
4873 exclude instances named `example-instance` by specifying
4874 `name != example-instance`.
4875
4876 The `:*` comparison can be used to test whether a key has been defined.
4877 For example, to find all objects with `owner` label use:
4878 ```
4879 labels.owner:*
4880 ```
4881
4882 You can also filter nested fields. For example, you could specify
4883 `scheduling.automaticRestart = false` to include instances only
4884 if they are not scheduled for automatic restarts. You can use filtering
4885 on nested fields to filter based onresource labels.
4886
4887 To filter on multiple expressions, provide each separate expression within
4888 parentheses. For example:
4889 ```
4890 (scheduling.automaticRestart = true)
4891 (cpuPlatform = &quot;Intel Skylake&quot;)
4892 ```
4893 By default, each expression is an `AND` expression. However, you
4894 can include `AND` and `OR` expressions explicitly.
4895 For example:
4896 ```
4897 (cpuPlatform = &quot;Intel Skylake&quot;) OR
4898 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
4899 (scheduling.automaticRestart = true)
4900 ```
4901
4902 If you want to use a regular expression, use the `eq` (equal) or `ne`
4903 (not equal) operator against a single un-parenthesized expression with or
4904 without quotes or against multiple parenthesized expressions. Examples:
4905
4906 `fieldname eq unquoted literal`
4907 `fieldname eq &#x27;single quoted literal&#x27;`
4908 `fieldname eq &quot;double quoted literal&quot;`
4909 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
4910
4911 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
4912 The literal value must match the entire field.
4913
4914 For example, to filter for instances that do not end with name &quot;instance&quot;,
4915 you would use `name ne .*instance`.
4916
4917 You cannot combine constraints on multiple fields using regular
4918 expressions.
4919 maxResults: integer, The maximum number of results per page that should be returned.
4920 If the number of available results is larger than `maxResults`,
4921 Compute Engine returns a `nextPageToken` that can be used to get
4922 the next page of results in subsequent list requests. Acceptable values are
4923 `0` to `500`, inclusive. (Default: `500`)
4924 orderBy: string, Sorts list results by a certain order. By default, results
4925 are returned in alphanumerical order based on the resource name.
4926
4927 You can also sort results in descending order based on the creation
4928 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
4929 results based on the `creationTimestamp` field in
4930 reverse chronological order (newest result first). Use this to sort
4931 resources like operations so that the newest operation is returned first.
4932
4933 Currently, only sorting by `name` or
4934 `creationTimestamp desc` is supported.
4935 pageToken: string, Specifies a page token to use. Set `pageToken` to the
4936 `nextPageToken` returned by a previous list request to get
4937 the next page of results.
4938 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
4939 of failure. The default value is false.
4940
4941 For example, when partial success behavior is enabled, aggregatedList for a
4942 single zone scope either returns all resources in the zone or no resources,
4943 with an error code.
4944 x__xgafv: string, V1 error format.
4945 Allowed values
4946 1 - v1 error format
4947 2 - v2 error format
4948
4949 Returns:
4950 An object of the form:
4951
4952 { # [Output Only] A list of managed instance groups.
4953 &quot;id&quot;: &quot;A String&quot;, # Output only. Unique identifier for the resource; defined by the server.
4954 &quot;items&quot;: [ # A list of InstanceGroupManager resources.
4955 { # Represents a Managed Instance Group resource.
4956 #
4957 # An instance group is a collection of VM instances that you can manage as a
4958 # single entity. For more information, readInstance groups.
4959 #
4960 # For zonal Managed Instance Group, use the instanceGroupManagers
4961 # resource.
4962 #
4963 # For regional Managed Instance Group, use theregionInstanceGroupManagers resource.
4964 &quot;allInstancesConfig&quot;: { # Specifies configuration that overrides the instance template configuration
4965 # for the group.
4966 &quot;properties&quot;: { # Represents the change that you want to make to the instance properties. # Properties to set on all instances in the group.
4967 #
4968 # You can add or modify properties using theinstanceGroupManagers.patch orregionInstanceGroupManagers.patch. After settingallInstancesConfig on the group, you must update the group&#x27;s
4969 # instances to apply the configuration. To apply the configuration, set the
4970 # group&#x27;s updatePolicy.type field to use proactive updates or
4971 # use the applyUpdatesToInstances method.
4972 &quot;labels&quot;: { # The label key-value pairs that you want to patch onto the instance.
4973 &quot;a_key&quot;: &quot;A String&quot;,
4974 },
4975 &quot;metadata&quot;: { # The metadata key-value pairs that you want to patch onto the instance. For
4976 # more information, see Project and
4977 # instance metadata.
4978 &quot;a_key&quot;: &quot;A String&quot;,
4979 },
4980 },
4981 },
4982 &quot;autoHealingPolicies&quot;: [ # The autohealing policy for this managed instance group. You can specify
4983 # only one value.
4984 {
4985 &quot;healthCheck&quot;: &quot;A String&quot;, # The URL for the health check that signals autohealing.
4986 &quot;initialDelaySec&quot;: 42, # The initial delay is the number of seconds that a new VM takes to
4987 # initialize and run its startup script. During a VM&#x27;s initial delay
4988 # period, the MIG ignores unsuccessful health checks because the VM might
4989 # be in the startup process. This prevents the MIG from prematurely
4990 # recreating a VM. If the health check receives a healthy response during
4991 # the initial delay, it indicates that the startup process is complete and
4992 # the VM is ready. The value of initial delay must be between 0 and 3600
4993 # seconds. The default value is 0.
4994 },
4995 ],
4996 &quot;baseInstanceName&quot;: &quot;A String&quot;, # The base instance name is a prefix that you want to attach to the names of
4997 # all VMs in a MIG. The maximum character length is 58 and the name must
4998 # comply with RFC1035 format.
4999 #
5000 # When a VM is created in the group, the MIG appends a hyphen and a random
5001 # four-character string to the base instance name. If you want the MIG to
5002 # assign sequential numbers instead of a random string, then end the base
5003 # instance name with a hyphen followed by one or more hash symbols. The hash
5004 # symbols indicate the number of digits. For example, a base instance name of
5005 # &quot;vm-###&quot; results in &quot;vm-001&quot; as a VM name.
5006 # @pattern
5007 # [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,51}-#{1,10}(\\[[0-9]{1,10}\\])?))
5008 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. The creation timestamp for this managed instance group inRFC3339
5009 # text format.
5010 &quot;currentActions&quot;: { # Output only. The list of instance actions and the number of instances
5011 # in this managed instance group that are scheduled for each of those
5012 # actions.
5013 &quot;abandoning&quot;: 42, # Output only. The total number of instances in the managed instance group
5014 # that are scheduled to be abandoned. Abandoning an instance removes it
5015 # from the managed instance group without deleting it.
5016 &quot;creating&quot;: 42, # Output only. The number of instances in the managed instance group that
5017 # are scheduled to be created or are currently being created. If the group
5018 # fails to create any of these instances, it tries again until it creates
5019 # the instance successfully.
5020 #
5021 # If you have disabled creation retries, this field will not be populated;
5022 # instead, the creatingWithoutRetries field will be populated.
5023 &quot;creatingWithoutRetries&quot;: 42, # Output only. The number of instances that the managed instance group
5024 # will attempt to create. The group attempts to create each instance
5025 # only once. If the group fails to create any of these instances, it
5026 # decreases the group&#x27;s targetSize value accordingly.
5027 &quot;deleting&quot;: 42, # Output only. The number of instances in the managed instance group that
5028 # are scheduled to be deleted or are currently being deleted.
5029 &quot;none&quot;: 42, # Output only. The number of instances in the managed instance group that
5030 # are running and have no scheduled actions.
5031 &quot;recreating&quot;: 42, # Output only. The number of instances in the managed instance group that
5032 # are scheduled to be recreated or are currently being being recreated.
5033 # Recreating an instance deletes the existing root persistent disk
5034 # and creates a new disk from the image that is defined in the
5035 # instance template.
5036 &quot;refreshing&quot;: 42, # Output only. The number of instances in the managed instance group that
5037 # are being reconfigured with properties that do not require a restart
5038 # or a recreate action. For example, setting or removing target
5039 # pools for the instance.
5040 &quot;restarting&quot;: 42, # Output only. The number of instances in the managed instance group that
5041 # are scheduled to be restarted or are currently being restarted.
5042 &quot;resuming&quot;: 42, # Output only. The number of instances in the managed instance group that
5043 # are scheduled to be resumed or are currently being resumed.
5044 &quot;starting&quot;: 42, # Output only. The number of instances in the managed instance group that
5045 # are scheduled to be started or are currently being started.
5046 &quot;stopping&quot;: 42, # Output only. The number of instances in the managed instance group that
5047 # are scheduled to be stopped or are currently being stopped.
5048 &quot;suspending&quot;: 42, # Output only. The number of instances in the managed instance group that
5049 # are scheduled to be suspended or are currently being suspended.
5050 &quot;verifying&quot;: 42, # Output only. The number of instances in the managed instance group that
5051 # are being verified. See the managedInstances[].currentAction
5052 # property in the listManagedInstances method documentation.
5053 },
5054 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource.
5055 &quot;distributionPolicy&quot;: { # Policy specifying the intended distribution of managed instances across
5056 # zones in a regional managed instance group.
5057 &quot;targetShape&quot;: &quot;A String&quot;, # The distribution shape to which the group converges either proactively or
5058 # on resize events (depending on the value set inupdatePolicy.instanceRedistributionType).
5059 &quot;zones&quot;: [ # Zones where the regional managed instance group will create and manage
5060 # its instances.
5061 # By default, a regional MIG doesn&#x27;t automatically select an AI zone to create
5062 # instances, even if an AI zone is available in the specified region. To
5063 # create instances in an AI zone in the selected region, you must explicitly
5064 # specify it in the distribution policy together with the other preferred
5065 # zones.
5066 {
5067 &quot;zone&quot;: &quot;A String&quot;, # The URL of thezone.
5068 # The zone must exist in the region where the managed instance group is
5069 # located.
5070 },
5071 ],
5072 },
5073 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. This field may be used in optimistic locking.
5074 # It will be ignored when inserting an InstanceGroupManager. An up-to-date
5075 # fingerprint must be provided in order to update the InstanceGroupManager,
5076 # otherwise the request will fail with error412 conditionNotMet.
5077 #
5078 # To see the latest fingerprint, make a get() request to
5079 # retrieve an InstanceGroupManager.
5080 &quot;id&quot;: &quot;A String&quot;, # Output only. A unique identifier for this resource type. The server
5081 # generates this identifier.
5082 &quot;instanceFlexibilityPolicy&quot;: { # Instance flexibility allowing MIG to create VMs from multiple
5083 # types of machines.
5084 # Instance flexibility configuration on MIG overrides instance
5085 # template configuration.
5086 &quot;instanceSelections&quot;: { # Named instance selections configuring properties that the group will use
5087 # when creating new VMs.
5088 &quot;a_key&quot;: {
5089 &quot;machineTypes&quot;: [ # Full machine-type names, e.g. &quot;n1-standard-16&quot;.
5090 &quot;A String&quot;,
5091 ],
5092 &quot;rank&quot;: 42, # Preference of this instance selection. Lower number means higher
5093 # preference. MIG will first try to create a VM based on the machine-type
5094 # with lowest rank and fallback to next rank based on availability.
5095 # Machine types and instance selections with the same rank have the same
5096 # preference.
5097 },
5098 },
5099 },
5100 &quot;instanceGroup&quot;: &quot;A String&quot;, # Output only. The URL of the Instance Group resource.
5101 &quot;instanceLifecyclePolicy&quot;: { # The repair policy for this managed instance group.
5102 &quot;defaultActionOnFailure&quot;: &quot;A String&quot;, # The action that a MIG performs on a failed VM. If the value of the
5103 # onFailedHealthCheck field is `DEFAULT_ACTION`, then the same action also
5104 # applies to the VMs on which your application fails a health check.
5105 # Valid values are
5106 #
5107 # - REPAIR (default): MIG automatically repairs a failed VM
5108 # by recreating it. For more information, see About
5109 # repairing VMs in a MIG.
5110 # - DO_NOTHING: MIG does not repair a failed VM.
5111 &quot;forceUpdateOnRepair&quot;: &quot;A String&quot;, # A bit indicating whether to forcefully apply the group&#x27;s latest
5112 # configuration when repairing a VM. Valid options are:
5113 #
5114 #
5115 #
5116 # - NO (default): If configuration updates are available, they are not
5117 # forcefully applied during repair. Instead, configuration updates are
5118 # applied according to the group&#x27;s update policy.
5119 #
5120 # - YES: If configuration updates are available, they are applied
5121 # during repair.
5122 &quot;onFailedHealthCheck&quot;: &quot;A String&quot;, # The action that a MIG performs on an unhealthy VM. A VM is marked as
5123 # unhealthy when the application running on that VM fails a health check.
5124 # Valid values are:
5125 #
5126 # - DEFAULT_ACTION (default): MIG uses the same action
5127 # configured for instanceLifecyclePolicy.defaultActionOnFailure field.
5128 # - REPAIR: MIG automatically repairs an unhealthy VM by
5129 # recreating it.
5130 # - DO_NOTHING: MIG doesn&#x27;t repair an unhealthy VM.
5131 # For more information, see
5132 # About repairing VMs in a MIG.
5133 &quot;onRepair&quot;: { # Configuration for VM repairs in the MIG. # Configuration for VM repairs in the MIG.
5134 &quot;allowChangingZone&quot;: &quot;A String&quot;, # Specifies whether the MIG can change a VM&#x27;s zone during a repair.
5135 # Valid values are:
5136 #
5137 # - NO (default): MIG cannot change a VM&#x27;s zone during a
5138 # repair.
5139 # - YES: MIG can select a different zone for the VM during
5140 # a repair.
5141 },
5142 },
5143 &quot;instanceTemplate&quot;: &quot;A String&quot;, # The URL of the instance template that is specified for this managed
5144 # instance group. The group uses this template to create all new instances
5145 # in the managed instance group. The templates for existing instances in the
5146 # group do not change unless you run recreateInstances, runapplyUpdatesToInstances, or set the group&#x27;supdatePolicy.type to PROACTIVE.
5147 &quot;kind&quot;: &quot;compute#instanceGroupManager&quot;, # Output only. The resource type, which is alwayscompute#instanceGroupManager for managed instance groups.
5148 &quot;listManagedInstancesResults&quot;: &quot;A String&quot;, # Pagination behavior of the listManagedInstances API method for
5149 # this managed instance group.
5150 &quot;name&quot;: &quot;A String&quot;, # The name of the managed instance group. The name must be 1-63 characters
5151 # long, and comply withRFC1035.
5152 &quot;namedPorts&quot;: [ # [Output Only] Named ports configured on the Instance Groups complementary
5153 # to this Instance Group Manager.
5154 { # The named port. For example: &lt;&quot;http&quot;, 80&gt;.
5155 &quot;name&quot;: &quot;A String&quot;, # The name for this named port.
5156 # The name must be 1-63 characters long, and comply withRFC1035.
5157 &quot;port&quot;: 42, # The port number, which can be a value between 1 and 65535.
5158 },
5159 ],
5160 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL of theregion
5161 # where the managed instance group resides (for regional resources).
5162 &quot;resourcePolicies&quot;: { # Resource policies for this managed instance group.
5163 &quot;workloadPolicy&quot;: &quot;A String&quot;, # The URL of the workload policy that is specified for this managed
5164 # instance group.
5165 # It can be a full or partial URL. For example, the following are
5166 # all valid URLs to a workload policy:
5167 #
5168 #
5169 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/resourcePolicies/resourcePolicy
5170 # - projects/project/regions/region/resourcePolicies/resourcePolicy
5171 # - regions/region/resourcePolicies/resourcePolicy
5172 },
5173 &quot;satisfiesPzi&quot;: True or False, # Output only. Reserved for future use.
5174 &quot;satisfiesPzs&quot;: True or False, # Output only. Reserved for future use.
5175 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. The URL for this managed instance group. The server defines
5176 # this URL.
5177 &quot;standbyPolicy&quot;: { # Standby policy for stopped and suspended instances.
5178 &quot;initialDelaySec&quot;: 42, # Specifies the number of seconds that the MIG should wait to suspend or
5179 # stop a VM after that VM was created. The initial delay gives the
5180 # initialization script the time to prepare your VM for a quick scale out.
5181 # The value of initial delay must be between 0 and 3600 seconds. The
5182 # default value is 0.
5183 &quot;mode&quot;: &quot;A String&quot;, # Defines how a MIG resumes or starts VMs from a standby pool when the
5184 # group scales out. The default mode is `MANUAL`.
5185 },
5186 &quot;statefulPolicy&quot;: { # Stateful configuration for this Instanced Group Manager
5187 &quot;preservedState&quot;: { # Configuration of preserved resources.
5188 &quot;disks&quot;: { # Disks created on the instances that will be preserved on instance
5189 # delete, update, etc. This map is keyed with the device names of
5190 # the disks.
5191 &quot;a_key&quot;: {
5192 &quot;autoDelete&quot;: &quot;A String&quot;, # These stateful disks will never be deleted during autohealing,
5193 # update or VM instance recreate operations.
5194 # This flag is used to configure if the disk should be deleted after it
5195 # is no longer used by the group, e.g. when the given instance or
5196 # the whole group is deleted. Note: disks attached inREAD_ONLY mode cannot be auto-deleted.
5197 },
5198 },
5199 &quot;externalIPs&quot;: { # External network IPs assigned to the instances that will be preserved on
5200 # instance delete, update, etc. This map is keyed with the network
5201 # interface name.
5202 &quot;a_key&quot;: {
5203 &quot;autoDelete&quot;: &quot;A String&quot;, # These stateful IPs will never be released during autohealing,
5204 # update or VM instance recreate operations.
5205 # This flag is used to configure if the IP reservation should be deleted
5206 # after it is no longer used by the group, e.g. when the given instance
5207 # or the whole group is deleted.
5208 },
5209 },
5210 &quot;internalIPs&quot;: { # Internal network IPs assigned to the instances that will be preserved on
5211 # instance delete, update, etc. This map is keyed with the network
5212 # interface name.
5213 &quot;a_key&quot;: {
5214 &quot;autoDelete&quot;: &quot;A String&quot;, # These stateful IPs will never be released during autohealing,
5215 # update or VM instance recreate operations.
5216 # This flag is used to configure if the IP reservation should be deleted
5217 # after it is no longer used by the group, e.g. when the given instance
5218 # or the whole group is deleted.
5219 },
5220 },
5221 },
5222 },
5223 &quot;status&quot;: { # Output only. The status of this managed instance group.
5224 &quot;allInstancesConfig&quot;: { # Output only. Status of all-instances configuration on the group.
5225 &quot;currentRevision&quot;: &quot;A String&quot;, # Output only. Current all-instances configuration revision.
5226 # This value is in RFC3339 text format.
5227 &quot;effective&quot;: True or False, # Output only. A bit indicating whether this configuration has
5228 # been applied to all managed instances in the group.
5229 },
5230 &quot;appliedAcceleratorTopologies&quot;: [ # Output only. The accelerator topology applied to this MIG.
5231 # Currently only one accelerator topology is supported.
5232 {
5233 &quot;acceleratorTopology&quot;: &quot;A String&quot;, # Output only. Topology in the format of: &quot;16x16&quot;, &quot;4x4x4&quot;, etc.
5234 # The value is the same as configured in the WorkloadPolicy.
5235 &quot;state&quot;: &quot;A String&quot;, # Output only. The state of the accelerator topology.
5236 &quot;stateDetails&quot;: { # Output only. The result of the latest accelerator topology state
5237 # check.
5238 &quot;error&quot;: { # Output only. Encountered errors.
5239 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
5240 # operation.
5241 {
5242 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
5243 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
5244 # details. There is a set of defined message types to use for providing
5245 # details.The syntax depends on the error code. For example,
5246 # QuotaExceededInfo will have details when the error code is
5247 # QUOTA_EXCEEDED.
5248 {
5249 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
5250 #
5251 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
5252 # is not enabled:
5253 #
5254 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
5255 # &quot;domain&quot;: &quot;googleapis.com&quot;
5256 # &quot;metadata&quot;: {
5257 # &quot;resource&quot;: &quot;projects/123&quot;,
5258 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
5259 # }
5260 # }
5261 #
5262 # This response indicates that the pubsub.googleapis.com API is not enabled.
5263 #
5264 # Example of an error that is returned when attempting to create a Spanner
5265 # instance in a region that is out of stock:
5266 #
5267 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
5268 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
5269 # &quot;metadata&quot;: {
5270 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
5271 # }
5272 # }
5273 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
5274 # is typically the registered service name of the tool or product that
5275 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
5276 # generated by some common infrastructure, the error domain must be a
5277 # globally unique value that identifies the infrastructure. For Google API
5278 # infrastructure, the error domain is &quot;googleapis.com&quot;.
5279 &quot;metadatas&quot;: { # Additional structured details about this error.
5280 #
5281 # Keys must match a regular expression of `a-z+` but should
5282 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
5283 # length. When identifying the current value of an exceeded limit, the units
5284 # should be contained in the key, not the value. For example, rather than
5285 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
5286 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
5287 # instances that can be created in a single (batch) request.
5288 &quot;a_key&quot;: &quot;A String&quot;,
5289 },
5290 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
5291 # proximate cause of the error. Error reasons are unique within a particular
5292 # domain of errors. This should be at most 63 characters and match a
5293 # regular expression of `A-Z+[A-Z0-9]`, which represents
5294 # UPPER_SNAKE_CASE.
5295 },
5296 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
5297 #
5298 # For example, if a quota check failed with an error indicating the calling
5299 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
5300 # directly to the right place in the developer console to flip the bit.
5301 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
5302 { # Describes a URL link.
5303 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
5304 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
5305 },
5306 ],
5307 },
5308 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
5309 # which can be attached to an RPC error.
5310 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
5311 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
5312 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
5313 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
5314 },
5315 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
5316 &quot;dimensions&quot;: { # The map holding related quota dimensions.
5317 &quot;a_key&quot;: &quot;A String&quot;,
5318 },
5319 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
5320 # type or metric.
5321 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
5322 # or metric.
5323 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
5324 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
5325 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
5326 },
5327 },
5328 ],
5329 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
5330 # This property is optional.
5331 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
5332 },
5333 ],
5334 },
5335 &quot;timestamp&quot;: &quot;A String&quot;, # Output only. Timestamp is shown only if there is an error. The field
5336 # has // RFC3339 //
5337 # text format.
5338 },
5339 },
5340 ],
5341 &quot;autoscaler&quot;: &quot;A String&quot;, # Output only. The URL of theAutoscaler
5342 # that targets this instance group manager.
5343 &quot;bulkInstanceOperation&quot;: { # Bulk instance operation is the creation of VMs in a MIG when the # Output only. The status of bulk instance operation.
5344 # targetSizePolicy.mode is set to BULK.
5345 &quot;inProgress&quot;: True or False, # Output only. Informs whether bulk instance operation is in progress.
5346 &quot;lastProgressCheck&quot;: { # Output only. Information from the last progress check of bulk instance
5347 # operation.
5348 &quot;error&quot;: { # Output only. Errors encountered during bulk instance operation.
5349 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
5350 # operation.
5351 {
5352 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
5353 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
5354 # details. There is a set of defined message types to use for providing
5355 # details.The syntax depends on the error code. For example,
5356 # QuotaExceededInfo will have details when the error code is
5357 # QUOTA_EXCEEDED.
5358 {
5359 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
5360 #
5361 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
5362 # is not enabled:
5363 #
5364 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
5365 # &quot;domain&quot;: &quot;googleapis.com&quot;
5366 # &quot;metadata&quot;: {
5367 # &quot;resource&quot;: &quot;projects/123&quot;,
5368 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
5369 # }
5370 # }
5371 #
5372 # This response indicates that the pubsub.googleapis.com API is not enabled.
5373 #
5374 # Example of an error that is returned when attempting to create a Spanner
5375 # instance in a region that is out of stock:
5376 #
5377 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
5378 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
5379 # &quot;metadata&quot;: {
5380 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
5381 # }
5382 # }
5383 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
5384 # is typically the registered service name of the tool or product that
5385 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
5386 # generated by some common infrastructure, the error domain must be a
5387 # globally unique value that identifies the infrastructure. For Google API
5388 # infrastructure, the error domain is &quot;googleapis.com&quot;.
5389 &quot;metadatas&quot;: { # Additional structured details about this error.
5390 #
5391 # Keys must match a regular expression of `a-z+` but should
5392 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
5393 # length. When identifying the current value of an exceeded limit, the units
5394 # should be contained in the key, not the value. For example, rather than
5395 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
5396 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
5397 # instances that can be created in a single (batch) request.
5398 &quot;a_key&quot;: &quot;A String&quot;,
5399 },
5400 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
5401 # proximate cause of the error. Error reasons are unique within a particular
5402 # domain of errors. This should be at most 63 characters and match a
5403 # regular expression of `A-Z+[A-Z0-9]`, which represents
5404 # UPPER_SNAKE_CASE.
5405 },
5406 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
5407 #
5408 # For example, if a quota check failed with an error indicating the calling
5409 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
5410 # directly to the right place in the developer console to flip the bit.
5411 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
5412 { # Describes a URL link.
5413 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
5414 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
5415 },
5416 ],
5417 },
5418 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
5419 # which can be attached to an RPC error.
5420 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
5421 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
5422 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
5423 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
5424 },
5425 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
5426 &quot;dimensions&quot;: { # The map holding related quota dimensions.
5427 &quot;a_key&quot;: &quot;A String&quot;,
5428 },
5429 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
5430 # type or metric.
5431 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
5432 # or metric.
5433 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
5434 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
5435 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
5436 },
5437 },
5438 ],
5439 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
5440 # This property is optional.
5441 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
5442 },
5443 ],
5444 },
5445 &quot;timestamp&quot;: &quot;A String&quot;, # Output only. Timestamp of the last progress check of bulk instance
5446 # operation. Timestamp is in RFC3339 text format.
5447 },
5448 },
5449 &quot;currentInstanceStatuses&quot;: { # The list of instance statuses and the number of instances in this managed # Output only. The list of instance statuses and the number of instances
5450 # in this managed instance group that have the status. Currently only shown
5451 # for TPU MIGs
5452 # instance group that have the status. For more information about how to
5453 # interpret each status check the instance lifecycle documentation.
5454 # Currently only shown for TPU MIGs.
5455 &quot;deprovisioning&quot;: 42, # Output only. The number of instances in the managed instance group
5456 # that have DEPROVISIONING status.
5457 &quot;nonExistent&quot;: 42, # Output only. The number of instances that have not been created yet or
5458 # have been deleted. Includes only instances that would be shown in the
5459 # listManagedInstances method and not all instances that have been
5460 # deleted in the lifetime of the MIG.
5461 # Does not include FlexStart instances that are waiting for the resources
5462 # availability, they are considered as &#x27;pending&#x27;.
5463 &quot;pending&quot;: 42, # Output only. The number of instances in the managed instance group
5464 # that have PENDING status, that is FlexStart instances that are waiting
5465 # for resources. Instances that do not exist because of the other reasons
5466 # are counted as &#x27;non_existent&#x27;.
5467 &quot;pendingStop&quot;: 42, # Output only. The number of instances in the managed instance group
5468 # that have PENDING_STOP status.
5469 &quot;provisioning&quot;: 42, # Output only. The number of instances in the managed instance group
5470 # that have PROVISIONING status.
5471 &quot;repairing&quot;: 42, # Output only. The number of instances in the managed instance group
5472 # that have REPAIRING status.
5473 &quot;running&quot;: 42, # Output only. The number of instances in the managed instance group
5474 # that have RUNNING status.
5475 &quot;staging&quot;: 42, # Output only. The number of instances in the managed instance group
5476 # that have STAGING status.
5477 &quot;stopped&quot;: 42, # Output only. The number of instances in the managed instance group
5478 # that have STOPPED status.
5479 &quot;stopping&quot;: 42, # Output only. The number of instances in the managed instance group
5480 # that have STOPPING status.
5481 &quot;suspended&quot;: 42, # Output only. The number of instances in the managed instance group
5482 # that have SUSPENDED status.
5483 &quot;suspending&quot;: 42, # Output only. The number of instances in the managed instance group
5484 # that have SUSPENDING status.
5485 &quot;terminated&quot;: 42, # Output only. The number of instances in the managed instance group
5486 # that have TERMINATED status.
5487 },
5488 &quot;isStable&quot;: True or False, # Output only. A bit indicating whether the managed instance group is in a
5489 # stable state. A stable state means that: none of the instances in the
5490 # managed instance group is currently undergoing any type of change (for
5491 # example, creation, restart, or deletion); no future changes are scheduled
5492 # for instances in the managed instance group; and the managed instance
5493 # group itself is not being modified.
5494 &quot;stateful&quot;: { # Output only. Stateful status of the given Instance Group Manager.
5495 &quot;hasStatefulConfig&quot;: True or False, # Output only. A bit indicating whether the managed instance group
5496 # has stateful configuration, that is, if you have configured any items
5497 # in a stateful policy or in per-instance configs.
5498 # The group might report that it has no stateful configuration even when
5499 # there is still some preserved state on a managed instance, for example,
5500 # if you have deleted all PICs but not yet applied those deletions.
5501 &quot;perInstanceConfigs&quot;: { # Output only. Status of per-instance configurations on the instances.
5502 &quot;allEffective&quot;: True or False, # Output only. A bit indicating if all of the group&#x27;s per-instance configurations
5503 # (listed in the output of a listPerInstanceConfigs API call) have
5504 # status EFFECTIVE or there are no per-instance-configs.
5505 },
5506 },
5507 &quot;versionTarget&quot;: { # Output only. A status of consistency of Instances&#x27; versions with their
5508 # target version specified by version field on Instance Group
5509 # Manager.
5510 &quot;isReached&quot;: True or False, # Output only. A bit indicating whether version target has been reached
5511 # in this managed instance group, i.e. all instances are in their target
5512 # version. Instances&#x27; target version are specified byversion field on Instance Group Manager.
5513 },
5514 },
5515 &quot;targetPools&quot;: [ # The URLs for all TargetPool resources to which instances in theinstanceGroup field are added. The target pools automatically
5516 # apply to all of the instances in the managed instance group.
5517 &quot;A String&quot;,
5518 ],
5519 &quot;targetSize&quot;: 42, # The target number of running instances for this managed instance group.
5520 # You can reduce this number by using the instanceGroupManager
5521 # deleteInstances or abandonInstances methods. Resizing the group also
5522 # changes this number.
5523 &quot;targetSizePolicy&quot;: { # The policy that specifies how the MIG creates its VMs to achieve the target
5524 # size.
5525 &quot;mode&quot;: &quot;A String&quot;, # The mode of target size policy based on which the MIG creates its VMs
5526 # individually or all at once.
5527 },
5528 &quot;targetStoppedSize&quot;: 42, # The target number of stopped instances for this managed instance group.
5529 # This number changes when you:
5530 #
5531 # - Stop instance using the stopInstances
5532 # method or start instances using the startInstances
5533 # method.
5534 # - Manually change the targetStoppedSize using the update
5535 # method.
5536 &quot;targetSuspendedSize&quot;: 42, # The target number of suspended instances for this managed instance group.
5537 # This number changes when you:
5538 #
5539 # - Suspend instance using the suspendInstances
5540 # method or resume instances using the resumeInstances
5541 # method.
5542 # - Manually change the targetSuspendedSize using the update
5543 # method.
5544 &quot;updatePolicy&quot;: { # The update policy for this managed instance group.
5545 &quot;instanceRedistributionType&quot;: &quot;A String&quot;, # The
5546 # instance redistribution policy for regional managed instance groups.
5547 # Valid values are:
5548 #
5549 # - PROACTIVE (default): The group attempts to maintain an
5550 # even distribution of VM instances across zones in the region.
5551 # - NONE: For non-autoscaled groups, proactive
5552 # redistribution is disabled.
5553 &quot;maxSurge&quot;: { # Encapsulates numeric value that can be either absolute or relative. # The maximum number of instances that can be created above the specifiedtargetSize during the update process. This value can be
5554 # either a fixed number or, if the group has 10 or more instances, a
5555 # percentage. If you set a percentage, the number of instances is rounded
5556 # if necessary. The default value for maxSurge is a fixed
5557 # value equal to the number of zones in which the managed instance group
5558 # operates.
5559 #
5560 # At least one of either maxSurge ormaxUnavailable must be greater than 0. Learn more about maxSurge.
5561 &quot;calculated&quot;: 42, # Output only. Absolute value of VM instances calculated based on the specific mode.
5562 #
5563 #
5564 #
5565 # - If the value is fixed, then the calculated
5566 # value is equal to the fixed value.
5567 # - If the value is a percent, then the
5568 # calculated
5569 # value is percent/100 * targetSize. For example,
5570 # the calculated value of a 80% of a managed instance group
5571 # with 150 instances would be (80/100 * 150) = 120 VM instances. If there
5572 # is a remainder, the number is rounded.
5573 &quot;fixed&quot;: 42, # Specifies a fixed number of VM instances. This must be a positive integer.
5574 &quot;percent&quot;: 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For
5575 # example, specify 80 for 80%.
5576 },
5577 &quot;maxUnavailable&quot;: { # Encapsulates numeric value that can be either absolute or relative. # The maximum number of instances that can be unavailable during the update
5578 # process. An instance is considered available if all of the following
5579 # conditions are satisfied:
5580 #
5581 #
5582 #
5583 # - The instance&#x27;s status is
5584 # RUNNING.
5585 # - If there is a health
5586 # check on the instance group, the instance&#x27;s health check status
5587 # must be HEALTHY at least once. If there is no health check
5588 # on the group, then the instance only needs to have a status of
5589 # RUNNING to be considered available.
5590 #
5591 #
5592 # This value can be either a fixed number or, if the group has 10 or more
5593 # instances, a percentage. If you set a percentage, the number of instances
5594 # is rounded if necessary. The default value formaxUnavailable is a fixed value equal to the number of zones
5595 # in which the managed instance group operates.
5596 #
5597 # At least one of either maxSurge ormaxUnavailable must be greater than 0. Learn more about maxUnavailable.
5598 &quot;calculated&quot;: 42, # Output only. Absolute value of VM instances calculated based on the specific mode.
5599 #
5600 #
5601 #
5602 # - If the value is fixed, then the calculated
5603 # value is equal to the fixed value.
5604 # - If the value is a percent, then the
5605 # calculated
5606 # value is percent/100 * targetSize. For example,
5607 # the calculated value of a 80% of a managed instance group
5608 # with 150 instances would be (80/100 * 150) = 120 VM instances. If there
5609 # is a remainder, the number is rounded.
5610 &quot;fixed&quot;: 42, # Specifies a fixed number of VM instances. This must be a positive integer.
5611 &quot;percent&quot;: 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For
5612 # example, specify 80 for 80%.
5613 },
5614 &quot;minimalAction&quot;: &quot;A String&quot;, # Minimal action to be taken on an instance. Use this option to minimize
5615 # disruption as much as possible or to apply a more disruptive action than
5616 # is necessary.
5617 #
5618 # - To limit disruption as much as possible, set the minimal action toREFRESH. If your update requires a more disruptive action,
5619 # Compute Engine performs the necessary action to execute the update.
5620 # - To apply a more disruptive action than is strictly necessary, set the
5621 # minimal action to RESTART or REPLACE. For
5622 # example, Compute Engine does not need to restart a VM to change its
5623 # metadata. But if your application reads instance metadata only when a VM
5624 # is restarted, you can set the minimal action to RESTART in
5625 # order to pick up metadata changes.
5626 &quot;mostDisruptiveAllowedAction&quot;: &quot;A String&quot;, # Most disruptive action that is allowed to be taken on an instance.
5627 # You can specify either NONE to forbid any actions,REFRESH to avoid restarting the VM and to limit disruption
5628 # as much as possible. RESTART to allow actions that can be
5629 # applied without instance replacing or REPLACE to allow all
5630 # possible actions. If the Updater determines that the minimal update
5631 # action needed is more disruptive than most disruptive allowed action you
5632 # specify it will not perform the update at all.
5633 &quot;replacementMethod&quot;: &quot;A String&quot;, # What action should be used to replace instances.
5634 # See minimal_action.REPLACE
5635 &quot;type&quot;: &quot;A String&quot;, # The type
5636 # of update process. You can specify either PROACTIVE so
5637 # that the MIG automatically updates VMs to the latest configurations orOPPORTUNISTIC so that you can select the VMs that you want
5638 # to update.
5639 },
5640 &quot;versions&quot;: [ # Specifies the instance templates used by this managed instance group to
5641 # create instances.
5642 #
5643 # Each version is defined by an instanceTemplate and aname. Every version can appear at most once per instance
5644 # group. This field overrides the top-level instanceTemplate
5645 # field. Read more about therelationships
5646 # between these fields. Exactly one version must leave thetargetSize field unset. That version will be applied to all
5647 # remaining instances. For more information, read aboutcanary
5648 # updates.
5649 {
5650 &quot;instanceTemplate&quot;: &quot;A String&quot;, # The URL of the instance template that is specified for this managed
5651 # instance group. The group uses this template to create new instances in
5652 # the managed instance group until the `targetSize` for this version is
5653 # reached. The templates for existing instances in the group do not change
5654 # unless you run recreateInstances, runapplyUpdatesToInstances, or set the group&#x27;supdatePolicy.type to PROACTIVE; in those cases,
5655 # existing instances are updated until the `targetSize` for this version is
5656 # reached.
5657 &quot;name&quot;: &quot;A String&quot;, # Name of the version. Unique among all versions in the scope of this
5658 # managed instance group.
5659 &quot;targetSize&quot;: { # Encapsulates numeric value that can be either absolute or relative. # Specifies the intended number of instances to be created from theinstanceTemplate. The final number of instances created
5660 # from the template will be equal to:
5661 #
5662 #
5663 # - If expressed as a fixed number, the minimum of either
5664 # targetSize.fixed or
5665 # instanceGroupManager.targetSize is used.
5666 # - if expressed as a percent, the targetSize
5667 # would be (targetSize.percent/100 *
5668 # InstanceGroupManager.targetSize) If there is a remainder, the
5669 # number is rounded.
5670 #
5671 # If unset, this version will update any remaining instances not
5672 # updated by another version. ReadStarting
5673 # a canary update for more information.
5674 &quot;calculated&quot;: 42, # Output only. Absolute value of VM instances calculated based on the specific mode.
5675 #
5676 #
5677 #
5678 # - If the value is fixed, then the calculated
5679 # value is equal to the fixed value.
5680 # - If the value is a percent, then the
5681 # calculated
5682 # value is percent/100 * targetSize. For example,
5683 # the calculated value of a 80% of a managed instance group
5684 # with 150 instances would be (80/100 * 150) = 120 VM instances. If there
5685 # is a remainder, the number is rounded.
5686 &quot;fixed&quot;: 42, # Specifies a fixed number of VM instances. This must be a positive integer.
5687 &quot;percent&quot;: 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For
5688 # example, specify 80 for 80%.
5689 },
5690 },
5691 ],
5692 &quot;zone&quot;: &quot;A String&quot;, # Output only. The URL of azone
5693 # where the managed instance group is located (for zonal resources).
5694 },
5695 ],
5696 &quot;kind&quot;: &quot;compute#instanceGroupManagerList&quot;, # Output only. The resource type, which is always compute#instanceGroupManagerList for a
5697 # list of managed instance groups.
5698 &quot;nextPageToken&quot;: &quot;A String&quot;, # Output only. This token allows you to get the next page of results for
5699 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
5700 # the query parameter pageToken in the next list request.
5701 # Subsequent list requests will have their own nextPageToken to
5702 # continue paging through the results.
5703 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. Server-defined URL for this resource.
5704 &quot;warning&quot;: { # Output only. Informational warning message.
5705 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
5706 # Engine returns NO_RESULTS_ON_PAGE if there
5707 # are no results in the response.
5708 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
5709 # value format. For example:
5710 #
5711 # &quot;data&quot;: [
5712 # {
5713 # &quot;key&quot;: &quot;scope&quot;,
5714 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
5715 # }
5716 {
5717 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
5718 # returned. For example, for warnings where there are no results in a list
5719 # request for a particular zone, this key might be scope and
5720 # the key value might be the zone name. Other examples might be a key
5721 # indicating a deprecated resource and a suggested replacement, or a
5722 # warning about invalid network settings (for example, if an instance
5723 # attempts to perform IP forwarding but is not enabled for IP forwarding).
5724 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
5725 },
5726 ],
5727 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
5728 },
5729 }</pre>
5730 </div>
5731
5732 <div class="method">
5733 <code class="details" id="listErrors">listErrors(project, zone, instanceGroupManager, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
5734 <pre>Lists all errors thrown by actions on instances for a given managed
5735 instance group. The filter and orderBy query
5736 parameters are not supported.
5737
5738 Args:
5739 project: string, Project ID for this request. (required)
5740 zone: string, The name of thezone where the managed
5741 instance group is located.
5742 It should conform to RFC1035. (required)
5743 instanceGroupManager: string, The name of the managed instance group.
5744 It must be a string that meets the requirements in RFC1035, or an
5745 unsigned long integer: must match regexp pattern:
5746 (?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)|1-9{0,19}. (required)
5747 filter: string, A filter expression that filters resources listed in the response. Most
5748 Compute resources support two types of filter expressions:
5749 expressions that support regular expressions and expressions that follow
5750 API improvement proposal AIP-160.
5751 These two types of filter expressions cannot be mixed in one request.
5752
5753 If you want to use AIP-160, your expression must specify the field name, an
5754 operator, and the value that you want to use for filtering. The value
5755 must be a string, a number, or a boolean. The operator
5756 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
5757
5758 For example, if you are filtering Compute Engine instances, you can
5759 exclude instances named `example-instance` by specifying
5760 `name != example-instance`.
5761
5762 The `:*` comparison can be used to test whether a key has been defined.
5763 For example, to find all objects with `owner` label use:
5764 ```
5765 labels.owner:*
5766 ```
5767
5768 You can also filter nested fields. For example, you could specify
5769 `scheduling.automaticRestart = false` to include instances only
5770 if they are not scheduled for automatic restarts. You can use filtering
5771 on nested fields to filter based onresource labels.
5772
5773 To filter on multiple expressions, provide each separate expression within
5774 parentheses. For example:
5775 ```
5776 (scheduling.automaticRestart = true)
5777 (cpuPlatform = &quot;Intel Skylake&quot;)
5778 ```
5779 By default, each expression is an `AND` expression. However, you
5780 can include `AND` and `OR` expressions explicitly.
5781 For example:
5782 ```
5783 (cpuPlatform = &quot;Intel Skylake&quot;) OR
5784 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
5785 (scheduling.automaticRestart = true)
5786 ```
5787
5788 If you want to use a regular expression, use the `eq` (equal) or `ne`
5789 (not equal) operator against a single un-parenthesized expression with or
5790 without quotes or against multiple parenthesized expressions. Examples:
5791
5792 `fieldname eq unquoted literal`
5793 `fieldname eq &#x27;single quoted literal&#x27;`
5794 `fieldname eq &quot;double quoted literal&quot;`
5795 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
5796
5797 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
5798 The literal value must match the entire field.
5799
5800 For example, to filter for instances that do not end with name &quot;instance&quot;,
5801 you would use `name ne .*instance`.
5802
5803 You cannot combine constraints on multiple fields using regular
5804 expressions.
5805 maxResults: integer, The maximum number of results per page that should be returned.
5806 If the number of available results is larger than `maxResults`,
5807 Compute Engine returns a `nextPageToken` that can be used to get
5808 the next page of results in subsequent list requests. Acceptable values are
5809 `0` to `500`, inclusive. (Default: `500`)
5810 orderBy: string, Sorts list results by a certain order. By default, results
5811 are returned in alphanumerical order based on the resource name.
5812
5813 You can also sort results in descending order based on the creation
5814 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
5815 results based on the `creationTimestamp` field in
5816 reverse chronological order (newest result first). Use this to sort
5817 resources like operations so that the newest operation is returned first.
5818
5819 Currently, only sorting by `name` or
5820 `creationTimestamp desc` is supported.
5821 pageToken: string, Specifies a page token to use. Set `pageToken` to the
5822 `nextPageToken` returned by a previous list request to get
5823 the next page of results.
5824 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
5825 of failure. The default value is false.
5826
5827 For example, when partial success behavior is enabled, aggregatedList for a
5828 single zone scope either returns all resources in the zone or no resources,
5829 with an error code.
5830 x__xgafv: string, V1 error format.
5831 Allowed values
5832 1 - v1 error format
5833 2 - v2 error format
5834
5835 Returns:
5836 An object of the form:
5837
5838 {
5839 &quot;items&quot;: [ # Output only. [Output Only] The list of errors of the managed instance group.
5840 {
5841 &quot;error&quot;: { # Output only. Contents of the error.
5842 &quot;code&quot;: &quot;A String&quot;, # Output only. Error code.
5843 &quot;message&quot;: &quot;A String&quot;, # Output only. Error message.
5844 },
5845 &quot;instanceActionDetails&quot;: { # Output only. Details of the instance action that triggered this error.
5846 # May be null, if the error was not caused by an action on an instance.
5847 # This field is optional.
5848 &quot;action&quot;: &quot;A String&quot;, # Output only. Action that managed instance group was executing on the instance when the
5849 # error occurred. Possible values:
5850 &quot;instance&quot;: &quot;A String&quot;, # Output only. The URL of the instance. The URL can be set even if the instance has not
5851 # yet been created.
5852 &quot;version&quot;: { # Output only. Version this instance was created from, or was being
5853 # created from, but the creation failed. Corresponds to one of the versions
5854 # that were set on the Instance Group Manager resource at the time this
5855 # instance was being created.
5856 &quot;instanceTemplate&quot;: &quot;A String&quot;, # Output only. [Output Only] The intended template of the instance. This field is empty
5857 # when current_action is one of { DELETING, ABANDONING }.
5858 &quot;name&quot;: &quot;A String&quot;, # Output only. [Output Only] Name of the version.
5859 },
5860 },
5861 &quot;timestamp&quot;: &quot;A String&quot;, # Output only. The time that this error occurred. This value is in RFC3339 text format.
5862 },
5863 ],
5864 &quot;nextPageToken&quot;: &quot;A String&quot;, # Output only. [Output Only] This token allows you to get the next page of results for
5865 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
5866 # the query parameter pageToken in the next list request.
5867 # Subsequent list requests will have their own nextPageToken to
5868 # continue paging through the results.
5869 }</pre>
5870 </div>
5871
5872 <div class="method">
5873 <code class="details" id="listErrors_next">listErrors_next()</code>
5874 <pre>Retrieves the next page of results.
5875
5876 Args:
5877 previous_request: The request for the previous page. (required)
5878 previous_response: The response from the request for the previous page. (required)
5879
5880 Returns:
5881 A request object that you can call &#x27;execute()&#x27; on to request the next
5882 page. Returns None if there are no more items in the collection.
5883 </pre>
5884 </div>
5885
5886 <div class="method">
5887 <code class="details" id="listManagedInstances">listManagedInstances(project, zone, instanceGroupManager, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
5888 <pre>Lists all of the instances in the managed instance group. Each instance
5889 in the list has a currentAction, which indicates the action
5890 that the managed instance group is performing on the instance. For example,
5891 if the group is still creating an instance, the currentAction
5892 is CREATING. If a previous action failed, the
5893 list displays the errors for that failed action. The orderBy
5894 query parameter is not supported. The `pageToken` query parameter is
5895 supported only if the group&#x27;s `listManagedInstancesResults` field is set
5896 to `PAGINATED`.
5897
5898 Args:
5899 project: string, Project ID for this request. (required)
5900 zone: string, The name of thezone where the managed
5901 instance group is located. (required)
5902 instanceGroupManager: string, The name of the managed instance group. (required)
5903 filter: string, A filter expression that filters resources listed in the response. Most
5904 Compute resources support two types of filter expressions:
5905 expressions that support regular expressions and expressions that follow
5906 API improvement proposal AIP-160.
5907 These two types of filter expressions cannot be mixed in one request.
5908
5909 If you want to use AIP-160, your expression must specify the field name, an
5910 operator, and the value that you want to use for filtering. The value
5911 must be a string, a number, or a boolean. The operator
5912 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
5913
5914 For example, if you are filtering Compute Engine instances, you can
5915 exclude instances named `example-instance` by specifying
5916 `name != example-instance`.
5917
5918 The `:*` comparison can be used to test whether a key has been defined.
5919 For example, to find all objects with `owner` label use:
5920 ```
5921 labels.owner:*
5922 ```
5923
5924 You can also filter nested fields. For example, you could specify
5925 `scheduling.automaticRestart = false` to include instances only
5926 if they are not scheduled for automatic restarts. You can use filtering
5927 on nested fields to filter based onresource labels.
5928
5929 To filter on multiple expressions, provide each separate expression within
5930 parentheses. For example:
5931 ```
5932 (scheduling.automaticRestart = true)
5933 (cpuPlatform = &quot;Intel Skylake&quot;)
5934 ```
5935 By default, each expression is an `AND` expression. However, you
5936 can include `AND` and `OR` expressions explicitly.
5937 For example:
5938 ```
5939 (cpuPlatform = &quot;Intel Skylake&quot;) OR
5940 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
5941 (scheduling.automaticRestart = true)
5942 ```
5943
5944 If you want to use a regular expression, use the `eq` (equal) or `ne`
5945 (not equal) operator against a single un-parenthesized expression with or
5946 without quotes or against multiple parenthesized expressions. Examples:
5947
5948 `fieldname eq unquoted literal`
5949 `fieldname eq &#x27;single quoted literal&#x27;`
5950 `fieldname eq &quot;double quoted literal&quot;`
5951 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
5952
5953 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
5954 The literal value must match the entire field.
5955
5956 For example, to filter for instances that do not end with name &quot;instance&quot;,
5957 you would use `name ne .*instance`.
5958
5959 You cannot combine constraints on multiple fields using regular
5960 expressions.
5961 maxResults: integer, The maximum number of results per page that should be returned.
5962 If the number of available results is larger than `maxResults`,
5963 Compute Engine returns a `nextPageToken` that can be used to get
5964 the next page of results in subsequent list requests. Acceptable values are
5965 `0` to `500`, inclusive. (Default: `500`)
5966 orderBy: string, Sorts list results by a certain order. By default, results
5967 are returned in alphanumerical order based on the resource name.
5968
5969 You can also sort results in descending order based on the creation
5970 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
5971 results based on the `creationTimestamp` field in
5972 reverse chronological order (newest result first). Use this to sort
5973 resources like operations so that the newest operation is returned first.
5974
5975 Currently, only sorting by `name` or
5976 `creationTimestamp desc` is supported.
5977 pageToken: string, Specifies a page token to use. Set `pageToken` to the
5978 `nextPageToken` returned by a previous list request to get
5979 the next page of results.
5980 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
5981 of failure. The default value is false.
5982
5983 For example, when partial success behavior is enabled, aggregatedList for a
5984 single zone scope either returns all resources in the zone or no resources,
5985 with an error code.
5986 x__xgafv: string, V1 error format.
5987 Allowed values
5988 1 - v1 error format
5989 2 - v2 error format
5990
5991 Returns:
5992 An object of the form:
5993
5994 {
5995 &quot;managedInstances&quot;: [ # Output only. [Output Only] The list of instances in the managed instance group.
5996 { # A Managed Instance resource.
5997 &quot;currentAction&quot;: &quot;A String&quot;, # Output only. [Output Only] The current action that the managed instance group has
5998 # scheduled for the instance. Possible values:
5999 #
6000 # - NONE The instance is running, and the managed
6001 # instance group does not have any scheduled actions for this instance.
6002 # - CREATING The managed instance group is creating this
6003 # instance. If the group fails to create this instance, it will try again
6004 # until it is successful.
6005 # - CREATING_WITHOUT_RETRIES The managed instance group
6006 # is attempting to create this instance only once. If the group fails
6007 # to create this instance, it does not try again and the group&#x27;stargetSize value is decreased instead.
6008 # - RECREATING The managed instance group is recreating
6009 # this instance.
6010 # - DELETING The managed instance group is permanently
6011 # deleting this instance.
6012 # - ABANDONING The managed instance group is abandoning
6013 # this instance. The instance will be removed from the instance group
6014 # and from any target pools that are associated with this group.
6015 # - RESTARTING The managed instance group is restarting
6016 # the instance.
6017 # - REFRESHING The managed instance group is applying
6018 # configuration changes to the instance without stopping it. For example,
6019 # the group can update the target pool list for an instance without
6020 # stopping that instance.
6021 # - VERIFYING The managed instance group has created the
6022 # instance and it is in the process of being verified.
6023 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output only] The unique identifier for this resource. This field is empty
6024 # when instance does not exist.
6025 &quot;instance&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL of the instance. The URL can exist even if the
6026 # instance has not yet been created.
6027 &quot;instanceHealth&quot;: [ # Output only. [Output Only] Health state of the instance per health-check.
6028 {
6029 &quot;detailedHealthState&quot;: &quot;A String&quot;, # Output only. [Output Only] The current detailed instance health state.
6030 &quot;healthCheck&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL for the health check that verifies whether the
6031 # instance is healthy.
6032 },
6033 ],
6034 &quot;instanceStatus&quot;: &quot;A String&quot;, # Output only. [Output Only] The status of the instance. This field is empty when
6035 # the instance does not exist.
6036 &quot;lastAttempt&quot;: { # Output only. [Output Only] Information about the last attempt to create or delete
6037 # the instance.
6038 &quot;errors&quot;: { # Output only. [Output Only] Encountered errors during the last attempt to create or
6039 # delete the instance.
6040 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
6041 # operation.
6042 {
6043 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
6044 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
6045 # details. There is a set of defined message types to use for providing
6046 # details.The syntax depends on the error code. For example,
6047 # QuotaExceededInfo will have details when the error code is
6048 # QUOTA_EXCEEDED.
6049 {
6050 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
6051 #
6052 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
6053 # is not enabled:
6054 #
6055 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
6056 # &quot;domain&quot;: &quot;googleapis.com&quot;
6057 # &quot;metadata&quot;: {
6058 # &quot;resource&quot;: &quot;projects/123&quot;,
6059 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
6060 # }
6061 # }
6062 #
6063 # This response indicates that the pubsub.googleapis.com API is not enabled.
6064 #
6065 # Example of an error that is returned when attempting to create a Spanner
6066 # instance in a region that is out of stock:
6067 #
6068 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
6069 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
6070 # &quot;metadata&quot;: {
6071 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
6072 # }
6073 # }
6074 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
6075 # is typically the registered service name of the tool or product that
6076 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
6077 # generated by some common infrastructure, the error domain must be a
6078 # globally unique value that identifies the infrastructure. For Google API
6079 # infrastructure, the error domain is &quot;googleapis.com&quot;.
6080 &quot;metadatas&quot;: { # Additional structured details about this error.
6081 #
6082 # Keys must match a regular expression of `a-z+` but should
6083 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
6084 # length. When identifying the current value of an exceeded limit, the units
6085 # should be contained in the key, not the value. For example, rather than
6086 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
6087 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
6088 # instances that can be created in a single (batch) request.
6089 &quot;a_key&quot;: &quot;A String&quot;,
6090 },
6091 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
6092 # proximate cause of the error. Error reasons are unique within a particular
6093 # domain of errors. This should be at most 63 characters and match a
6094 # regular expression of `A-Z+[A-Z0-9]`, which represents
6095 # UPPER_SNAKE_CASE.
6096 },
6097 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
6098 #
6099 # For example, if a quota check failed with an error indicating the calling
6100 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
6101 # directly to the right place in the developer console to flip the bit.
6102 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
6103 { # Describes a URL link.
6104 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
6105 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
6106 },
6107 ],
6108 },
6109 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
6110 # which can be attached to an RPC error.
6111 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
6112 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
6113 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
6114 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
6115 },
6116 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
6117 &quot;dimensions&quot;: { # The map holding related quota dimensions.
6118 &quot;a_key&quot;: &quot;A String&quot;,
6119 },
6120 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
6121 # type or metric.
6122 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
6123 # or metric.
6124 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
6125 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
6126 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
6127 },
6128 },
6129 ],
6130 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
6131 # This property is optional.
6132 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
6133 },
6134 ],
6135 },
6136 },
6137 &quot;name&quot;: &quot;A String&quot;, # Output only. [Output Only] The name of the instance. The name always exists even if the
6138 # instance has not yet been created.
6139 &quot;preservedStateFromConfig&quot;: { # Preserved state for a given instance. # Output only. [Output Only] Preserved state applied from per-instance config
6140 # for this instance.
6141 &quot;disks&quot;: { # Preserved disks defined for this instance.
6142 # This map is keyed with the device names of the disks.
6143 &quot;a_key&quot;: {
6144 &quot;autoDelete&quot;: &quot;A String&quot;, # These stateful disks will never be deleted during autohealing,
6145 # update, instance recreate operations. This flag is used to configure
6146 # if the disk should be deleted after it is no longer used by the group,
6147 # e.g. when the given instance or the whole MIG is deleted.
6148 # Note: disks attached in READ_ONLY mode cannot be
6149 # auto-deleted.
6150 &quot;mode&quot;: &quot;A String&quot;, # The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the
6151 # disk in READ_WRITE mode.
6152 &quot;source&quot;: &quot;A String&quot;, # The URL of the disk resource that is stateful and should be attached
6153 # to the VM instance.
6154 },
6155 },
6156 &quot;externalIPs&quot;: { # Preserved external IPs defined for this instance.
6157 # This map is keyed with the name of the network interface.
6158 &quot;a_key&quot;: {
6159 &quot;autoDelete&quot;: &quot;A String&quot;, # These stateful IPs will never be released during autohealing,
6160 # update or VM instance recreate operations.
6161 # This flag is used to configure if the IP reservation should be deleted
6162 # after it is no longer used by the group, e.g. when the given instance
6163 # or the whole group is deleted.
6164 &quot;ipAddress&quot;: { # Ip address representation
6165 &quot;address&quot;: &quot;A String&quot;, # The URL of the reservation for this IP address.
6166 &quot;literal&quot;: &quot;A String&quot;, # An IPv4 internal network address to assign to the instance for this
6167 # network interface.
6168 },
6169 },
6170 },
6171 &quot;internalIPs&quot;: { # Preserved internal IPs defined for this instance.
6172 # This map is keyed with the name of the network interface.
6173 &quot;a_key&quot;: {
6174 &quot;autoDelete&quot;: &quot;A String&quot;, # These stateful IPs will never be released during autohealing,
6175 # update or VM instance recreate operations.
6176 # This flag is used to configure if the IP reservation should be deleted
6177 # after it is no longer used by the group, e.g. when the given instance
6178 # or the whole group is deleted.
6179 &quot;ipAddress&quot;: { # Ip address representation
6180 &quot;address&quot;: &quot;A String&quot;, # The URL of the reservation for this IP address.
6181 &quot;literal&quot;: &quot;A String&quot;, # An IPv4 internal network address to assign to the instance for this
6182 # network interface.
6183 },
6184 },
6185 },
6186 &quot;metadata&quot;: { # Preserved metadata defined for this instance.
6187 &quot;a_key&quot;: &quot;A String&quot;,
6188 },
6189 },
6190 &quot;preservedStateFromPolicy&quot;: { # Preserved state for a given instance. # Output only. [Output Only] Preserved state generated based on stateful policy
6191 # for this instance.
6192 &quot;disks&quot;: { # Preserved disks defined for this instance.
6193 # This map is keyed with the device names of the disks.
6194 &quot;a_key&quot;: {
6195 &quot;autoDelete&quot;: &quot;A String&quot;, # These stateful disks will never be deleted during autohealing,
6196 # update, instance recreate operations. This flag is used to configure
6197 # if the disk should be deleted after it is no longer used by the group,
6198 # e.g. when the given instance or the whole MIG is deleted.
6199 # Note: disks attached in READ_ONLY mode cannot be
6200 # auto-deleted.
6201 &quot;mode&quot;: &quot;A String&quot;, # The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the
6202 # disk in READ_WRITE mode.
6203 &quot;source&quot;: &quot;A String&quot;, # The URL of the disk resource that is stateful and should be attached
6204 # to the VM instance.
6205 },
6206 },
6207 &quot;externalIPs&quot;: { # Preserved external IPs defined for this instance.
6208 # This map is keyed with the name of the network interface.
6209 &quot;a_key&quot;: {
6210 &quot;autoDelete&quot;: &quot;A String&quot;, # These stateful IPs will never be released during autohealing,
6211 # update or VM instance recreate operations.
6212 # This flag is used to configure if the IP reservation should be deleted
6213 # after it is no longer used by the group, e.g. when the given instance
6214 # or the whole group is deleted.
6215 &quot;ipAddress&quot;: { # Ip address representation
6216 &quot;address&quot;: &quot;A String&quot;, # The URL of the reservation for this IP address.
6217 &quot;literal&quot;: &quot;A String&quot;, # An IPv4 internal network address to assign to the instance for this
6218 # network interface.
6219 },
6220 },
6221 },
6222 &quot;internalIPs&quot;: { # Preserved internal IPs defined for this instance.
6223 # This map is keyed with the name of the network interface.
6224 &quot;a_key&quot;: {
6225 &quot;autoDelete&quot;: &quot;A String&quot;, # These stateful IPs will never be released during autohealing,
6226 # update or VM instance recreate operations.
6227 # This flag is used to configure if the IP reservation should be deleted
6228 # after it is no longer used by the group, e.g. when the given instance
6229 # or the whole group is deleted.
6230 &quot;ipAddress&quot;: { # Ip address representation
6231 &quot;address&quot;: &quot;A String&quot;, # The URL of the reservation for this IP address.
6232 &quot;literal&quot;: &quot;A String&quot;, # An IPv4 internal network address to assign to the instance for this
6233 # network interface.
6234 },
6235 },
6236 },
6237 &quot;metadata&quot;: { # Preserved metadata defined for this instance.
6238 &quot;a_key&quot;: &quot;A String&quot;,
6239 },
6240 },
6241 &quot;propertiesFromFlexibilityPolicy&quot;: { # Output only. [Output Only] Instance properties selected for this instance resulting from
6242 # InstanceFlexibilityPolicy.
6243 &quot;machineType&quot;: &quot;A String&quot;, # Output only. The machine type to be used for this instance.
6244 },
6245 &quot;version&quot;: { # Output only. [Output Only] Intended version of this instance.
6246 &quot;instanceTemplate&quot;: &quot;A String&quot;, # Output only. [Output Only] The intended template of the instance. This field is empty
6247 # when current_action is one of { DELETING, ABANDONING }.
6248 &quot;name&quot;: &quot;A String&quot;, # Output only. [Output Only] Name of the version.
6249 },
6250 },
6251 ],
6252 &quot;nextPageToken&quot;: &quot;A String&quot;, # Output only. [Output Only] This token allows you to get the next page of results for
6253 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
6254 # the query parameter pageToken in the next list request.
6255 # Subsequent list requests will have their own nextPageToken to
6256 # continue paging through the results.
6257 }</pre>
6258 </div>
6259
6260 <div class="method">
6261 <code class="details" id="listManagedInstances_next">listManagedInstances_next()</code>
6262 <pre>Retrieves the next page of results.
6263
6264 Args:
6265 previous_request: The request for the previous page. (required)
6266 previous_response: The response from the request for the previous page. (required)
6267
6268 Returns:
6269 A request object that you can call &#x27;execute()&#x27; on to request the next
6270 page. Returns None if there are no more items in the collection.
6271 </pre>
6272 </div>
6273
6274 <div class="method">
6275 <code class="details" id="listPerInstanceConfigs">listPerInstanceConfigs(project, zone, instanceGroupManager, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
6276 <pre>Lists all of the per-instance configurations defined for the managed
6277 instance group. The orderBy query parameter is not supported.
6278
6279 Args:
6280 project: string, Project ID for this request. (required)
6281 zone: string, The name of thezone
6282 where the managed instance group is located.
6283 It should conform to RFC1035. (required)
6284 instanceGroupManager: string, The name of the managed instance group. It should conform to RFC1035. (required)
6285 filter: string, A filter expression that filters resources listed in the response. Most
6286 Compute resources support two types of filter expressions:
6287 expressions that support regular expressions and expressions that follow
6288 API improvement proposal AIP-160.
6289 These two types of filter expressions cannot be mixed in one request.
6290
6291 If you want to use AIP-160, your expression must specify the field name, an
6292 operator, and the value that you want to use for filtering. The value
6293 must be a string, a number, or a boolean. The operator
6294 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
6295
6296 For example, if you are filtering Compute Engine instances, you can
6297 exclude instances named `example-instance` by specifying
6298 `name != example-instance`.
6299
6300 The `:*` comparison can be used to test whether a key has been defined.
6301 For example, to find all objects with `owner` label use:
6302 ```
6303 labels.owner:*
6304 ```
6305
6306 You can also filter nested fields. For example, you could specify
6307 `scheduling.automaticRestart = false` to include instances only
6308 if they are not scheduled for automatic restarts. You can use filtering
6309 on nested fields to filter based onresource labels.
6310
6311 To filter on multiple expressions, provide each separate expression within
6312 parentheses. For example:
6313 ```
6314 (scheduling.automaticRestart = true)
6315 (cpuPlatform = &quot;Intel Skylake&quot;)
6316 ```
6317 By default, each expression is an `AND` expression. However, you
6318 can include `AND` and `OR` expressions explicitly.
6319 For example:
6320 ```
6321 (cpuPlatform = &quot;Intel Skylake&quot;) OR
6322 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
6323 (scheduling.automaticRestart = true)
6324 ```
6325
6326 If you want to use a regular expression, use the `eq` (equal) or `ne`
6327 (not equal) operator against a single un-parenthesized expression with or
6328 without quotes or against multiple parenthesized expressions. Examples:
6329
6330 `fieldname eq unquoted literal`
6331 `fieldname eq &#x27;single quoted literal&#x27;`
6332 `fieldname eq &quot;double quoted literal&quot;`
6333 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
6334
6335 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
6336 The literal value must match the entire field.
6337
6338 For example, to filter for instances that do not end with name &quot;instance&quot;,
6339 you would use `name ne .*instance`.
6340
6341 You cannot combine constraints on multiple fields using regular
6342 expressions.
6343 maxResults: integer, The maximum number of results per page that should be returned.
6344 If the number of available results is larger than `maxResults`,
6345 Compute Engine returns a `nextPageToken` that can be used to get
6346 the next page of results in subsequent list requests. Acceptable values are
6347 `0` to `500`, inclusive. (Default: `500`)
6348 orderBy: string, Sorts list results by a certain order. By default, results
6349 are returned in alphanumerical order based on the resource name.
6350
6351 You can also sort results in descending order based on the creation
6352 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
6353 results based on the `creationTimestamp` field in
6354 reverse chronological order (newest result first). Use this to sort
6355 resources like operations so that the newest operation is returned first.
6356
6357 Currently, only sorting by `name` or
6358 `creationTimestamp desc` is supported.
6359 pageToken: string, Specifies a page token to use. Set `pageToken` to the
6360 `nextPageToken` returned by a previous list request to get
6361 the next page of results.
6362 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
6363 of failure. The default value is false.
6364
6365 For example, when partial success behavior is enabled, aggregatedList for a
6366 single zone scope either returns all resources in the zone or no resources,
6367 with an error code.
6368 x__xgafv: string, V1 error format.
6369 Allowed values
6370 1 - v1 error format
6371 2 - v2 error format
6372
6373 Returns:
6374 An object of the form:
6375
6376 {
6377 &quot;items&quot;: [ # Output only. [Output Only] The list of PerInstanceConfig.
6378 {
6379 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this per-instance config. This field can be used in
6380 # optimistic locking. It is ignored when inserting a per-instance
6381 # config. An up-to-date fingerprint must be provided in order to update an
6382 # existing per-instance configuration or the field needs to be unset.
6383 &quot;name&quot;: &quot;A String&quot;, # The name of a per-instance configuration and its corresponding instance.
6384 # Serves as a merge key during UpdatePerInstanceConfigs
6385 # operations, that is, if a per-instance configuration with the same name
6386 # exists then it will be updated, otherwise a new one will be created for the
6387 # VM instance with the same name. An attempt to create a per-instance
6388 # configuration for a VM instance that either doesn&#x27;t exist or is not part
6389 # of the group will result in an error.
6390 &quot;preservedState&quot;: { # Preserved state for a given instance. # The intended preserved state for the given instance. Does not contain
6391 # preserved state generated from a stateful policy.
6392 &quot;disks&quot;: { # Preserved disks defined for this instance.
6393 # This map is keyed with the device names of the disks.
6394 &quot;a_key&quot;: {
6395 &quot;autoDelete&quot;: &quot;A String&quot;, # These stateful disks will never be deleted during autohealing,
6396 # update, instance recreate operations. This flag is used to configure
6397 # if the disk should be deleted after it is no longer used by the group,
6398 # e.g. when the given instance or the whole MIG is deleted.
6399 # Note: disks attached in READ_ONLY mode cannot be
6400 # auto-deleted.
6401 &quot;mode&quot;: &quot;A String&quot;, # The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the
6402 # disk in READ_WRITE mode.
6403 &quot;source&quot;: &quot;A String&quot;, # The URL of the disk resource that is stateful and should be attached
6404 # to the VM instance.
6405 },
6406 },
6407 &quot;externalIPs&quot;: { # Preserved external IPs defined for this instance.
6408 # This map is keyed with the name of the network interface.
6409 &quot;a_key&quot;: {
6410 &quot;autoDelete&quot;: &quot;A String&quot;, # These stateful IPs will never be released during autohealing,
6411 # update or VM instance recreate operations.
6412 # This flag is used to configure if the IP reservation should be deleted
6413 # after it is no longer used by the group, e.g. when the given instance
6414 # or the whole group is deleted.
6415 &quot;ipAddress&quot;: { # Ip address representation
6416 &quot;address&quot;: &quot;A String&quot;, # The URL of the reservation for this IP address.
6417 &quot;literal&quot;: &quot;A String&quot;, # An IPv4 internal network address to assign to the instance for this
6418 # network interface.
6419 },
6420 },
6421 },
6422 &quot;internalIPs&quot;: { # Preserved internal IPs defined for this instance.
6423 # This map is keyed with the name of the network interface.
6424 &quot;a_key&quot;: {
6425 &quot;autoDelete&quot;: &quot;A String&quot;, # These stateful IPs will never be released during autohealing,
6426 # update or VM instance recreate operations.
6427 # This flag is used to configure if the IP reservation should be deleted
6428 # after it is no longer used by the group, e.g. when the given instance
6429 # or the whole group is deleted.
6430 &quot;ipAddress&quot;: { # Ip address representation
6431 &quot;address&quot;: &quot;A String&quot;, # The URL of the reservation for this IP address.
6432 &quot;literal&quot;: &quot;A String&quot;, # An IPv4 internal network address to assign to the instance for this
6433 # network interface.
6434 },
6435 },
6436 },
6437 &quot;metadata&quot;: { # Preserved metadata defined for this instance.
6438 &quot;a_key&quot;: &quot;A String&quot;,
6439 },
6440 },
6441 &quot;status&quot;: &quot;A String&quot;, # The status of applying this per-instance configuration on the corresponding
6442 # managed instance.
6443 },
6444 ],
6445 &quot;nextPageToken&quot;: &quot;A String&quot;, # Output only. [Output Only] This token allows you to get the next page of results for
6446 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
6447 # the query parameter pageToken in the next list request.
6448 # Subsequent list requests will have their own nextPageToken to
6449 # continue paging through the results.
6450 &quot;warning&quot;: { # Output only. [Output Only] Informational warning message.
6451 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
6452 # Engine returns NO_RESULTS_ON_PAGE if there
6453 # are no results in the response.
6454 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
6455 # value format. For example:
6456 #
6457 # &quot;data&quot;: [
6458 # {
6459 # &quot;key&quot;: &quot;scope&quot;,
6460 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
6461 # }
6462 {
6463 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
6464 # returned. For example, for warnings where there are no results in a list
6465 # request for a particular zone, this key might be scope and
6466 # the key value might be the zone name. Other examples might be a key
6467 # indicating a deprecated resource and a suggested replacement, or a
6468 # warning about invalid network settings (for example, if an instance
6469 # attempts to perform IP forwarding but is not enabled for IP forwarding).
6470 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
6471 },
6472 ],
6473 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
6474 },
6475 }</pre>
6476 </div>
6477
6478 <div class="method">
6479 <code class="details" id="listPerInstanceConfigs_next">listPerInstanceConfigs_next()</code>
6480 <pre>Retrieves the next page of results.
6481
6482 Args:
6483 previous_request: The request for the previous page. (required)
6484 previous_response: The response from the request for the previous page. (required)
6485
6486 Returns:
6487 A request object that you can call &#x27;execute()&#x27; on to request the next
6488 page. Returns None if there are no more items in the collection.
6489 </pre>
6490 </div>
6491
6492 <div class="method">
6493 <code class="details" id="list_next">list_next()</code>
6494 <pre>Retrieves the next page of results.
6495
6496 Args:
6497 previous_request: The request for the previous page. (required)
6498 previous_response: The response from the request for the previous page. (required)
6499
6500 Returns:
6501 A request object that you can call &#x27;execute()&#x27; on to request the next
6502 page. Returns None if there are no more items in the collection.
6503 </pre>
6504 </div>
6505
6506 <div class="method">
6507 <code class="details" id="patch">patch(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
6508 <pre>Updates a managed instance group using the information that you specify
6509 in the request.
6510 This operation is marked as DONE when the group is patched
6511 even if the instances in the group are still in the process of being
6512 patched. You must separately verify the status of the individual instances
6513 with thelistManagedInstances
6514 method. This method supportsPATCH
6515 semantics and uses theJSON merge
6516 patch format and processing rules.
6517
6518 If you update your group to specify a new template or instance
6519 configuration, it&#x27;s possible that your intended specification for each VM
6520 in the group is different from the current state of that VM. To learn how
6521 to apply an updated configuration to the VMs in a MIG, seeUpdating instances in
6522 a MIG.
6523
6524 Args:
6525 project: string, Project ID for this request. (required)
6526 zone: string, The name of the zone where
6527 you want to create the managed instance group. (required)
6528 instanceGroupManager: string, The name of the instance group manager. (required)
6529 body: object, The request body.
6530 The object takes the form of:
6531
6532 { # Represents a Managed Instance Group resource.
6533 #
6534 # An instance group is a collection of VM instances that you can manage as a
6535 # single entity. For more information, readInstance groups.
6536 #
6537 # For zonal Managed Instance Group, use the instanceGroupManagers
6538 # resource.
6539 #
6540 # For regional Managed Instance Group, use theregionInstanceGroupManagers resource.
6541 &quot;allInstancesConfig&quot;: { # Specifies configuration that overrides the instance template configuration
6542 # for the group.
6543 &quot;properties&quot;: { # Represents the change that you want to make to the instance properties. # Properties to set on all instances in the group.
6544 #
6545 # You can add or modify properties using theinstanceGroupManagers.patch orregionInstanceGroupManagers.patch. After settingallInstancesConfig on the group, you must update the group&#x27;s
6546 # instances to apply the configuration. To apply the configuration, set the
6547 # group&#x27;s updatePolicy.type field to use proactive updates or
6548 # use the applyUpdatesToInstances method.
6549 &quot;labels&quot;: { # The label key-value pairs that you want to patch onto the instance.
6550 &quot;a_key&quot;: &quot;A String&quot;,
6551 },
6552 &quot;metadata&quot;: { # The metadata key-value pairs that you want to patch onto the instance. For
6553 # more information, see Project and
6554 # instance metadata.
6555 &quot;a_key&quot;: &quot;A String&quot;,
6556 },
6557 },
6558 },
6559 &quot;autoHealingPolicies&quot;: [ # The autohealing policy for this managed instance group. You can specify
6560 # only one value.
6561 {
6562 &quot;healthCheck&quot;: &quot;A String&quot;, # The URL for the health check that signals autohealing.
6563 &quot;initialDelaySec&quot;: 42, # The initial delay is the number of seconds that a new VM takes to
6564 # initialize and run its startup script. During a VM&#x27;s initial delay
6565 # period, the MIG ignores unsuccessful health checks because the VM might
6566 # be in the startup process. This prevents the MIG from prematurely
6567 # recreating a VM. If the health check receives a healthy response during
6568 # the initial delay, it indicates that the startup process is complete and
6569 # the VM is ready. The value of initial delay must be between 0 and 3600
6570 # seconds. The default value is 0.
6571 },
6572 ],
6573 &quot;baseInstanceName&quot;: &quot;A String&quot;, # The base instance name is a prefix that you want to attach to the names of
6574 # all VMs in a MIG. The maximum character length is 58 and the name must
6575 # comply with RFC1035 format.
6576 #
6577 # When a VM is created in the group, the MIG appends a hyphen and a random
6578 # four-character string to the base instance name. If you want the MIG to
6579 # assign sequential numbers instead of a random string, then end the base
6580 # instance name with a hyphen followed by one or more hash symbols. The hash
6581 # symbols indicate the number of digits. For example, a base instance name of
6582 # &quot;vm-###&quot; results in &quot;vm-001&quot; as a VM name.
6583 # @pattern
6584 # [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,51}-#{1,10}(\\[[0-9]{1,10}\\])?))
6585 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. The creation timestamp for this managed instance group inRFC3339
6586 # text format.
6587 &quot;currentActions&quot;: { # Output only. The list of instance actions and the number of instances
6588 # in this managed instance group that are scheduled for each of those
6589 # actions.
6590 &quot;abandoning&quot;: 42, # Output only. The total number of instances in the managed instance group
6591 # that are scheduled to be abandoned. Abandoning an instance removes it
6592 # from the managed instance group without deleting it.
6593 &quot;creating&quot;: 42, # Output only. The number of instances in the managed instance group that
6594 # are scheduled to be created or are currently being created. If the group
6595 # fails to create any of these instances, it tries again until it creates
6596 # the instance successfully.
6597 #
6598 # If you have disabled creation retries, this field will not be populated;
6599 # instead, the creatingWithoutRetries field will be populated.
6600 &quot;creatingWithoutRetries&quot;: 42, # Output only. The number of instances that the managed instance group
6601 # will attempt to create. The group attempts to create each instance
6602 # only once. If the group fails to create any of these instances, it
6603 # decreases the group&#x27;s targetSize value accordingly.
6604 &quot;deleting&quot;: 42, # Output only. The number of instances in the managed instance group that
6605 # are scheduled to be deleted or are currently being deleted.
6606 &quot;none&quot;: 42, # Output only. The number of instances in the managed instance group that
6607 # are running and have no scheduled actions.
6608 &quot;recreating&quot;: 42, # Output only. The number of instances in the managed instance group that
6609 # are scheduled to be recreated or are currently being being recreated.
6610 # Recreating an instance deletes the existing root persistent disk
6611 # and creates a new disk from the image that is defined in the
6612 # instance template.
6613 &quot;refreshing&quot;: 42, # Output only. The number of instances in the managed instance group that
6614 # are being reconfigured with properties that do not require a restart
6615 # or a recreate action. For example, setting or removing target
6616 # pools for the instance.
6617 &quot;restarting&quot;: 42, # Output only. The number of instances in the managed instance group that
6618 # are scheduled to be restarted or are currently being restarted.
6619 &quot;resuming&quot;: 42, # Output only. The number of instances in the managed instance group that
6620 # are scheduled to be resumed or are currently being resumed.
6621 &quot;starting&quot;: 42, # Output only. The number of instances in the managed instance group that
6622 # are scheduled to be started or are currently being started.
6623 &quot;stopping&quot;: 42, # Output only. The number of instances in the managed instance group that
6624 # are scheduled to be stopped or are currently being stopped.
6625 &quot;suspending&quot;: 42, # Output only. The number of instances in the managed instance group that
6626 # are scheduled to be suspended or are currently being suspended.
6627 &quot;verifying&quot;: 42, # Output only. The number of instances in the managed instance group that
6628 # are being verified. See the managedInstances[].currentAction
6629 # property in the listManagedInstances method documentation.
6630 },
6631 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource.
6632 &quot;distributionPolicy&quot;: { # Policy specifying the intended distribution of managed instances across
6633 # zones in a regional managed instance group.
6634 &quot;targetShape&quot;: &quot;A String&quot;, # The distribution shape to which the group converges either proactively or
6635 # on resize events (depending on the value set inupdatePolicy.instanceRedistributionType).
6636 &quot;zones&quot;: [ # Zones where the regional managed instance group will create and manage
6637 # its instances.
6638 # By default, a regional MIG doesn&#x27;t automatically select an AI zone to create
6639 # instances, even if an AI zone is available in the specified region. To
6640 # create instances in an AI zone in the selected region, you must explicitly
6641 # specify it in the distribution policy together with the other preferred
6642 # zones.
6643 {
6644 &quot;zone&quot;: &quot;A String&quot;, # The URL of thezone.
6645 # The zone must exist in the region where the managed instance group is
6646 # located.
6647 },
6648 ],
6649 },
6650 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. This field may be used in optimistic locking.
6651 # It will be ignored when inserting an InstanceGroupManager. An up-to-date
6652 # fingerprint must be provided in order to update the InstanceGroupManager,
6653 # otherwise the request will fail with error412 conditionNotMet.
6654 #
6655 # To see the latest fingerprint, make a get() request to
6656 # retrieve an InstanceGroupManager.
6657 &quot;id&quot;: &quot;A String&quot;, # Output only. A unique identifier for this resource type. The server
6658 # generates this identifier.
6659 &quot;instanceFlexibilityPolicy&quot;: { # Instance flexibility allowing MIG to create VMs from multiple
6660 # types of machines.
6661 # Instance flexibility configuration on MIG overrides instance
6662 # template configuration.
6663 &quot;instanceSelections&quot;: { # Named instance selections configuring properties that the group will use
6664 # when creating new VMs.
6665 &quot;a_key&quot;: {
6666 &quot;machineTypes&quot;: [ # Full machine-type names, e.g. &quot;n1-standard-16&quot;.
6667 &quot;A String&quot;,
6668 ],
6669 &quot;rank&quot;: 42, # Preference of this instance selection. Lower number means higher
6670 # preference. MIG will first try to create a VM based on the machine-type
6671 # with lowest rank and fallback to next rank based on availability.
6672 # Machine types and instance selections with the same rank have the same
6673 # preference.
6674 },
6675 },
6676 },
6677 &quot;instanceGroup&quot;: &quot;A String&quot;, # Output only. The URL of the Instance Group resource.
6678 &quot;instanceLifecyclePolicy&quot;: { # The repair policy for this managed instance group.
6679 &quot;defaultActionOnFailure&quot;: &quot;A String&quot;, # The action that a MIG performs on a failed VM. If the value of the
6680 # onFailedHealthCheck field is `DEFAULT_ACTION`, then the same action also
6681 # applies to the VMs on which your application fails a health check.
6682 # Valid values are
6683 #
6684 # - REPAIR (default): MIG automatically repairs a failed VM
6685 # by recreating it. For more information, see About
6686 # repairing VMs in a MIG.
6687 # - DO_NOTHING: MIG does not repair a failed VM.
6688 &quot;forceUpdateOnRepair&quot;: &quot;A String&quot;, # A bit indicating whether to forcefully apply the group&#x27;s latest
6689 # configuration when repairing a VM. Valid options are:
6690 #
6691 #
6692 #
6693 # - NO (default): If configuration updates are available, they are not
6694 # forcefully applied during repair. Instead, configuration updates are
6695 # applied according to the group&#x27;s update policy.
6696 #
6697 # - YES: If configuration updates are available, they are applied
6698 # during repair.
6699 &quot;onFailedHealthCheck&quot;: &quot;A String&quot;, # The action that a MIG performs on an unhealthy VM. A VM is marked as
6700 # unhealthy when the application running on that VM fails a health check.
6701 # Valid values are:
6702 #
6703 # - DEFAULT_ACTION (default): MIG uses the same action
6704 # configured for instanceLifecyclePolicy.defaultActionOnFailure field.
6705 # - REPAIR: MIG automatically repairs an unhealthy VM by
6706 # recreating it.
6707 # - DO_NOTHING: MIG doesn&#x27;t repair an unhealthy VM.
6708 # For more information, see
6709 # About repairing VMs in a MIG.
6710 &quot;onRepair&quot;: { # Configuration for VM repairs in the MIG. # Configuration for VM repairs in the MIG.
6711 &quot;allowChangingZone&quot;: &quot;A String&quot;, # Specifies whether the MIG can change a VM&#x27;s zone during a repair.
6712 # Valid values are:
6713 #
6714 # - NO (default): MIG cannot change a VM&#x27;s zone during a
6715 # repair.
6716 # - YES: MIG can select a different zone for the VM during
6717 # a repair.
6718 },
6719 },
6720 &quot;instanceTemplate&quot;: &quot;A String&quot;, # The URL of the instance template that is specified for this managed
6721 # instance group. The group uses this template to create all new instances
6722 # in the managed instance group. The templates for existing instances in the
6723 # group do not change unless you run recreateInstances, runapplyUpdatesToInstances, or set the group&#x27;supdatePolicy.type to PROACTIVE.
6724 &quot;kind&quot;: &quot;compute#instanceGroupManager&quot;, # Output only. The resource type, which is alwayscompute#instanceGroupManager for managed instance groups.
6725 &quot;listManagedInstancesResults&quot;: &quot;A String&quot;, # Pagination behavior of the listManagedInstances API method for
6726 # this managed instance group.
6727 &quot;name&quot;: &quot;A String&quot;, # The name of the managed instance group. The name must be 1-63 characters
6728 # long, and comply withRFC1035.
6729 &quot;namedPorts&quot;: [ # [Output Only] Named ports configured on the Instance Groups complementary
6730 # to this Instance Group Manager.
6731 { # The named port. For example: &lt;&quot;http&quot;, 80&gt;.
6732 &quot;name&quot;: &quot;A String&quot;, # The name for this named port.
6733 # The name must be 1-63 characters long, and comply withRFC1035.
6734 &quot;port&quot;: 42, # The port number, which can be a value between 1 and 65535.
6735 },
6736 ],
6737 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL of theregion
6738 # where the managed instance group resides (for regional resources).
6739 &quot;resourcePolicies&quot;: { # Resource policies for this managed instance group.
6740 &quot;workloadPolicy&quot;: &quot;A String&quot;, # The URL of the workload policy that is specified for this managed
6741 # instance group.
6742 # It can be a full or partial URL. For example, the following are
6743 # all valid URLs to a workload policy:
6744 #
6745 #
6746 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/resourcePolicies/resourcePolicy
6747 # - projects/project/regions/region/resourcePolicies/resourcePolicy
6748 # - regions/region/resourcePolicies/resourcePolicy
6749 },
6750 &quot;satisfiesPzi&quot;: True or False, # Output only. Reserved for future use.
6751 &quot;satisfiesPzs&quot;: True or False, # Output only. Reserved for future use.
6752 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. The URL for this managed instance group. The server defines
6753 # this URL.
6754 &quot;standbyPolicy&quot;: { # Standby policy for stopped and suspended instances.
6755 &quot;initialDelaySec&quot;: 42, # Specifies the number of seconds that the MIG should wait to suspend or
6756 # stop a VM after that VM was created. The initial delay gives the
6757 # initialization script the time to prepare your VM for a quick scale out.
6758 # The value of initial delay must be between 0 and 3600 seconds. The
6759 # default value is 0.
6760 &quot;mode&quot;: &quot;A String&quot;, # Defines how a MIG resumes or starts VMs from a standby pool when the
6761 # group scales out. The default mode is `MANUAL`.
6762 },
6763 &quot;statefulPolicy&quot;: { # Stateful configuration for this Instanced Group Manager
6764 &quot;preservedState&quot;: { # Configuration of preserved resources.
6765 &quot;disks&quot;: { # Disks created on the instances that will be preserved on instance
6766 # delete, update, etc. This map is keyed with the device names of
6767 # the disks.
6768 &quot;a_key&quot;: {
6769 &quot;autoDelete&quot;: &quot;A String&quot;, # These stateful disks will never be deleted during autohealing,
6770 # update or VM instance recreate operations.
6771 # This flag is used to configure if the disk should be deleted after it
6772 # is no longer used by the group, e.g. when the given instance or
6773 # the whole group is deleted. Note: disks attached inREAD_ONLY mode cannot be auto-deleted.
6774 },
6775 },
6776 &quot;externalIPs&quot;: { # External network IPs assigned to the instances that will be preserved on
6777 # instance delete, update, etc. This map is keyed with the network
6778 # interface name.
6779 &quot;a_key&quot;: {
6780 &quot;autoDelete&quot;: &quot;A String&quot;, # These stateful IPs will never be released during autohealing,
6781 # update or VM instance recreate operations.
6782 # This flag is used to configure if the IP reservation should be deleted
6783 # after it is no longer used by the group, e.g. when the given instance
6784 # or the whole group is deleted.
6785 },
6786 },
6787 &quot;internalIPs&quot;: { # Internal network IPs assigned to the instances that will be preserved on
6788 # instance delete, update, etc. This map is keyed with the network
6789 # interface name.
6790 &quot;a_key&quot;: {
6791 &quot;autoDelete&quot;: &quot;A String&quot;, # These stateful IPs will never be released during autohealing,
6792 # update or VM instance recreate operations.
6793 # This flag is used to configure if the IP reservation should be deleted
6794 # after it is no longer used by the group, e.g. when the given instance
6795 # or the whole group is deleted.
6796 },
6797 },
6798 },
6799 },
6800 &quot;status&quot;: { # Output only. The status of this managed instance group.
6801 &quot;allInstancesConfig&quot;: { # Output only. Status of all-instances configuration on the group.
6802 &quot;currentRevision&quot;: &quot;A String&quot;, # Output only. Current all-instances configuration revision.
6803 # This value is in RFC3339 text format.
6804 &quot;effective&quot;: True or False, # Output only. A bit indicating whether this configuration has
6805 # been applied to all managed instances in the group.
6806 },
6807 &quot;appliedAcceleratorTopologies&quot;: [ # Output only. The accelerator topology applied to this MIG.
6808 # Currently only one accelerator topology is supported.
6809 {
6810 &quot;acceleratorTopology&quot;: &quot;A String&quot;, # Output only. Topology in the format of: &quot;16x16&quot;, &quot;4x4x4&quot;, etc.
6811 # The value is the same as configured in the WorkloadPolicy.
6812 &quot;state&quot;: &quot;A String&quot;, # Output only. The state of the accelerator topology.
6813 &quot;stateDetails&quot;: { # Output only. The result of the latest accelerator topology state
6814 # check.
6815 &quot;error&quot;: { # Output only. Encountered errors.
6816 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
6817 # operation.
6818 {
6819 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
6820 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
6821 # details. There is a set of defined message types to use for providing
6822 # details.The syntax depends on the error code. For example,
6823 # QuotaExceededInfo will have details when the error code is
6824 # QUOTA_EXCEEDED.
6825 {
6826 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
6827 #
6828 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
6829 # is not enabled:
6830 #
6831 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
6832 # &quot;domain&quot;: &quot;googleapis.com&quot;
6833 # &quot;metadata&quot;: {
6834 # &quot;resource&quot;: &quot;projects/123&quot;,
6835 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
6836 # }
6837 # }
6838 #
6839 # This response indicates that the pubsub.googleapis.com API is not enabled.
6840 #
6841 # Example of an error that is returned when attempting to create a Spanner
6842 # instance in a region that is out of stock:
6843 #
6844 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
6845 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
6846 # &quot;metadata&quot;: {
6847 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
6848 # }
6849 # }
6850 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
6851 # is typically the registered service name of the tool or product that
6852 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
6853 # generated by some common infrastructure, the error domain must be a
6854 # globally unique value that identifies the infrastructure. For Google API
6855 # infrastructure, the error domain is &quot;googleapis.com&quot;.
6856 &quot;metadatas&quot;: { # Additional structured details about this error.
6857 #
6858 # Keys must match a regular expression of `a-z+` but should
6859 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
6860 # length. When identifying the current value of an exceeded limit, the units
6861 # should be contained in the key, not the value. For example, rather than
6862 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
6863 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
6864 # instances that can be created in a single (batch) request.
6865 &quot;a_key&quot;: &quot;A String&quot;,
6866 },
6867 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
6868 # proximate cause of the error. Error reasons are unique within a particular
6869 # domain of errors. This should be at most 63 characters and match a
6870 # regular expression of `A-Z+[A-Z0-9]`, which represents
6871 # UPPER_SNAKE_CASE.
6872 },
6873 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
6874 #
6875 # For example, if a quota check failed with an error indicating the calling
6876 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
6877 # directly to the right place in the developer console to flip the bit.
6878 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
6879 { # Describes a URL link.
6880 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
6881 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
6882 },
6883 ],
6884 },
6885 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
6886 # which can be attached to an RPC error.
6887 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
6888 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
6889 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
6890 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
6891 },
6892 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
6893 &quot;dimensions&quot;: { # The map holding related quota dimensions.
6894 &quot;a_key&quot;: &quot;A String&quot;,
6895 },
6896 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
6897 # type or metric.
6898 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
6899 # or metric.
6900 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
6901 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
6902 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
6903 },
6904 },
6905 ],
6906 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
6907 # This property is optional.
6908 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
6909 },
6910 ],
6911 },
6912 &quot;timestamp&quot;: &quot;A String&quot;, # Output only. Timestamp is shown only if there is an error. The field
6913 # has // RFC3339 //
6914 # text format.
6915 },
6916 },
6917 ],
6918 &quot;autoscaler&quot;: &quot;A String&quot;, # Output only. The URL of theAutoscaler
6919 # that targets this instance group manager.
6920 &quot;bulkInstanceOperation&quot;: { # Bulk instance operation is the creation of VMs in a MIG when the # Output only. The status of bulk instance operation.
6921 # targetSizePolicy.mode is set to BULK.
6922 &quot;inProgress&quot;: True or False, # Output only. Informs whether bulk instance operation is in progress.
6923 &quot;lastProgressCheck&quot;: { # Output only. Information from the last progress check of bulk instance
6924 # operation.
6925 &quot;error&quot;: { # Output only. Errors encountered during bulk instance operation.
6926 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
6927 # operation.
6928 {
6929 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
6930 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
6931 # details. There is a set of defined message types to use for providing
6932 # details.The syntax depends on the error code. For example,
6933 # QuotaExceededInfo will have details when the error code is
6934 # QUOTA_EXCEEDED.
6935 {
6936 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
6937 #
6938 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
6939 # is not enabled:
6940 #
6941 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
6942 # &quot;domain&quot;: &quot;googleapis.com&quot;
6943 # &quot;metadata&quot;: {
6944 # &quot;resource&quot;: &quot;projects/123&quot;,
6945 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
6946 # }
6947 # }
6948 #
6949 # This response indicates that the pubsub.googleapis.com API is not enabled.
6950 #
6951 # Example of an error that is returned when attempting to create a Spanner
6952 # instance in a region that is out of stock:
6953 #
6954 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
6955 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
6956 # &quot;metadata&quot;: {
6957 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
6958 # }
6959 # }
6960 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
6961 # is typically the registered service name of the tool or product that
6962 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
6963 # generated by some common infrastructure, the error domain must be a
6964 # globally unique value that identifies the infrastructure. For Google API
6965 # infrastructure, the error domain is &quot;googleapis.com&quot;.
6966 &quot;metadatas&quot;: { # Additional structured details about this error.
6967 #
6968 # Keys must match a regular expression of `a-z+` but should
6969 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
6970 # length. When identifying the current value of an exceeded limit, the units
6971 # should be contained in the key, not the value. For example, rather than
6972 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
6973 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
6974 # instances that can be created in a single (batch) request.
6975 &quot;a_key&quot;: &quot;A String&quot;,
6976 },
6977 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
6978 # proximate cause of the error. Error reasons are unique within a particular
6979 # domain of errors. This should be at most 63 characters and match a
6980 # regular expression of `A-Z+[A-Z0-9]`, which represents
6981 # UPPER_SNAKE_CASE.
6982 },
6983 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
6984 #
6985 # For example, if a quota check failed with an error indicating the calling
6986 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
6987 # directly to the right place in the developer console to flip the bit.
6988 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
6989 { # Describes a URL link.
6990 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
6991 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
6992 },
6993 ],
6994 },
6995 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
6996 # which can be attached to an RPC error.
6997 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
6998 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
6999 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
7000 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
7001 },
7002 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
7003 &quot;dimensions&quot;: { # The map holding related quota dimensions.
7004 &quot;a_key&quot;: &quot;A String&quot;,
7005 },
7006 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
7007 # type or metric.
7008 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
7009 # or metric.
7010 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
7011 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
7012 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
7013 },
7014 },
7015 ],
7016 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
7017 # This property is optional.
7018 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
7019 },
7020 ],
7021 },
7022 &quot;timestamp&quot;: &quot;A String&quot;, # Output only. Timestamp of the last progress check of bulk instance
7023 # operation. Timestamp is in RFC3339 text format.
7024 },
7025 },
7026 &quot;currentInstanceStatuses&quot;: { # The list of instance statuses and the number of instances in this managed # Output only. The list of instance statuses and the number of instances
7027 # in this managed instance group that have the status. Currently only shown
7028 # for TPU MIGs
7029 # instance group that have the status. For more information about how to
7030 # interpret each status check the instance lifecycle documentation.
7031 # Currently only shown for TPU MIGs.
7032 &quot;deprovisioning&quot;: 42, # Output only. The number of instances in the managed instance group
7033 # that have DEPROVISIONING status.
7034 &quot;nonExistent&quot;: 42, # Output only. The number of instances that have not been created yet or
7035 # have been deleted. Includes only instances that would be shown in the
7036 # listManagedInstances method and not all instances that have been
7037 # deleted in the lifetime of the MIG.
7038 # Does not include FlexStart instances that are waiting for the resources
7039 # availability, they are considered as &#x27;pending&#x27;.
7040 &quot;pending&quot;: 42, # Output only. The number of instances in the managed instance group
7041 # that have PENDING status, that is FlexStart instances that are waiting
7042 # for resources. Instances that do not exist because of the other reasons
7043 # are counted as &#x27;non_existent&#x27;.
7044 &quot;pendingStop&quot;: 42, # Output only. The number of instances in the managed instance group
7045 # that have PENDING_STOP status.
7046 &quot;provisioning&quot;: 42, # Output only. The number of instances in the managed instance group
7047 # that have PROVISIONING status.
7048 &quot;repairing&quot;: 42, # Output only. The number of instances in the managed instance group
7049 # that have REPAIRING status.
7050 &quot;running&quot;: 42, # Output only. The number of instances in the managed instance group
7051 # that have RUNNING status.
7052 &quot;staging&quot;: 42, # Output only. The number of instances in the managed instance group
7053 # that have STAGING status.
7054 &quot;stopped&quot;: 42, # Output only. The number of instances in the managed instance group
7055 # that have STOPPED status.
7056 &quot;stopping&quot;: 42, # Output only. The number of instances in the managed instance group
7057 # that have STOPPING status.
7058 &quot;suspended&quot;: 42, # Output only. The number of instances in the managed instance group
7059 # that have SUSPENDED status.
7060 &quot;suspending&quot;: 42, # Output only. The number of instances in the managed instance group
7061 # that have SUSPENDING status.
7062 &quot;terminated&quot;: 42, # Output only. The number of instances in the managed instance group
7063 # that have TERMINATED status.
7064 },
7065 &quot;isStable&quot;: True or False, # Output only. A bit indicating whether the managed instance group is in a
7066 # stable state. A stable state means that: none of the instances in the
7067 # managed instance group is currently undergoing any type of change (for
7068 # example, creation, restart, or deletion); no future changes are scheduled
7069 # for instances in the managed instance group; and the managed instance
7070 # group itself is not being modified.
7071 &quot;stateful&quot;: { # Output only. Stateful status of the given Instance Group Manager.
7072 &quot;hasStatefulConfig&quot;: True or False, # Output only. A bit indicating whether the managed instance group
7073 # has stateful configuration, that is, if you have configured any items
7074 # in a stateful policy or in per-instance configs.
7075 # The group might report that it has no stateful configuration even when
7076 # there is still some preserved state on a managed instance, for example,
7077 # if you have deleted all PICs but not yet applied those deletions.
7078 &quot;perInstanceConfigs&quot;: { # Output only. Status of per-instance configurations on the instances.
7079 &quot;allEffective&quot;: True or False, # Output only. A bit indicating if all of the group&#x27;s per-instance configurations
7080 # (listed in the output of a listPerInstanceConfigs API call) have
7081 # status EFFECTIVE or there are no per-instance-configs.
7082 },
7083 },
7084 &quot;versionTarget&quot;: { # Output only. A status of consistency of Instances&#x27; versions with their
7085 # target version specified by version field on Instance Group
7086 # Manager.
7087 &quot;isReached&quot;: True or False, # Output only. A bit indicating whether version target has been reached
7088 # in this managed instance group, i.e. all instances are in their target
7089 # version. Instances&#x27; target version are specified byversion field on Instance Group Manager.
7090 },
7091 },
7092 &quot;targetPools&quot;: [ # The URLs for all TargetPool resources to which instances in theinstanceGroup field are added. The target pools automatically
7093 # apply to all of the instances in the managed instance group.
7094 &quot;A String&quot;,
7095 ],
7096 &quot;targetSize&quot;: 42, # The target number of running instances for this managed instance group.
7097 # You can reduce this number by using the instanceGroupManager
7098 # deleteInstances or abandonInstances methods. Resizing the group also
7099 # changes this number.
7100 &quot;targetSizePolicy&quot;: { # The policy that specifies how the MIG creates its VMs to achieve the target
7101 # size.
7102 &quot;mode&quot;: &quot;A String&quot;, # The mode of target size policy based on which the MIG creates its VMs
7103 # individually or all at once.
7104 },
7105 &quot;targetStoppedSize&quot;: 42, # The target number of stopped instances for this managed instance group.
7106 # This number changes when you:
7107 #
7108 # - Stop instance using the stopInstances
7109 # method or start instances using the startInstances
7110 # method.
7111 # - Manually change the targetStoppedSize using the update
7112 # method.
7113 &quot;targetSuspendedSize&quot;: 42, # The target number of suspended instances for this managed instance group.
7114 # This number changes when you:
7115 #
7116 # - Suspend instance using the suspendInstances
7117 # method or resume instances using the resumeInstances
7118 # method.
7119 # - Manually change the targetSuspendedSize using the update
7120 # method.
7121 &quot;updatePolicy&quot;: { # The update policy for this managed instance group.
7122 &quot;instanceRedistributionType&quot;: &quot;A String&quot;, # The
7123 # instance redistribution policy for regional managed instance groups.
7124 # Valid values are:
7125 #
7126 # - PROACTIVE (default): The group attempts to maintain an
7127 # even distribution of VM instances across zones in the region.
7128 # - NONE: For non-autoscaled groups, proactive
7129 # redistribution is disabled.
7130 &quot;maxSurge&quot;: { # Encapsulates numeric value that can be either absolute or relative. # The maximum number of instances that can be created above the specifiedtargetSize during the update process. This value can be
7131 # either a fixed number or, if the group has 10 or more instances, a
7132 # percentage. If you set a percentage, the number of instances is rounded
7133 # if necessary. The default value for maxSurge is a fixed
7134 # value equal to the number of zones in which the managed instance group
7135 # operates.
7136 #
7137 # At least one of either maxSurge ormaxUnavailable must be greater than 0. Learn more about maxSurge.
7138 &quot;calculated&quot;: 42, # Output only. Absolute value of VM instances calculated based on the specific mode.
7139 #
7140 #
7141 #
7142 # - If the value is fixed, then the calculated
7143 # value is equal to the fixed value.
7144 # - If the value is a percent, then the
7145 # calculated
7146 # value is percent/100 * targetSize. For example,
7147 # the calculated value of a 80% of a managed instance group
7148 # with 150 instances would be (80/100 * 150) = 120 VM instances. If there
7149 # is a remainder, the number is rounded.
7150 &quot;fixed&quot;: 42, # Specifies a fixed number of VM instances. This must be a positive integer.
7151 &quot;percent&quot;: 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For
7152 # example, specify 80 for 80%.
7153 },
7154 &quot;maxUnavailable&quot;: { # Encapsulates numeric value that can be either absolute or relative. # The maximum number of instances that can be unavailable during the update
7155 # process. An instance is considered available if all of the following
7156 # conditions are satisfied:
7157 #
7158 #
7159 #
7160 # - The instance&#x27;s status is
7161 # RUNNING.
7162 # - If there is a health
7163 # check on the instance group, the instance&#x27;s health check status
7164 # must be HEALTHY at least once. If there is no health check
7165 # on the group, then the instance only needs to have a status of
7166 # RUNNING to be considered available.
7167 #
7168 #
7169 # This value can be either a fixed number or, if the group has 10 or more
7170 # instances, a percentage. If you set a percentage, the number of instances
7171 # is rounded if necessary. The default value formaxUnavailable is a fixed value equal to the number of zones
7172 # in which the managed instance group operates.
7173 #
7174 # At least one of either maxSurge ormaxUnavailable must be greater than 0. Learn more about maxUnavailable.
7175 &quot;calculated&quot;: 42, # Output only. Absolute value of VM instances calculated based on the specific mode.
7176 #
7177 #
7178 #
7179 # - If the value is fixed, then the calculated
7180 # value is equal to the fixed value.
7181 # - If the value is a percent, then the
7182 # calculated
7183 # value is percent/100 * targetSize. For example,
7184 # the calculated value of a 80% of a managed instance group
7185 # with 150 instances would be (80/100 * 150) = 120 VM instances. If there
7186 # is a remainder, the number is rounded.
7187 &quot;fixed&quot;: 42, # Specifies a fixed number of VM instances. This must be a positive integer.
7188 &quot;percent&quot;: 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For
7189 # example, specify 80 for 80%.
7190 },
7191 &quot;minimalAction&quot;: &quot;A String&quot;, # Minimal action to be taken on an instance. Use this option to minimize
7192 # disruption as much as possible or to apply a more disruptive action than
7193 # is necessary.
7194 #
7195 # - To limit disruption as much as possible, set the minimal action toREFRESH. If your update requires a more disruptive action,
7196 # Compute Engine performs the necessary action to execute the update.
7197 # - To apply a more disruptive action than is strictly necessary, set the
7198 # minimal action to RESTART or REPLACE. For
7199 # example, Compute Engine does not need to restart a VM to change its
7200 # metadata. But if your application reads instance metadata only when a VM
7201 # is restarted, you can set the minimal action to RESTART in
7202 # order to pick up metadata changes.
7203 &quot;mostDisruptiveAllowedAction&quot;: &quot;A String&quot;, # Most disruptive action that is allowed to be taken on an instance.
7204 # You can specify either NONE to forbid any actions,REFRESH to avoid restarting the VM and to limit disruption
7205 # as much as possible. RESTART to allow actions that can be
7206 # applied without instance replacing or REPLACE to allow all
7207 # possible actions. If the Updater determines that the minimal update
7208 # action needed is more disruptive than most disruptive allowed action you
7209 # specify it will not perform the update at all.
7210 &quot;replacementMethod&quot;: &quot;A String&quot;, # What action should be used to replace instances.
7211 # See minimal_action.REPLACE
7212 &quot;type&quot;: &quot;A String&quot;, # The type
7213 # of update process. You can specify either PROACTIVE so
7214 # that the MIG automatically updates VMs to the latest configurations orOPPORTUNISTIC so that you can select the VMs that you want
7215 # to update.
7216 },
7217 &quot;versions&quot;: [ # Specifies the instance templates used by this managed instance group to
7218 # create instances.
7219 #
7220 # Each version is defined by an instanceTemplate and aname. Every version can appear at most once per instance
7221 # group. This field overrides the top-level instanceTemplate
7222 # field. Read more about therelationships
7223 # between these fields. Exactly one version must leave thetargetSize field unset. That version will be applied to all
7224 # remaining instances. For more information, read aboutcanary
7225 # updates.
7226 {
7227 &quot;instanceTemplate&quot;: &quot;A String&quot;, # The URL of the instance template that is specified for this managed
7228 # instance group. The group uses this template to create new instances in
7229 # the managed instance group until the `targetSize` for this version is
7230 # reached. The templates for existing instances in the group do not change
7231 # unless you run recreateInstances, runapplyUpdatesToInstances, or set the group&#x27;supdatePolicy.type to PROACTIVE; in those cases,
7232 # existing instances are updated until the `targetSize` for this version is
7233 # reached.
7234 &quot;name&quot;: &quot;A String&quot;, # Name of the version. Unique among all versions in the scope of this
7235 # managed instance group.
7236 &quot;targetSize&quot;: { # Encapsulates numeric value that can be either absolute or relative. # Specifies the intended number of instances to be created from theinstanceTemplate. The final number of instances created
7237 # from the template will be equal to:
7238 #
7239 #
7240 # - If expressed as a fixed number, the minimum of either
7241 # targetSize.fixed or
7242 # instanceGroupManager.targetSize is used.
7243 # - if expressed as a percent, the targetSize
7244 # would be (targetSize.percent/100 *
7245 # InstanceGroupManager.targetSize) If there is a remainder, the
7246 # number is rounded.
7247 #
7248 # If unset, this version will update any remaining instances not
7249 # updated by another version. ReadStarting
7250 # a canary update for more information.
7251 &quot;calculated&quot;: 42, # Output only. Absolute value of VM instances calculated based on the specific mode.
7252 #
7253 #
7254 #
7255 # - If the value is fixed, then the calculated
7256 # value is equal to the fixed value.
7257 # - If the value is a percent, then the
7258 # calculated
7259 # value is percent/100 * targetSize. For example,
7260 # the calculated value of a 80% of a managed instance group
7261 # with 150 instances would be (80/100 * 150) = 120 VM instances. If there
7262 # is a remainder, the number is rounded.
7263 &quot;fixed&quot;: 42, # Specifies a fixed number of VM instances. This must be a positive integer.
7264 &quot;percent&quot;: 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For
7265 # example, specify 80 for 80%.
7266 },
7267 },
7268 ],
7269 &quot;zone&quot;: &quot;A String&quot;, # Output only. The URL of azone
7270 # where the managed instance group is located (for zonal resources).
7271 }
7272
7273 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
7274 that if you must retry your request, the server will know to ignore the
7275 request if it has already been completed.
7276
7277 For example, consider a situation where you make an initial request and
7278 the request times out. If you make the request again with the same
7279 request ID, the server can check if original operation with the same
7280 request ID was received, and if so, will ignore the second request. This
7281 prevents clients from accidentally creating duplicate commitments.
7282
7283 The request ID must be
7284 a valid UUID with the exception that zero UUID is not supported
7285 (00000000-0000-0000-0000-000000000000).
7286 x__xgafv: string, V1 error format.
7287 Allowed values
7288 1 - v1 error format
7289 2 - v2 error format
7290
7291 Returns:
7292 An object of the form:
7293
7294 { # Represents an Operation resource.
7295 #
7296 # Google Compute Engine has three Operation resources:
7297 #
7298 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
7299 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
7300 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
7301 #
7302 # You can use an operation resource to manage asynchronous API requests.
7303 # For more information, readHandling
7304 # API responses.
7305 #
7306 # Operations can be global, regional or zonal.
7307 #
7308 # - For global operations, use the `globalOperations`
7309 # resource.
7310 # - For regional operations, use the
7311 # `regionOperations` resource.
7312 # - For zonal operations, use
7313 # the `zoneOperations` resource.
7314 #
7315 #
7316 #
7317 # For more information, read
7318 # Global, Regional, and Zonal Resources.
7319 #
7320 # Note that completed Operation resources have a limited
7321 # retention period.
7322 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
7323 # Not present otherwise.
7324 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
7325 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
7326 # set when the operation is created.
7327 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
7328 # text format.
7329 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
7330 # this field will be populated.
7331 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
7332 # operation.
7333 {
7334 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
7335 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
7336 # details. There is a set of defined message types to use for providing
7337 # details.The syntax depends on the error code. For example,
7338 # QuotaExceededInfo will have details when the error code is
7339 # QUOTA_EXCEEDED.
7340 {
7341 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
7342 #
7343 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
7344 # is not enabled:
7345 #
7346 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
7347 # &quot;domain&quot;: &quot;googleapis.com&quot;
7348 # &quot;metadata&quot;: {
7349 # &quot;resource&quot;: &quot;projects/123&quot;,
7350 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
7351 # }
7352 # }
7353 #
7354 # This response indicates that the pubsub.googleapis.com API is not enabled.
7355 #
7356 # Example of an error that is returned when attempting to create a Spanner
7357 # instance in a region that is out of stock:
7358 #
7359 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
7360 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
7361 # &quot;metadata&quot;: {
7362 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
7363 # }
7364 # }
7365 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
7366 # is typically the registered service name of the tool or product that
7367 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
7368 # generated by some common infrastructure, the error domain must be a
7369 # globally unique value that identifies the infrastructure. For Google API
7370 # infrastructure, the error domain is &quot;googleapis.com&quot;.
7371 &quot;metadatas&quot;: { # Additional structured details about this error.
7372 #
7373 # Keys must match a regular expression of `a-z+` but should
7374 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
7375 # length. When identifying the current value of an exceeded limit, the units
7376 # should be contained in the key, not the value. For example, rather than
7377 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
7378 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
7379 # instances that can be created in a single (batch) request.
7380 &quot;a_key&quot;: &quot;A String&quot;,
7381 },
7382 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
7383 # proximate cause of the error. Error reasons are unique within a particular
7384 # domain of errors. This should be at most 63 characters and match a
7385 # regular expression of `A-Z+[A-Z0-9]`, which represents
7386 # UPPER_SNAKE_CASE.
7387 },
7388 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
7389 #
7390 # For example, if a quota check failed with an error indicating the calling
7391 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
7392 # directly to the right place in the developer console to flip the bit.
7393 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
7394 { # Describes a URL link.
7395 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
7396 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
7397 },
7398 ],
7399 },
7400 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
7401 # which can be attached to an RPC error.
7402 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
7403 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
7404 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
7405 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
7406 },
7407 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
7408 &quot;dimensions&quot;: { # The map holding related quota dimensions.
7409 &quot;a_key&quot;: &quot;A String&quot;,
7410 },
7411 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
7412 # type or metric.
7413 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
7414 # or metric.
7415 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
7416 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
7417 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
7418 },
7419 },
7420 ],
7421 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
7422 # This property is optional.
7423 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
7424 },
7425 ],
7426 },
7427 &quot;getVersionOperationMetadata&quot;: {
7428 &quot;inlineSbomInfo&quot;: {
7429 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
7430 # appropriate identifiers.
7431 &quot;a_key&quot;: &quot;A String&quot;,
7432 },
7433 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
7434 # identifiers.
7435 &quot;a_key&quot;: &quot;A String&quot;,
7436 },
7437 },
7438 },
7439 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
7440 # message that was returned, such as `NOT FOUND`.
7441 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
7442 # status code that was returned. For example, a `404` means the
7443 # resource was not found.
7444 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
7445 # defined by the server.
7446 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
7447 # This value is inRFC3339
7448 # text format.
7449 &quot;instancesBulkInsertOperationMetadata&quot;: {
7450 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
7451 # Example key: zones/us-central1-a
7452 &quot;a_key&quot;: {
7453 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
7454 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
7455 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
7456 # error.
7457 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
7458 # if the flow is rolling forward or rolling back.
7459 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
7460 },
7461 },
7462 },
7463 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
7464 # Operation resources.
7465 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
7466 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
7467 # group of operations results from a `bulkInsert` API request.
7468 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
7469 # `update`, or `delete`, and so on.
7470 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
7471 # There is no requirement that this be linear or support any granularity of
7472 # operations. This should not be used to guess when the operation will be
7473 # complete. This number should monotonically increase as the operation
7474 # progresses.
7475 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
7476 # applicable when performing regional operations.
7477 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
7478 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
7479 # this field will contain information on all underlying zonal actions and
7480 # their state.
7481 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
7482 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
7483 # Example key: zones/us-central1-a
7484 &quot;a_key&quot;: {
7485 &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
7486 # populated.
7487 # different programming environments, including REST APIs and RPC APIs. It is
7488 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
7489 # three pieces of data: error code, error message, and error details.
7490 #
7491 # You can find out more about this error model and how to work with it in the
7492 # [API Design Guide](https://cloud.google.com/apis/design/errors).
7493 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
7494 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
7495 # message types for APIs to use.
7496 {
7497 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
7498 },
7499 ],
7500 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
7501 # user-facing error message should be localized and sent in the
7502 # google.rpc.Status.details field, or localized by the client.
7503 },
7504 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
7505 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
7506 },
7507 },
7508 },
7509 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
7510 # This value is inRFC3339
7511 # text format.
7512 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
7513 # following:
7514 # `PENDING`, `RUNNING`, or `DONE`.
7515 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
7516 # operation.
7517 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
7518 # of the target resource.
7519 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
7520 # operations related to creating a snapshot, this points to the disk
7521 # that the snapshot was created from.
7522 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
7523 # `[email protected]` or
7524 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
7525 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
7526 # operation, this field will be populated.
7527 {
7528 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
7529 # Engine returns NO_RESULTS_ON_PAGE if there
7530 # are no results in the response.
7531 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
7532 # value format. For example:
7533 #
7534 # &quot;data&quot;: [
7535 # {
7536 # &quot;key&quot;: &quot;scope&quot;,
7537 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
7538 # }
7539 {
7540 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
7541 # returned. For example, for warnings where there are no results in a list
7542 # request for a particular zone, this key might be scope and
7543 # the key value might be the zone name. Other examples might be a key
7544 # indicating a deprecated resource and a suggested replacement, or a
7545 # warning about invalid network settings (for example, if an instance
7546 # attempts to perform IP forwarding but is not enabled for IP forwarding).
7547 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
7548 },
7549 ],
7550 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
7551 },
7552 ],
7553 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
7554 # applicable when performing per-zone operations.
7555 }</pre>
7556 </div>
7557
7558 <div class="method">
7559 <code class="details" id="patchPerInstanceConfigs">patchPerInstanceConfigs(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
7560 <pre>Inserts or patches per-instance configurations for the managed instance
7561 group. perInstanceConfig.name serves as a key used to
7562 distinguish whether to perform insert or patch.
7563
7564 Args:
7565 project: string, Project ID for this request. (required)
7566 zone: string, The name of thezone
7567 where the managed instance group is located.
7568 It should conform to RFC1035. (required)
7569 instanceGroupManager: string, The name of the managed instance group.
7570 It should conform to RFC1035. (required)
7571 body: object, The request body.
7572 The object takes the form of:
7573
7574 { # InstanceGroupManagers.patchPerInstanceConfigs
7575 &quot;perInstanceConfigs&quot;: [ # The list of per-instance configurations to insert or patch on this managed
7576 # instance group.
7577 {
7578 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this per-instance config. This field can be used in
7579 # optimistic locking. It is ignored when inserting a per-instance
7580 # config. An up-to-date fingerprint must be provided in order to update an
7581 # existing per-instance configuration or the field needs to be unset.
7582 &quot;name&quot;: &quot;A String&quot;, # The name of a per-instance configuration and its corresponding instance.
7583 # Serves as a merge key during UpdatePerInstanceConfigs
7584 # operations, that is, if a per-instance configuration with the same name
7585 # exists then it will be updated, otherwise a new one will be created for the
7586 # VM instance with the same name. An attempt to create a per-instance
7587 # configuration for a VM instance that either doesn&#x27;t exist or is not part
7588 # of the group will result in an error.
7589 &quot;preservedState&quot;: { # Preserved state for a given instance. # The intended preserved state for the given instance. Does not contain
7590 # preserved state generated from a stateful policy.
7591 &quot;disks&quot;: { # Preserved disks defined for this instance.
7592 # This map is keyed with the device names of the disks.
7593 &quot;a_key&quot;: {
7594 &quot;autoDelete&quot;: &quot;A String&quot;, # These stateful disks will never be deleted during autohealing,
7595 # update, instance recreate operations. This flag is used to configure
7596 # if the disk should be deleted after it is no longer used by the group,
7597 # e.g. when the given instance or the whole MIG is deleted.
7598 # Note: disks attached in READ_ONLY mode cannot be
7599 # auto-deleted.
7600 &quot;mode&quot;: &quot;A String&quot;, # The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the
7601 # disk in READ_WRITE mode.
7602 &quot;source&quot;: &quot;A String&quot;, # The URL of the disk resource that is stateful and should be attached
7603 # to the VM instance.
7604 },
7605 },
7606 &quot;externalIPs&quot;: { # Preserved external IPs defined for this instance.
7607 # This map is keyed with the name of the network interface.
7608 &quot;a_key&quot;: {
7609 &quot;autoDelete&quot;: &quot;A String&quot;, # These stateful IPs will never be released during autohealing,
7610 # update or VM instance recreate operations.
7611 # This flag is used to configure if the IP reservation should be deleted
7612 # after it is no longer used by the group, e.g. when the given instance
7613 # or the whole group is deleted.
7614 &quot;ipAddress&quot;: { # Ip address representation
7615 &quot;address&quot;: &quot;A String&quot;, # The URL of the reservation for this IP address.
7616 &quot;literal&quot;: &quot;A String&quot;, # An IPv4 internal network address to assign to the instance for this
7617 # network interface.
7618 },
7619 },
7620 },
7621 &quot;internalIPs&quot;: { # Preserved internal IPs defined for this instance.
7622 # This map is keyed with the name of the network interface.
7623 &quot;a_key&quot;: {
7624 &quot;autoDelete&quot;: &quot;A String&quot;, # These stateful IPs will never be released during autohealing,
7625 # update or VM instance recreate operations.
7626 # This flag is used to configure if the IP reservation should be deleted
7627 # after it is no longer used by the group, e.g. when the given instance
7628 # or the whole group is deleted.
7629 &quot;ipAddress&quot;: { # Ip address representation
7630 &quot;address&quot;: &quot;A String&quot;, # The URL of the reservation for this IP address.
7631 &quot;literal&quot;: &quot;A String&quot;, # An IPv4 internal network address to assign to the instance for this
7632 # network interface.
7633 },
7634 },
7635 },
7636 &quot;metadata&quot;: { # Preserved metadata defined for this instance.
7637 &quot;a_key&quot;: &quot;A String&quot;,
7638 },
7639 },
7640 &quot;status&quot;: &quot;A String&quot;, # The status of applying this per-instance configuration on the corresponding
7641 # managed instance.
7642 },
7643 ],
7644 }
7645
7646 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
7647 that if you must retry your request, the server will know to ignore the
7648 request if it has already been completed.
7649
7650 For example, consider a situation where you make an initial request and
7651 the request times out. If you make the request again with the same
7652 request ID, the server can check if original operation with the same
7653 request ID was received, and if so, will ignore the second request. This
7654 prevents clients from accidentally creating duplicate commitments.
7655
7656 The request ID must be
7657 a valid UUID with the exception that zero UUID is not supported
7658 (00000000-0000-0000-0000-000000000000).
7659 x__xgafv: string, V1 error format.
7660 Allowed values
7661 1 - v1 error format
7662 2 - v2 error format
7663
7664 Returns:
7665 An object of the form:
7666
7667 { # Represents an Operation resource.
7668 #
7669 # Google Compute Engine has three Operation resources:
7670 #
7671 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
7672 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
7673 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
7674 #
7675 # You can use an operation resource to manage asynchronous API requests.
7676 # For more information, readHandling
7677 # API responses.
7678 #
7679 # Operations can be global, regional or zonal.
7680 #
7681 # - For global operations, use the `globalOperations`
7682 # resource.
7683 # - For regional operations, use the
7684 # `regionOperations` resource.
7685 # - For zonal operations, use
7686 # the `zoneOperations` resource.
7687 #
7688 #
7689 #
7690 # For more information, read
7691 # Global, Regional, and Zonal Resources.
7692 #
7693 # Note that completed Operation resources have a limited
7694 # retention period.
7695 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
7696 # Not present otherwise.
7697 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
7698 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
7699 # set when the operation is created.
7700 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
7701 # text format.
7702 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
7703 # this field will be populated.
7704 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
7705 # operation.
7706 {
7707 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
7708 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
7709 # details. There is a set of defined message types to use for providing
7710 # details.The syntax depends on the error code. For example,
7711 # QuotaExceededInfo will have details when the error code is
7712 # QUOTA_EXCEEDED.
7713 {
7714 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
7715 #
7716 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
7717 # is not enabled:
7718 #
7719 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
7720 # &quot;domain&quot;: &quot;googleapis.com&quot;
7721 # &quot;metadata&quot;: {
7722 # &quot;resource&quot;: &quot;projects/123&quot;,
7723 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
7724 # }
7725 # }
7726 #
7727 # This response indicates that the pubsub.googleapis.com API is not enabled.
7728 #
7729 # Example of an error that is returned when attempting to create a Spanner
7730 # instance in a region that is out of stock:
7731 #
7732 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
7733 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
7734 # &quot;metadata&quot;: {
7735 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
7736 # }
7737 # }
7738 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
7739 # is typically the registered service name of the tool or product that
7740 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
7741 # generated by some common infrastructure, the error domain must be a
7742 # globally unique value that identifies the infrastructure. For Google API
7743 # infrastructure, the error domain is &quot;googleapis.com&quot;.
7744 &quot;metadatas&quot;: { # Additional structured details about this error.
7745 #
7746 # Keys must match a regular expression of `a-z+` but should
7747 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
7748 # length. When identifying the current value of an exceeded limit, the units
7749 # should be contained in the key, not the value. For example, rather than
7750 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
7751 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
7752 # instances that can be created in a single (batch) request.
7753 &quot;a_key&quot;: &quot;A String&quot;,
7754 },
7755 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
7756 # proximate cause of the error. Error reasons are unique within a particular
7757 # domain of errors. This should be at most 63 characters and match a
7758 # regular expression of `A-Z+[A-Z0-9]`, which represents
7759 # UPPER_SNAKE_CASE.
7760 },
7761 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
7762 #
7763 # For example, if a quota check failed with an error indicating the calling
7764 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
7765 # directly to the right place in the developer console to flip the bit.
7766 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
7767 { # Describes a URL link.
7768 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
7769 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
7770 },
7771 ],
7772 },
7773 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
7774 # which can be attached to an RPC error.
7775 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
7776 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
7777 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
7778 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
7779 },
7780 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
7781 &quot;dimensions&quot;: { # The map holding related quota dimensions.
7782 &quot;a_key&quot;: &quot;A String&quot;,
7783 },
7784 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
7785 # type or metric.
7786 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
7787 # or metric.
7788 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
7789 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
7790 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
7791 },
7792 },
7793 ],
7794 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
7795 # This property is optional.
7796 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
7797 },
7798 ],
7799 },
7800 &quot;getVersionOperationMetadata&quot;: {
7801 &quot;inlineSbomInfo&quot;: {
7802 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
7803 # appropriate identifiers.
7804 &quot;a_key&quot;: &quot;A String&quot;,
7805 },
7806 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
7807 # identifiers.
7808 &quot;a_key&quot;: &quot;A String&quot;,
7809 },
7810 },
7811 },
7812 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
7813 # message that was returned, such as `NOT FOUND`.
7814 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
7815 # status code that was returned. For example, a `404` means the
7816 # resource was not found.
7817 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
7818 # defined by the server.
7819 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
7820 # This value is inRFC3339
7821 # text format.
7822 &quot;instancesBulkInsertOperationMetadata&quot;: {
7823 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
7824 # Example key: zones/us-central1-a
7825 &quot;a_key&quot;: {
7826 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
7827 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
7828 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
7829 # error.
7830 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
7831 # if the flow is rolling forward or rolling back.
7832 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
7833 },
7834 },
7835 },
7836 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
7837 # Operation resources.
7838 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
7839 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
7840 # group of operations results from a `bulkInsert` API request.
7841 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
7842 # `update`, or `delete`, and so on.
7843 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
7844 # There is no requirement that this be linear or support any granularity of
7845 # operations. This should not be used to guess when the operation will be
7846 # complete. This number should monotonically increase as the operation
7847 # progresses.
7848 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
7849 # applicable when performing regional operations.
7850 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
7851 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
7852 # this field will contain information on all underlying zonal actions and
7853 # their state.
7854 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
7855 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
7856 # Example key: zones/us-central1-a
7857 &quot;a_key&quot;: {
7858 &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
7859 # populated.
7860 # different programming environments, including REST APIs and RPC APIs. It is
7861 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
7862 # three pieces of data: error code, error message, and error details.
7863 #
7864 # You can find out more about this error model and how to work with it in the
7865 # [API Design Guide](https://cloud.google.com/apis/design/errors).
7866 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
7867 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
7868 # message types for APIs to use.
7869 {
7870 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
7871 },
7872 ],
7873 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
7874 # user-facing error message should be localized and sent in the
7875 # google.rpc.Status.details field, or localized by the client.
7876 },
7877 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
7878 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
7879 },
7880 },
7881 },
7882 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
7883 # This value is inRFC3339
7884 # text format.
7885 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
7886 # following:
7887 # `PENDING`, `RUNNING`, or `DONE`.
7888 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
7889 # operation.
7890 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
7891 # of the target resource.
7892 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
7893 # operations related to creating a snapshot, this points to the disk
7894 # that the snapshot was created from.
7895 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
7896 # `[email protected]` or
7897 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
7898 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
7899 # operation, this field will be populated.
7900 {
7901 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
7902 # Engine returns NO_RESULTS_ON_PAGE if there
7903 # are no results in the response.
7904 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
7905 # value format. For example:
7906 #
7907 # &quot;data&quot;: [
7908 # {
7909 # &quot;key&quot;: &quot;scope&quot;,
7910 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
7911 # }
7912 {
7913 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
7914 # returned. For example, for warnings where there are no results in a list
7915 # request for a particular zone, this key might be scope and
7916 # the key value might be the zone name. Other examples might be a key
7917 # indicating a deprecated resource and a suggested replacement, or a
7918 # warning about invalid network settings (for example, if an instance
7919 # attempts to perform IP forwarding but is not enabled for IP forwarding).
7920 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
7921 },
7922 ],
7923 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
7924 },
7925 ],
7926 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
7927 # applicable when performing per-zone operations.
7928 }</pre>
7929 </div>
7930
7931 <div class="method">
7932 <code class="details" id="recreateInstances">recreateInstances(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
7933 <pre>Flags the specified VM instances in the managed instance group to be
7934 immediately recreated. Each instance is recreated using the group&#x27;s current
7935 configuration. This operation is marked as DONE when the flag
7936 is set even if the instances have not yet been recreated. You must
7937 separately verify the status of each instance by checking itscurrentAction field; for more information, see Checking
7938 the status of managed instances.
7939
7940 If the group is part of a backend
7941 service that has enabled
7942 connection draining, it can take up to 60 seconds after the connection
7943 draining duration has elapsed before the VM instance is removed or deleted.
7944
7945 You can specify a maximum of 1000 instances with this method per request.
7946
7947 Args:
7948 project: string, Project ID for this request. (required)
7949 zone: string, The name of thezone where the managed
7950 instance group is located. (required)
7951 instanceGroupManager: string, The name of the managed instance group. (required)
7952 body: object, The request body.
7953 The object takes the form of:
7954
7955 {
7956 &quot;instances&quot;: [ # The URLs of one or more instances to recreate. This can be a full URL or
7957 # a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].
7958 &quot;A String&quot;,
7959 ],
7960 }
7961
7962 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
7963 that if you must retry your request, the server will know to ignore the
7964 request if it has already been completed.
7965
7966 For example, consider a situation where you make an initial request and
7967 the request times out. If you make the request again with the same
7968 request ID, the server can check if original operation with the same
7969 request ID was received, and if so, will ignore the second request. This
7970 prevents clients from accidentally creating duplicate commitments.
7971
7972 The request ID must be
7973 a valid UUID with the exception that zero UUID is not supported
7974 (00000000-0000-0000-0000-000000000000).
7975 x__xgafv: string, V1 error format.
7976 Allowed values
7977 1 - v1 error format
7978 2 - v2 error format
7979
7980 Returns:
7981 An object of the form:
7982
7983 { # Represents an Operation resource.
7984 #
7985 # Google Compute Engine has three Operation resources:
7986 #
7987 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
7988 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
7989 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
7990 #
7991 # You can use an operation resource to manage asynchronous API requests.
7992 # For more information, readHandling
7993 # API responses.
7994 #
7995 # Operations can be global, regional or zonal.
7996 #
7997 # - For global operations, use the `globalOperations`
7998 # resource.
7999 # - For regional operations, use the
8000 # `regionOperations` resource.
8001 # - For zonal operations, use
8002 # the `zoneOperations` resource.
8003 #
8004 #
8005 #
8006 # For more information, read
8007 # Global, Regional, and Zonal Resources.
8008 #
8009 # Note that completed Operation resources have a limited
8010 # retention period.
8011 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
8012 # Not present otherwise.
8013 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
8014 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
8015 # set when the operation is created.
8016 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
8017 # text format.
8018 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
8019 # this field will be populated.
8020 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
8021 # operation.
8022 {
8023 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
8024 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
8025 # details. There is a set of defined message types to use for providing
8026 # details.The syntax depends on the error code. For example,
8027 # QuotaExceededInfo will have details when the error code is
8028 # QUOTA_EXCEEDED.
8029 {
8030 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
8031 #
8032 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
8033 # is not enabled:
8034 #
8035 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
8036 # &quot;domain&quot;: &quot;googleapis.com&quot;
8037 # &quot;metadata&quot;: {
8038 # &quot;resource&quot;: &quot;projects/123&quot;,
8039 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
8040 # }
8041 # }
8042 #
8043 # This response indicates that the pubsub.googleapis.com API is not enabled.
8044 #
8045 # Example of an error that is returned when attempting to create a Spanner
8046 # instance in a region that is out of stock:
8047 #
8048 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
8049 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
8050 # &quot;metadata&quot;: {
8051 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
8052 # }
8053 # }
8054 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
8055 # is typically the registered service name of the tool or product that
8056 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
8057 # generated by some common infrastructure, the error domain must be a
8058 # globally unique value that identifies the infrastructure. For Google API
8059 # infrastructure, the error domain is &quot;googleapis.com&quot;.
8060 &quot;metadatas&quot;: { # Additional structured details about this error.
8061 #
8062 # Keys must match a regular expression of `a-z+` but should
8063 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
8064 # length. When identifying the current value of an exceeded limit, the units
8065 # should be contained in the key, not the value. For example, rather than
8066 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
8067 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
8068 # instances that can be created in a single (batch) request.
8069 &quot;a_key&quot;: &quot;A String&quot;,
8070 },
8071 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
8072 # proximate cause of the error. Error reasons are unique within a particular
8073 # domain of errors. This should be at most 63 characters and match a
8074 # regular expression of `A-Z+[A-Z0-9]`, which represents
8075 # UPPER_SNAKE_CASE.
8076 },
8077 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
8078 #
8079 # For example, if a quota check failed with an error indicating the calling
8080 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
8081 # directly to the right place in the developer console to flip the bit.
8082 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
8083 { # Describes a URL link.
8084 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
8085 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
8086 },
8087 ],
8088 },
8089 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
8090 # which can be attached to an RPC error.
8091 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
8092 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
8093 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
8094 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
8095 },
8096 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
8097 &quot;dimensions&quot;: { # The map holding related quota dimensions.
8098 &quot;a_key&quot;: &quot;A String&quot;,
8099 },
8100 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
8101 # type or metric.
8102 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
8103 # or metric.
8104 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
8105 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
8106 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
8107 },
8108 },
8109 ],
8110 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
8111 # This property is optional.
8112 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
8113 },
8114 ],
8115 },
8116 &quot;getVersionOperationMetadata&quot;: {
8117 &quot;inlineSbomInfo&quot;: {
8118 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
8119 # appropriate identifiers.
8120 &quot;a_key&quot;: &quot;A String&quot;,
8121 },
8122 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
8123 # identifiers.
8124 &quot;a_key&quot;: &quot;A String&quot;,
8125 },
8126 },
8127 },
8128 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
8129 # message that was returned, such as `NOT FOUND`.
8130 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
8131 # status code that was returned. For example, a `404` means the
8132 # resource was not found.
8133 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
8134 # defined by the server.
8135 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
8136 # This value is inRFC3339
8137 # text format.
8138 &quot;instancesBulkInsertOperationMetadata&quot;: {
8139 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
8140 # Example key: zones/us-central1-a
8141 &quot;a_key&quot;: {
8142 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
8143 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
8144 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
8145 # error.
8146 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
8147 # if the flow is rolling forward or rolling back.
8148 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
8149 },
8150 },
8151 },
8152 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
8153 # Operation resources.
8154 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
8155 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
8156 # group of operations results from a `bulkInsert` API request.
8157 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
8158 # `update`, or `delete`, and so on.
8159 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
8160 # There is no requirement that this be linear or support any granularity of
8161 # operations. This should not be used to guess when the operation will be
8162 # complete. This number should monotonically increase as the operation
8163 # progresses.
8164 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
8165 # applicable when performing regional operations.
8166 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
8167 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
8168 # this field will contain information on all underlying zonal actions and
8169 # their state.
8170 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
8171 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
8172 # Example key: zones/us-central1-a
8173 &quot;a_key&quot;: {
8174 &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
8175 # populated.
8176 # different programming environments, including REST APIs and RPC APIs. It is
8177 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
8178 # three pieces of data: error code, error message, and error details.
8179 #
8180 # You can find out more about this error model and how to work with it in the
8181 # [API Design Guide](https://cloud.google.com/apis/design/errors).
8182 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
8183 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
8184 # message types for APIs to use.
8185 {
8186 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
8187 },
8188 ],
8189 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
8190 # user-facing error message should be localized and sent in the
8191 # google.rpc.Status.details field, or localized by the client.
8192 },
8193 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
8194 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
8195 },
8196 },
8197 },
8198 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
8199 # This value is inRFC3339
8200 # text format.
8201 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
8202 # following:
8203 # `PENDING`, `RUNNING`, or `DONE`.
8204 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
8205 # operation.
8206 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
8207 # of the target resource.
8208 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
8209 # operations related to creating a snapshot, this points to the disk
8210 # that the snapshot was created from.
8211 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
8212 # `[email protected]` or
8213 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
8214 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
8215 # operation, this field will be populated.
8216 {
8217 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
8218 # Engine returns NO_RESULTS_ON_PAGE if there
8219 # are no results in the response.
8220 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
8221 # value format. For example:
8222 #
8223 # &quot;data&quot;: [
8224 # {
8225 # &quot;key&quot;: &quot;scope&quot;,
8226 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
8227 # }
8228 {
8229 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
8230 # returned. For example, for warnings where there are no results in a list
8231 # request for a particular zone, this key might be scope and
8232 # the key value might be the zone name. Other examples might be a key
8233 # indicating a deprecated resource and a suggested replacement, or a
8234 # warning about invalid network settings (for example, if an instance
8235 # attempts to perform IP forwarding but is not enabled for IP forwarding).
8236 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
8237 },
8238 ],
8239 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
8240 },
8241 ],
8242 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
8243 # applicable when performing per-zone operations.
8244 }</pre>
8245 </div>
8246
8247 <div class="method">
8248 <code class="details" id="resize">resize(project, zone, instanceGroupManager, size, requestId=None, x__xgafv=None)</code>
8249 <pre>Resizes the managed instance group. If you increase the size, the group
8250 creates new instances using the current instance template. If you decrease
8251 the size, the group deletes instances. The resize operation is markedDONE when the resize actions are scheduled even if the group
8252 has not yet added or deleted any instances. You must separately
8253 verify the status of the creating or deleting
8254 actions with thelistmanagedinstances
8255 method.
8256
8257 When resizing down, the instance group arbitrarily chooses the order in
8258 which VMs are deleted. The group takes into account some VM attributes when
8259 making the selection including:
8260
8261 + The status of the VM instance.
8262 + The health of the VM instance.
8263 + The instance template version the VM is based on.
8264 + For regional managed instance groups, the location of the VM instance.
8265
8266 This list is subject to change.
8267
8268 If the group is part of a backend
8269 service that has enabled
8270 connection draining, it can take up to 60 seconds after the connection
8271 draining duration has elapsed before the VM instance is removed or deleted.
8272
8273 Args:
8274 project: string, Project ID for this request. (required)
8275 zone: string, The name of thezone where the managed
8276 instance group is located. (required)
8277 instanceGroupManager: string, The name of the managed instance group. (required)
8278 size: integer, The number of running instances that the managed instance group should
8279 maintain at any given time. The group automatically adds or removes
8280 instances to maintain the number of instances specified by this parameter. (required)
8281 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
8282 that if you must retry your request, the server will know to ignore the
8283 request if it has already been completed.
8284
8285 For example, consider a situation where you make an initial request and
8286 the request times out. If you make the request again with the same
8287 request ID, the server can check if original operation with the same
8288 request ID was received, and if so, will ignore the second request. This
8289 prevents clients from accidentally creating duplicate commitments.
8290
8291 The request ID must be
8292 a valid UUID with the exception that zero UUID is not supported
8293 (00000000-0000-0000-0000-000000000000).
8294 x__xgafv: string, V1 error format.
8295 Allowed values
8296 1 - v1 error format
8297 2 - v2 error format
8298
8299 Returns:
8300 An object of the form:
8301
8302 { # Represents an Operation resource.
8303 #
8304 # Google Compute Engine has three Operation resources:
8305 #
8306 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
8307 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
8308 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
8309 #
8310 # You can use an operation resource to manage asynchronous API requests.
8311 # For more information, readHandling
8312 # API responses.
8313 #
8314 # Operations can be global, regional or zonal.
8315 #
8316 # - For global operations, use the `globalOperations`
8317 # resource.
8318 # - For regional operations, use the
8319 # `regionOperations` resource.
8320 # - For zonal operations, use
8321 # the `zoneOperations` resource.
8322 #
8323 #
8324 #
8325 # For more information, read
8326 # Global, Regional, and Zonal Resources.
8327 #
8328 # Note that completed Operation resources have a limited
8329 # retention period.
8330 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
8331 # Not present otherwise.
8332 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
8333 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
8334 # set when the operation is created.
8335 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
8336 # text format.
8337 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
8338 # this field will be populated.
8339 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
8340 # operation.
8341 {
8342 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
8343 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
8344 # details. There is a set of defined message types to use for providing
8345 # details.The syntax depends on the error code. For example,
8346 # QuotaExceededInfo will have details when the error code is
8347 # QUOTA_EXCEEDED.
8348 {
8349 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
8350 #
8351 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
8352 # is not enabled:
8353 #
8354 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
8355 # &quot;domain&quot;: &quot;googleapis.com&quot;
8356 # &quot;metadata&quot;: {
8357 # &quot;resource&quot;: &quot;projects/123&quot;,
8358 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
8359 # }
8360 # }
8361 #
8362 # This response indicates that the pubsub.googleapis.com API is not enabled.
8363 #
8364 # Example of an error that is returned when attempting to create a Spanner
8365 # instance in a region that is out of stock:
8366 #
8367 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
8368 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
8369 # &quot;metadata&quot;: {
8370 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
8371 # }
8372 # }
8373 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
8374 # is typically the registered service name of the tool or product that
8375 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
8376 # generated by some common infrastructure, the error domain must be a
8377 # globally unique value that identifies the infrastructure. For Google API
8378 # infrastructure, the error domain is &quot;googleapis.com&quot;.
8379 &quot;metadatas&quot;: { # Additional structured details about this error.
8380 #
8381 # Keys must match a regular expression of `a-z+` but should
8382 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
8383 # length. When identifying the current value of an exceeded limit, the units
8384 # should be contained in the key, not the value. For example, rather than
8385 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
8386 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
8387 # instances that can be created in a single (batch) request.
8388 &quot;a_key&quot;: &quot;A String&quot;,
8389 },
8390 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
8391 # proximate cause of the error. Error reasons are unique within a particular
8392 # domain of errors. This should be at most 63 characters and match a
8393 # regular expression of `A-Z+[A-Z0-9]`, which represents
8394 # UPPER_SNAKE_CASE.
8395 },
8396 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
8397 #
8398 # For example, if a quota check failed with an error indicating the calling
8399 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
8400 # directly to the right place in the developer console to flip the bit.
8401 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
8402 { # Describes a URL link.
8403 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
8404 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
8405 },
8406 ],
8407 },
8408 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
8409 # which can be attached to an RPC error.
8410 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
8411 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
8412 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
8413 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
8414 },
8415 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
8416 &quot;dimensions&quot;: { # The map holding related quota dimensions.
8417 &quot;a_key&quot;: &quot;A String&quot;,
8418 },
8419 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
8420 # type or metric.
8421 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
8422 # or metric.
8423 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
8424 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
8425 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
8426 },
8427 },
8428 ],
8429 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
8430 # This property is optional.
8431 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
8432 },
8433 ],
8434 },
8435 &quot;getVersionOperationMetadata&quot;: {
8436 &quot;inlineSbomInfo&quot;: {
8437 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
8438 # appropriate identifiers.
8439 &quot;a_key&quot;: &quot;A String&quot;,
8440 },
8441 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
8442 # identifiers.
8443 &quot;a_key&quot;: &quot;A String&quot;,
8444 },
8445 },
8446 },
8447 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
8448 # message that was returned, such as `NOT FOUND`.
8449 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
8450 # status code that was returned. For example, a `404` means the
8451 # resource was not found.
8452 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
8453 # defined by the server.
8454 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
8455 # This value is inRFC3339
8456 # text format.
8457 &quot;instancesBulkInsertOperationMetadata&quot;: {
8458 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
8459 # Example key: zones/us-central1-a
8460 &quot;a_key&quot;: {
8461 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
8462 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
8463 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
8464 # error.
8465 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
8466 # if the flow is rolling forward or rolling back.
8467 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
8468 },
8469 },
8470 },
8471 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
8472 # Operation resources.
8473 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
8474 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
8475 # group of operations results from a `bulkInsert` API request.
8476 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
8477 # `update`, or `delete`, and so on.
8478 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
8479 # There is no requirement that this be linear or support any granularity of
8480 # operations. This should not be used to guess when the operation will be
8481 # complete. This number should monotonically increase as the operation
8482 # progresses.
8483 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
8484 # applicable when performing regional operations.
8485 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
8486 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
8487 # this field will contain information on all underlying zonal actions and
8488 # their state.
8489 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
8490 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
8491 # Example key: zones/us-central1-a
8492 &quot;a_key&quot;: {
8493 &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
8494 # populated.
8495 # different programming environments, including REST APIs and RPC APIs. It is
8496 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
8497 # three pieces of data: error code, error message, and error details.
8498 #
8499 # You can find out more about this error model and how to work with it in the
8500 # [API Design Guide](https://cloud.google.com/apis/design/errors).
8501 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
8502 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
8503 # message types for APIs to use.
8504 {
8505 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
8506 },
8507 ],
8508 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
8509 # user-facing error message should be localized and sent in the
8510 # google.rpc.Status.details field, or localized by the client.
8511 },
8512 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
8513 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
8514 },
8515 },
8516 },
8517 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
8518 # This value is inRFC3339
8519 # text format.
8520 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
8521 # following:
8522 # `PENDING`, `RUNNING`, or `DONE`.
8523 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
8524 # operation.
8525 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
8526 # of the target resource.
8527 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
8528 # operations related to creating a snapshot, this points to the disk
8529 # that the snapshot was created from.
8530 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
8531 # `[email protected]` or
8532 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
8533 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
8534 # operation, this field will be populated.
8535 {
8536 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
8537 # Engine returns NO_RESULTS_ON_PAGE if there
8538 # are no results in the response.
8539 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
8540 # value format. For example:
8541 #
8542 # &quot;data&quot;: [
8543 # {
8544 # &quot;key&quot;: &quot;scope&quot;,
8545 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
8546 # }
8547 {
8548 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
8549 # returned. For example, for warnings where there are no results in a list
8550 # request for a particular zone, this key might be scope and
8551 # the key value might be the zone name. Other examples might be a key
8552 # indicating a deprecated resource and a suggested replacement, or a
8553 # warning about invalid network settings (for example, if an instance
8554 # attempts to perform IP forwarding but is not enabled for IP forwarding).
8555 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
8556 },
8557 ],
8558 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
8559 },
8560 ],
8561 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
8562 # applicable when performing per-zone operations.
8563 }</pre>
8564 </div>
8565
8566 <div class="method">
8567 <code class="details" id="resumeInstances">resumeInstances(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
8568 <pre>Flags the specified instances in the managed instance group to be
8569 resumed. This method increases thetargetSize and decreases the targetSuspendedSize
8570 of the managed instance group by the number of instances that you resume.
8571 The resumeInstances operation is marked DONE if
8572 the resumeInstances request is successful. The underlying
8573 actions take additional time. You must separately verify the status of theRESUMING action with thelistmanagedinstances
8574 method.
8575
8576 In this request, you can only specify instances that are suspended. For
8577 example, if an instance was previously suspended using the suspendInstances
8578 method, it can be resumed using the resumeInstances method.
8579
8580 If a health check is attached to the managed instance group, the specified
8581 instances will be verified as healthy after they are resumed.
8582
8583 You can specify a maximum of 1000 instances with this method per request.
8584
8585 Args:
8586 project: string, Project ID for this request. (required)
8587 zone: string, The name of thezone where the managed
8588 instance group is located. (required)
8589 instanceGroupManager: string, The name of the managed instance group. (required)
8590 body: object, The request body.
8591 The object takes the form of:
8592
8593 {
8594 &quot;instances&quot;: [ # The URLs of one or more instances to resume. This can be a full URL or
8595 # a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].
8596 &quot;A String&quot;,
8597 ],
8598 }
8599
8600 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
8601 that if you must retry your request, the server will know to ignore the
8602 request if it has already been completed.
8603
8604 For example, consider a situation where you make an initial request and
8605 the request times out. If you make the request again with the same
8606 request ID, the server can check if original operation with the same
8607 request ID was received, and if so, will ignore the second request. This
8608 prevents clients from accidentally creating duplicate commitments.
8609
8610 The request ID must be
8611 a valid UUID with the exception that zero UUID is not supported
8612 (00000000-0000-0000-0000-000000000000).
8613 x__xgafv: string, V1 error format.
8614 Allowed values
8615 1 - v1 error format
8616 2 - v2 error format
8617
8618 Returns:
8619 An object of the form:
8620
8621 { # Represents an Operation resource.
8622 #
8623 # Google Compute Engine has three Operation resources:
8624 #
8625 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
8626 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
8627 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
8628 #
8629 # You can use an operation resource to manage asynchronous API requests.
8630 # For more information, readHandling
8631 # API responses.
8632 #
8633 # Operations can be global, regional or zonal.
8634 #
8635 # - For global operations, use the `globalOperations`
8636 # resource.
8637 # - For regional operations, use the
8638 # `regionOperations` resource.
8639 # - For zonal operations, use
8640 # the `zoneOperations` resource.
8641 #
8642 #
8643 #
8644 # For more information, read
8645 # Global, Regional, and Zonal Resources.
8646 #
8647 # Note that completed Operation resources have a limited
8648 # retention period.
8649 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
8650 # Not present otherwise.
8651 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
8652 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
8653 # set when the operation is created.
8654 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
8655 # text format.
8656 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
8657 # this field will be populated.
8658 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
8659 # operation.
8660 {
8661 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
8662 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
8663 # details. There is a set of defined message types to use for providing
8664 # details.The syntax depends on the error code. For example,
8665 # QuotaExceededInfo will have details when the error code is
8666 # QUOTA_EXCEEDED.
8667 {
8668 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
8669 #
8670 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
8671 # is not enabled:
8672 #
8673 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
8674 # &quot;domain&quot;: &quot;googleapis.com&quot;
8675 # &quot;metadata&quot;: {
8676 # &quot;resource&quot;: &quot;projects/123&quot;,
8677 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
8678 # }
8679 # }
8680 #
8681 # This response indicates that the pubsub.googleapis.com API is not enabled.
8682 #
8683 # Example of an error that is returned when attempting to create a Spanner
8684 # instance in a region that is out of stock:
8685 #
8686 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
8687 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
8688 # &quot;metadata&quot;: {
8689 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
8690 # }
8691 # }
8692 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
8693 # is typically the registered service name of the tool or product that
8694 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
8695 # generated by some common infrastructure, the error domain must be a
8696 # globally unique value that identifies the infrastructure. For Google API
8697 # infrastructure, the error domain is &quot;googleapis.com&quot;.
8698 &quot;metadatas&quot;: { # Additional structured details about this error.
8699 #
8700 # Keys must match a regular expression of `a-z+` but should
8701 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
8702 # length. When identifying the current value of an exceeded limit, the units
8703 # should be contained in the key, not the value. For example, rather than
8704 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
8705 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
8706 # instances that can be created in a single (batch) request.
8707 &quot;a_key&quot;: &quot;A String&quot;,
8708 },
8709 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
8710 # proximate cause of the error. Error reasons are unique within a particular
8711 # domain of errors. This should be at most 63 characters and match a
8712 # regular expression of `A-Z+[A-Z0-9]`, which represents
8713 # UPPER_SNAKE_CASE.
8714 },
8715 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
8716 #
8717 # For example, if a quota check failed with an error indicating the calling
8718 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
8719 # directly to the right place in the developer console to flip the bit.
8720 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
8721 { # Describes a URL link.
8722 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
8723 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
8724 },
8725 ],
8726 },
8727 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
8728 # which can be attached to an RPC error.
8729 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
8730 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
8731 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
8732 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
8733 },
8734 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
8735 &quot;dimensions&quot;: { # The map holding related quota dimensions.
8736 &quot;a_key&quot;: &quot;A String&quot;,
8737 },
8738 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
8739 # type or metric.
8740 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
8741 # or metric.
8742 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
8743 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
8744 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
8745 },
8746 },
8747 ],
8748 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
8749 # This property is optional.
8750 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
8751 },
8752 ],
8753 },
8754 &quot;getVersionOperationMetadata&quot;: {
8755 &quot;inlineSbomInfo&quot;: {
8756 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
8757 # appropriate identifiers.
8758 &quot;a_key&quot;: &quot;A String&quot;,
8759 },
8760 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
8761 # identifiers.
8762 &quot;a_key&quot;: &quot;A String&quot;,
8763 },
8764 },
8765 },
8766 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
8767 # message that was returned, such as `NOT FOUND`.
8768 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
8769 # status code that was returned. For example, a `404` means the
8770 # resource was not found.
8771 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
8772 # defined by the server.
8773 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
8774 # This value is inRFC3339
8775 # text format.
8776 &quot;instancesBulkInsertOperationMetadata&quot;: {
8777 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
8778 # Example key: zones/us-central1-a
8779 &quot;a_key&quot;: {
8780 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
8781 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
8782 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
8783 # error.
8784 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
8785 # if the flow is rolling forward or rolling back.
8786 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
8787 },
8788 },
8789 },
8790 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
8791 # Operation resources.
8792 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
8793 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
8794 # group of operations results from a `bulkInsert` API request.
8795 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
8796 # `update`, or `delete`, and so on.
8797 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
8798 # There is no requirement that this be linear or support any granularity of
8799 # operations. This should not be used to guess when the operation will be
8800 # complete. This number should monotonically increase as the operation
8801 # progresses.
8802 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
8803 # applicable when performing regional operations.
8804 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
8805 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
8806 # this field will contain information on all underlying zonal actions and
8807 # their state.
8808 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
8809 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
8810 # Example key: zones/us-central1-a
8811 &quot;a_key&quot;: {
8812 &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
8813 # populated.
8814 # different programming environments, including REST APIs and RPC APIs. It is
8815 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
8816 # three pieces of data: error code, error message, and error details.
8817 #
8818 # You can find out more about this error model and how to work with it in the
8819 # [API Design Guide](https://cloud.google.com/apis/design/errors).
8820 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
8821 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
8822 # message types for APIs to use.
8823 {
8824 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
8825 },
8826 ],
8827 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
8828 # user-facing error message should be localized and sent in the
8829 # google.rpc.Status.details field, or localized by the client.
8830 },
8831 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
8832 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
8833 },
8834 },
8835 },
8836 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
8837 # This value is inRFC3339
8838 # text format.
8839 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
8840 # following:
8841 # `PENDING`, `RUNNING`, or `DONE`.
8842 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
8843 # operation.
8844 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
8845 # of the target resource.
8846 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
8847 # operations related to creating a snapshot, this points to the disk
8848 # that the snapshot was created from.
8849 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
8850 # `[email protected]` or
8851 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
8852 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
8853 # operation, this field will be populated.
8854 {
8855 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
8856 # Engine returns NO_RESULTS_ON_PAGE if there
8857 # are no results in the response.
8858 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
8859 # value format. For example:
8860 #
8861 # &quot;data&quot;: [
8862 # {
8863 # &quot;key&quot;: &quot;scope&quot;,
8864 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
8865 # }
8866 {
8867 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
8868 # returned. For example, for warnings where there are no results in a list
8869 # request for a particular zone, this key might be scope and
8870 # the key value might be the zone name. Other examples might be a key
8871 # indicating a deprecated resource and a suggested replacement, or a
8872 # warning about invalid network settings (for example, if an instance
8873 # attempts to perform IP forwarding but is not enabled for IP forwarding).
8874 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
8875 },
8876 ],
8877 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
8878 },
8879 ],
8880 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
8881 # applicable when performing per-zone operations.
8882 }</pre>
8883 </div>
8884
8885 <div class="method">
8886 <code class="details" id="setInstanceTemplate">setInstanceTemplate(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
8887 <pre>Specifies the instance template to use when creating new instances in this
8888 group. The templates for existing instances in the group do not change
8889 unless you run recreateInstances, runapplyUpdatesToInstances, or set the group&#x27;supdatePolicy.type to PROACTIVE.
8890
8891 Args:
8892 project: string, Project ID for this request. (required)
8893 zone: string, The name of thezone where the managed
8894 instance group is located. (required)
8895 instanceGroupManager: string, The name of the managed instance group. (required)
8896 body: object, The request body.
8897 The object takes the form of:
8898
8899 {
8900 &quot;instanceTemplate&quot;: &quot;A String&quot;, # The URL of the instance template that is specified for this managed
8901 # instance group. The group uses this template to create all new instances
8902 # in the managed instance group. The templates for existing instances in the
8903 # group do not change unless you run recreateInstances, runapplyUpdatesToInstances, or set the group&#x27;supdatePolicy.type to PROACTIVE.
8904 }
8905
8906 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
8907 that if you must retry your request, the server will know to ignore the
8908 request if it has already been completed.
8909
8910 For example, consider a situation where you make an initial request and
8911 the request times out. If you make the request again with the same
8912 request ID, the server can check if original operation with the same
8913 request ID was received, and if so, will ignore the second request. This
8914 prevents clients from accidentally creating duplicate commitments.
8915
8916 The request ID must be
8917 a valid UUID with the exception that zero UUID is not supported
8918 (00000000-0000-0000-0000-000000000000).
8919 x__xgafv: string, V1 error format.
8920 Allowed values
8921 1 - v1 error format
8922 2 - v2 error format
8923
8924 Returns:
8925 An object of the form:
8926
8927 { # Represents an Operation resource.
8928 #
8929 # Google Compute Engine has three Operation resources:
8930 #
8931 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
8932 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
8933 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
8934 #
8935 # You can use an operation resource to manage asynchronous API requests.
8936 # For more information, readHandling
8937 # API responses.
8938 #
8939 # Operations can be global, regional or zonal.
8940 #
8941 # - For global operations, use the `globalOperations`
8942 # resource.
8943 # - For regional operations, use the
8944 # `regionOperations` resource.
8945 # - For zonal operations, use
8946 # the `zoneOperations` resource.
8947 #
8948 #
8949 #
8950 # For more information, read
8951 # Global, Regional, and Zonal Resources.
8952 #
8953 # Note that completed Operation resources have a limited
8954 # retention period.
8955 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
8956 # Not present otherwise.
8957 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
8958 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
8959 # set when the operation is created.
8960 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
8961 # text format.
8962 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
8963 # this field will be populated.
8964 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
8965 # operation.
8966 {
8967 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
8968 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
8969 # details. There is a set of defined message types to use for providing
8970 # details.The syntax depends on the error code. For example,
8971 # QuotaExceededInfo will have details when the error code is
8972 # QUOTA_EXCEEDED.
8973 {
8974 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
8975 #
8976 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
8977 # is not enabled:
8978 #
8979 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
8980 # &quot;domain&quot;: &quot;googleapis.com&quot;
8981 # &quot;metadata&quot;: {
8982 # &quot;resource&quot;: &quot;projects/123&quot;,
8983 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
8984 # }
8985 # }
8986 #
8987 # This response indicates that the pubsub.googleapis.com API is not enabled.
8988 #
8989 # Example of an error that is returned when attempting to create a Spanner
8990 # instance in a region that is out of stock:
8991 #
8992 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
8993 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
8994 # &quot;metadata&quot;: {
8995 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
8996 # }
8997 # }
8998 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
8999 # is typically the registered service name of the tool or product that
9000 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
9001 # generated by some common infrastructure, the error domain must be a
9002 # globally unique value that identifies the infrastructure. For Google API
9003 # infrastructure, the error domain is &quot;googleapis.com&quot;.
9004 &quot;metadatas&quot;: { # Additional structured details about this error.
9005 #
9006 # Keys must match a regular expression of `a-z+` but should
9007 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
9008 # length. When identifying the current value of an exceeded limit, the units
9009 # should be contained in the key, not the value. For example, rather than
9010 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
9011 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
9012 # instances that can be created in a single (batch) request.
9013 &quot;a_key&quot;: &quot;A String&quot;,
9014 },
9015 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
9016 # proximate cause of the error. Error reasons are unique within a particular
9017 # domain of errors. This should be at most 63 characters and match a
9018 # regular expression of `A-Z+[A-Z0-9]`, which represents
9019 # UPPER_SNAKE_CASE.
9020 },
9021 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
9022 #
9023 # For example, if a quota check failed with an error indicating the calling
9024 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
9025 # directly to the right place in the developer console to flip the bit.
9026 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
9027 { # Describes a URL link.
9028 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
9029 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
9030 },
9031 ],
9032 },
9033 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
9034 # which can be attached to an RPC error.
9035 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
9036 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
9037 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
9038 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
9039 },
9040 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
9041 &quot;dimensions&quot;: { # The map holding related quota dimensions.
9042 &quot;a_key&quot;: &quot;A String&quot;,
9043 },
9044 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
9045 # type or metric.
9046 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
9047 # or metric.
9048 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
9049 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
9050 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
9051 },
9052 },
9053 ],
9054 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
9055 # This property is optional.
9056 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
9057 },
9058 ],
9059 },
9060 &quot;getVersionOperationMetadata&quot;: {
9061 &quot;inlineSbomInfo&quot;: {
9062 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
9063 # appropriate identifiers.
9064 &quot;a_key&quot;: &quot;A String&quot;,
9065 },
9066 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
9067 # identifiers.
9068 &quot;a_key&quot;: &quot;A String&quot;,
9069 },
9070 },
9071 },
9072 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
9073 # message that was returned, such as `NOT FOUND`.
9074 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
9075 # status code that was returned. For example, a `404` means the
9076 # resource was not found.
9077 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
9078 # defined by the server.
9079 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
9080 # This value is inRFC3339
9081 # text format.
9082 &quot;instancesBulkInsertOperationMetadata&quot;: {
9083 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
9084 # Example key: zones/us-central1-a
9085 &quot;a_key&quot;: {
9086 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
9087 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
9088 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
9089 # error.
9090 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
9091 # if the flow is rolling forward or rolling back.
9092 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
9093 },
9094 },
9095 },
9096 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
9097 # Operation resources.
9098 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
9099 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
9100 # group of operations results from a `bulkInsert` API request.
9101 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
9102 # `update`, or `delete`, and so on.
9103 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
9104 # There is no requirement that this be linear or support any granularity of
9105 # operations. This should not be used to guess when the operation will be
9106 # complete. This number should monotonically increase as the operation
9107 # progresses.
9108 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
9109 # applicable when performing regional operations.
9110 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
9111 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
9112 # this field will contain information on all underlying zonal actions and
9113 # their state.
9114 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
9115 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
9116 # Example key: zones/us-central1-a
9117 &quot;a_key&quot;: {
9118 &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
9119 # populated.
9120 # different programming environments, including REST APIs and RPC APIs. It is
9121 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
9122 # three pieces of data: error code, error message, and error details.
9123 #
9124 # You can find out more about this error model and how to work with it in the
9125 # [API Design Guide](https://cloud.google.com/apis/design/errors).
9126 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
9127 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
9128 # message types for APIs to use.
9129 {
9130 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
9131 },
9132 ],
9133 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
9134 # user-facing error message should be localized and sent in the
9135 # google.rpc.Status.details field, or localized by the client.
9136 },
9137 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
9138 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
9139 },
9140 },
9141 },
9142 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
9143 # This value is inRFC3339
9144 # text format.
9145 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
9146 # following:
9147 # `PENDING`, `RUNNING`, or `DONE`.
9148 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
9149 # operation.
9150 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
9151 # of the target resource.
9152 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
9153 # operations related to creating a snapshot, this points to the disk
9154 # that the snapshot was created from.
9155 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
9156 # `[email protected]` or
9157 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
9158 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
9159 # operation, this field will be populated.
9160 {
9161 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
9162 # Engine returns NO_RESULTS_ON_PAGE if there
9163 # are no results in the response.
9164 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
9165 # value format. For example:
9166 #
9167 # &quot;data&quot;: [
9168 # {
9169 # &quot;key&quot;: &quot;scope&quot;,
9170 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
9171 # }
9172 {
9173 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
9174 # returned. For example, for warnings where there are no results in a list
9175 # request for a particular zone, this key might be scope and
9176 # the key value might be the zone name. Other examples might be a key
9177 # indicating a deprecated resource and a suggested replacement, or a
9178 # warning about invalid network settings (for example, if an instance
9179 # attempts to perform IP forwarding but is not enabled for IP forwarding).
9180 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
9181 },
9182 ],
9183 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
9184 },
9185 ],
9186 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
9187 # applicable when performing per-zone operations.
9188 }</pre>
9189 </div>
9190
9191 <div class="method">
9192 <code class="details" id="setTargetPools">setTargetPools(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
9193 <pre>Modifies the target pools to which all instances in this managed instance
9194 group are assigned. The target pools automatically apply to all of the
9195 instances in the managed instance group. This operation is markedDONE when you make the request even if the instances have not
9196 yet been added to their target pools. The change might take some time to
9197 apply to all of the instances in the group depending on the size of the
9198 group.
9199
9200 Args:
9201 project: string, Project ID for this request. (required)
9202 zone: string, The name of thezone where the managed
9203 instance group is located. (required)
9204 instanceGroupManager: string, The name of the managed instance group. (required)
9205 body: object, The request body.
9206 The object takes the form of:
9207
9208 {
9209 &quot;fingerprint&quot;: &quot;A String&quot;, # The fingerprint of the target pools information. Use this optional
9210 # property to prevent conflicts when multiple users change the target pools
9211 # settings concurrently. Obtain the fingerprint with theinstanceGroupManagers.get
9212 # method. Then, include the fingerprint in your request to ensure that you
9213 # do not overwrite changes that were applied from another
9214 # concurrent request.
9215 &quot;targetPools&quot;: [ # The list of target pool URLs that instances in this managed instance group
9216 # belong to. The managed instance group applies these target pools to all
9217 # of the instances in the group. Existing instances and new instances in the
9218 # group all receive these target pool settings.
9219 &quot;A String&quot;,
9220 ],
9221 }
9222
9223 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
9224 that if you must retry your request, the server will know to ignore the
9225 request if it has already been completed.
9226
9227 For example, consider a situation where you make an initial request and
9228 the request times out. If you make the request again with the same
9229 request ID, the server can check if original operation with the same
9230 request ID was received, and if so, will ignore the second request. This
9231 prevents clients from accidentally creating duplicate commitments.
9232
9233 The request ID must be
9234 a valid UUID with the exception that zero UUID is not supported
9235 (00000000-0000-0000-0000-000000000000).
9236 x__xgafv: string, V1 error format.
9237 Allowed values
9238 1 - v1 error format
9239 2 - v2 error format
9240
9241 Returns:
9242 An object of the form:
9243
9244 { # Represents an Operation resource.
9245 #
9246 # Google Compute Engine has three Operation resources:
9247 #
9248 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
9249 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
9250 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
9251 #
9252 # You can use an operation resource to manage asynchronous API requests.
9253 # For more information, readHandling
9254 # API responses.
9255 #
9256 # Operations can be global, regional or zonal.
9257 #
9258 # - For global operations, use the `globalOperations`
9259 # resource.
9260 # - For regional operations, use the
9261 # `regionOperations` resource.
9262 # - For zonal operations, use
9263 # the `zoneOperations` resource.
9264 #
9265 #
9266 #
9267 # For more information, read
9268 # Global, Regional, and Zonal Resources.
9269 #
9270 # Note that completed Operation resources have a limited
9271 # retention period.
9272 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
9273 # Not present otherwise.
9274 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
9275 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
9276 # set when the operation is created.
9277 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
9278 # text format.
9279 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
9280 # this field will be populated.
9281 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
9282 # operation.
9283 {
9284 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
9285 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
9286 # details. There is a set of defined message types to use for providing
9287 # details.The syntax depends on the error code. For example,
9288 # QuotaExceededInfo will have details when the error code is
9289 # QUOTA_EXCEEDED.
9290 {
9291 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
9292 #
9293 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
9294 # is not enabled:
9295 #
9296 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
9297 # &quot;domain&quot;: &quot;googleapis.com&quot;
9298 # &quot;metadata&quot;: {
9299 # &quot;resource&quot;: &quot;projects/123&quot;,
9300 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
9301 # }
9302 # }
9303 #
9304 # This response indicates that the pubsub.googleapis.com API is not enabled.
9305 #
9306 # Example of an error that is returned when attempting to create a Spanner
9307 # instance in a region that is out of stock:
9308 #
9309 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
9310 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
9311 # &quot;metadata&quot;: {
9312 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
9313 # }
9314 # }
9315 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
9316 # is typically the registered service name of the tool or product that
9317 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
9318 # generated by some common infrastructure, the error domain must be a
9319 # globally unique value that identifies the infrastructure. For Google API
9320 # infrastructure, the error domain is &quot;googleapis.com&quot;.
9321 &quot;metadatas&quot;: { # Additional structured details about this error.
9322 #
9323 # Keys must match a regular expression of `a-z+` but should
9324 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
9325 # length. When identifying the current value of an exceeded limit, the units
9326 # should be contained in the key, not the value. For example, rather than
9327 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
9328 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
9329 # instances that can be created in a single (batch) request.
9330 &quot;a_key&quot;: &quot;A String&quot;,
9331 },
9332 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
9333 # proximate cause of the error. Error reasons are unique within a particular
9334 # domain of errors. This should be at most 63 characters and match a
9335 # regular expression of `A-Z+[A-Z0-9]`, which represents
9336 # UPPER_SNAKE_CASE.
9337 },
9338 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
9339 #
9340 # For example, if a quota check failed with an error indicating the calling
9341 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
9342 # directly to the right place in the developer console to flip the bit.
9343 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
9344 { # Describes a URL link.
9345 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
9346 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
9347 },
9348 ],
9349 },
9350 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
9351 # which can be attached to an RPC error.
9352 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
9353 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
9354 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
9355 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
9356 },
9357 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
9358 &quot;dimensions&quot;: { # The map holding related quota dimensions.
9359 &quot;a_key&quot;: &quot;A String&quot;,
9360 },
9361 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
9362 # type or metric.
9363 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
9364 # or metric.
9365 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
9366 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
9367 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
9368 },
9369 },
9370 ],
9371 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
9372 # This property is optional.
9373 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
9374 },
9375 ],
9376 },
9377 &quot;getVersionOperationMetadata&quot;: {
9378 &quot;inlineSbomInfo&quot;: {
9379 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
9380 # appropriate identifiers.
9381 &quot;a_key&quot;: &quot;A String&quot;,
9382 },
9383 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
9384 # identifiers.
9385 &quot;a_key&quot;: &quot;A String&quot;,
9386 },
9387 },
9388 },
9389 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
9390 # message that was returned, such as `NOT FOUND`.
9391 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
9392 # status code that was returned. For example, a `404` means the
9393 # resource was not found.
9394 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
9395 # defined by the server.
9396 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
9397 # This value is inRFC3339
9398 # text format.
9399 &quot;instancesBulkInsertOperationMetadata&quot;: {
9400 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
9401 # Example key: zones/us-central1-a
9402 &quot;a_key&quot;: {
9403 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
9404 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
9405 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
9406 # error.
9407 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
9408 # if the flow is rolling forward or rolling back.
9409 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
9410 },
9411 },
9412 },
9413 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
9414 # Operation resources.
9415 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
9416 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
9417 # group of operations results from a `bulkInsert` API request.
9418 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
9419 # `update`, or `delete`, and so on.
9420 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
9421 # There is no requirement that this be linear or support any granularity of
9422 # operations. This should not be used to guess when the operation will be
9423 # complete. This number should monotonically increase as the operation
9424 # progresses.
9425 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
9426 # applicable when performing regional operations.
9427 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
9428 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
9429 # this field will contain information on all underlying zonal actions and
9430 # their state.
9431 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
9432 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
9433 # Example key: zones/us-central1-a
9434 &quot;a_key&quot;: {
9435 &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
9436 # populated.
9437 # different programming environments, including REST APIs and RPC APIs. It is
9438 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
9439 # three pieces of data: error code, error message, and error details.
9440 #
9441 # You can find out more about this error model and how to work with it in the
9442 # [API Design Guide](https://cloud.google.com/apis/design/errors).
9443 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
9444 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
9445 # message types for APIs to use.
9446 {
9447 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
9448 },
9449 ],
9450 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
9451 # user-facing error message should be localized and sent in the
9452 # google.rpc.Status.details field, or localized by the client.
9453 },
9454 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
9455 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
9456 },
9457 },
9458 },
9459 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
9460 # This value is inRFC3339
9461 # text format.
9462 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
9463 # following:
9464 # `PENDING`, `RUNNING`, or `DONE`.
9465 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
9466 # operation.
9467 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
9468 # of the target resource.
9469 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
9470 # operations related to creating a snapshot, this points to the disk
9471 # that the snapshot was created from.
9472 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
9473 # `[email protected]` or
9474 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
9475 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
9476 # operation, this field will be populated.
9477 {
9478 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
9479 # Engine returns NO_RESULTS_ON_PAGE if there
9480 # are no results in the response.
9481 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
9482 # value format. For example:
9483 #
9484 # &quot;data&quot;: [
9485 # {
9486 # &quot;key&quot;: &quot;scope&quot;,
9487 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
9488 # }
9489 {
9490 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
9491 # returned. For example, for warnings where there are no results in a list
9492 # request for a particular zone, this key might be scope and
9493 # the key value might be the zone name. Other examples might be a key
9494 # indicating a deprecated resource and a suggested replacement, or a
9495 # warning about invalid network settings (for example, if an instance
9496 # attempts to perform IP forwarding but is not enabled for IP forwarding).
9497 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
9498 },
9499 ],
9500 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
9501 },
9502 ],
9503 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
9504 # applicable when performing per-zone operations.
9505 }</pre>
9506 </div>
9507
9508 <div class="method">
9509 <code class="details" id="startInstances">startInstances(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
9510 <pre>Flags the specified instances in the managed instance group to be
9511 started. This method increases thetargetSize and decreases the targetStoppedSize
9512 of the managed instance group by the number of instances that you start.
9513 The startInstances operation is marked DONE if
9514 the startInstances request is successful. The underlying
9515 actions take additional time. You must separately verify the status of theSTARTING action with thelistmanagedinstances
9516 method.
9517
9518 In this request, you can only specify instances that are stopped. For
9519 example, if an instance was previously stopped using the stopInstances
9520 method, it can be started using the startInstances method.
9521
9522 If a health check is attached to the managed instance group, the specified
9523 instances will be verified as healthy after they are started.
9524
9525 You can specify a maximum of 1000 instances with this method per request.
9526
9527 Args:
9528 project: string, Project ID for this request. (required)
9529 zone: string, The name of thezone where the managed
9530 instance group is located. (required)
9531 instanceGroupManager: string, The name of the managed instance group. (required)
9532 body: object, The request body.
9533 The object takes the form of:
9534
9535 {
9536 &quot;instances&quot;: [ # The URLs of one or more instances to start. This can be a full URL or
9537 # a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].
9538 &quot;A String&quot;,
9539 ],
9540 }
9541
9542 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
9543 that if you must retry your request, the server will know to ignore the
9544 request if it has already been completed.
9545
9546 For example, consider a situation where you make an initial request and
9547 the request times out. If you make the request again with the same
9548 request ID, the server can check if original operation with the same
9549 request ID was received, and if so, will ignore the second request. This
9550 prevents clients from accidentally creating duplicate commitments.
9551
9552 The request ID must be
9553 a valid UUID with the exception that zero UUID is not supported
9554 (00000000-0000-0000-0000-000000000000).
9555 x__xgafv: string, V1 error format.
9556 Allowed values
9557 1 - v1 error format
9558 2 - v2 error format
9559
9560 Returns:
9561 An object of the form:
9562
9563 { # Represents an Operation resource.
9564 #
9565 # Google Compute Engine has three Operation resources:
9566 #
9567 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
9568 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
9569 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
9570 #
9571 # You can use an operation resource to manage asynchronous API requests.
9572 # For more information, readHandling
9573 # API responses.
9574 #
9575 # Operations can be global, regional or zonal.
9576 #
9577 # - For global operations, use the `globalOperations`
9578 # resource.
9579 # - For regional operations, use the
9580 # `regionOperations` resource.
9581 # - For zonal operations, use
9582 # the `zoneOperations` resource.
9583 #
9584 #
9585 #
9586 # For more information, read
9587 # Global, Regional, and Zonal Resources.
9588 #
9589 # Note that completed Operation resources have a limited
9590 # retention period.
9591 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
9592 # Not present otherwise.
9593 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
9594 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
9595 # set when the operation is created.
9596 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
9597 # text format.
9598 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
9599 # this field will be populated.
9600 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
9601 # operation.
9602 {
9603 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
9604 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
9605 # details. There is a set of defined message types to use for providing
9606 # details.The syntax depends on the error code. For example,
9607 # QuotaExceededInfo will have details when the error code is
9608 # QUOTA_EXCEEDED.
9609 {
9610 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
9611 #
9612 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
9613 # is not enabled:
9614 #
9615 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
9616 # &quot;domain&quot;: &quot;googleapis.com&quot;
9617 # &quot;metadata&quot;: {
9618 # &quot;resource&quot;: &quot;projects/123&quot;,
9619 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
9620 # }
9621 # }
9622 #
9623 # This response indicates that the pubsub.googleapis.com API is not enabled.
9624 #
9625 # Example of an error that is returned when attempting to create a Spanner
9626 # instance in a region that is out of stock:
9627 #
9628 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
9629 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
9630 # &quot;metadata&quot;: {
9631 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
9632 # }
9633 # }
9634 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
9635 # is typically the registered service name of the tool or product that
9636 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
9637 # generated by some common infrastructure, the error domain must be a
9638 # globally unique value that identifies the infrastructure. For Google API
9639 # infrastructure, the error domain is &quot;googleapis.com&quot;.
9640 &quot;metadatas&quot;: { # Additional structured details about this error.
9641 #
9642 # Keys must match a regular expression of `a-z+` but should
9643 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
9644 # length. When identifying the current value of an exceeded limit, the units
9645 # should be contained in the key, not the value. For example, rather than
9646 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
9647 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
9648 # instances that can be created in a single (batch) request.
9649 &quot;a_key&quot;: &quot;A String&quot;,
9650 },
9651 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
9652 # proximate cause of the error. Error reasons are unique within a particular
9653 # domain of errors. This should be at most 63 characters and match a
9654 # regular expression of `A-Z+[A-Z0-9]`, which represents
9655 # UPPER_SNAKE_CASE.
9656 },
9657 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
9658 #
9659 # For example, if a quota check failed with an error indicating the calling
9660 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
9661 # directly to the right place in the developer console to flip the bit.
9662 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
9663 { # Describes a URL link.
9664 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
9665 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
9666 },
9667 ],
9668 },
9669 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
9670 # which can be attached to an RPC error.
9671 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
9672 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
9673 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
9674 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
9675 },
9676 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
9677 &quot;dimensions&quot;: { # The map holding related quota dimensions.
9678 &quot;a_key&quot;: &quot;A String&quot;,
9679 },
9680 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
9681 # type or metric.
9682 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
9683 # or metric.
9684 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
9685 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
9686 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
9687 },
9688 },
9689 ],
9690 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
9691 # This property is optional.
9692 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
9693 },
9694 ],
9695 },
9696 &quot;getVersionOperationMetadata&quot;: {
9697 &quot;inlineSbomInfo&quot;: {
9698 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
9699 # appropriate identifiers.
9700 &quot;a_key&quot;: &quot;A String&quot;,
9701 },
9702 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
9703 # identifiers.
9704 &quot;a_key&quot;: &quot;A String&quot;,
9705 },
9706 },
9707 },
9708 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
9709 # message that was returned, such as `NOT FOUND`.
9710 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
9711 # status code that was returned. For example, a `404` means the
9712 # resource was not found.
9713 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
9714 # defined by the server.
9715 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
9716 # This value is inRFC3339
9717 # text format.
9718 &quot;instancesBulkInsertOperationMetadata&quot;: {
9719 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
9720 # Example key: zones/us-central1-a
9721 &quot;a_key&quot;: {
9722 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
9723 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
9724 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
9725 # error.
9726 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
9727 # if the flow is rolling forward or rolling back.
9728 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
9729 },
9730 },
9731 },
9732 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
9733 # Operation resources.
9734 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
9735 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
9736 # group of operations results from a `bulkInsert` API request.
9737 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
9738 # `update`, or `delete`, and so on.
9739 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
9740 # There is no requirement that this be linear or support any granularity of
9741 # operations. This should not be used to guess when the operation will be
9742 # complete. This number should monotonically increase as the operation
9743 # progresses.
9744 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
9745 # applicable when performing regional operations.
9746 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
9747 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
9748 # this field will contain information on all underlying zonal actions and
9749 # their state.
9750 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
9751 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
9752 # Example key: zones/us-central1-a
9753 &quot;a_key&quot;: {
9754 &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
9755 # populated.
9756 # different programming environments, including REST APIs and RPC APIs. It is
9757 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
9758 # three pieces of data: error code, error message, and error details.
9759 #
9760 # You can find out more about this error model and how to work with it in the
9761 # [API Design Guide](https://cloud.google.com/apis/design/errors).
9762 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
9763 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
9764 # message types for APIs to use.
9765 {
9766 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
9767 },
9768 ],
9769 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
9770 # user-facing error message should be localized and sent in the
9771 # google.rpc.Status.details field, or localized by the client.
9772 },
9773 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
9774 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
9775 },
9776 },
9777 },
9778 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
9779 # This value is inRFC3339
9780 # text format.
9781 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
9782 # following:
9783 # `PENDING`, `RUNNING`, or `DONE`.
9784 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
9785 # operation.
9786 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
9787 # of the target resource.
9788 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
9789 # operations related to creating a snapshot, this points to the disk
9790 # that the snapshot was created from.
9791 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
9792 # `[email protected]` or
9793 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
9794 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
9795 # operation, this field will be populated.
9796 {
9797 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
9798 # Engine returns NO_RESULTS_ON_PAGE if there
9799 # are no results in the response.
9800 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
9801 # value format. For example:
9802 #
9803 # &quot;data&quot;: [
9804 # {
9805 # &quot;key&quot;: &quot;scope&quot;,
9806 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
9807 # }
9808 {
9809 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
9810 # returned. For example, for warnings where there are no results in a list
9811 # request for a particular zone, this key might be scope and
9812 # the key value might be the zone name. Other examples might be a key
9813 # indicating a deprecated resource and a suggested replacement, or a
9814 # warning about invalid network settings (for example, if an instance
9815 # attempts to perform IP forwarding but is not enabled for IP forwarding).
9816 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
9817 },
9818 ],
9819 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
9820 },
9821 ],
9822 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
9823 # applicable when performing per-zone operations.
9824 }</pre>
9825 </div>
9826
9827 <div class="method">
9828 <code class="details" id="stopInstances">stopInstances(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
9829 <pre>Flags the specified instances in the managed instance group to be
9830 immediately stopped. You can only specify instances that are running in
9831 this request. This method reduces thetargetSize and increases the targetStoppedSize
9832 of the managed instance group by the number of instances that you stop.
9833 The stopInstances operation is marked DONE if
9834 the stopInstances request is successful. The underlying
9835 actions take additional time. You must separately verify the status of theSTOPPING action with thelistmanagedinstances
9836 method.
9837
9838 If the standbyPolicy.initialDelaySec field is set, the group
9839 delays stopping the instances until initialDelaySec have
9840 passed from instance.creationTimestamp (that is, when the
9841 instance was created). This delay gives your application time to
9842 set itself up and initialize on the instance. If more thaninitialDelaySec seconds have passed sinceinstance.creationTimestamp when this method is called, there
9843 will be zero delay.
9844
9845 If the group is part of a backend
9846 service that has enabled
9847 connection draining, it can take up to 60 seconds after the connection
9848 draining duration has elapsed before the VM instance is stopped.
9849
9850 Stopped instances can be started using the startInstances
9851 method.
9852
9853 You can specify a maximum of 1000 instances with this method per request.
9854
9855 Args:
9856 project: string, Project ID for this request. (required)
9857 zone: string, The name of thezone where the managed
9858 instance group is located. (required)
9859 instanceGroupManager: string, The name of the managed instance group. (required)
9860 body: object, The request body.
9861 The object takes the form of:
9862
9863 {
9864 &quot;forceStop&quot;: True or False, # If this flag is set to true, the Instance Group Manager will proceed to
9865 # stop the instances, skipping initialization on them.
9866 &quot;instances&quot;: [ # The URLs of one or more instances to stop. This can be a full URL or
9867 # a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].
9868 &quot;A String&quot;,
9869 ],
9870 }
9871
9872 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
9873 that if you must retry your request, the server will know to ignore the
9874 request if it has already been completed.
9875
9876 For example, consider a situation where you make an initial request and
9877 the request times out. If you make the request again with the same
9878 request ID, the server can check if original operation with the same
9879 request ID was received, and if so, will ignore the second request. This
9880 prevents clients from accidentally creating duplicate commitments.
9881
9882 The request ID must be
9883 a valid UUID with the exception that zero UUID is not supported
9884 (00000000-0000-0000-0000-000000000000).
9885 x__xgafv: string, V1 error format.
9886 Allowed values
9887 1 - v1 error format
9888 2 - v2 error format
9889
9890 Returns:
9891 An object of the form:
9892
9893 { # Represents an Operation resource.
9894 #
9895 # Google Compute Engine has three Operation resources:
9896 #
9897 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
9898 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
9899 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
9900 #
9901 # You can use an operation resource to manage asynchronous API requests.
9902 # For more information, readHandling
9903 # API responses.
9904 #
9905 # Operations can be global, regional or zonal.
9906 #
9907 # - For global operations, use the `globalOperations`
9908 # resource.
9909 # - For regional operations, use the
9910 # `regionOperations` resource.
9911 # - For zonal operations, use
9912 # the `zoneOperations` resource.
9913 #
9914 #
9915 #
9916 # For more information, read
9917 # Global, Regional, and Zonal Resources.
9918 #
9919 # Note that completed Operation resources have a limited
9920 # retention period.
9921 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
9922 # Not present otherwise.
9923 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
9924 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
9925 # set when the operation is created.
9926 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
9927 # text format.
9928 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
9929 # this field will be populated.
9930 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
9931 # operation.
9932 {
9933 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
9934 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
9935 # details. There is a set of defined message types to use for providing
9936 # details.The syntax depends on the error code. For example,
9937 # QuotaExceededInfo will have details when the error code is
9938 # QUOTA_EXCEEDED.
9939 {
9940 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
9941 #
9942 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
9943 # is not enabled:
9944 #
9945 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
9946 # &quot;domain&quot;: &quot;googleapis.com&quot;
9947 # &quot;metadata&quot;: {
9948 # &quot;resource&quot;: &quot;projects/123&quot;,
9949 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
9950 # }
9951 # }
9952 #
9953 # This response indicates that the pubsub.googleapis.com API is not enabled.
9954 #
9955 # Example of an error that is returned when attempting to create a Spanner
9956 # instance in a region that is out of stock:
9957 #
9958 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
9959 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
9960 # &quot;metadata&quot;: {
9961 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
9962 # }
9963 # }
9964 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
9965 # is typically the registered service name of the tool or product that
9966 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
9967 # generated by some common infrastructure, the error domain must be a
9968 # globally unique value that identifies the infrastructure. For Google API
9969 # infrastructure, the error domain is &quot;googleapis.com&quot;.
9970 &quot;metadatas&quot;: { # Additional structured details about this error.
9971 #
9972 # Keys must match a regular expression of `a-z+` but should
9973 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
9974 # length. When identifying the current value of an exceeded limit, the units
9975 # should be contained in the key, not the value. For example, rather than
9976 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
9977 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
9978 # instances that can be created in a single (batch) request.
9979 &quot;a_key&quot;: &quot;A String&quot;,
9980 },
9981 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
9982 # proximate cause of the error. Error reasons are unique within a particular
9983 # domain of errors. This should be at most 63 characters and match a
9984 # regular expression of `A-Z+[A-Z0-9]`, which represents
9985 # UPPER_SNAKE_CASE.
9986 },
9987 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
9988 #
9989 # For example, if a quota check failed with an error indicating the calling
9990 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
9991 # directly to the right place in the developer console to flip the bit.
9992 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
9993 { # Describes a URL link.
9994 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
9995 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
9996 },
9997 ],
9998 },
9999 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
10000 # which can be attached to an RPC error.
10001 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
10002 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
10003 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
10004 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
10005 },
10006 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
10007 &quot;dimensions&quot;: { # The map holding related quota dimensions.
10008 &quot;a_key&quot;: &quot;A String&quot;,
10009 },
10010 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
10011 # type or metric.
10012 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
10013 # or metric.
10014 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
10015 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
10016 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
10017 },
10018 },
10019 ],
10020 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
10021 # This property is optional.
10022 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
10023 },
10024 ],
10025 },
10026 &quot;getVersionOperationMetadata&quot;: {
10027 &quot;inlineSbomInfo&quot;: {
10028 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
10029 # appropriate identifiers.
10030 &quot;a_key&quot;: &quot;A String&quot;,
10031 },
10032 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
10033 # identifiers.
10034 &quot;a_key&quot;: &quot;A String&quot;,
10035 },
10036 },
10037 },
10038 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
10039 # message that was returned, such as `NOT FOUND`.
10040 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
10041 # status code that was returned. For example, a `404` means the
10042 # resource was not found.
10043 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
10044 # defined by the server.
10045 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
10046 # This value is inRFC3339
10047 # text format.
10048 &quot;instancesBulkInsertOperationMetadata&quot;: {
10049 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
10050 # Example key: zones/us-central1-a
10051 &quot;a_key&quot;: {
10052 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
10053 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
10054 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
10055 # error.
10056 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
10057 # if the flow is rolling forward or rolling back.
10058 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
10059 },
10060 },
10061 },
10062 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
10063 # Operation resources.
10064 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
10065 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
10066 # group of operations results from a `bulkInsert` API request.
10067 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
10068 # `update`, or `delete`, and so on.
10069 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
10070 # There is no requirement that this be linear or support any granularity of
10071 # operations. This should not be used to guess when the operation will be
10072 # complete. This number should monotonically increase as the operation
10073 # progresses.
10074 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
10075 # applicable when performing regional operations.
10076 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
10077 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
10078 # this field will contain information on all underlying zonal actions and
10079 # their state.
10080 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
10081 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
10082 # Example key: zones/us-central1-a
10083 &quot;a_key&quot;: {
10084 &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
10085 # populated.
10086 # different programming environments, including REST APIs and RPC APIs. It is
10087 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
10088 # three pieces of data: error code, error message, and error details.
10089 #
10090 # You can find out more about this error model and how to work with it in the
10091 # [API Design Guide](https://cloud.google.com/apis/design/errors).
10092 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
10093 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
10094 # message types for APIs to use.
10095 {
10096 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
10097 },
10098 ],
10099 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
10100 # user-facing error message should be localized and sent in the
10101 # google.rpc.Status.details field, or localized by the client.
10102 },
10103 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
10104 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
10105 },
10106 },
10107 },
10108 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
10109 # This value is inRFC3339
10110 # text format.
10111 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
10112 # following:
10113 # `PENDING`, `RUNNING`, or `DONE`.
10114 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
10115 # operation.
10116 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
10117 # of the target resource.
10118 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
10119 # operations related to creating a snapshot, this points to the disk
10120 # that the snapshot was created from.
10121 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
10122 # `[email protected]` or
10123 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
10124 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
10125 # operation, this field will be populated.
10126 {
10127 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
10128 # Engine returns NO_RESULTS_ON_PAGE if there
10129 # are no results in the response.
10130 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
10131 # value format. For example:
10132 #
10133 # &quot;data&quot;: [
10134 # {
10135 # &quot;key&quot;: &quot;scope&quot;,
10136 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
10137 # }
10138 {
10139 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
10140 # returned. For example, for warnings where there are no results in a list
10141 # request for a particular zone, this key might be scope and
10142 # the key value might be the zone name. Other examples might be a key
10143 # indicating a deprecated resource and a suggested replacement, or a
10144 # warning about invalid network settings (for example, if an instance
10145 # attempts to perform IP forwarding but is not enabled for IP forwarding).
10146 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
10147 },
10148 ],
10149 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
10150 },
10151 ],
10152 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
10153 # applicable when performing per-zone operations.
10154 }</pre>
10155 </div>
10156
10157 <div class="method">
10158 <code class="details" id="suspendInstances">suspendInstances(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
10159 <pre>Flags the specified instances in the managed instance group to be
10160 immediately suspended. You can only specify instances that are running in
10161 this request. This method reduces thetargetSize and increases the targetSuspendedSize
10162 of the managed instance group by the number of instances that you suspend.
10163 The suspendInstances operation is marked DONE if
10164 the suspendInstances request is successful. The underlying
10165 actions take additional time. You must separately verify the status of theSUSPENDING action with thelistmanagedinstances
10166 method.
10167
10168 If the standbyPolicy.initialDelaySec field is set, the group
10169 delays suspension of the instances until initialDelaySec have
10170 passed from instance.creationTimestamp (that is, when the
10171 instance was created). This delay gives your application time to
10172 set itself up and initialize on the instance. If more thaninitialDelaySec seconds have passed sinceinstance.creationTimestamp when this method is called, there
10173 will be zero delay.
10174
10175 If the group is part of a backend
10176 service that has enabled
10177 connection draining, it can take up to 60 seconds after the connection
10178 draining duration has elapsed before the VM instance is suspended.
10179
10180 Suspended instances can be resumed using the resumeInstances
10181 method.
10182
10183 You can specify a maximum of 1000 instances with this method per request.
10184
10185 Args:
10186 project: string, Project ID for this request. (required)
10187 zone: string, The name of thezone where the managed
10188 instance group is located. (required)
10189 instanceGroupManager: string, The name of the managed instance group. (required)
10190 body: object, The request body.
10191 The object takes the form of:
10192
10193 {
10194 &quot;forceSuspend&quot;: True or False, # If this flag is set to true, the Instance Group Manager will proceed to
10195 # suspend the instances, skipping initialization on them.
10196 &quot;instances&quot;: [ # The URLs of one or more instances to suspend. This can be a full URL or
10197 # a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].
10198 &quot;A String&quot;,
10199 ],
10200 }
10201
10202 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
10203 that if you must retry your request, the server will know to ignore the
10204 request if it has already been completed.
10205
10206 For example, consider a situation where you make an initial request and
10207 the request times out. If you make the request again with the same
10208 request ID, the server can check if original operation with the same
10209 request ID was received, and if so, will ignore the second request. This
10210 prevents clients from accidentally creating duplicate commitments.
10211
10212 The request ID must be
10213 a valid UUID with the exception that zero UUID is not supported
10214 (00000000-0000-0000-0000-000000000000).
10215 x__xgafv: string, V1 error format.
10216 Allowed values
10217 1 - v1 error format
10218 2 - v2 error format
10219
10220 Returns:
10221 An object of the form:
10222
10223 { # Represents an Operation resource.
10224 #
10225 # Google Compute Engine has three Operation resources:
10226 #
10227 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
10228 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
10229 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
10230 #
10231 # You can use an operation resource to manage asynchronous API requests.
10232 # For more information, readHandling
10233 # API responses.
10234 #
10235 # Operations can be global, regional or zonal.
10236 #
10237 # - For global operations, use the `globalOperations`
10238 # resource.
10239 # - For regional operations, use the
10240 # `regionOperations` resource.
10241 # - For zonal operations, use
10242 # the `zoneOperations` resource.
10243 #
10244 #
10245 #
10246 # For more information, read
10247 # Global, Regional, and Zonal Resources.
10248 #
10249 # Note that completed Operation resources have a limited
10250 # retention period.
10251 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
10252 # Not present otherwise.
10253 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
10254 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
10255 # set when the operation is created.
10256 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
10257 # text format.
10258 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
10259 # this field will be populated.
10260 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
10261 # operation.
10262 {
10263 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
10264 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
10265 # details. There is a set of defined message types to use for providing
10266 # details.The syntax depends on the error code. For example,
10267 # QuotaExceededInfo will have details when the error code is
10268 # QUOTA_EXCEEDED.
10269 {
10270 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
10271 #
10272 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
10273 # is not enabled:
10274 #
10275 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
10276 # &quot;domain&quot;: &quot;googleapis.com&quot;
10277 # &quot;metadata&quot;: {
10278 # &quot;resource&quot;: &quot;projects/123&quot;,
10279 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
10280 # }
10281 # }
10282 #
10283 # This response indicates that the pubsub.googleapis.com API is not enabled.
10284 #
10285 # Example of an error that is returned when attempting to create a Spanner
10286 # instance in a region that is out of stock:
10287 #
10288 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
10289 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
10290 # &quot;metadata&quot;: {
10291 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
10292 # }
10293 # }
10294 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
10295 # is typically the registered service name of the tool or product that
10296 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
10297 # generated by some common infrastructure, the error domain must be a
10298 # globally unique value that identifies the infrastructure. For Google API
10299 # infrastructure, the error domain is &quot;googleapis.com&quot;.
10300 &quot;metadatas&quot;: { # Additional structured details about this error.
10301 #
10302 # Keys must match a regular expression of `a-z+` but should
10303 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
10304 # length. When identifying the current value of an exceeded limit, the units
10305 # should be contained in the key, not the value. For example, rather than
10306 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
10307 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
10308 # instances that can be created in a single (batch) request.
10309 &quot;a_key&quot;: &quot;A String&quot;,
10310 },
10311 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
10312 # proximate cause of the error. Error reasons are unique within a particular
10313 # domain of errors. This should be at most 63 characters and match a
10314 # regular expression of `A-Z+[A-Z0-9]`, which represents
10315 # UPPER_SNAKE_CASE.
10316 },
10317 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
10318 #
10319 # For example, if a quota check failed with an error indicating the calling
10320 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
10321 # directly to the right place in the developer console to flip the bit.
10322 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
10323 { # Describes a URL link.
10324 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
10325 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
10326 },
10327 ],
10328 },
10329 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
10330 # which can be attached to an RPC error.
10331 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
10332 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
10333 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
10334 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
10335 },
10336 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
10337 &quot;dimensions&quot;: { # The map holding related quota dimensions.
10338 &quot;a_key&quot;: &quot;A String&quot;,
10339 },
10340 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
10341 # type or metric.
10342 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
10343 # or metric.
10344 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
10345 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
10346 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
10347 },
10348 },
10349 ],
10350 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
10351 # This property is optional.
10352 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
10353 },
10354 ],
10355 },
10356 &quot;getVersionOperationMetadata&quot;: {
10357 &quot;inlineSbomInfo&quot;: {
10358 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
10359 # appropriate identifiers.
10360 &quot;a_key&quot;: &quot;A String&quot;,
10361 },
10362 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
10363 # identifiers.
10364 &quot;a_key&quot;: &quot;A String&quot;,
10365 },
10366 },
10367 },
10368 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
10369 # message that was returned, such as `NOT FOUND`.
10370 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
10371 # status code that was returned. For example, a `404` means the
10372 # resource was not found.
10373 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
10374 # defined by the server.
10375 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
10376 # This value is inRFC3339
10377 # text format.
10378 &quot;instancesBulkInsertOperationMetadata&quot;: {
10379 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
10380 # Example key: zones/us-central1-a
10381 &quot;a_key&quot;: {
10382 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
10383 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
10384 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
10385 # error.
10386 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
10387 # if the flow is rolling forward or rolling back.
10388 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
10389 },
10390 },
10391 },
10392 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
10393 # Operation resources.
10394 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
10395 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
10396 # group of operations results from a `bulkInsert` API request.
10397 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
10398 # `update`, or `delete`, and so on.
10399 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
10400 # There is no requirement that this be linear or support any granularity of
10401 # operations. This should not be used to guess when the operation will be
10402 # complete. This number should monotonically increase as the operation
10403 # progresses.
10404 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
10405 # applicable when performing regional operations.
10406 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
10407 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
10408 # this field will contain information on all underlying zonal actions and
10409 # their state.
10410 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
10411 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
10412 # Example key: zones/us-central1-a
10413 &quot;a_key&quot;: {
10414 &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
10415 # populated.
10416 # different programming environments, including REST APIs and RPC APIs. It is
10417 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
10418 # three pieces of data: error code, error message, and error details.
10419 #
10420 # You can find out more about this error model and how to work with it in the
10421 # [API Design Guide](https://cloud.google.com/apis/design/errors).
10422 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
10423 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
10424 # message types for APIs to use.
10425 {
10426 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
10427 },
10428 ],
10429 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
10430 # user-facing error message should be localized and sent in the
10431 # google.rpc.Status.details field, or localized by the client.
10432 },
10433 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
10434 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
10435 },
10436 },
10437 },
10438 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
10439 # This value is inRFC3339
10440 # text format.
10441 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
10442 # following:
10443 # `PENDING`, `RUNNING`, or `DONE`.
10444 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
10445 # operation.
10446 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
10447 # of the target resource.
10448 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
10449 # operations related to creating a snapshot, this points to the disk
10450 # that the snapshot was created from.
10451 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
10452 # `[email protected]` or
10453 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
10454 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
10455 # operation, this field will be populated.
10456 {
10457 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
10458 # Engine returns NO_RESULTS_ON_PAGE if there
10459 # are no results in the response.
10460 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
10461 # value format. For example:
10462 #
10463 # &quot;data&quot;: [
10464 # {
10465 # &quot;key&quot;: &quot;scope&quot;,
10466 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
10467 # }
10468 {
10469 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
10470 # returned. For example, for warnings where there are no results in a list
10471 # request for a particular zone, this key might be scope and
10472 # the key value might be the zone name. Other examples might be a key
10473 # indicating a deprecated resource and a suggested replacement, or a
10474 # warning about invalid network settings (for example, if an instance
10475 # attempts to perform IP forwarding but is not enabled for IP forwarding).
10476 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
10477 },
10478 ],
10479 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
10480 },
10481 ],
10482 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
10483 # applicable when performing per-zone operations.
10484 }</pre>
10485 </div>
10486
10487 <div class="method">
10488 <code class="details" id="updatePerInstanceConfigs">updatePerInstanceConfigs(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
10489 <pre>Inserts or updates per-instance configurations for the managed instance
10490 group. perInstanceConfig.name serves as a key used to
10491 distinguish whether to perform insert or patch.
10492
10493 Args:
10494 project: string, Project ID for this request. (required)
10495 zone: string, The name of thezone
10496 where the managed instance group is located.
10497 It should conform to RFC1035. (required)
10498 instanceGroupManager: string, The name of the managed instance group.
10499 It should conform to RFC1035. (required)
10500 body: object, The request body.
10501 The object takes the form of:
10502
10503 { # InstanceGroupManagers.updatePerInstanceConfigs
10504 &quot;perInstanceConfigs&quot;: [ # The list of per-instance configurations to insert or patch on this managed
10505 # instance group.
10506 {
10507 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this per-instance config. This field can be used in
10508 # optimistic locking. It is ignored when inserting a per-instance
10509 # config. An up-to-date fingerprint must be provided in order to update an
10510 # existing per-instance configuration or the field needs to be unset.
10511 &quot;name&quot;: &quot;A String&quot;, # The name of a per-instance configuration and its corresponding instance.
10512 # Serves as a merge key during UpdatePerInstanceConfigs
10513 # operations, that is, if a per-instance configuration with the same name
10514 # exists then it will be updated, otherwise a new one will be created for the
10515 # VM instance with the same name. An attempt to create a per-instance
10516 # configuration for a VM instance that either doesn&#x27;t exist or is not part
10517 # of the group will result in an error.
10518 &quot;preservedState&quot;: { # Preserved state for a given instance. # The intended preserved state for the given instance. Does not contain
10519 # preserved state generated from a stateful policy.
10520 &quot;disks&quot;: { # Preserved disks defined for this instance.
10521 # This map is keyed with the device names of the disks.
10522 &quot;a_key&quot;: {
10523 &quot;autoDelete&quot;: &quot;A String&quot;, # These stateful disks will never be deleted during autohealing,
10524 # update, instance recreate operations. This flag is used to configure
10525 # if the disk should be deleted after it is no longer used by the group,
10526 # e.g. when the given instance or the whole MIG is deleted.
10527 # Note: disks attached in READ_ONLY mode cannot be
10528 # auto-deleted.
10529 &quot;mode&quot;: &quot;A String&quot;, # The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the
10530 # disk in READ_WRITE mode.
10531 &quot;source&quot;: &quot;A String&quot;, # The URL of the disk resource that is stateful and should be attached
10532 # to the VM instance.
10533 },
10534 },
10535 &quot;externalIPs&quot;: { # Preserved external IPs defined for this instance.
10536 # This map is keyed with the name of the network interface.
10537 &quot;a_key&quot;: {
10538 &quot;autoDelete&quot;: &quot;A String&quot;, # These stateful IPs will never be released during autohealing,
10539 # update or VM instance recreate operations.
10540 # This flag is used to configure if the IP reservation should be deleted
10541 # after it is no longer used by the group, e.g. when the given instance
10542 # or the whole group is deleted.
10543 &quot;ipAddress&quot;: { # Ip address representation
10544 &quot;address&quot;: &quot;A String&quot;, # The URL of the reservation for this IP address.
10545 &quot;literal&quot;: &quot;A String&quot;, # An IPv4 internal network address to assign to the instance for this
10546 # network interface.
10547 },
10548 },
10549 },
10550 &quot;internalIPs&quot;: { # Preserved internal IPs defined for this instance.
10551 # This map is keyed with the name of the network interface.
10552 &quot;a_key&quot;: {
10553 &quot;autoDelete&quot;: &quot;A String&quot;, # These stateful IPs will never be released during autohealing,
10554 # update or VM instance recreate operations.
10555 # This flag is used to configure if the IP reservation should be deleted
10556 # after it is no longer used by the group, e.g. when the given instance
10557 # or the whole group is deleted.
10558 &quot;ipAddress&quot;: { # Ip address representation
10559 &quot;address&quot;: &quot;A String&quot;, # The URL of the reservation for this IP address.
10560 &quot;literal&quot;: &quot;A String&quot;, # An IPv4 internal network address to assign to the instance for this
10561 # network interface.
10562 },
10563 },
10564 },
10565 &quot;metadata&quot;: { # Preserved metadata defined for this instance.
10566 &quot;a_key&quot;: &quot;A String&quot;,
10567 },
10568 },
10569 &quot;status&quot;: &quot;A String&quot;, # The status of applying this per-instance configuration on the corresponding
10570 # managed instance.
10571 },
10572 ],
10573 }
10574
10575 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
10576 that if you must retry your request, the server will know to ignore the
10577 request if it has already been completed.
10578
10579 For example, consider a situation where you make an initial request and
10580 the request times out. If you make the request again with the same
10581 request ID, the server can check if original operation with the same
10582 request ID was received, and if so, will ignore the second request. This
10583 prevents clients from accidentally creating duplicate commitments.
10584
10585 The request ID must be
10586 a valid UUID with the exception that zero UUID is not supported
10587 (00000000-0000-0000-0000-000000000000).
10588 x__xgafv: string, V1 error format.
10589 Allowed values
10590 1 - v1 error format
10591 2 - v2 error format
10592
10593 Returns:
10594 An object of the form:
10595
10596 { # Represents an Operation resource.
10597 #
10598 # Google Compute Engine has three Operation resources:
10599 #
10600 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
10601 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
10602 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
10603 #
10604 # You can use an operation resource to manage asynchronous API requests.
10605 # For more information, readHandling
10606 # API responses.
10607 #
10608 # Operations can be global, regional or zonal.
10609 #
10610 # - For global operations, use the `globalOperations`
10611 # resource.
10612 # - For regional operations, use the
10613 # `regionOperations` resource.
10614 # - For zonal operations, use
10615 # the `zoneOperations` resource.
10616 #
10617 #
10618 #
10619 # For more information, read
10620 # Global, Regional, and Zonal Resources.
10621 #
10622 # Note that completed Operation resources have a limited
10623 # retention period.
10624 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
10625 # Not present otherwise.
10626 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
10627 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
10628 # set when the operation is created.
10629 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
10630 # text format.
10631 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
10632 # this field will be populated.
10633 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
10634 # operation.
10635 {
10636 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
10637 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
10638 # details. There is a set of defined message types to use for providing
10639 # details.The syntax depends on the error code. For example,
10640 # QuotaExceededInfo will have details when the error code is
10641 # QUOTA_EXCEEDED.
10642 {
10643 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
10644 #
10645 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
10646 # is not enabled:
10647 #
10648 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
10649 # &quot;domain&quot;: &quot;googleapis.com&quot;
10650 # &quot;metadata&quot;: {
10651 # &quot;resource&quot;: &quot;projects/123&quot;,
10652 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
10653 # }
10654 # }
10655 #
10656 # This response indicates that the pubsub.googleapis.com API is not enabled.
10657 #
10658 # Example of an error that is returned when attempting to create a Spanner
10659 # instance in a region that is out of stock:
10660 #
10661 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
10662 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
10663 # &quot;metadata&quot;: {
10664 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
10665 # }
10666 # }
10667 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
10668 # is typically the registered service name of the tool or product that
10669 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
10670 # generated by some common infrastructure, the error domain must be a
10671 # globally unique value that identifies the infrastructure. For Google API
10672 # infrastructure, the error domain is &quot;googleapis.com&quot;.
10673 &quot;metadatas&quot;: { # Additional structured details about this error.
10674 #
10675 # Keys must match a regular expression of `a-z+` but should
10676 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
10677 # length. When identifying the current value of an exceeded limit, the units
10678 # should be contained in the key, not the value. For example, rather than
10679 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
10680 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
10681 # instances that can be created in a single (batch) request.
10682 &quot;a_key&quot;: &quot;A String&quot;,
10683 },
10684 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
10685 # proximate cause of the error. Error reasons are unique within a particular
10686 # domain of errors. This should be at most 63 characters and match a
10687 # regular expression of `A-Z+[A-Z0-9]`, which represents
10688 # UPPER_SNAKE_CASE.
10689 },
10690 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
10691 #
10692 # For example, if a quota check failed with an error indicating the calling
10693 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
10694 # directly to the right place in the developer console to flip the bit.
10695 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
10696 { # Describes a URL link.
10697 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
10698 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
10699 },
10700 ],
10701 },
10702 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
10703 # which can be attached to an RPC error.
10704 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
10705 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
10706 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
10707 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
10708 },
10709 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
10710 &quot;dimensions&quot;: { # The map holding related quota dimensions.
10711 &quot;a_key&quot;: &quot;A String&quot;,
10712 },
10713 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
10714 # type or metric.
10715 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
10716 # or metric.
10717 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
10718 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
10719 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
10720 },
10721 },
10722 ],
10723 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
10724 # This property is optional.
10725 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
10726 },
10727 ],
10728 },
10729 &quot;getVersionOperationMetadata&quot;: {
10730 &quot;inlineSbomInfo&quot;: {
10731 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
10732 # appropriate identifiers.
10733 &quot;a_key&quot;: &quot;A String&quot;,
10734 },
10735 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
10736 # identifiers.
10737 &quot;a_key&quot;: &quot;A String&quot;,
10738 },
10739 },
10740 },
10741 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
10742 # message that was returned, such as `NOT FOUND`.
10743 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
10744 # status code that was returned. For example, a `404` means the
10745 # resource was not found.
10746 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
10747 # defined by the server.
10748 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
10749 # This value is inRFC3339
10750 # text format.
10751 &quot;instancesBulkInsertOperationMetadata&quot;: {
10752 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
10753 # Example key: zones/us-central1-a
10754 &quot;a_key&quot;: {
10755 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
10756 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
10757 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
10758 # error.
10759 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
10760 # if the flow is rolling forward or rolling back.
10761 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
10762 },
10763 },
10764 },
10765 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
10766 # Operation resources.
10767 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
10768 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
10769 # group of operations results from a `bulkInsert` API request.
10770 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
10771 # `update`, or `delete`, and so on.
10772 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
10773 # There is no requirement that this be linear or support any granularity of
10774 # operations. This should not be used to guess when the operation will be
10775 # complete. This number should monotonically increase as the operation
10776 # progresses.
10777 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
10778 # applicable when performing regional operations.
10779 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
10780 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
10781 # this field will contain information on all underlying zonal actions and
10782 # their state.
10783 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
10784 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
10785 # Example key: zones/us-central1-a
10786 &quot;a_key&quot;: {
10787 &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
10788 # populated.
10789 # different programming environments, including REST APIs and RPC APIs. It is
10790 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
10791 # three pieces of data: error code, error message, and error details.
10792 #
10793 # You can find out more about this error model and how to work with it in the
10794 # [API Design Guide](https://cloud.google.com/apis/design/errors).
10795 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
10796 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
10797 # message types for APIs to use.
10798 {
10799 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
10800 },
10801 ],
10802 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
10803 # user-facing error message should be localized and sent in the
10804 # google.rpc.Status.details field, or localized by the client.
10805 },
10806 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
10807 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
10808 },
10809 },
10810 },
10811 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
10812 # This value is inRFC3339
10813 # text format.
10814 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
10815 # following:
10816 # `PENDING`, `RUNNING`, or `DONE`.
10817 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
10818 # operation.
10819 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
10820 # of the target resource.
10821 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
10822 # operations related to creating a snapshot, this points to the disk
10823 # that the snapshot was created from.
10824 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
10825 # `[email protected]` or
10826 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
10827 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
10828 # operation, this field will be populated.
10829 {
10830 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
10831 # Engine returns NO_RESULTS_ON_PAGE if there
10832 # are no results in the response.
10833 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
10834 # value format. For example:
10835 #
10836 # &quot;data&quot;: [
10837 # {
10838 # &quot;key&quot;: &quot;scope&quot;,
10839 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
10840 # }
10841 {
10842 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
10843 # returned. For example, for warnings where there are no results in a list
10844 # request for a particular zone, this key might be scope and
10845 # the key value might be the zone name. Other examples might be a key
10846 # indicating a deprecated resource and a suggested replacement, or a
10847 # warning about invalid network settings (for example, if an instance
10848 # attempts to perform IP forwarding but is not enabled for IP forwarding).
10849 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
10850 },
10851 ],
10852 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
10853 },
10854 ],
10855 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
10856 # applicable when performing per-zone operations.
10857 }</pre>
10858 </div>
10859
10860 </body></html>