Debian Codegraph @

docs/dyn/compute_v1.regionInstanceGroupManagers.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.regionInstanceGroupManagers.html">regionInstanceGroupManagers</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#abandonInstances">abandonInstances(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p>
79 <p class="firstline">Flags the specified instances to be immediately removed from the managed</p>
80 <p class="toc_element">
81 <code><a href="#applyUpdatesToInstances">applyUpdatesToInstances(project, region, instanceGroupManager, body=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Apply updates to selected instances the managed instance group.</p>
83 <p class="toc_element">
84 <code><a href="#close">close()</a></code></p>
85 <p class="firstline">Close httplib2 connections.</p>
86 <p class="toc_element">
87 <code><a href="#createInstances">createInstances(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Creates instances with per-instance configurations in this regional managed</p>
89 <p class="toc_element">
90 <code><a href="#delete">delete(project, region, instanceGroupManager, requestId=None, x__xgafv=None)</a></code></p>
91 <p class="firstline">Deletes the specified managed instance group and all of the instances</p>
92 <p class="toc_element">
93 <code><a href="#deleteInstances">deleteInstances(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p>
94 <p class="firstline">Flags the specified instances in the managed instance group to be</p>
95 <p class="toc_element">
96 <code><a href="#deletePerInstanceConfigs">deletePerInstanceConfigs(project, region, instanceGroupManager, body=None, x__xgafv=None)</a></code></p>
97 <p class="firstline">Deletes selected per-instance configurations for the managed instance</p>
98 <p class="toc_element">
99 <code><a href="#get">get(project, region, instanceGroupManager, x__xgafv=None)</a></code></p>
100 <p class="firstline">Returns all of the details about the specified managed instance group.</p>
101 <p class="toc_element">
102 <code><a href="#insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</a></code></p>
103 <p class="firstline">Creates a managed instance group using the information that you specify</p>
104 <p class="toc_element">
105 <code><a href="#list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
106 <p class="firstline">Retrieves the list of managed instance groups that are contained</p>
107 <p class="toc_element">
108 <code><a href="#listErrors">listErrors(project, region, instanceGroupManager, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
109 <p class="firstline">Lists all errors thrown by actions on instances for a given regional</p>
110 <p class="toc_element">
111 <code><a href="#listErrors_next">listErrors_next()</a></code></p>
112 <p class="firstline">Retrieves the next page of results.</p>
113 <p class="toc_element">
114 <code><a href="#listManagedInstances">listManagedInstances(project, region, instanceGroupManager, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
115 <p class="firstline">Lists the instances in the managed instance group and instances that are</p>
116 <p class="toc_element">
117 <code><a href="#listManagedInstances_next">listManagedInstances_next()</a></code></p>
118 <p class="firstline">Retrieves the next page of results.</p>
119 <p class="toc_element">
120 <code><a href="#listPerInstanceConfigs">listPerInstanceConfigs(project, region, 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 per-instance configurations defined for the managed</p>
122 <p class="toc_element">
123 <code><a href="#listPerInstanceConfigs_next">listPerInstanceConfigs_next()</a></code></p>
124 <p class="firstline">Retrieves the next page of results.</p>
125 <p class="toc_element">
126 <code><a href="#list_next">list_next()</a></code></p>
127 <p class="firstline">Retrieves the next page of results.</p>
128 <p class="toc_element">
129 <code><a href="#patch">patch(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p>
130 <p class="firstline">Updates a managed instance group using the information that you specify</p>
131 <p class="toc_element">
132 <code><a href="#patchPerInstanceConfigs">patchPerInstanceConfigs(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p>
133 <p class="firstline">Inserts or patches per-instance configurations for the managed instance</p>
134 <p class="toc_element">
135 <code><a href="#recreateInstances">recreateInstances(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p>
136 <p class="firstline">Flags the specified VM instances in the managed instance group to be</p>
137 <p class="toc_element">
138 <code><a href="#resize">resize(project, region, instanceGroupManager, size, requestId=None, x__xgafv=None)</a></code></p>
139 <p class="firstline">Changes the intended size of the managed instance group. If you increase</p>
140 <p class="toc_element">
141 <code><a href="#resumeInstances">resumeInstances(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p>
142 <p class="firstline">Flags the specified instances in the managed instance group to be</p>
143 <p class="toc_element">
144 <code><a href="#setInstanceTemplate">setInstanceTemplate(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p>
145 <p class="firstline">Sets the instance template to use when creating new instances or recreating</p>
146 <p class="toc_element">
147 <code><a href="#setTargetPools">setTargetPools(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p>
148 <p class="firstline">Modifies the target pools to which all new instances in this group are</p>
149 <p class="toc_element">
150 <code><a href="#startInstances">startInstances(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p>
151 <p class="firstline">Flags the specified instances in the managed instance group to be</p>
152 <p class="toc_element">
153 <code><a href="#stopInstances">stopInstances(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p>
154 <p class="firstline">Flags the specified instances in the managed instance group to be</p>
155 <p class="toc_element">
156 <code><a href="#suspendInstances">suspendInstances(project, region, 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="#updatePerInstanceConfigs">updatePerInstanceConfigs(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</a></code></p>
160 <p class="firstline">Inserts or updates per-instance configurations for the managed instance</p>
161 <h3>Method Details</h3>
162 <div class="method">
163 <code class="details" id="abandonInstances">abandonInstances(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
164 <pre>Flags the specified instances to be immediately removed from the managed
165 instance group. Abandoning an instance does not delete the
166 instance, but it does remove the instance from any target pools that are
167 applied by the managed instance group. This method reduces thetargetSize of the managed instance group by the
168 number of instances that you abandon. This operation is marked asDONE when the action is scheduled even if the instances have
169 not yet been removed from the group. You must separately verify the
170 status of the abandoning action with thelistmanagedinstances
171 method.
172
173 If the group is part of a backend
174 service that has enabled
175 connection draining, it can take up to 60 seconds after the connection
176 draining duration has elapsed before the VM instance is removed or deleted.
177
178 You can specify a maximum of 1000 instances with this method per request.
179
180 Args:
181 project: string, Project ID for this request. (required)
182 region: string, Name of the region scoping this request. (required)
183 instanceGroupManager: string, Name of the managed instance group. (required)
184 body: object, The request body.
185 The object takes the form of:
186
187 {
188 &quot;instances&quot;: [ # The URLs of one or more instances to abandon. This can be a full URL or
189 # a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].
190 &quot;A String&quot;,
191 ],
192 }
193
194 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
195 that if you must retry your request, the server will know to ignore the
196 request if it has already been completed.
197
198 For example, consider a situation where you make an initial request and
199 the request times out. If you make the request again with the same
200 request ID, the server can check if original operation with the same
201 request ID was received, and if so, will ignore the second request. This
202 prevents clients from accidentally creating duplicate commitments.
203
204 The request ID must be
205 a valid UUID with the exception that zero UUID is not supported
206 (00000000-0000-0000-0000-000000000000).
207 x__xgafv: string, V1 error format.
208 Allowed values
209 1 - v1 error format
210 2 - v2 error format
211
212 Returns:
213 An object of the form:
214
215 { # Represents an Operation resource.
216 #
217 # Google Compute Engine has three Operation resources:
218 #
219 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
220 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
221 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
222 #
223 # You can use an operation resource to manage asynchronous API requests.
224 # For more information, readHandling
225 # API responses.
226 #
227 # Operations can be global, regional or zonal.
228 #
229 # - For global operations, use the `globalOperations`
230 # resource.
231 # - For regional operations, use the
232 # `regionOperations` resource.
233 # - For zonal operations, use
234 # the `zoneOperations` resource.
235 #
236 #
237 #
238 # For more information, read
239 # Global, Regional, and Zonal Resources.
240 #
241 # Note that completed Operation resources have a limited
242 # retention period.
243 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
244 # Not present otherwise.
245 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
246 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
247 # set when the operation is created.
248 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
249 # text format.
250 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
251 # this field will be populated.
252 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
253 # operation.
254 {
255 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
256 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
257 # details. There is a set of defined message types to use for providing
258 # details.The syntax depends on the error code. For example,
259 # QuotaExceededInfo will have details when the error code is
260 # QUOTA_EXCEEDED.
261 {
262 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
263 #
264 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
265 # is not enabled:
266 #
267 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
268 # &quot;domain&quot;: &quot;googleapis.com&quot;
269 # &quot;metadata&quot;: {
270 # &quot;resource&quot;: &quot;projects/123&quot;,
271 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
272 # }
273 # }
274 #
275 # This response indicates that the pubsub.googleapis.com API is not enabled.
276 #
277 # Example of an error that is returned when attempting to create a Spanner
278 # instance in a region that is out of stock:
279 #
280 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
281 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
282 # &quot;metadata&quot;: {
283 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
284 # }
285 # }
286 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
287 # is typically the registered service name of the tool or product that
288 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
289 # generated by some common infrastructure, the error domain must be a
290 # globally unique value that identifies the infrastructure. For Google API
291 # infrastructure, the error domain is &quot;googleapis.com&quot;.
292 &quot;metadatas&quot;: { # Additional structured details about this error.
293 #
294 # Keys must match a regular expression of `a-z+` but should
295 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
296 # length. When identifying the current value of an exceeded limit, the units
297 # should be contained in the key, not the value. For example, rather than
298 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
299 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
300 # instances that can be created in a single (batch) request.
301 &quot;a_key&quot;: &quot;A String&quot;,
302 },
303 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
304 # proximate cause of the error. Error reasons are unique within a particular
305 # domain of errors. This should be at most 63 characters and match a
306 # regular expression of `A-Z+[A-Z0-9]`, which represents
307 # UPPER_SNAKE_CASE.
308 },
309 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
310 #
311 # For example, if a quota check failed with an error indicating the calling
312 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
313 # directly to the right place in the developer console to flip the bit.
314 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
315 { # Describes a URL link.
316 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
317 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
318 },
319 ],
320 },
321 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
322 # which can be attached to an RPC error.
323 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
324 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
325 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
326 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
327 },
328 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
329 &quot;dimensions&quot;: { # The map holding related quota dimensions.
330 &quot;a_key&quot;: &quot;A String&quot;,
331 },
332 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
333 # type or metric.
334 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
335 # or metric.
336 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
337 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
338 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
339 },
340 },
341 ],
342 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
343 # This property is optional.
344 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
345 },
346 ],
347 },
348 &quot;getVersionOperationMetadata&quot;: {
349 &quot;inlineSbomInfo&quot;: {
350 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
351 # appropriate identifiers.
352 &quot;a_key&quot;: &quot;A String&quot;,
353 },
354 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
355 # identifiers.
356 &quot;a_key&quot;: &quot;A String&quot;,
357 },
358 },
359 },
360 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
361 # message that was returned, such as `NOT FOUND`.
362 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
363 # status code that was returned. For example, a `404` means the
364 # resource was not found.
365 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
366 # defined by the server.
367 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
368 # This value is inRFC3339
369 # text format.
370 &quot;instancesBulkInsertOperationMetadata&quot;: {
371 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
372 # Example key: zones/us-central1-a
373 &quot;a_key&quot;: {
374 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
375 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
376 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
377 # error.
378 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
379 # if the flow is rolling forward or rolling back.
380 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
381 },
382 },
383 },
384 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
385 # Operation resources.
386 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
387 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
388 # group of operations results from a `bulkInsert` API request.
389 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
390 # `update`, or `delete`, and so on.
391 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
392 # There is no requirement that this be linear or support any granularity of
393 # operations. This should not be used to guess when the operation will be
394 # complete. This number should monotonically increase as the operation
395 # progresses.
396 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
397 # applicable when performing regional operations.
398 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
399 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
400 # this field will contain information on all underlying zonal actions and
401 # their state.
402 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
403 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
404 # Example key: zones/us-central1-a
405 &quot;a_key&quot;: {
406 &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
407 # populated.
408 # different programming environments, including REST APIs and RPC APIs. It is
409 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
410 # three pieces of data: error code, error message, and error details.
411 #
412 # You can find out more about this error model and how to work with it in the
413 # [API Design Guide](https://cloud.google.com/apis/design/errors).
414 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
415 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
416 # message types for APIs to use.
417 {
418 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
419 },
420 ],
421 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
422 # user-facing error message should be localized and sent in the
423 # google.rpc.Status.details field, or localized by the client.
424 },
425 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
426 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
427 },
428 },
429 },
430 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
431 # This value is inRFC3339
432 # text format.
433 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
434 # following:
435 # `PENDING`, `RUNNING`, or `DONE`.
436 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
437 # operation.
438 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
439 # of the target resource.
440 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
441 # operations related to creating a snapshot, this points to the disk
442 # that the snapshot was created from.
443 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
444 # `[email protected]` or
445 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
446 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
447 # operation, this field will be populated.
448 {
449 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
450 # Engine returns NO_RESULTS_ON_PAGE if there
451 # are no results in the response.
452 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
453 # value format. For example:
454 #
455 # &quot;data&quot;: [
456 # {
457 # &quot;key&quot;: &quot;scope&quot;,
458 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
459 # }
460 {
461 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
462 # returned. For example, for warnings where there are no results in a list
463 # request for a particular zone, this key might be scope and
464 # the key value might be the zone name. Other examples might be a key
465 # indicating a deprecated resource and a suggested replacement, or a
466 # warning about invalid network settings (for example, if an instance
467 # attempts to perform IP forwarding but is not enabled for IP forwarding).
468 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
469 },
470 ],
471 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
472 },
473 ],
474 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
475 # applicable when performing per-zone operations.
476 }</pre>
477 </div>
478
479 <div class="method">
480 <code class="details" id="applyUpdatesToInstances">applyUpdatesToInstances(project, region, instanceGroupManager, body=None, x__xgafv=None)</code>
481 <pre>Apply updates to selected instances the managed instance group.
482
483 Args:
484 project: string, Project ID for this request. (required)
485 region: string, Name of the region scoping this request, should conform to RFC1035. (required)
486 instanceGroupManager: string, The name of the managed instance group, should conform to RFC1035. (required)
487 body: object, The request body.
488 The object takes the form of:
489
490 { # RegionInstanceGroupManagers.applyUpdatesToInstances
491 &quot;allInstances&quot;: True or False, # Flag to update all instances instead of specified list of “instances”.
492 # If the flag is set to true then the instances may not be specified
493 # in the request.
494 &quot;instances&quot;: [ # The list of URLs of one or more instances for which you want to apply
495 # updates. Each URL can be a full URL or a partial URL, such aszones/[ZONE]/instances/[INSTANCE_NAME].
496 &quot;A String&quot;,
497 ],
498 &quot;minimalAction&quot;: &quot;A String&quot;, # The minimal action that you want to perform on each instance during the
499 # update:
500 #
501 #
502 # - REPLACE: At minimum, delete the instance and create it
503 # again.
504 # - RESTART: Stop the instance and start it
505 # again.
506 # - REFRESH: Do not stop the instance and limit
507 # disruption as much as possible.
508 # - NONE: Do not
509 # disrupt the instance at all.
510 #
511 #
512 # By default, the minimum action is NONE. If your update
513 # requires a more disruptive action than you set with this flag, the
514 # necessary action is performed to execute the update.
515 &quot;mostDisruptiveAllowedAction&quot;: &quot;A String&quot;, # The most disruptive action that you want to perform on each instance during
516 # the update:
517 #
518 #
519 # - REPLACE: Delete the instance and create it again.
520 # - RESTART: Stop the instance and start it again.
521 # - REFRESH: Do not stop the instance and limit disruption
522 # as much as possible.
523 # - NONE: Do not disrupt the
524 # instance at all.
525 #
526 #
527 # By default, the most disruptive allowed action is REPLACE. If
528 # your update requires a more disruptive action than you set with this flag,
529 # the update request will fail.
530 }
531
532 x__xgafv: string, V1 error format.
533 Allowed values
534 1 - v1 error format
535 2 - v2 error format
536
537 Returns:
538 An object of the form:
539
540 { # Represents an Operation resource.
541 #
542 # Google Compute Engine has three Operation resources:
543 #
544 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
545 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
546 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
547 #
548 # You can use an operation resource to manage asynchronous API requests.
549 # For more information, readHandling
550 # API responses.
551 #
552 # Operations can be global, regional or zonal.
553 #
554 # - For global operations, use the `globalOperations`
555 # resource.
556 # - For regional operations, use the
557 # `regionOperations` resource.
558 # - For zonal operations, use
559 # the `zoneOperations` resource.
560 #
561 #
562 #
563 # For more information, read
564 # Global, Regional, and Zonal Resources.
565 #
566 # Note that completed Operation resources have a limited
567 # retention period.
568 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
569 # Not present otherwise.
570 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
571 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
572 # set when the operation is created.
573 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
574 # text format.
575 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
576 # this field will be populated.
577 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
578 # operation.
579 {
580 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
581 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
582 # details. There is a set of defined message types to use for providing
583 # details.The syntax depends on the error code. For example,
584 # QuotaExceededInfo will have details when the error code is
585 # QUOTA_EXCEEDED.
586 {
587 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
588 #
589 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
590 # is not enabled:
591 #
592 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
593 # &quot;domain&quot;: &quot;googleapis.com&quot;
594 # &quot;metadata&quot;: {
595 # &quot;resource&quot;: &quot;projects/123&quot;,
596 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
597 # }
598 # }
599 #
600 # This response indicates that the pubsub.googleapis.com API is not enabled.
601 #
602 # Example of an error that is returned when attempting to create a Spanner
603 # instance in a region that is out of stock:
604 #
605 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
606 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
607 # &quot;metadata&quot;: {
608 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
609 # }
610 # }
611 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
612 # is typically the registered service name of the tool or product that
613 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
614 # generated by some common infrastructure, the error domain must be a
615 # globally unique value that identifies the infrastructure. For Google API
616 # infrastructure, the error domain is &quot;googleapis.com&quot;.
617 &quot;metadatas&quot;: { # Additional structured details about this error.
618 #
619 # Keys must match a regular expression of `a-z+` but should
620 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
621 # length. When identifying the current value of an exceeded limit, the units
622 # should be contained in the key, not the value. For example, rather than
623 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
624 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
625 # instances that can be created in a single (batch) request.
626 &quot;a_key&quot;: &quot;A String&quot;,
627 },
628 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
629 # proximate cause of the error. Error reasons are unique within a particular
630 # domain of errors. This should be at most 63 characters and match a
631 # regular expression of `A-Z+[A-Z0-9]`, which represents
632 # UPPER_SNAKE_CASE.
633 },
634 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
635 #
636 # For example, if a quota check failed with an error indicating the calling
637 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
638 # directly to the right place in the developer console to flip the bit.
639 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
640 { # Describes a URL link.
641 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
642 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
643 },
644 ],
645 },
646 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
647 # which can be attached to an RPC error.
648 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
649 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
650 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
651 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
652 },
653 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
654 &quot;dimensions&quot;: { # The map holding related quota dimensions.
655 &quot;a_key&quot;: &quot;A String&quot;,
656 },
657 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
658 # type or metric.
659 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
660 # or metric.
661 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
662 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
663 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
664 },
665 },
666 ],
667 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
668 # This property is optional.
669 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
670 },
671 ],
672 },
673 &quot;getVersionOperationMetadata&quot;: {
674 &quot;inlineSbomInfo&quot;: {
675 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
676 # appropriate identifiers.
677 &quot;a_key&quot;: &quot;A String&quot;,
678 },
679 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
680 # identifiers.
681 &quot;a_key&quot;: &quot;A String&quot;,
682 },
683 },
684 },
685 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
686 # message that was returned, such as `NOT FOUND`.
687 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
688 # status code that was returned. For example, a `404` means the
689 # resource was not found.
690 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
691 # defined by the server.
692 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
693 # This value is inRFC3339
694 # text format.
695 &quot;instancesBulkInsertOperationMetadata&quot;: {
696 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
697 # Example key: zones/us-central1-a
698 &quot;a_key&quot;: {
699 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
700 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
701 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
702 # error.
703 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
704 # if the flow is rolling forward or rolling back.
705 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
706 },
707 },
708 },
709 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
710 # Operation resources.
711 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
712 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
713 # group of operations results from a `bulkInsert` API request.
714 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
715 # `update`, or `delete`, and so on.
716 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
717 # There is no requirement that this be linear or support any granularity of
718 # operations. This should not be used to guess when the operation will be
719 # complete. This number should monotonically increase as the operation
720 # progresses.
721 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
722 # applicable when performing regional operations.
723 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
724 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
725 # this field will contain information on all underlying zonal actions and
726 # their state.
727 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
728 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
729 # Example key: zones/us-central1-a
730 &quot;a_key&quot;: {
731 &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
732 # populated.
733 # different programming environments, including REST APIs and RPC APIs. It is
734 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
735 # three pieces of data: error code, error message, and error details.
736 #
737 # You can find out more about this error model and how to work with it in the
738 # [API Design Guide](https://cloud.google.com/apis/design/errors).
739 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
740 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
741 # message types for APIs to use.
742 {
743 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
744 },
745 ],
746 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
747 # user-facing error message should be localized and sent in the
748 # google.rpc.Status.details field, or localized by the client.
749 },
750 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
751 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
752 },
753 },
754 },
755 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
756 # This value is inRFC3339
757 # text format.
758 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
759 # following:
760 # `PENDING`, `RUNNING`, or `DONE`.
761 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
762 # operation.
763 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
764 # of the target resource.
765 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
766 # operations related to creating a snapshot, this points to the disk
767 # that the snapshot was created from.
768 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
769 # `[email protected]` or
770 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
771 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
772 # operation, this field will be populated.
773 {
774 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
775 # Engine returns NO_RESULTS_ON_PAGE if there
776 # are no results in the response.
777 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
778 # value format. For example:
779 #
780 # &quot;data&quot;: [
781 # {
782 # &quot;key&quot;: &quot;scope&quot;,
783 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
784 # }
785 {
786 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
787 # returned. For example, for warnings where there are no results in a list
788 # request for a particular zone, this key might be scope and
789 # the key value might be the zone name. Other examples might be a key
790 # indicating a deprecated resource and a suggested replacement, or a
791 # warning about invalid network settings (for example, if an instance
792 # attempts to perform IP forwarding but is not enabled for IP forwarding).
793 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
794 },
795 ],
796 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
797 },
798 ],
799 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
800 # applicable when performing per-zone operations.
801 }</pre>
802 </div>
803
804 <div class="method">
805 <code class="details" id="close">close()</code>
806 <pre>Close httplib2 connections.</pre>
807 </div>
808
809 <div class="method">
810 <code class="details" id="createInstances">createInstances(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
811 <pre>Creates instances with per-instance configurations in this regional managed
812 instance group. Instances are created using the current instance template.
813 The create instances operation is marked DONE if
814 the createInstances request is successful. The underlying
815 actions take additional time. You must separately verify the status of thecreating or actions with the listmanagedinstances
816 method.
817
818 Args:
819 project: string, Project ID for this request. (required)
820 region: string, The name of theregion
821 where the managed instance group is located.
822 It should conform to RFC1035. (required)
823 instanceGroupManager: string, The name of the managed instance group.
824 It should conform to RFC1035. (required)
825 body: object, The request body.
826 The object takes the form of:
827
828 { # RegionInstanceGroupManagers.createInstances
829 &quot;instances&quot;: [ # [Required] List of specifications of per-instance configs.
830 {
831 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this per-instance config. This field can be used in
832 # optimistic locking. It is ignored when inserting a per-instance
833 # config. An up-to-date fingerprint must be provided in order to update an
834 # existing per-instance configuration or the field needs to be unset.
835 &quot;name&quot;: &quot;A String&quot;, # The name of a per-instance configuration and its corresponding instance.
836 # Serves as a merge key during UpdatePerInstanceConfigs
837 # operations, that is, if a per-instance configuration with the same name
838 # exists then it will be updated, otherwise a new one will be created for the
839 # VM instance with the same name. An attempt to create a per-instance
840 # configuration for a VM instance that either doesn&#x27;t exist or is not part
841 # of the group will result in an error.
842 &quot;preservedState&quot;: { # Preserved state for a given instance. # The intended preserved state for the given instance. Does not contain
843 # preserved state generated from a stateful policy.
844 &quot;disks&quot;: { # Preserved disks defined for this instance.
845 # This map is keyed with the device names of the disks.
846 &quot;a_key&quot;: {
847 &quot;autoDelete&quot;: &quot;A String&quot;, # These stateful disks will never be deleted during autohealing,
848 # update, instance recreate operations. This flag is used to configure
849 # if the disk should be deleted after it is no longer used by the group,
850 # e.g. when the given instance or the whole MIG is deleted.
851 # Note: disks attached in READ_ONLY mode cannot be
852 # auto-deleted.
853 &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
854 # disk in READ_WRITE mode.
855 &quot;source&quot;: &quot;A String&quot;, # The URL of the disk resource that is stateful and should be attached
856 # to the VM instance.
857 },
858 },
859 &quot;externalIPs&quot;: { # Preserved external IPs defined for this instance.
860 # This map is keyed with the name of the network interface.
861 &quot;a_key&quot;: {
862 &quot;autoDelete&quot;: &quot;A String&quot;, # These stateful IPs will never be released during autohealing,
863 # update or VM instance recreate operations.
864 # This flag is used to configure if the IP reservation should be deleted
865 # after it is no longer used by the group, e.g. when the given instance
866 # or the whole group is deleted.
867 &quot;ipAddress&quot;: { # Ip address representation
868 &quot;address&quot;: &quot;A String&quot;, # The URL of the reservation for this IP address.
869 &quot;literal&quot;: &quot;A String&quot;, # An IPv4 internal network address to assign to the instance for this
870 # network interface.
871 },
872 },
873 },
874 &quot;internalIPs&quot;: { # Preserved internal IPs defined for this instance.
875 # This map is keyed with the name of the network interface.
876 &quot;a_key&quot;: {
877 &quot;autoDelete&quot;: &quot;A String&quot;, # These stateful IPs will never be released during autohealing,
878 # update or VM instance recreate operations.
879 # This flag is used to configure if the IP reservation should be deleted
880 # after it is no longer used by the group, e.g. when the given instance
881 # or the whole group is deleted.
882 &quot;ipAddress&quot;: { # Ip address representation
883 &quot;address&quot;: &quot;A String&quot;, # The URL of the reservation for this IP address.
884 &quot;literal&quot;: &quot;A String&quot;, # An IPv4 internal network address to assign to the instance for this
885 # network interface.
886 },
887 },
888 },
889 &quot;metadata&quot;: { # Preserved metadata defined for this instance.
890 &quot;a_key&quot;: &quot;A String&quot;,
891 },
892 },
893 &quot;status&quot;: &quot;A String&quot;, # The status of applying this per-instance configuration on the corresponding
894 # managed instance.
895 },
896 ],
897 }
898
899 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
900 that if you must retry your request, the server will know to ignore the
901 request if it has already been completed.
902
903 For example, consider a situation where you make an initial request and
904 the request times out. If you make the request again with the same
905 request ID, the server can check if original operation with the same
906 request ID was received, and if so, will ignore the second request.
907
908 The request ID must be
909 a valid UUID with the exception that zero UUID is not supported
910 (00000000-0000-0000-0000-000000000000).
911 x__xgafv: string, V1 error format.
912 Allowed values
913 1 - v1 error format
914 2 - v2 error format
915
916 Returns:
917 An object of the form:
918
919 { # Represents an Operation resource.
920 #
921 # Google Compute Engine has three Operation resources:
922 #
923 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
924 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
925 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
926 #
927 # You can use an operation resource to manage asynchronous API requests.
928 # For more information, readHandling
929 # API responses.
930 #
931 # Operations can be global, regional or zonal.
932 #
933 # - For global operations, use the `globalOperations`
934 # resource.
935 # - For regional operations, use the
936 # `regionOperations` resource.
937 # - For zonal operations, use
938 # the `zoneOperations` resource.
939 #
940 #
941 #
942 # For more information, read
943 # Global, Regional, and Zonal Resources.
944 #
945 # Note that completed Operation resources have a limited
946 # retention period.
947 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
948 # Not present otherwise.
949 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
950 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
951 # set when the operation is created.
952 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
953 # text format.
954 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
955 # this field will be populated.
956 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
957 # operation.
958 {
959 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
960 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
961 # details. There is a set of defined message types to use for providing
962 # details.The syntax depends on the error code. For example,
963 # QuotaExceededInfo will have details when the error code is
964 # QUOTA_EXCEEDED.
965 {
966 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
967 #
968 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
969 # is not enabled:
970 #
971 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
972 # &quot;domain&quot;: &quot;googleapis.com&quot;
973 # &quot;metadata&quot;: {
974 # &quot;resource&quot;: &quot;projects/123&quot;,
975 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
976 # }
977 # }
978 #
979 # This response indicates that the pubsub.googleapis.com API is not enabled.
980 #
981 # Example of an error that is returned when attempting to create a Spanner
982 # instance in a region that is out of stock:
983 #
984 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
985 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
986 # &quot;metadata&quot;: {
987 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
988 # }
989 # }
990 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
991 # is typically the registered service name of the tool or product that
992 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
993 # generated by some common infrastructure, the error domain must be a
994 # globally unique value that identifies the infrastructure. For Google API
995 # infrastructure, the error domain is &quot;googleapis.com&quot;.
996 &quot;metadatas&quot;: { # Additional structured details about this error.
997 #
998 # Keys must match a regular expression of `a-z+` but should
999 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
1000 # length. When identifying the current value of an exceeded limit, the units
1001 # should be contained in the key, not the value. For example, rather than
1002 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1003 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1004 # instances that can be created in a single (batch) request.
1005 &quot;a_key&quot;: &quot;A String&quot;,
1006 },
1007 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1008 # proximate cause of the error. Error reasons are unique within a particular
1009 # domain of errors. This should be at most 63 characters and match a
1010 # regular expression of `A-Z+[A-Z0-9]`, which represents
1011 # UPPER_SNAKE_CASE.
1012 },
1013 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1014 #
1015 # For example, if a quota check failed with an error indicating the calling
1016 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1017 # directly to the right place in the developer console to flip the bit.
1018 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1019 { # Describes a URL link.
1020 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1021 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1022 },
1023 ],
1024 },
1025 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1026 # which can be attached to an RPC error.
1027 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1028 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1029 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1030 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1031 },
1032 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1033 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1034 &quot;a_key&quot;: &quot;A String&quot;,
1035 },
1036 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1037 # type or metric.
1038 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1039 # or metric.
1040 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1041 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1042 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1043 },
1044 },
1045 ],
1046 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1047 # This property is optional.
1048 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1049 },
1050 ],
1051 },
1052 &quot;getVersionOperationMetadata&quot;: {
1053 &quot;inlineSbomInfo&quot;: {
1054 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1055 # appropriate identifiers.
1056 &quot;a_key&quot;: &quot;A String&quot;,
1057 },
1058 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
1059 # identifiers.
1060 &quot;a_key&quot;: &quot;A String&quot;,
1061 },
1062 },
1063 },
1064 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1065 # message that was returned, such as `NOT FOUND`.
1066 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1067 # status code that was returned. For example, a `404` means the
1068 # resource was not found.
1069 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1070 # defined by the server.
1071 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1072 # This value is inRFC3339
1073 # text format.
1074 &quot;instancesBulkInsertOperationMetadata&quot;: {
1075 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1076 # Example key: zones/us-central1-a
1077 &quot;a_key&quot;: {
1078 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1079 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1080 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1081 # error.
1082 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1083 # if the flow is rolling forward or rolling back.
1084 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1085 },
1086 },
1087 },
1088 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1089 # Operation resources.
1090 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1091 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1092 # group of operations results from a `bulkInsert` API request.
1093 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1094 # `update`, or `delete`, and so on.
1095 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1096 # There is no requirement that this be linear or support any granularity of
1097 # operations. This should not be used to guess when the operation will be
1098 # complete. This number should monotonically increase as the operation
1099 # progresses.
1100 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1101 # applicable when performing regional operations.
1102 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1103 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1104 # this field will contain information on all underlying zonal actions and
1105 # their state.
1106 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1107 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1108 # Example key: zones/us-central1-a
1109 &quot;a_key&quot;: {
1110 &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
1111 # populated.
1112 # different programming environments, including REST APIs and RPC APIs. It is
1113 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1114 # three pieces of data: error code, error message, and error details.
1115 #
1116 # You can find out more about this error model and how to work with it in the
1117 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1118 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1119 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1120 # message types for APIs to use.
1121 {
1122 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1123 },
1124 ],
1125 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1126 # user-facing error message should be localized and sent in the
1127 # google.rpc.Status.details field, or localized by the client.
1128 },
1129 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1130 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1131 },
1132 },
1133 },
1134 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1135 # This value is inRFC3339
1136 # text format.
1137 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1138 # following:
1139 # `PENDING`, `RUNNING`, or `DONE`.
1140 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1141 # operation.
1142 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1143 # of the target resource.
1144 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1145 # operations related to creating a snapshot, this points to the disk
1146 # that the snapshot was created from.
1147 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1148 # `[email protected]` or
1149 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1150 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1151 # operation, this field will be populated.
1152 {
1153 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1154 # Engine returns NO_RESULTS_ON_PAGE if there
1155 # are no results in the response.
1156 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1157 # value format. For example:
1158 #
1159 # &quot;data&quot;: [
1160 # {
1161 # &quot;key&quot;: &quot;scope&quot;,
1162 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1163 # }
1164 {
1165 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1166 # returned. For example, for warnings where there are no results in a list
1167 # request for a particular zone, this key might be scope and
1168 # the key value might be the zone name. Other examples might be a key
1169 # indicating a deprecated resource and a suggested replacement, or a
1170 # warning about invalid network settings (for example, if an instance
1171 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1172 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1173 },
1174 ],
1175 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1176 },
1177 ],
1178 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1179 # applicable when performing per-zone operations.
1180 }</pre>
1181 </div>
1182
1183 <div class="method">
1184 <code class="details" id="delete">delete(project, region, instanceGroupManager, requestId=None, x__xgafv=None)</code>
1185 <pre>Deletes the specified managed instance group and all of the instances
1186 in that group.
1187
1188 Args:
1189 project: string, Project ID for this request. (required)
1190 region: string, Name of the region scoping this request. (required)
1191 instanceGroupManager: string, Name of the managed instance group to delete. (required)
1192 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
1193 that if you must retry your request, the server will know to ignore the
1194 request if it has already been completed.
1195
1196 For example, consider a situation where you make an initial request and
1197 the request times out. If you make the request again with the same
1198 request ID, the server can check if original operation with the same
1199 request ID was received, and if so, will ignore the second request. This
1200 prevents clients from accidentally creating duplicate commitments.
1201
1202 The request ID must be
1203 a valid UUID with the exception that zero UUID is not supported
1204 (00000000-0000-0000-0000-000000000000).
1205 x__xgafv: string, V1 error format.
1206 Allowed values
1207 1 - v1 error format
1208 2 - v2 error format
1209
1210 Returns:
1211 An object of the form:
1212
1213 { # Represents an Operation resource.
1214 #
1215 # Google Compute Engine has three Operation resources:
1216 #
1217 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
1218 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
1219 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
1220 #
1221 # You can use an operation resource to manage asynchronous API requests.
1222 # For more information, readHandling
1223 # API responses.
1224 #
1225 # Operations can be global, regional or zonal.
1226 #
1227 # - For global operations, use the `globalOperations`
1228 # resource.
1229 # - For regional operations, use the
1230 # `regionOperations` resource.
1231 # - For zonal operations, use
1232 # the `zoneOperations` resource.
1233 #
1234 #
1235 #
1236 # For more information, read
1237 # Global, Regional, and Zonal Resources.
1238 #
1239 # Note that completed Operation resources have a limited
1240 # retention period.
1241 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
1242 # Not present otherwise.
1243 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1244 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
1245 # set when the operation is created.
1246 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
1247 # text format.
1248 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
1249 # this field will be populated.
1250 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
1251 # operation.
1252 {
1253 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1254 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
1255 # details. There is a set of defined message types to use for providing
1256 # details.The syntax depends on the error code. For example,
1257 # QuotaExceededInfo will have details when the error code is
1258 # QUOTA_EXCEEDED.
1259 {
1260 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
1261 #
1262 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
1263 # is not enabled:
1264 #
1265 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
1266 # &quot;domain&quot;: &quot;googleapis.com&quot;
1267 # &quot;metadata&quot;: {
1268 # &quot;resource&quot;: &quot;projects/123&quot;,
1269 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
1270 # }
1271 # }
1272 #
1273 # This response indicates that the pubsub.googleapis.com API is not enabled.
1274 #
1275 # Example of an error that is returned when attempting to create a Spanner
1276 # instance in a region that is out of stock:
1277 #
1278 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
1279 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
1280 # &quot;metadata&quot;: {
1281 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
1282 # }
1283 # }
1284 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
1285 # is typically the registered service name of the tool or product that
1286 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
1287 # generated by some common infrastructure, the error domain must be a
1288 # globally unique value that identifies the infrastructure. For Google API
1289 # infrastructure, the error domain is &quot;googleapis.com&quot;.
1290 &quot;metadatas&quot;: { # Additional structured details about this error.
1291 #
1292 # Keys must match a regular expression of `a-z+` but should
1293 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
1294 # length. When identifying the current value of an exceeded limit, the units
1295 # should be contained in the key, not the value. For example, rather than
1296 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1297 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1298 # instances that can be created in a single (batch) request.
1299 &quot;a_key&quot;: &quot;A String&quot;,
1300 },
1301 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1302 # proximate cause of the error. Error reasons are unique within a particular
1303 # domain of errors. This should be at most 63 characters and match a
1304 # regular expression of `A-Z+[A-Z0-9]`, which represents
1305 # UPPER_SNAKE_CASE.
1306 },
1307 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1308 #
1309 # For example, if a quota check failed with an error indicating the calling
1310 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1311 # directly to the right place in the developer console to flip the bit.
1312 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1313 { # Describes a URL link.
1314 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1315 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1316 },
1317 ],
1318 },
1319 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1320 # which can be attached to an RPC error.
1321 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1322 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1323 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1324 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1325 },
1326 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1327 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1328 &quot;a_key&quot;: &quot;A String&quot;,
1329 },
1330 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1331 # type or metric.
1332 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1333 # or metric.
1334 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1335 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1336 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1337 },
1338 },
1339 ],
1340 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1341 # This property is optional.
1342 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1343 },
1344 ],
1345 },
1346 &quot;getVersionOperationMetadata&quot;: {
1347 &quot;inlineSbomInfo&quot;: {
1348 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1349 # appropriate identifiers.
1350 &quot;a_key&quot;: &quot;A String&quot;,
1351 },
1352 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
1353 # identifiers.
1354 &quot;a_key&quot;: &quot;A String&quot;,
1355 },
1356 },
1357 },
1358 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1359 # message that was returned, such as `NOT FOUND`.
1360 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1361 # status code that was returned. For example, a `404` means the
1362 # resource was not found.
1363 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1364 # defined by the server.
1365 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1366 # This value is inRFC3339
1367 # text format.
1368 &quot;instancesBulkInsertOperationMetadata&quot;: {
1369 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1370 # Example key: zones/us-central1-a
1371 &quot;a_key&quot;: {
1372 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1373 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1374 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1375 # error.
1376 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1377 # if the flow is rolling forward or rolling back.
1378 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1379 },
1380 },
1381 },
1382 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1383 # Operation resources.
1384 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1385 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1386 # group of operations results from a `bulkInsert` API request.
1387 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1388 # `update`, or `delete`, and so on.
1389 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1390 # There is no requirement that this be linear or support any granularity of
1391 # operations. This should not be used to guess when the operation will be
1392 # complete. This number should monotonically increase as the operation
1393 # progresses.
1394 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1395 # applicable when performing regional operations.
1396 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1397 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1398 # this field will contain information on all underlying zonal actions and
1399 # their state.
1400 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1401 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1402 # Example key: zones/us-central1-a
1403 &quot;a_key&quot;: {
1404 &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
1405 # populated.
1406 # different programming environments, including REST APIs and RPC APIs. It is
1407 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1408 # three pieces of data: error code, error message, and error details.
1409 #
1410 # You can find out more about this error model and how to work with it in the
1411 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1412 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1413 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1414 # message types for APIs to use.
1415 {
1416 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1417 },
1418 ],
1419 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1420 # user-facing error message should be localized and sent in the
1421 # google.rpc.Status.details field, or localized by the client.
1422 },
1423 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1424 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1425 },
1426 },
1427 },
1428 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1429 # This value is inRFC3339
1430 # text format.
1431 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1432 # following:
1433 # `PENDING`, `RUNNING`, or `DONE`.
1434 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1435 # operation.
1436 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1437 # of the target resource.
1438 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1439 # operations related to creating a snapshot, this points to the disk
1440 # that the snapshot was created from.
1441 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1442 # `[email protected]` or
1443 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1444 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1445 # operation, this field will be populated.
1446 {
1447 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1448 # Engine returns NO_RESULTS_ON_PAGE if there
1449 # are no results in the response.
1450 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1451 # value format. For example:
1452 #
1453 # &quot;data&quot;: [
1454 # {
1455 # &quot;key&quot;: &quot;scope&quot;,
1456 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1457 # }
1458 {
1459 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1460 # returned. For example, for warnings where there are no results in a list
1461 # request for a particular zone, this key might be scope and
1462 # the key value might be the zone name. Other examples might be a key
1463 # indicating a deprecated resource and a suggested replacement, or a
1464 # warning about invalid network settings (for example, if an instance
1465 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1466 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1467 },
1468 ],
1469 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1470 },
1471 ],
1472 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1473 # applicable when performing per-zone operations.
1474 }</pre>
1475 </div>
1476
1477 <div class="method">
1478 <code class="details" id="deleteInstances">deleteInstances(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
1479 <pre>Flags the specified instances in the managed instance group to be
1480 immediately deleted. The instances are also removed from any target
1481 pools of which they were a member. This method reduces thetargetSize of the managed instance group by the number of
1482 instances that you delete.
1483 The deleteInstances operation is marked DONE if
1484 the deleteInstances request is successful. The underlying
1485 actions take additional time. You must separately verify the status of thedeleting action with thelistmanagedinstances
1486 method.
1487
1488 If the group is part of a backend
1489 service that has enabled
1490 connection draining, it can take up to 60 seconds after the connection
1491 draining duration has elapsed before the VM instance is removed or deleted.
1492
1493 You can specify a maximum of 1000 instances with this method per request.
1494
1495 Args:
1496 project: string, Project ID for this request. (required)
1497 region: string, Name of the region scoping this request. (required)
1498 instanceGroupManager: string, Name of the managed instance group. (required)
1499 body: object, The request body.
1500 The object takes the form of:
1501
1502 {
1503 &quot;instances&quot;: [ # The URLs of one or more instances to delete. This can be a full URL or
1504 # a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].
1505 &quot;A String&quot;,
1506 ],
1507 &quot;skipInstancesOnValidationError&quot;: True or False, # Specifies whether the request should proceed despite the inclusion of
1508 # instances that are not members of the group or that are already in the
1509 # process of being deleted or abandoned. If this field is set to `false` and
1510 # such an instance is specified in the request, the operation fails. The
1511 # operation always fails if the request contains a malformed instance URL or
1512 # a reference to an instance that exists in a zone or region other than the
1513 # group&#x27;s zone or region.
1514 }
1515
1516 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
1517 that if you must retry your request, the server will know to ignore the
1518 request if it has already been completed.
1519
1520 For example, consider a situation where you make an initial request and
1521 the request times out. If you make the request again with the same
1522 request ID, the server can check if original operation with the same
1523 request ID was received, and if so, will ignore the second request. This
1524 prevents clients from accidentally creating duplicate commitments.
1525
1526 The request ID must be
1527 a valid UUID with the exception that zero UUID is not supported
1528 (00000000-0000-0000-0000-000000000000).
1529 x__xgafv: string, V1 error format.
1530 Allowed values
1531 1 - v1 error format
1532 2 - v2 error format
1533
1534 Returns:
1535 An object of the form:
1536
1537 { # Represents an Operation resource.
1538 #
1539 # Google Compute Engine has three Operation resources:
1540 #
1541 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
1542 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
1543 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
1544 #
1545 # You can use an operation resource to manage asynchronous API requests.
1546 # For more information, readHandling
1547 # API responses.
1548 #
1549 # Operations can be global, regional or zonal.
1550 #
1551 # - For global operations, use the `globalOperations`
1552 # resource.
1553 # - For regional operations, use the
1554 # `regionOperations` resource.
1555 # - For zonal operations, use
1556 # the `zoneOperations` resource.
1557 #
1558 #
1559 #
1560 # For more information, read
1561 # Global, Regional, and Zonal Resources.
1562 #
1563 # Note that completed Operation resources have a limited
1564 # retention period.
1565 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
1566 # Not present otherwise.
1567 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1568 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
1569 # set when the operation is created.
1570 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
1571 # text format.
1572 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
1573 # this field will be populated.
1574 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
1575 # operation.
1576 {
1577 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1578 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
1579 # details. There is a set of defined message types to use for providing
1580 # details.The syntax depends on the error code. For example,
1581 # QuotaExceededInfo will have details when the error code is
1582 # QUOTA_EXCEEDED.
1583 {
1584 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
1585 #
1586 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
1587 # is not enabled:
1588 #
1589 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
1590 # &quot;domain&quot;: &quot;googleapis.com&quot;
1591 # &quot;metadata&quot;: {
1592 # &quot;resource&quot;: &quot;projects/123&quot;,
1593 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
1594 # }
1595 # }
1596 #
1597 # This response indicates that the pubsub.googleapis.com API is not enabled.
1598 #
1599 # Example of an error that is returned when attempting to create a Spanner
1600 # instance in a region that is out of stock:
1601 #
1602 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
1603 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
1604 # &quot;metadata&quot;: {
1605 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
1606 # }
1607 # }
1608 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
1609 # is typically the registered service name of the tool or product that
1610 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
1611 # generated by some common infrastructure, the error domain must be a
1612 # globally unique value that identifies the infrastructure. For Google API
1613 # infrastructure, the error domain is &quot;googleapis.com&quot;.
1614 &quot;metadatas&quot;: { # Additional structured details about this error.
1615 #
1616 # Keys must match a regular expression of `a-z+` but should
1617 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
1618 # length. When identifying the current value of an exceeded limit, the units
1619 # should be contained in the key, not the value. For example, rather than
1620 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1621 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1622 # instances that can be created in a single (batch) request.
1623 &quot;a_key&quot;: &quot;A String&quot;,
1624 },
1625 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1626 # proximate cause of the error. Error reasons are unique within a particular
1627 # domain of errors. This should be at most 63 characters and match a
1628 # regular expression of `A-Z+[A-Z0-9]`, which represents
1629 # UPPER_SNAKE_CASE.
1630 },
1631 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1632 #
1633 # For example, if a quota check failed with an error indicating the calling
1634 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1635 # directly to the right place in the developer console to flip the bit.
1636 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1637 { # Describes a URL link.
1638 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1639 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1640 },
1641 ],
1642 },
1643 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1644 # which can be attached to an RPC error.
1645 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1646 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1647 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1648 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1649 },
1650 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1651 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1652 &quot;a_key&quot;: &quot;A String&quot;,
1653 },
1654 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1655 # type or metric.
1656 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1657 # or metric.
1658 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1659 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1660 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1661 },
1662 },
1663 ],
1664 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1665 # This property is optional.
1666 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1667 },
1668 ],
1669 },
1670 &quot;getVersionOperationMetadata&quot;: {
1671 &quot;inlineSbomInfo&quot;: {
1672 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1673 # appropriate identifiers.
1674 &quot;a_key&quot;: &quot;A String&quot;,
1675 },
1676 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
1677 # identifiers.
1678 &quot;a_key&quot;: &quot;A String&quot;,
1679 },
1680 },
1681 },
1682 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1683 # message that was returned, such as `NOT FOUND`.
1684 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1685 # status code that was returned. For example, a `404` means the
1686 # resource was not found.
1687 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1688 # defined by the server.
1689 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1690 # This value is inRFC3339
1691 # text format.
1692 &quot;instancesBulkInsertOperationMetadata&quot;: {
1693 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1694 # Example key: zones/us-central1-a
1695 &quot;a_key&quot;: {
1696 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1697 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1698 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1699 # error.
1700 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1701 # if the flow is rolling forward or rolling back.
1702 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1703 },
1704 },
1705 },
1706 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1707 # Operation resources.
1708 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1709 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1710 # group of operations results from a `bulkInsert` API request.
1711 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1712 # `update`, or `delete`, and so on.
1713 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1714 # There is no requirement that this be linear or support any granularity of
1715 # operations. This should not be used to guess when the operation will be
1716 # complete. This number should monotonically increase as the operation
1717 # progresses.
1718 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1719 # applicable when performing regional operations.
1720 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1721 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1722 # this field will contain information on all underlying zonal actions and
1723 # their state.
1724 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1725 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1726 # Example key: zones/us-central1-a
1727 &quot;a_key&quot;: {
1728 &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
1729 # populated.
1730 # different programming environments, including REST APIs and RPC APIs. It is
1731 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1732 # three pieces of data: error code, error message, and error details.
1733 #
1734 # You can find out more about this error model and how to work with it in the
1735 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1736 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1737 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1738 # message types for APIs to use.
1739 {
1740 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1741 },
1742 ],
1743 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1744 # user-facing error message should be localized and sent in the
1745 # google.rpc.Status.details field, or localized by the client.
1746 },
1747 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1748 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1749 },
1750 },
1751 },
1752 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1753 # This value is inRFC3339
1754 # text format.
1755 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1756 # following:
1757 # `PENDING`, `RUNNING`, or `DONE`.
1758 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1759 # operation.
1760 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1761 # of the target resource.
1762 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1763 # operations related to creating a snapshot, this points to the disk
1764 # that the snapshot was created from.
1765 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1766 # `[email protected]` or
1767 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1768 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1769 # operation, this field will be populated.
1770 {
1771 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1772 # Engine returns NO_RESULTS_ON_PAGE if there
1773 # are no results in the response.
1774 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1775 # value format. For example:
1776 #
1777 # &quot;data&quot;: [
1778 # {
1779 # &quot;key&quot;: &quot;scope&quot;,
1780 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1781 # }
1782 {
1783 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1784 # returned. For example, for warnings where there are no results in a list
1785 # request for a particular zone, this key might be scope and
1786 # the key value might be the zone name. Other examples might be a key
1787 # indicating a deprecated resource and a suggested replacement, or a
1788 # warning about invalid network settings (for example, if an instance
1789 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1790 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1791 },
1792 ],
1793 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1794 },
1795 ],
1796 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1797 # applicable when performing per-zone operations.
1798 }</pre>
1799 </div>
1800
1801 <div class="method">
1802 <code class="details" id="deletePerInstanceConfigs">deletePerInstanceConfigs(project, region, instanceGroupManager, body=None, x__xgafv=None)</code>
1803 <pre>Deletes selected per-instance configurations for the managed instance
1804 group.
1805
1806 Args:
1807 project: string, Project ID for this request. (required)
1808 region: string, Name of the region scoping this request, should conform to RFC1035. (required)
1809 instanceGroupManager: string, The name of the managed instance group. It should conform to RFC1035. (required)
1810 body: object, The request body.
1811 The object takes the form of:
1812
1813 { # RegionInstanceGroupManagers.deletePerInstanceConfigs
1814 &quot;names&quot;: [ # The list of instance names for which we want to delete per-instance configs
1815 # on this managed instance group.
1816 &quot;A String&quot;,
1817 ],
1818 }
1819
1820 x__xgafv: string, V1 error format.
1821 Allowed values
1822 1 - v1 error format
1823 2 - v2 error format
1824
1825 Returns:
1826 An object of the form:
1827
1828 { # Represents an Operation resource.
1829 #
1830 # Google Compute Engine has three Operation resources:
1831 #
1832 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
1833 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
1834 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
1835 #
1836 # You can use an operation resource to manage asynchronous API requests.
1837 # For more information, readHandling
1838 # API responses.
1839 #
1840 # Operations can be global, regional or zonal.
1841 #
1842 # - For global operations, use the `globalOperations`
1843 # resource.
1844 # - For regional operations, use the
1845 # `regionOperations` resource.
1846 # - For zonal operations, use
1847 # the `zoneOperations` resource.
1848 #
1849 #
1850 #
1851 # For more information, read
1852 # Global, Regional, and Zonal Resources.
1853 #
1854 # Note that completed Operation resources have a limited
1855 # retention period.
1856 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
1857 # Not present otherwise.
1858 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1859 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
1860 # set when the operation is created.
1861 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
1862 # text format.
1863 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
1864 # this field will be populated.
1865 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
1866 # operation.
1867 {
1868 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1869 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
1870 # details. There is a set of defined message types to use for providing
1871 # details.The syntax depends on the error code. For example,
1872 # QuotaExceededInfo will have details when the error code is
1873 # QUOTA_EXCEEDED.
1874 {
1875 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
1876 #
1877 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
1878 # is not enabled:
1879 #
1880 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
1881 # &quot;domain&quot;: &quot;googleapis.com&quot;
1882 # &quot;metadata&quot;: {
1883 # &quot;resource&quot;: &quot;projects/123&quot;,
1884 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
1885 # }
1886 # }
1887 #
1888 # This response indicates that the pubsub.googleapis.com API is not enabled.
1889 #
1890 # Example of an error that is returned when attempting to create a Spanner
1891 # instance in a region that is out of stock:
1892 #
1893 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
1894 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
1895 # &quot;metadata&quot;: {
1896 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
1897 # }
1898 # }
1899 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
1900 # is typically the registered service name of the tool or product that
1901 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
1902 # generated by some common infrastructure, the error domain must be a
1903 # globally unique value that identifies the infrastructure. For Google API
1904 # infrastructure, the error domain is &quot;googleapis.com&quot;.
1905 &quot;metadatas&quot;: { # Additional structured details about this error.
1906 #
1907 # Keys must match a regular expression of `a-z+` but should
1908 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
1909 # length. When identifying the current value of an exceeded limit, the units
1910 # should be contained in the key, not the value. For example, rather than
1911 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1912 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1913 # instances that can be created in a single (batch) request.
1914 &quot;a_key&quot;: &quot;A String&quot;,
1915 },
1916 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1917 # proximate cause of the error. Error reasons are unique within a particular
1918 # domain of errors. This should be at most 63 characters and match a
1919 # regular expression of `A-Z+[A-Z0-9]`, which represents
1920 # UPPER_SNAKE_CASE.
1921 },
1922 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1923 #
1924 # For example, if a quota check failed with an error indicating the calling
1925 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1926 # directly to the right place in the developer console to flip the bit.
1927 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1928 { # Describes a URL link.
1929 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1930 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1931 },
1932 ],
1933 },
1934 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1935 # which can be attached to an RPC error.
1936 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1937 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1938 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1939 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1940 },
1941 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1942 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1943 &quot;a_key&quot;: &quot;A String&quot;,
1944 },
1945 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1946 # type or metric.
1947 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1948 # or metric.
1949 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1950 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1951 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1952 },
1953 },
1954 ],
1955 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1956 # This property is optional.
1957 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1958 },
1959 ],
1960 },
1961 &quot;getVersionOperationMetadata&quot;: {
1962 &quot;inlineSbomInfo&quot;: {
1963 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1964 # appropriate identifiers.
1965 &quot;a_key&quot;: &quot;A String&quot;,
1966 },
1967 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
1968 # identifiers.
1969 &quot;a_key&quot;: &quot;A String&quot;,
1970 },
1971 },
1972 },
1973 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1974 # message that was returned, such as `NOT FOUND`.
1975 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1976 # status code that was returned. For example, a `404` means the
1977 # resource was not found.
1978 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1979 # defined by the server.
1980 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1981 # This value is inRFC3339
1982 # text format.
1983 &quot;instancesBulkInsertOperationMetadata&quot;: {
1984 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1985 # Example key: zones/us-central1-a
1986 &quot;a_key&quot;: {
1987 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1988 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1989 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1990 # error.
1991 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1992 # if the flow is rolling forward or rolling back.
1993 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1994 },
1995 },
1996 },
1997 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1998 # Operation resources.
1999 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
2000 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
2001 # group of operations results from a `bulkInsert` API request.
2002 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
2003 # `update`, or `delete`, and so on.
2004 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
2005 # There is no requirement that this be linear or support any granularity of
2006 # operations. This should not be used to guess when the operation will be
2007 # complete. This number should monotonically increase as the operation
2008 # progresses.
2009 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
2010 # applicable when performing regional operations.
2011 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
2012 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
2013 # this field will contain information on all underlying zonal actions and
2014 # their state.
2015 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
2016 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
2017 # Example key: zones/us-central1-a
2018 &quot;a_key&quot;: {
2019 &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
2020 # populated.
2021 # different programming environments, including REST APIs and RPC APIs. It is
2022 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
2023 # three pieces of data: error code, error message, and error details.
2024 #
2025 # You can find out more about this error model and how to work with it in the
2026 # [API Design Guide](https://cloud.google.com/apis/design/errors).
2027 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
2028 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
2029 # message types for APIs to use.
2030 {
2031 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
2032 },
2033 ],
2034 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
2035 # user-facing error message should be localized and sent in the
2036 # google.rpc.Status.details field, or localized by the client.
2037 },
2038 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
2039 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
2040 },
2041 },
2042 },
2043 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
2044 # This value is inRFC3339
2045 # text format.
2046 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
2047 # following:
2048 # `PENDING`, `RUNNING`, or `DONE`.
2049 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
2050 # operation.
2051 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
2052 # of the target resource.
2053 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
2054 # operations related to creating a snapshot, this points to the disk
2055 # that the snapshot was created from.
2056 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
2057 # `[email protected]` or
2058 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
2059 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
2060 # operation, this field will be populated.
2061 {
2062 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2063 # Engine returns NO_RESULTS_ON_PAGE if there
2064 # are no results in the response.
2065 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2066 # value format. For example:
2067 #
2068 # &quot;data&quot;: [
2069 # {
2070 # &quot;key&quot;: &quot;scope&quot;,
2071 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2072 # }
2073 {
2074 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2075 # returned. For example, for warnings where there are no results in a list
2076 # request for a particular zone, this key might be scope and
2077 # the key value might be the zone name. Other examples might be a key
2078 # indicating a deprecated resource and a suggested replacement, or a
2079 # warning about invalid network settings (for example, if an instance
2080 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2081 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2082 },
2083 ],
2084 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2085 },
2086 ],
2087 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
2088 # applicable when performing per-zone operations.
2089 }</pre>
2090 </div>
2091
2092 <div class="method">
2093 <code class="details" id="get">get(project, region, instanceGroupManager, x__xgafv=None)</code>
2094 <pre>Returns all of the details about the specified managed instance group.
2095
2096 Args:
2097 project: string, Project ID for this request. (required)
2098 region: string, Name of the region scoping this request. (required)
2099 instanceGroupManager: string, Name of the managed instance group to return. (required)
2100 x__xgafv: string, V1 error format.
2101 Allowed values
2102 1 - v1 error format
2103 2 - v2 error format
2104
2105 Returns:
2106 An object of the form:
2107
2108 { # Represents a Managed Instance Group resource.
2109 #
2110 # An instance group is a collection of VM instances that you can manage as a
2111 # single entity. For more information, readInstance groups.
2112 #
2113 # For zonal Managed Instance Group, use the instanceGroupManagers
2114 # resource.
2115 #
2116 # For regional Managed Instance Group, use theregionInstanceGroupManagers resource.
2117 &quot;allInstancesConfig&quot;: { # Specifies configuration that overrides the instance template configuration
2118 # for the group.
2119 &quot;properties&quot;: { # Represents the change that you want to make to the instance properties. # Properties to set on all instances in the group.
2120 #
2121 # You can add or modify properties using theinstanceGroupManagers.patch orregionInstanceGroupManagers.patch. After settingallInstancesConfig on the group, you must update the group&#x27;s
2122 # instances to apply the configuration. To apply the configuration, set the
2123 # group&#x27;s updatePolicy.type field to use proactive updates or
2124 # use the applyUpdatesToInstances method.
2125 &quot;labels&quot;: { # The label key-value pairs that you want to patch onto the instance.
2126 &quot;a_key&quot;: &quot;A String&quot;,
2127 },
2128 &quot;metadata&quot;: { # The metadata key-value pairs that you want to patch onto the instance. For
2129 # more information, see Project and
2130 # instance metadata.
2131 &quot;a_key&quot;: &quot;A String&quot;,
2132 },
2133 },
2134 },
2135 &quot;autoHealingPolicies&quot;: [ # The autohealing policy for this managed instance group. You can specify
2136 # only one value.
2137 {
2138 &quot;healthCheck&quot;: &quot;A String&quot;, # The URL for the health check that signals autohealing.
2139 &quot;initialDelaySec&quot;: 42, # The initial delay is the number of seconds that a new VM takes to
2140 # initialize and run its startup script. During a VM&#x27;s initial delay
2141 # period, the MIG ignores unsuccessful health checks because the VM might
2142 # be in the startup process. This prevents the MIG from prematurely
2143 # recreating a VM. If the health check receives a healthy response during
2144 # the initial delay, it indicates that the startup process is complete and
2145 # the VM is ready. The value of initial delay must be between 0 and 3600
2146 # seconds. The default value is 0.
2147 },
2148 ],
2149 &quot;baseInstanceName&quot;: &quot;A String&quot;, # The base instance name is a prefix that you want to attach to the names of
2150 # all VMs in a MIG. The maximum character length is 58 and the name must
2151 # comply with RFC1035 format.
2152 #
2153 # When a VM is created in the group, the MIG appends a hyphen and a random
2154 # four-character string to the base instance name. If you want the MIG to
2155 # assign sequential numbers instead of a random string, then end the base
2156 # instance name with a hyphen followed by one or more hash symbols. The hash
2157 # symbols indicate the number of digits. For example, a base instance name of
2158 # &quot;vm-###&quot; results in &quot;vm-001&quot; as a VM name.
2159 # @pattern
2160 # [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,51}-#{1,10}(\\[[0-9]{1,10}\\])?))
2161 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. The creation timestamp for this managed instance group inRFC3339
2162 # text format.
2163 &quot;currentActions&quot;: { # Output only. The list of instance actions and the number of instances
2164 # in this managed instance group that are scheduled for each of those
2165 # actions.
2166 &quot;abandoning&quot;: 42, # Output only. The total number of instances in the managed instance group
2167 # that are scheduled to be abandoned. Abandoning an instance removes it
2168 # from the managed instance group without deleting it.
2169 &quot;creating&quot;: 42, # Output only. The number of instances in the managed instance group that
2170 # are scheduled to be created or are currently being created. If the group
2171 # fails to create any of these instances, it tries again until it creates
2172 # the instance successfully.
2173 #
2174 # If you have disabled creation retries, this field will not be populated;
2175 # instead, the creatingWithoutRetries field will be populated.
2176 &quot;creatingWithoutRetries&quot;: 42, # Output only. The number of instances that the managed instance group
2177 # will attempt to create. The group attempts to create each instance
2178 # only once. If the group fails to create any of these instances, it
2179 # decreases the group&#x27;s targetSize value accordingly.
2180 &quot;deleting&quot;: 42, # Output only. The number of instances in the managed instance group that
2181 # are scheduled to be deleted or are currently being deleted.
2182 &quot;none&quot;: 42, # Output only. The number of instances in the managed instance group that
2183 # are running and have no scheduled actions.
2184 &quot;recreating&quot;: 42, # Output only. The number of instances in the managed instance group that
2185 # are scheduled to be recreated or are currently being being recreated.
2186 # Recreating an instance deletes the existing root persistent disk
2187 # and creates a new disk from the image that is defined in the
2188 # instance template.
2189 &quot;refreshing&quot;: 42, # Output only. The number of instances in the managed instance group that
2190 # are being reconfigured with properties that do not require a restart
2191 # or a recreate action. For example, setting or removing target
2192 # pools for the instance.
2193 &quot;restarting&quot;: 42, # Output only. The number of instances in the managed instance group that
2194 # are scheduled to be restarted or are currently being restarted.
2195 &quot;resuming&quot;: 42, # Output only. The number of instances in the managed instance group that
2196 # are scheduled to be resumed or are currently being resumed.
2197 &quot;starting&quot;: 42, # Output only. The number of instances in the managed instance group that
2198 # are scheduled to be started or are currently being started.
2199 &quot;stopping&quot;: 42, # Output only. The number of instances in the managed instance group that
2200 # are scheduled to be stopped or are currently being stopped.
2201 &quot;suspending&quot;: 42, # Output only. The number of instances in the managed instance group that
2202 # are scheduled to be suspended or are currently being suspended.
2203 &quot;verifying&quot;: 42, # Output only. The number of instances in the managed instance group that
2204 # are being verified. See the managedInstances[].currentAction
2205 # property in the listManagedInstances method documentation.
2206 },
2207 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource.
2208 &quot;distributionPolicy&quot;: { # Policy specifying the intended distribution of managed instances across
2209 # zones in a regional managed instance group.
2210 &quot;targetShape&quot;: &quot;A String&quot;, # The distribution shape to which the group converges either proactively or
2211 # on resize events (depending on the value set inupdatePolicy.instanceRedistributionType).
2212 &quot;zones&quot;: [ # Zones where the regional managed instance group will create and manage
2213 # its instances.
2214 # By default, a regional MIG doesn&#x27;t automatically select an AI zone to create
2215 # instances, even if an AI zone is available in the specified region. To
2216 # create instances in an AI zone in the selected region, you must explicitly
2217 # specify it in the distribution policy together with the other preferred
2218 # zones.
2219 {
2220 &quot;zone&quot;: &quot;A String&quot;, # The URL of thezone.
2221 # The zone must exist in the region where the managed instance group is
2222 # located.
2223 },
2224 ],
2225 },
2226 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. This field may be used in optimistic locking.
2227 # It will be ignored when inserting an InstanceGroupManager. An up-to-date
2228 # fingerprint must be provided in order to update the InstanceGroupManager,
2229 # otherwise the request will fail with error412 conditionNotMet.
2230 #
2231 # To see the latest fingerprint, make a get() request to
2232 # retrieve an InstanceGroupManager.
2233 &quot;id&quot;: &quot;A String&quot;, # Output only. A unique identifier for this resource type. The server
2234 # generates this identifier.
2235 &quot;instanceFlexibilityPolicy&quot;: { # Instance flexibility allowing MIG to create VMs from multiple
2236 # types of machines.
2237 # Instance flexibility configuration on MIG overrides instance
2238 # template configuration.
2239 &quot;instanceSelections&quot;: { # Named instance selections configuring properties that the group will use
2240 # when creating new VMs.
2241 &quot;a_key&quot;: {
2242 &quot;machineTypes&quot;: [ # Full machine-type names, e.g. &quot;n1-standard-16&quot;.
2243 &quot;A String&quot;,
2244 ],
2245 &quot;rank&quot;: 42, # Preference of this instance selection. Lower number means higher
2246 # preference. MIG will first try to create a VM based on the machine-type
2247 # with lowest rank and fallback to next rank based on availability.
2248 # Machine types and instance selections with the same rank have the same
2249 # preference.
2250 },
2251 },
2252 },
2253 &quot;instanceGroup&quot;: &quot;A String&quot;, # Output only. The URL of the Instance Group resource.
2254 &quot;instanceLifecyclePolicy&quot;: { # The repair policy for this managed instance group.
2255 &quot;defaultActionOnFailure&quot;: &quot;A String&quot;, # The action that a MIG performs on a failed VM. If the value of the
2256 # onFailedHealthCheck field is `DEFAULT_ACTION`, then the same action also
2257 # applies to the VMs on which your application fails a health check.
2258 # Valid values are
2259 #
2260 # - REPAIR (default): MIG automatically repairs a failed VM
2261 # by recreating it. For more information, see About
2262 # repairing VMs in a MIG.
2263 # - DO_NOTHING: MIG does not repair a failed VM.
2264 &quot;forceUpdateOnRepair&quot;: &quot;A String&quot;, # A bit indicating whether to forcefully apply the group&#x27;s latest
2265 # configuration when repairing a VM. Valid options are:
2266 #
2267 #
2268 #
2269 # - NO (default): If configuration updates are available, they are not
2270 # forcefully applied during repair. Instead, configuration updates are
2271 # applied according to the group&#x27;s update policy.
2272 #
2273 # - YES: If configuration updates are available, they are applied
2274 # during repair.
2275 &quot;onFailedHealthCheck&quot;: &quot;A String&quot;, # The action that a MIG performs on an unhealthy VM. A VM is marked as
2276 # unhealthy when the application running on that VM fails a health check.
2277 # Valid values are:
2278 #
2279 # - DEFAULT_ACTION (default): MIG uses the same action
2280 # configured for instanceLifecyclePolicy.defaultActionOnFailure field.
2281 # - REPAIR: MIG automatically repairs an unhealthy VM by
2282 # recreating it.
2283 # - DO_NOTHING: MIG doesn&#x27;t repair an unhealthy VM.
2284 # For more information, see
2285 # About repairing VMs in a MIG.
2286 &quot;onRepair&quot;: { # Configuration for VM repairs in the MIG. # Configuration for VM repairs in the MIG.
2287 &quot;allowChangingZone&quot;: &quot;A String&quot;, # Specifies whether the MIG can change a VM&#x27;s zone during a repair.
2288 # Valid values are:
2289 #
2290 # - NO (default): MIG cannot change a VM&#x27;s zone during a
2291 # repair.
2292 # - YES: MIG can select a different zone for the VM during
2293 # a repair.
2294 },
2295 },
2296 &quot;instanceTemplate&quot;: &quot;A String&quot;, # The URL of the instance template that is specified for this managed
2297 # instance group. The group uses this template to create all new instances
2298 # in the managed instance group. The templates for existing instances in the
2299 # group do not change unless you run recreateInstances, runapplyUpdatesToInstances, or set the group&#x27;supdatePolicy.type to PROACTIVE.
2300 &quot;kind&quot;: &quot;compute#instanceGroupManager&quot;, # Output only. The resource type, which is alwayscompute#instanceGroupManager for managed instance groups.
2301 &quot;listManagedInstancesResults&quot;: &quot;A String&quot;, # Pagination behavior of the listManagedInstances API method for
2302 # this managed instance group.
2303 &quot;name&quot;: &quot;A String&quot;, # The name of the managed instance group. The name must be 1-63 characters
2304 # long, and comply withRFC1035.
2305 &quot;namedPorts&quot;: [ # [Output Only] Named ports configured on the Instance Groups complementary
2306 # to this Instance Group Manager.
2307 { # The named port. For example: &lt;&quot;http&quot;, 80&gt;.
2308 &quot;name&quot;: &quot;A String&quot;, # The name for this named port.
2309 # The name must be 1-63 characters long, and comply withRFC1035.
2310 &quot;port&quot;: 42, # The port number, which can be a value between 1 and 65535.
2311 },
2312 ],
2313 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL of theregion
2314 # where the managed instance group resides (for regional resources).
2315 &quot;resourcePolicies&quot;: { # Resource policies for this managed instance group.
2316 &quot;workloadPolicy&quot;: &quot;A String&quot;, # The URL of the workload policy that is specified for this managed
2317 # instance group.
2318 # It can be a full or partial URL. For example, the following are
2319 # all valid URLs to a workload policy:
2320 #
2321 #
2322 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/resourcePolicies/resourcePolicy
2323 # - projects/project/regions/region/resourcePolicies/resourcePolicy
2324 # - regions/region/resourcePolicies/resourcePolicy
2325 },
2326 &quot;satisfiesPzi&quot;: True or False, # Output only. Reserved for future use.
2327 &quot;satisfiesPzs&quot;: True or False, # Output only. Reserved for future use.
2328 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. The URL for this managed instance group. The server defines
2329 # this URL.
2330 &quot;standbyPolicy&quot;: { # Standby policy for stopped and suspended instances.
2331 &quot;initialDelaySec&quot;: 42, # Specifies the number of seconds that the MIG should wait to suspend or
2332 # stop a VM after that VM was created. The initial delay gives the
2333 # initialization script the time to prepare your VM for a quick scale out.
2334 # The value of initial delay must be between 0 and 3600 seconds. The
2335 # default value is 0.
2336 &quot;mode&quot;: &quot;A String&quot;, # Defines how a MIG resumes or starts VMs from a standby pool when the
2337 # group scales out. The default mode is `MANUAL`.
2338 },
2339 &quot;statefulPolicy&quot;: { # Stateful configuration for this Instanced Group Manager
2340 &quot;preservedState&quot;: { # Configuration of preserved resources.
2341 &quot;disks&quot;: { # Disks created on the instances that will be preserved on instance
2342 # delete, update, etc. This map is keyed with the device names of
2343 # the disks.
2344 &quot;a_key&quot;: {
2345 &quot;autoDelete&quot;: &quot;A String&quot;, # These stateful disks will never be deleted during autohealing,
2346 # update or VM instance recreate operations.
2347 # This flag is used to configure if the disk should be deleted after it
2348 # is no longer used by the group, e.g. when the given instance or
2349 # the whole group is deleted. Note: disks attached inREAD_ONLY mode cannot be auto-deleted.
2350 },
2351 },
2352 &quot;externalIPs&quot;: { # External network IPs assigned to the instances that will be preserved on
2353 # instance delete, update, etc. This map is keyed with the network
2354 # interface name.
2355 &quot;a_key&quot;: {
2356 &quot;autoDelete&quot;: &quot;A String&quot;, # These stateful IPs will never be released during autohealing,
2357 # update or VM instance recreate operations.
2358 # This flag is used to configure if the IP reservation should be deleted
2359 # after it is no longer used by the group, e.g. when the given instance
2360 # or the whole group is deleted.
2361 },
2362 },
2363 &quot;internalIPs&quot;: { # Internal network IPs assigned to the instances that will be preserved on
2364 # instance delete, update, etc. This map is keyed with the network
2365 # interface name.
2366 &quot;a_key&quot;: {
2367 &quot;autoDelete&quot;: &quot;A String&quot;, # These stateful IPs will never be released during autohealing,
2368 # update or VM instance recreate operations.
2369 # This flag is used to configure if the IP reservation should be deleted
2370 # after it is no longer used by the group, e.g. when the given instance
2371 # or the whole group is deleted.
2372 },
2373 },
2374 },
2375 },
2376 &quot;status&quot;: { # Output only. The status of this managed instance group.
2377 &quot;allInstancesConfig&quot;: { # Output only. Status of all-instances configuration on the group.
2378 &quot;currentRevision&quot;: &quot;A String&quot;, # Output only. Current all-instances configuration revision.
2379 # This value is in RFC3339 text format.
2380 &quot;effective&quot;: True or False, # Output only. A bit indicating whether this configuration has
2381 # been applied to all managed instances in the group.
2382 },
2383 &quot;appliedAcceleratorTopologies&quot;: [ # Output only. The accelerator topology applied to this MIG.
2384 # Currently only one accelerator topology is supported.
2385 {
2386 &quot;acceleratorTopology&quot;: &quot;A String&quot;, # Output only. Topology in the format of: &quot;16x16&quot;, &quot;4x4x4&quot;, etc.
2387 # The value is the same as configured in the WorkloadPolicy.
2388 &quot;state&quot;: &quot;A String&quot;, # Output only. The state of the accelerator topology.
2389 &quot;stateDetails&quot;: { # Output only. The result of the latest accelerator topology state
2390 # check.
2391 &quot;error&quot;: { # Output only. Encountered errors.
2392 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
2393 # operation.
2394 {
2395 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
2396 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
2397 # details. There is a set of defined message types to use for providing
2398 # details.The syntax depends on the error code. For example,
2399 # QuotaExceededInfo will have details when the error code is
2400 # QUOTA_EXCEEDED.
2401 {
2402 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
2403 #
2404 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
2405 # is not enabled:
2406 #
2407 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
2408 # &quot;domain&quot;: &quot;googleapis.com&quot;
2409 # &quot;metadata&quot;: {
2410 # &quot;resource&quot;: &quot;projects/123&quot;,
2411 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
2412 # }
2413 # }
2414 #
2415 # This response indicates that the pubsub.googleapis.com API is not enabled.
2416 #
2417 # Example of an error that is returned when attempting to create a Spanner
2418 # instance in a region that is out of stock:
2419 #
2420 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
2421 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
2422 # &quot;metadata&quot;: {
2423 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
2424 # }
2425 # }
2426 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
2427 # is typically the registered service name of the tool or product that
2428 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
2429 # generated by some common infrastructure, the error domain must be a
2430 # globally unique value that identifies the infrastructure. For Google API
2431 # infrastructure, the error domain is &quot;googleapis.com&quot;.
2432 &quot;metadatas&quot;: { # Additional structured details about this error.
2433 #
2434 # Keys must match a regular expression of `a-z+` but should
2435 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
2436 # length. When identifying the current value of an exceeded limit, the units
2437 # should be contained in the key, not the value. For example, rather than
2438 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
2439 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
2440 # instances that can be created in a single (batch) request.
2441 &quot;a_key&quot;: &quot;A String&quot;,
2442 },
2443 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
2444 # proximate cause of the error. Error reasons are unique within a particular
2445 # domain of errors. This should be at most 63 characters and match a
2446 # regular expression of `A-Z+[A-Z0-9]`, which represents
2447 # UPPER_SNAKE_CASE.
2448 },
2449 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
2450 #
2451 # For example, if a quota check failed with an error indicating the calling
2452 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
2453 # directly to the right place in the developer console to flip the bit.
2454 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
2455 { # Describes a URL link.
2456 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
2457 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
2458 },
2459 ],
2460 },
2461 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
2462 # which can be attached to an RPC error.
2463 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
2464 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
2465 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
2466 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
2467 },
2468 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
2469 &quot;dimensions&quot;: { # The map holding related quota dimensions.
2470 &quot;a_key&quot;: &quot;A String&quot;,
2471 },
2472 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
2473 # type or metric.
2474 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
2475 # or metric.
2476 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
2477 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
2478 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
2479 },
2480 },
2481 ],
2482 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
2483 # This property is optional.
2484 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
2485 },
2486 ],
2487 },
2488 &quot;timestamp&quot;: &quot;A String&quot;, # Output only. Timestamp is shown only if there is an error. The field
2489 # has // RFC3339 //
2490 # text format.
2491 },
2492 },
2493 ],
2494 &quot;autoscaler&quot;: &quot;A String&quot;, # Output only. The URL of theAutoscaler
2495 # that targets this instance group manager.
2496 &quot;bulkInstanceOperation&quot;: { # Bulk instance operation is the creation of VMs in a MIG when the # Output only. The status of bulk instance operation.
2497 # targetSizePolicy.mode is set to BULK.
2498 &quot;inProgress&quot;: True or False, # Output only. Informs whether bulk instance operation is in progress.
2499 &quot;lastProgressCheck&quot;: { # Output only. Information from the last progress check of bulk instance
2500 # operation.
2501 &quot;error&quot;: { # Output only. Errors encountered during bulk instance operation.
2502 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
2503 # operation.
2504 {
2505 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
2506 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
2507 # details. There is a set of defined message types to use for providing
2508 # details.The syntax depends on the error code. For example,
2509 # QuotaExceededInfo will have details when the error code is
2510 # QUOTA_EXCEEDED.
2511 {
2512 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
2513 #
2514 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
2515 # is not enabled:
2516 #
2517 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
2518 # &quot;domain&quot;: &quot;googleapis.com&quot;
2519 # &quot;metadata&quot;: {
2520 # &quot;resource&quot;: &quot;projects/123&quot;,
2521 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
2522 # }
2523 # }
2524 #
2525 # This response indicates that the pubsub.googleapis.com API is not enabled.
2526 #
2527 # Example of an error that is returned when attempting to create a Spanner
2528 # instance in a region that is out of stock:
2529 #
2530 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
2531 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
2532 # &quot;metadata&quot;: {
2533 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
2534 # }
2535 # }
2536 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
2537 # is typically the registered service name of the tool or product that
2538 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
2539 # generated by some common infrastructure, the error domain must be a
2540 # globally unique value that identifies the infrastructure. For Google API
2541 # infrastructure, the error domain is &quot;googleapis.com&quot;.
2542 &quot;metadatas&quot;: { # Additional structured details about this error.
2543 #
2544 # Keys must match a regular expression of `a-z+` but should
2545 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
2546 # length. When identifying the current value of an exceeded limit, the units
2547 # should be contained in the key, not the value. For example, rather than
2548 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
2549 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
2550 # instances that can be created in a single (batch) request.
2551 &quot;a_key&quot;: &quot;A String&quot;,
2552 },
2553 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
2554 # proximate cause of the error. Error reasons are unique within a particular
2555 # domain of errors. This should be at most 63 characters and match a
2556 # regular expression of `A-Z+[A-Z0-9]`, which represents
2557 # UPPER_SNAKE_CASE.
2558 },
2559 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
2560 #
2561 # For example, if a quota check failed with an error indicating the calling
2562 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
2563 # directly to the right place in the developer console to flip the bit.
2564 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
2565 { # Describes a URL link.
2566 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
2567 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
2568 },
2569 ],
2570 },
2571 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
2572 # which can be attached to an RPC error.
2573 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
2574 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
2575 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
2576 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
2577 },
2578 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
2579 &quot;dimensions&quot;: { # The map holding related quota dimensions.
2580 &quot;a_key&quot;: &quot;A String&quot;,
2581 },
2582 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
2583 # type or metric.
2584 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
2585 # or metric.
2586 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
2587 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
2588 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
2589 },
2590 },
2591 ],
2592 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
2593 # This property is optional.
2594 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
2595 },
2596 ],
2597 },
2598 &quot;timestamp&quot;: &quot;A String&quot;, # Output only. Timestamp of the last progress check of bulk instance
2599 # operation. Timestamp is in RFC3339 text format.
2600 },
2601 },
2602 &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
2603 # in this managed instance group that have the status. Currently only shown
2604 # for TPU MIGs
2605 # instance group that have the status. For more information about how to
2606 # interpret each status check the instance lifecycle documentation.
2607 # Currently only shown for TPU MIGs.
2608 &quot;deprovisioning&quot;: 42, # Output only. The number of instances in the managed instance group
2609 # that have DEPROVISIONING status.
2610 &quot;nonExistent&quot;: 42, # Output only. The number of instances that have not been created yet or
2611 # have been deleted. Includes only instances that would be shown in the
2612 # listManagedInstances method and not all instances that have been
2613 # deleted in the lifetime of the MIG.
2614 # Does not include FlexStart instances that are waiting for the resources
2615 # availability, they are considered as &#x27;pending&#x27;.
2616 &quot;pending&quot;: 42, # Output only. The number of instances in the managed instance group
2617 # that have PENDING status, that is FlexStart instances that are waiting
2618 # for resources. Instances that do not exist because of the other reasons
2619 # are counted as &#x27;non_existent&#x27;.
2620 &quot;pendingStop&quot;: 42, # Output only. The number of instances in the managed instance group
2621 # that have PENDING_STOP status.
2622 &quot;provisioning&quot;: 42, # Output only. The number of instances in the managed instance group
2623 # that have PROVISIONING status.
2624 &quot;repairing&quot;: 42, # Output only. The number of instances in the managed instance group
2625 # that have REPAIRING status.
2626 &quot;running&quot;: 42, # Output only. The number of instances in the managed instance group
2627 # that have RUNNING status.
2628 &quot;staging&quot;: 42, # Output only. The number of instances in the managed instance group
2629 # that have STAGING status.
2630 &quot;stopped&quot;: 42, # Output only. The number of instances in the managed instance group
2631 # that have STOPPED status.
2632 &quot;stopping&quot;: 42, # Output only. The number of instances in the managed instance group
2633 # that have STOPPING status.
2634 &quot;suspended&quot;: 42, # Output only. The number of instances in the managed instance group
2635 # that have SUSPENDED status.
2636 &quot;suspending&quot;: 42, # Output only. The number of instances in the managed instance group
2637 # that have SUSPENDING status.
2638 &quot;terminated&quot;: 42, # Output only. The number of instances in the managed instance group
2639 # that have TERMINATED status.
2640 },
2641 &quot;isStable&quot;: True or False, # Output only. A bit indicating whether the managed instance group is in a
2642 # stable state. A stable state means that: none of the instances in the
2643 # managed instance group is currently undergoing any type of change (for
2644 # example, creation, restart, or deletion); no future changes are scheduled
2645 # for instances in the managed instance group; and the managed instance
2646 # group itself is not being modified.
2647 &quot;stateful&quot;: { # Output only. Stateful status of the given Instance Group Manager.
2648 &quot;hasStatefulConfig&quot;: True or False, # Output only. A bit indicating whether the managed instance group
2649 # has stateful configuration, that is, if you have configured any items
2650 # in a stateful policy or in per-instance configs.
2651 # The group might report that it has no stateful configuration even when
2652 # there is still some preserved state on a managed instance, for example,
2653 # if you have deleted all PICs but not yet applied those deletions.
2654 &quot;perInstanceConfigs&quot;: { # Output only. Status of per-instance configurations on the instances.
2655 &quot;allEffective&quot;: True or False, # Output only. A bit indicating if all of the group&#x27;s per-instance configurations
2656 # (listed in the output of a listPerInstanceConfigs API call) have
2657 # status EFFECTIVE or there are no per-instance-configs.
2658 },
2659 },
2660 &quot;versionTarget&quot;: { # Output only. A status of consistency of Instances&#x27; versions with their
2661 # target version specified by version field on Instance Group
2662 # Manager.
2663 &quot;isReached&quot;: True or False, # Output only. A bit indicating whether version target has been reached
2664 # in this managed instance group, i.e. all instances are in their target
2665 # version. Instances&#x27; target version are specified byversion field on Instance Group Manager.
2666 },
2667 },
2668 &quot;targetPools&quot;: [ # The URLs for all TargetPool resources to which instances in theinstanceGroup field are added. The target pools automatically
2669 # apply to all of the instances in the managed instance group.
2670 &quot;A String&quot;,
2671 ],
2672 &quot;targetSize&quot;: 42, # The target number of running instances for this managed instance group.
2673 # You can reduce this number by using the instanceGroupManager
2674 # deleteInstances or abandonInstances methods. Resizing the group also
2675 # changes this number.
2676 &quot;targetSizePolicy&quot;: { # The policy that specifies how the MIG creates its VMs to achieve the target
2677 # size.
2678 &quot;mode&quot;: &quot;A String&quot;, # The mode of target size policy based on which the MIG creates its VMs
2679 # individually or all at once.
2680 },
2681 &quot;targetStoppedSize&quot;: 42, # The target number of stopped instances for this managed instance group.
2682 # This number changes when you:
2683 #
2684 # - Stop instance using the stopInstances
2685 # method or start instances using the startInstances
2686 # method.
2687 # - Manually change the targetStoppedSize using the update
2688 # method.
2689 &quot;targetSuspendedSize&quot;: 42, # The target number of suspended instances for this managed instance group.
2690 # This number changes when you:
2691 #
2692 # - Suspend instance using the suspendInstances
2693 # method or resume instances using the resumeInstances
2694 # method.
2695 # - Manually change the targetSuspendedSize using the update
2696 # method.
2697 &quot;updatePolicy&quot;: { # The update policy for this managed instance group.
2698 &quot;instanceRedistributionType&quot;: &quot;A String&quot;, # The
2699 # instance redistribution policy for regional managed instance groups.
2700 # Valid values are:
2701 #
2702 # - PROACTIVE (default): The group attempts to maintain an
2703 # even distribution of VM instances across zones in the region.
2704 # - NONE: For non-autoscaled groups, proactive
2705 # redistribution is disabled.
2706 &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
2707 # either a fixed number or, if the group has 10 or more instances, a
2708 # percentage. If you set a percentage, the number of instances is rounded
2709 # if necessary. The default value for maxSurge is a fixed
2710 # value equal to the number of zones in which the managed instance group
2711 # operates.
2712 #
2713 # At least one of either maxSurge ormaxUnavailable must be greater than 0. Learn more about maxSurge.
2714 &quot;calculated&quot;: 42, # Output only. Absolute value of VM instances calculated based on the specific mode.
2715 #
2716 #
2717 #
2718 # - If the value is fixed, then the calculated
2719 # value is equal to the fixed value.
2720 # - If the value is a percent, then the
2721 # calculated
2722 # value is percent/100 * targetSize. For example,
2723 # the calculated value of a 80% of a managed instance group
2724 # with 150 instances would be (80/100 * 150) = 120 VM instances. If there
2725 # is a remainder, the number is rounded.
2726 &quot;fixed&quot;: 42, # Specifies a fixed number of VM instances. This must be a positive integer.
2727 &quot;percent&quot;: 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For
2728 # example, specify 80 for 80%.
2729 },
2730 &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
2731 # process. An instance is considered available if all of the following
2732 # conditions are satisfied:
2733 #
2734 #
2735 #
2736 # - The instance&#x27;s status is
2737 # RUNNING.
2738 # - If there is a health
2739 # check on the instance group, the instance&#x27;s health check status
2740 # must be HEALTHY at least once. If there is no health check
2741 # on the group, then the instance only needs to have a status of
2742 # RUNNING to be considered available.
2743 #
2744 #
2745 # This value can be either a fixed number or, if the group has 10 or more
2746 # instances, a percentage. If you set a percentage, the number of instances
2747 # is rounded if necessary. The default value formaxUnavailable is a fixed value equal to the number of zones
2748 # in which the managed instance group operates.
2749 #
2750 # At least one of either maxSurge ormaxUnavailable must be greater than 0. Learn more about maxUnavailable.
2751 &quot;calculated&quot;: 42, # Output only. Absolute value of VM instances calculated based on the specific mode.
2752 #
2753 #
2754 #
2755 # - If the value is fixed, then the calculated
2756 # value is equal to the fixed value.
2757 # - If the value is a percent, then the
2758 # calculated
2759 # value is percent/100 * targetSize. For example,
2760 # the calculated value of a 80% of a managed instance group
2761 # with 150 instances would be (80/100 * 150) = 120 VM instances. If there
2762 # is a remainder, the number is rounded.
2763 &quot;fixed&quot;: 42, # Specifies a fixed number of VM instances. This must be a positive integer.
2764 &quot;percent&quot;: 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For
2765 # example, specify 80 for 80%.
2766 },
2767 &quot;minimalAction&quot;: &quot;A String&quot;, # Minimal action to be taken on an instance. Use this option to minimize
2768 # disruption as much as possible or to apply a more disruptive action than
2769 # is necessary.
2770 #
2771 # - To limit disruption as much as possible, set the minimal action toREFRESH. If your update requires a more disruptive action,
2772 # Compute Engine performs the necessary action to execute the update.
2773 # - To apply a more disruptive action than is strictly necessary, set the
2774 # minimal action to RESTART or REPLACE. For
2775 # example, Compute Engine does not need to restart a VM to change its
2776 # metadata. But if your application reads instance metadata only when a VM
2777 # is restarted, you can set the minimal action to RESTART in
2778 # order to pick up metadata changes.
2779 &quot;mostDisruptiveAllowedAction&quot;: &quot;A String&quot;, # Most disruptive action that is allowed to be taken on an instance.
2780 # You can specify either NONE to forbid any actions,REFRESH to avoid restarting the VM and to limit disruption
2781 # as much as possible. RESTART to allow actions that can be
2782 # applied without instance replacing or REPLACE to allow all
2783 # possible actions. If the Updater determines that the minimal update
2784 # action needed is more disruptive than most disruptive allowed action you
2785 # specify it will not perform the update at all.
2786 &quot;replacementMethod&quot;: &quot;A String&quot;, # What action should be used to replace instances.
2787 # See minimal_action.REPLACE
2788 &quot;type&quot;: &quot;A String&quot;, # The type
2789 # of update process. You can specify either PROACTIVE so
2790 # that the MIG automatically updates VMs to the latest configurations orOPPORTUNISTIC so that you can select the VMs that you want
2791 # to update.
2792 },
2793 &quot;versions&quot;: [ # Specifies the instance templates used by this managed instance group to
2794 # create instances.
2795 #
2796 # Each version is defined by an instanceTemplate and aname. Every version can appear at most once per instance
2797 # group. This field overrides the top-level instanceTemplate
2798 # field. Read more about therelationships
2799 # between these fields. Exactly one version must leave thetargetSize field unset. That version will be applied to all
2800 # remaining instances. For more information, read aboutcanary
2801 # updates.
2802 {
2803 &quot;instanceTemplate&quot;: &quot;A String&quot;, # The URL of the instance template that is specified for this managed
2804 # instance group. The group uses this template to create new instances in
2805 # the managed instance group until the `targetSize` for this version is
2806 # reached. The templates for existing instances in the group do not change
2807 # unless you run recreateInstances, runapplyUpdatesToInstances, or set the group&#x27;supdatePolicy.type to PROACTIVE; in those cases,
2808 # existing instances are updated until the `targetSize` for this version is
2809 # reached.
2810 &quot;name&quot;: &quot;A String&quot;, # Name of the version. Unique among all versions in the scope of this
2811 # managed instance group.
2812 &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
2813 # from the template will be equal to:
2814 #
2815 #
2816 # - If expressed as a fixed number, the minimum of either
2817 # targetSize.fixed or
2818 # instanceGroupManager.targetSize is used.
2819 # - if expressed as a percent, the targetSize
2820 # would be (targetSize.percent/100 *
2821 # InstanceGroupManager.targetSize) If there is a remainder, the
2822 # number is rounded.
2823 #
2824 # If unset, this version will update any remaining instances not
2825 # updated by another version. ReadStarting
2826 # a canary update for more information.
2827 &quot;calculated&quot;: 42, # Output only. Absolute value of VM instances calculated based on the specific mode.
2828 #
2829 #
2830 #
2831 # - If the value is fixed, then the calculated
2832 # value is equal to the fixed value.
2833 # - If the value is a percent, then the
2834 # calculated
2835 # value is percent/100 * targetSize. For example,
2836 # the calculated value of a 80% of a managed instance group
2837 # with 150 instances would be (80/100 * 150) = 120 VM instances. If there
2838 # is a remainder, the number is rounded.
2839 &quot;fixed&quot;: 42, # Specifies a fixed number of VM instances. This must be a positive integer.
2840 &quot;percent&quot;: 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For
2841 # example, specify 80 for 80%.
2842 },
2843 },
2844 ],
2845 &quot;zone&quot;: &quot;A String&quot;, # Output only. The URL of azone
2846 # where the managed instance group is located (for zonal resources).
2847 }</pre>
2848 </div>
2849
2850 <div class="method">
2851 <code class="details" id="insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</code>
2852 <pre>Creates a managed instance group using the information that you specify
2853 in the request. After the group is created, instances in the group are
2854 created using the specified instance template.
2855 This operation is marked as DONE when the group is created
2856 even if the instances in the group have not yet been created. You must
2857 separately verify the status of the individual instances with thelistmanagedinstances
2858 method.
2859
2860 A regional managed instance group can contain up to 2000 instances.
2861
2862 Args:
2863 project: string, Project ID for this request. (required)
2864 region: string, Name of the region scoping this request. (required)
2865 body: object, The request body.
2866 The object takes the form of:
2867
2868 { # Represents a Managed Instance Group resource.
2869 #
2870 # An instance group is a collection of VM instances that you can manage as a
2871 # single entity. For more information, readInstance groups.
2872 #
2873 # For zonal Managed Instance Group, use the instanceGroupManagers
2874 # resource.
2875 #
2876 # For regional Managed Instance Group, use theregionInstanceGroupManagers resource.
2877 &quot;allInstancesConfig&quot;: { # Specifies configuration that overrides the instance template configuration
2878 # for the group.
2879 &quot;properties&quot;: { # Represents the change that you want to make to the instance properties. # Properties to set on all instances in the group.
2880 #
2881 # You can add or modify properties using theinstanceGroupManagers.patch orregionInstanceGroupManagers.patch. After settingallInstancesConfig on the group, you must update the group&#x27;s
2882 # instances to apply the configuration. To apply the configuration, set the
2883 # group&#x27;s updatePolicy.type field to use proactive updates or
2884 # use the applyUpdatesToInstances method.
2885 &quot;labels&quot;: { # The label key-value pairs that you want to patch onto the instance.
2886 &quot;a_key&quot;: &quot;A String&quot;,
2887 },
2888 &quot;metadata&quot;: { # The metadata key-value pairs that you want to patch onto the instance. For
2889 # more information, see Project and
2890 # instance metadata.
2891 &quot;a_key&quot;: &quot;A String&quot;,
2892 },
2893 },
2894 },
2895 &quot;autoHealingPolicies&quot;: [ # The autohealing policy for this managed instance group. You can specify
2896 # only one value.
2897 {
2898 &quot;healthCheck&quot;: &quot;A String&quot;, # The URL for the health check that signals autohealing.
2899 &quot;initialDelaySec&quot;: 42, # The initial delay is the number of seconds that a new VM takes to
2900 # initialize and run its startup script. During a VM&#x27;s initial delay
2901 # period, the MIG ignores unsuccessful health checks because the VM might
2902 # be in the startup process. This prevents the MIG from prematurely
2903 # recreating a VM. If the health check receives a healthy response during
2904 # the initial delay, it indicates that the startup process is complete and
2905 # the VM is ready. The value of initial delay must be between 0 and 3600
2906 # seconds. The default value is 0.
2907 },
2908 ],
2909 &quot;baseInstanceName&quot;: &quot;A String&quot;, # The base instance name is a prefix that you want to attach to the names of
2910 # all VMs in a MIG. The maximum character length is 58 and the name must
2911 # comply with RFC1035 format.
2912 #
2913 # When a VM is created in the group, the MIG appends a hyphen and a random
2914 # four-character string to the base instance name. If you want the MIG to
2915 # assign sequential numbers instead of a random string, then end the base
2916 # instance name with a hyphen followed by one or more hash symbols. The hash
2917 # symbols indicate the number of digits. For example, a base instance name of
2918 # &quot;vm-###&quot; results in &quot;vm-001&quot; as a VM name.
2919 # @pattern
2920 # [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,51}-#{1,10}(\\[[0-9]{1,10}\\])?))
2921 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. The creation timestamp for this managed instance group inRFC3339
2922 # text format.
2923 &quot;currentActions&quot;: { # Output only. The list of instance actions and the number of instances
2924 # in this managed instance group that are scheduled for each of those
2925 # actions.
2926 &quot;abandoning&quot;: 42, # Output only. The total number of instances in the managed instance group
2927 # that are scheduled to be abandoned. Abandoning an instance removes it
2928 # from the managed instance group without deleting it.
2929 &quot;creating&quot;: 42, # Output only. The number of instances in the managed instance group that
2930 # are scheduled to be created or are currently being created. If the group
2931 # fails to create any of these instances, it tries again until it creates
2932 # the instance successfully.
2933 #
2934 # If you have disabled creation retries, this field will not be populated;
2935 # instead, the creatingWithoutRetries field will be populated.
2936 &quot;creatingWithoutRetries&quot;: 42, # Output only. The number of instances that the managed instance group
2937 # will attempt to create. The group attempts to create each instance
2938 # only once. If the group fails to create any of these instances, it
2939 # decreases the group&#x27;s targetSize value accordingly.
2940 &quot;deleting&quot;: 42, # Output only. The number of instances in the managed instance group that
2941 # are scheduled to be deleted or are currently being deleted.
2942 &quot;none&quot;: 42, # Output only. The number of instances in the managed instance group that
2943 # are running and have no scheduled actions.
2944 &quot;recreating&quot;: 42, # Output only. The number of instances in the managed instance group that
2945 # are scheduled to be recreated or are currently being being recreated.
2946 # Recreating an instance deletes the existing root persistent disk
2947 # and creates a new disk from the image that is defined in the
2948 # instance template.
2949 &quot;refreshing&quot;: 42, # Output only. The number of instances in the managed instance group that
2950 # are being reconfigured with properties that do not require a restart
2951 # or a recreate action. For example, setting or removing target
2952 # pools for the instance.
2953 &quot;restarting&quot;: 42, # Output only. The number of instances in the managed instance group that
2954 # are scheduled to be restarted or are currently being restarted.
2955 &quot;resuming&quot;: 42, # Output only. The number of instances in the managed instance group that
2956 # are scheduled to be resumed or are currently being resumed.
2957 &quot;starting&quot;: 42, # Output only. The number of instances in the managed instance group that
2958 # are scheduled to be started or are currently being started.
2959 &quot;stopping&quot;: 42, # Output only. The number of instances in the managed instance group that
2960 # are scheduled to be stopped or are currently being stopped.
2961 &quot;suspending&quot;: 42, # Output only. The number of instances in the managed instance group that
2962 # are scheduled to be suspended or are currently being suspended.
2963 &quot;verifying&quot;: 42, # Output only. The number of instances in the managed instance group that
2964 # are being verified. See the managedInstances[].currentAction
2965 # property in the listManagedInstances method documentation.
2966 },
2967 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource.
2968 &quot;distributionPolicy&quot;: { # Policy specifying the intended distribution of managed instances across
2969 # zones in a regional managed instance group.
2970 &quot;targetShape&quot;: &quot;A String&quot;, # The distribution shape to which the group converges either proactively or
2971 # on resize events (depending on the value set inupdatePolicy.instanceRedistributionType).
2972 &quot;zones&quot;: [ # Zones where the regional managed instance group will create and manage
2973 # its instances.
2974 # By default, a regional MIG doesn&#x27;t automatically select an AI zone to create
2975 # instances, even if an AI zone is available in the specified region. To
2976 # create instances in an AI zone in the selected region, you must explicitly
2977 # specify it in the distribution policy together with the other preferred
2978 # zones.
2979 {
2980 &quot;zone&quot;: &quot;A String&quot;, # The URL of thezone.
2981 # The zone must exist in the region where the managed instance group is
2982 # located.
2983 },
2984 ],
2985 },
2986 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. This field may be used in optimistic locking.
2987 # It will be ignored when inserting an InstanceGroupManager. An up-to-date
2988 # fingerprint must be provided in order to update the InstanceGroupManager,
2989 # otherwise the request will fail with error412 conditionNotMet.
2990 #
2991 # To see the latest fingerprint, make a get() request to
2992 # retrieve an InstanceGroupManager.
2993 &quot;id&quot;: &quot;A String&quot;, # Output only. A unique identifier for this resource type. The server
2994 # generates this identifier.
2995 &quot;instanceFlexibilityPolicy&quot;: { # Instance flexibility allowing MIG to create VMs from multiple
2996 # types of machines.
2997 # Instance flexibility configuration on MIG overrides instance
2998 # template configuration.
2999 &quot;instanceSelections&quot;: { # Named instance selections configuring properties that the group will use
3000 # when creating new VMs.
3001 &quot;a_key&quot;: {
3002 &quot;machineTypes&quot;: [ # Full machine-type names, e.g. &quot;n1-standard-16&quot;.
3003 &quot;A String&quot;,
3004 ],
3005 &quot;rank&quot;: 42, # Preference of this instance selection. Lower number means higher
3006 # preference. MIG will first try to create a VM based on the machine-type
3007 # with lowest rank and fallback to next rank based on availability.
3008 # Machine types and instance selections with the same rank have the same
3009 # preference.
3010 },
3011 },
3012 },
3013 &quot;instanceGroup&quot;: &quot;A String&quot;, # Output only. The URL of the Instance Group resource.
3014 &quot;instanceLifecyclePolicy&quot;: { # The repair policy for this managed instance group.
3015 &quot;defaultActionOnFailure&quot;: &quot;A String&quot;, # The action that a MIG performs on a failed VM. If the value of the
3016 # onFailedHealthCheck field is `DEFAULT_ACTION`, then the same action also
3017 # applies to the VMs on which your application fails a health check.
3018 # Valid values are
3019 #
3020 # - REPAIR (default): MIG automatically repairs a failed VM
3021 # by recreating it. For more information, see About
3022 # repairing VMs in a MIG.
3023 # - DO_NOTHING: MIG does not repair a failed VM.
3024 &quot;forceUpdateOnRepair&quot;: &quot;A String&quot;, # A bit indicating whether to forcefully apply the group&#x27;s latest
3025 # configuration when repairing a VM. Valid options are:
3026 #
3027 #
3028 #
3029 # - NO (default): If configuration updates are available, they are not
3030 # forcefully applied during repair. Instead, configuration updates are
3031 # applied according to the group&#x27;s update policy.
3032 #
3033 # - YES: If configuration updates are available, they are applied
3034 # during repair.
3035 &quot;onFailedHealthCheck&quot;: &quot;A String&quot;, # The action that a MIG performs on an unhealthy VM. A VM is marked as
3036 # unhealthy when the application running on that VM fails a health check.
3037 # Valid values are:
3038 #
3039 # - DEFAULT_ACTION (default): MIG uses the same action
3040 # configured for instanceLifecyclePolicy.defaultActionOnFailure field.
3041 # - REPAIR: MIG automatically repairs an unhealthy VM by
3042 # recreating it.
3043 # - DO_NOTHING: MIG doesn&#x27;t repair an unhealthy VM.
3044 # For more information, see
3045 # About repairing VMs in a MIG.
3046 &quot;onRepair&quot;: { # Configuration for VM repairs in the MIG. # Configuration for VM repairs in the MIG.
3047 &quot;allowChangingZone&quot;: &quot;A String&quot;, # Specifies whether the MIG can change a VM&#x27;s zone during a repair.
3048 # Valid values are:
3049 #
3050 # - NO (default): MIG cannot change a VM&#x27;s zone during a
3051 # repair.
3052 # - YES: MIG can select a different zone for the VM during
3053 # a repair.
3054 },
3055 },
3056 &quot;instanceTemplate&quot;: &quot;A String&quot;, # The URL of the instance template that is specified for this managed
3057 # instance group. The group uses this template to create all new instances
3058 # in the managed instance group. The templates for existing instances in the
3059 # group do not change unless you run recreateInstances, runapplyUpdatesToInstances, or set the group&#x27;supdatePolicy.type to PROACTIVE.
3060 &quot;kind&quot;: &quot;compute#instanceGroupManager&quot;, # Output only. The resource type, which is alwayscompute#instanceGroupManager for managed instance groups.
3061 &quot;listManagedInstancesResults&quot;: &quot;A String&quot;, # Pagination behavior of the listManagedInstances API method for
3062 # this managed instance group.
3063 &quot;name&quot;: &quot;A String&quot;, # The name of the managed instance group. The name must be 1-63 characters
3064 # long, and comply withRFC1035.
3065 &quot;namedPorts&quot;: [ # [Output Only] Named ports configured on the Instance Groups complementary
3066 # to this Instance Group Manager.
3067 { # The named port. For example: &lt;&quot;http&quot;, 80&gt;.
3068 &quot;name&quot;: &quot;A String&quot;, # The name for this named port.
3069 # The name must be 1-63 characters long, and comply withRFC1035.
3070 &quot;port&quot;: 42, # The port number, which can be a value between 1 and 65535.
3071 },
3072 ],
3073 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL of theregion
3074 # where the managed instance group resides (for regional resources).
3075 &quot;resourcePolicies&quot;: { # Resource policies for this managed instance group.
3076 &quot;workloadPolicy&quot;: &quot;A String&quot;, # The URL of the workload policy that is specified for this managed
3077 # instance group.
3078 # It can be a full or partial URL. For example, the following are
3079 # all valid URLs to a workload policy:
3080 #
3081 #
3082 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/resourcePolicies/resourcePolicy
3083 # - projects/project/regions/region/resourcePolicies/resourcePolicy
3084 # - regions/region/resourcePolicies/resourcePolicy
3085 },
3086 &quot;satisfiesPzi&quot;: True or False, # Output only. Reserved for future use.
3087 &quot;satisfiesPzs&quot;: True or False, # Output only. Reserved for future use.
3088 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. The URL for this managed instance group. The server defines
3089 # this URL.
3090 &quot;standbyPolicy&quot;: { # Standby policy for stopped and suspended instances.
3091 &quot;initialDelaySec&quot;: 42, # Specifies the number of seconds that the MIG should wait to suspend or
3092 # stop a VM after that VM was created. The initial delay gives the
3093 # initialization script the time to prepare your VM for a quick scale out.
3094 # The value of initial delay must be between 0 and 3600 seconds. The
3095 # default value is 0.
3096 &quot;mode&quot;: &quot;A String&quot;, # Defines how a MIG resumes or starts VMs from a standby pool when the
3097 # group scales out. The default mode is `MANUAL`.
3098 },
3099 &quot;statefulPolicy&quot;: { # Stateful configuration for this Instanced Group Manager
3100 &quot;preservedState&quot;: { # Configuration of preserved resources.
3101 &quot;disks&quot;: { # Disks created on the instances that will be preserved on instance
3102 # delete, update, etc. This map is keyed with the device names of
3103 # the disks.
3104 &quot;a_key&quot;: {
3105 &quot;autoDelete&quot;: &quot;A String&quot;, # These stateful disks will never be deleted during autohealing,
3106 # update or VM instance recreate operations.
3107 # This flag is used to configure if the disk should be deleted after it
3108 # is no longer used by the group, e.g. when the given instance or
3109 # the whole group is deleted. Note: disks attached inREAD_ONLY mode cannot be auto-deleted.
3110 },
3111 },
3112 &quot;externalIPs&quot;: { # External network IPs assigned to the instances that will be preserved on
3113 # instance delete, update, etc. This map is keyed with the network
3114 # interface name.
3115 &quot;a_key&quot;: {
3116 &quot;autoDelete&quot;: &quot;A String&quot;, # These stateful IPs will never be released during autohealing,
3117 # update or VM instance recreate operations.
3118 # This flag is used to configure if the IP reservation should be deleted
3119 # after it is no longer used by the group, e.g. when the given instance
3120 # or the whole group is deleted.
3121 },
3122 },
3123 &quot;internalIPs&quot;: { # Internal network IPs assigned to the instances that will be preserved on
3124 # instance delete, update, etc. This map is keyed with the network
3125 # interface name.
3126 &quot;a_key&quot;: {
3127 &quot;autoDelete&quot;: &quot;A String&quot;, # These stateful IPs will never be released during autohealing,
3128 # update or VM instance recreate operations.
3129 # This flag is used to configure if the IP reservation should be deleted
3130 # after it is no longer used by the group, e.g. when the given instance
3131 # or the whole group is deleted.
3132 },
3133 },
3134 },
3135 },
3136 &quot;status&quot;: { # Output only. The status of this managed instance group.
3137 &quot;allInstancesConfig&quot;: { # Output only. Status of all-instances configuration on the group.
3138 &quot;currentRevision&quot;: &quot;A String&quot;, # Output only. Current all-instances configuration revision.
3139 # This value is in RFC3339 text format.
3140 &quot;effective&quot;: True or False, # Output only. A bit indicating whether this configuration has
3141 # been applied to all managed instances in the group.
3142 },
3143 &quot;appliedAcceleratorTopologies&quot;: [ # Output only. The accelerator topology applied to this MIG.
3144 # Currently only one accelerator topology is supported.
3145 {
3146 &quot;acceleratorTopology&quot;: &quot;A String&quot;, # Output only. Topology in the format of: &quot;16x16&quot;, &quot;4x4x4&quot;, etc.
3147 # The value is the same as configured in the WorkloadPolicy.
3148 &quot;state&quot;: &quot;A String&quot;, # Output only. The state of the accelerator topology.
3149 &quot;stateDetails&quot;: { # Output only. The result of the latest accelerator topology state
3150 # check.
3151 &quot;error&quot;: { # Output only. Encountered errors.
3152 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
3153 # operation.
3154 {
3155 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
3156 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
3157 # details. There is a set of defined message types to use for providing
3158 # details.The syntax depends on the error code. For example,
3159 # QuotaExceededInfo will have details when the error code is
3160 # QUOTA_EXCEEDED.
3161 {
3162 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
3163 #
3164 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
3165 # is not enabled:
3166 #
3167 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
3168 # &quot;domain&quot;: &quot;googleapis.com&quot;
3169 # &quot;metadata&quot;: {
3170 # &quot;resource&quot;: &quot;projects/123&quot;,
3171 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
3172 # }
3173 # }
3174 #
3175 # This response indicates that the pubsub.googleapis.com API is not enabled.
3176 #
3177 # Example of an error that is returned when attempting to create a Spanner
3178 # instance in a region that is out of stock:
3179 #
3180 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
3181 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
3182 # &quot;metadata&quot;: {
3183 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
3184 # }
3185 # }
3186 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
3187 # is typically the registered service name of the tool or product that
3188 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
3189 # generated by some common infrastructure, the error domain must be a
3190 # globally unique value that identifies the infrastructure. For Google API
3191 # infrastructure, the error domain is &quot;googleapis.com&quot;.
3192 &quot;metadatas&quot;: { # Additional structured details about this error.
3193 #
3194 # Keys must match a regular expression of `a-z+` but should
3195 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
3196 # length. When identifying the current value of an exceeded limit, the units
3197 # should be contained in the key, not the value. For example, rather than
3198 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
3199 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
3200 # instances that can be created in a single (batch) request.
3201 &quot;a_key&quot;: &quot;A String&quot;,
3202 },
3203 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
3204 # proximate cause of the error. Error reasons are unique within a particular
3205 # domain of errors. This should be at most 63 characters and match a
3206 # regular expression of `A-Z+[A-Z0-9]`, which represents
3207 # UPPER_SNAKE_CASE.
3208 },
3209 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
3210 #
3211 # For example, if a quota check failed with an error indicating the calling
3212 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
3213 # directly to the right place in the developer console to flip the bit.
3214 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
3215 { # Describes a URL link.
3216 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
3217 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
3218 },
3219 ],
3220 },
3221 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
3222 # which can be attached to an RPC error.
3223 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
3224 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
3225 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
3226 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
3227 },
3228 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
3229 &quot;dimensions&quot;: { # The map holding related quota dimensions.
3230 &quot;a_key&quot;: &quot;A String&quot;,
3231 },
3232 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
3233 # type or metric.
3234 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
3235 # or metric.
3236 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
3237 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
3238 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
3239 },
3240 },
3241 ],
3242 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
3243 # This property is optional.
3244 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
3245 },
3246 ],
3247 },
3248 &quot;timestamp&quot;: &quot;A String&quot;, # Output only. Timestamp is shown only if there is an error. The field
3249 # has // RFC3339 //
3250 # text format.
3251 },
3252 },
3253 ],
3254 &quot;autoscaler&quot;: &quot;A String&quot;, # Output only. The URL of theAutoscaler
3255 # that targets this instance group manager.
3256 &quot;bulkInstanceOperation&quot;: { # Bulk instance operation is the creation of VMs in a MIG when the # Output only. The status of bulk instance operation.
3257 # targetSizePolicy.mode is set to BULK.
3258 &quot;inProgress&quot;: True or False, # Output only. Informs whether bulk instance operation is in progress.
3259 &quot;lastProgressCheck&quot;: { # Output only. Information from the last progress check of bulk instance
3260 # operation.
3261 &quot;error&quot;: { # Output only. Errors encountered during bulk instance operation.
3262 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
3263 # operation.
3264 {
3265 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
3266 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
3267 # details. There is a set of defined message types to use for providing
3268 # details.The syntax depends on the error code. For example,
3269 # QuotaExceededInfo will have details when the error code is
3270 # QUOTA_EXCEEDED.
3271 {
3272 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
3273 #
3274 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
3275 # is not enabled:
3276 #
3277 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
3278 # &quot;domain&quot;: &quot;googleapis.com&quot;
3279 # &quot;metadata&quot;: {
3280 # &quot;resource&quot;: &quot;projects/123&quot;,
3281 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
3282 # }
3283 # }
3284 #
3285 # This response indicates that the pubsub.googleapis.com API is not enabled.
3286 #
3287 # Example of an error that is returned when attempting to create a Spanner
3288 # instance in a region that is out of stock:
3289 #
3290 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
3291 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
3292 # &quot;metadata&quot;: {
3293 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
3294 # }
3295 # }
3296 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
3297 # is typically the registered service name of the tool or product that
3298 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
3299 # generated by some common infrastructure, the error domain must be a
3300 # globally unique value that identifies the infrastructure. For Google API
3301 # infrastructure, the error domain is &quot;googleapis.com&quot;.
3302 &quot;metadatas&quot;: { # Additional structured details about this error.
3303 #
3304 # Keys must match a regular expression of `a-z+` but should
3305 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
3306 # length. When identifying the current value of an exceeded limit, the units
3307 # should be contained in the key, not the value. For example, rather than
3308 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
3309 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
3310 # instances that can be created in a single (batch) request.
3311 &quot;a_key&quot;: &quot;A String&quot;,
3312 },
3313 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
3314 # proximate cause of the error. Error reasons are unique within a particular
3315 # domain of errors. This should be at most 63 characters and match a
3316 # regular expression of `A-Z+[A-Z0-9]`, which represents
3317 # UPPER_SNAKE_CASE.
3318 },
3319 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
3320 #
3321 # For example, if a quota check failed with an error indicating the calling
3322 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
3323 # directly to the right place in the developer console to flip the bit.
3324 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
3325 { # Describes a URL link.
3326 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
3327 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
3328 },
3329 ],
3330 },
3331 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
3332 # which can be attached to an RPC error.
3333 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
3334 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
3335 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
3336 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
3337 },
3338 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
3339 &quot;dimensions&quot;: { # The map holding related quota dimensions.
3340 &quot;a_key&quot;: &quot;A String&quot;,
3341 },
3342 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
3343 # type or metric.
3344 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
3345 # or metric.
3346 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
3347 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
3348 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
3349 },
3350 },
3351 ],
3352 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
3353 # This property is optional.
3354 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
3355 },
3356 ],
3357 },
3358 &quot;timestamp&quot;: &quot;A String&quot;, # Output only. Timestamp of the last progress check of bulk instance
3359 # operation. Timestamp is in RFC3339 text format.
3360 },
3361 },
3362 &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
3363 # in this managed instance group that have the status. Currently only shown
3364 # for TPU MIGs
3365 # instance group that have the status. For more information about how to
3366 # interpret each status check the instance lifecycle documentation.
3367 # Currently only shown for TPU MIGs.
3368 &quot;deprovisioning&quot;: 42, # Output only. The number of instances in the managed instance group
3369 # that have DEPROVISIONING status.
3370 &quot;nonExistent&quot;: 42, # Output only. The number of instances that have not been created yet or
3371 # have been deleted. Includes only instances that would be shown in the
3372 # listManagedInstances method and not all instances that have been
3373 # deleted in the lifetime of the MIG.
3374 # Does not include FlexStart instances that are waiting for the resources
3375 # availability, they are considered as &#x27;pending&#x27;.
3376 &quot;pending&quot;: 42, # Output only. The number of instances in the managed instance group
3377 # that have PENDING status, that is FlexStart instances that are waiting
3378 # for resources. Instances that do not exist because of the other reasons
3379 # are counted as &#x27;non_existent&#x27;.
3380 &quot;pendingStop&quot;: 42, # Output only. The number of instances in the managed instance group
3381 # that have PENDING_STOP status.
3382 &quot;provisioning&quot;: 42, # Output only. The number of instances in the managed instance group
3383 # that have PROVISIONING status.
3384 &quot;repairing&quot;: 42, # Output only. The number of instances in the managed instance group
3385 # that have REPAIRING status.
3386 &quot;running&quot;: 42, # Output only. The number of instances in the managed instance group
3387 # that have RUNNING status.
3388 &quot;staging&quot;: 42, # Output only. The number of instances in the managed instance group
3389 # that have STAGING status.
3390 &quot;stopped&quot;: 42, # Output only. The number of instances in the managed instance group
3391 # that have STOPPED status.
3392 &quot;stopping&quot;: 42, # Output only. The number of instances in the managed instance group
3393 # that have STOPPING status.
3394 &quot;suspended&quot;: 42, # Output only. The number of instances in the managed instance group
3395 # that have SUSPENDED status.
3396 &quot;suspending&quot;: 42, # Output only. The number of instances in the managed instance group
3397 # that have SUSPENDING status.
3398 &quot;terminated&quot;: 42, # Output only. The number of instances in the managed instance group
3399 # that have TERMINATED status.
3400 },
3401 &quot;isStable&quot;: True or False, # Output only. A bit indicating whether the managed instance group is in a
3402 # stable state. A stable state means that: none of the instances in the
3403 # managed instance group is currently undergoing any type of change (for
3404 # example, creation, restart, or deletion); no future changes are scheduled
3405 # for instances in the managed instance group; and the managed instance
3406 # group itself is not being modified.
3407 &quot;stateful&quot;: { # Output only. Stateful status of the given Instance Group Manager.
3408 &quot;hasStatefulConfig&quot;: True or False, # Output only. A bit indicating whether the managed instance group
3409 # has stateful configuration, that is, if you have configured any items
3410 # in a stateful policy or in per-instance configs.
3411 # The group might report that it has no stateful configuration even when
3412 # there is still some preserved state on a managed instance, for example,
3413 # if you have deleted all PICs but not yet applied those deletions.
3414 &quot;perInstanceConfigs&quot;: { # Output only. Status of per-instance configurations on the instances.
3415 &quot;allEffective&quot;: True or False, # Output only. A bit indicating if all of the group&#x27;s per-instance configurations
3416 # (listed in the output of a listPerInstanceConfigs API call) have
3417 # status EFFECTIVE or there are no per-instance-configs.
3418 },
3419 },
3420 &quot;versionTarget&quot;: { # Output only. A status of consistency of Instances&#x27; versions with their
3421 # target version specified by version field on Instance Group
3422 # Manager.
3423 &quot;isReached&quot;: True or False, # Output only. A bit indicating whether version target has been reached
3424 # in this managed instance group, i.e. all instances are in their target
3425 # version. Instances&#x27; target version are specified byversion field on Instance Group Manager.
3426 },
3427 },
3428 &quot;targetPools&quot;: [ # The URLs for all TargetPool resources to which instances in theinstanceGroup field are added. The target pools automatically
3429 # apply to all of the instances in the managed instance group.
3430 &quot;A String&quot;,
3431 ],
3432 &quot;targetSize&quot;: 42, # The target number of running instances for this managed instance group.
3433 # You can reduce this number by using the instanceGroupManager
3434 # deleteInstances or abandonInstances methods. Resizing the group also
3435 # changes this number.
3436 &quot;targetSizePolicy&quot;: { # The policy that specifies how the MIG creates its VMs to achieve the target
3437 # size.
3438 &quot;mode&quot;: &quot;A String&quot;, # The mode of target size policy based on which the MIG creates its VMs
3439 # individually or all at once.
3440 },
3441 &quot;targetStoppedSize&quot;: 42, # The target number of stopped instances for this managed instance group.
3442 # This number changes when you:
3443 #
3444 # - Stop instance using the stopInstances
3445 # method or start instances using the startInstances
3446 # method.
3447 # - Manually change the targetStoppedSize using the update
3448 # method.
3449 &quot;targetSuspendedSize&quot;: 42, # The target number of suspended instances for this managed instance group.
3450 # This number changes when you:
3451 #
3452 # - Suspend instance using the suspendInstances
3453 # method or resume instances using the resumeInstances
3454 # method.
3455 # - Manually change the targetSuspendedSize using the update
3456 # method.
3457 &quot;updatePolicy&quot;: { # The update policy for this managed instance group.
3458 &quot;instanceRedistributionType&quot;: &quot;A String&quot;, # The
3459 # instance redistribution policy for regional managed instance groups.
3460 # Valid values are:
3461 #
3462 # - PROACTIVE (default): The group attempts to maintain an
3463 # even distribution of VM instances across zones in the region.
3464 # - NONE: For non-autoscaled groups, proactive
3465 # redistribution is disabled.
3466 &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
3467 # either a fixed number or, if the group has 10 or more instances, a
3468 # percentage. If you set a percentage, the number of instances is rounded
3469 # if necessary. The default value for maxSurge is a fixed
3470 # value equal to the number of zones in which the managed instance group
3471 # operates.
3472 #
3473 # At least one of either maxSurge ormaxUnavailable must be greater than 0. Learn more about maxSurge.
3474 &quot;calculated&quot;: 42, # Output only. Absolute value of VM instances calculated based on the specific mode.
3475 #
3476 #
3477 #
3478 # - If the value is fixed, then the calculated
3479 # value is equal to the fixed value.
3480 # - If the value is a percent, then the
3481 # calculated
3482 # value is percent/100 * targetSize. For example,
3483 # the calculated value of a 80% of a managed instance group
3484 # with 150 instances would be (80/100 * 150) = 120 VM instances. If there
3485 # is a remainder, the number is rounded.
3486 &quot;fixed&quot;: 42, # Specifies a fixed number of VM instances. This must be a positive integer.
3487 &quot;percent&quot;: 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For
3488 # example, specify 80 for 80%.
3489 },
3490 &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
3491 # process. An instance is considered available if all of the following
3492 # conditions are satisfied:
3493 #
3494 #
3495 #
3496 # - The instance&#x27;s status is
3497 # RUNNING.
3498 # - If there is a health
3499 # check on the instance group, the instance&#x27;s health check status
3500 # must be HEALTHY at least once. If there is no health check
3501 # on the group, then the instance only needs to have a status of
3502 # RUNNING to be considered available.
3503 #
3504 #
3505 # This value can be either a fixed number or, if the group has 10 or more
3506 # instances, a percentage. If you set a percentage, the number of instances
3507 # is rounded if necessary. The default value formaxUnavailable is a fixed value equal to the number of zones
3508 # in which the managed instance group operates.
3509 #
3510 # At least one of either maxSurge ormaxUnavailable must be greater than 0. Learn more about maxUnavailable.
3511 &quot;calculated&quot;: 42, # Output only. Absolute value of VM instances calculated based on the specific mode.
3512 #
3513 #
3514 #
3515 # - If the value is fixed, then the calculated
3516 # value is equal to the fixed value.
3517 # - If the value is a percent, then the
3518 # calculated
3519 # value is percent/100 * targetSize. For example,
3520 # the calculated value of a 80% of a managed instance group
3521 # with 150 instances would be (80/100 * 150) = 120 VM instances. If there
3522 # is a remainder, the number is rounded.
3523 &quot;fixed&quot;: 42, # Specifies a fixed number of VM instances. This must be a positive integer.
3524 &quot;percent&quot;: 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For
3525 # example, specify 80 for 80%.
3526 },
3527 &quot;minimalAction&quot;: &quot;A String&quot;, # Minimal action to be taken on an instance. Use this option to minimize
3528 # disruption as much as possible or to apply a more disruptive action than
3529 # is necessary.
3530 #
3531 # - To limit disruption as much as possible, set the minimal action toREFRESH. If your update requires a more disruptive action,
3532 # Compute Engine performs the necessary action to execute the update.
3533 # - To apply a more disruptive action than is strictly necessary, set the
3534 # minimal action to RESTART or REPLACE. For
3535 # example, Compute Engine does not need to restart a VM to change its
3536 # metadata. But if your application reads instance metadata only when a VM
3537 # is restarted, you can set the minimal action to RESTART in
3538 # order to pick up metadata changes.
3539 &quot;mostDisruptiveAllowedAction&quot;: &quot;A String&quot;, # Most disruptive action that is allowed to be taken on an instance.
3540 # You can specify either NONE to forbid any actions,REFRESH to avoid restarting the VM and to limit disruption
3541 # as much as possible. RESTART to allow actions that can be
3542 # applied without instance replacing or REPLACE to allow all
3543 # possible actions. If the Updater determines that the minimal update
3544 # action needed is more disruptive than most disruptive allowed action you
3545 # specify it will not perform the update at all.
3546 &quot;replacementMethod&quot;: &quot;A String&quot;, # What action should be used to replace instances.
3547 # See minimal_action.REPLACE
3548 &quot;type&quot;: &quot;A String&quot;, # The type
3549 # of update process. You can specify either PROACTIVE so
3550 # that the MIG automatically updates VMs to the latest configurations orOPPORTUNISTIC so that you can select the VMs that you want
3551 # to update.
3552 },
3553 &quot;versions&quot;: [ # Specifies the instance templates used by this managed instance group to
3554 # create instances.
3555 #
3556 # Each version is defined by an instanceTemplate and aname. Every version can appear at most once per instance
3557 # group. This field overrides the top-level instanceTemplate
3558 # field. Read more about therelationships
3559 # between these fields. Exactly one version must leave thetargetSize field unset. That version will be applied to all
3560 # remaining instances. For more information, read aboutcanary
3561 # updates.
3562 {
3563 &quot;instanceTemplate&quot;: &quot;A String&quot;, # The URL of the instance template that is specified for this managed
3564 # instance group. The group uses this template to create new instances in
3565 # the managed instance group until the `targetSize` for this version is
3566 # reached. The templates for existing instances in the group do not change
3567 # unless you run recreateInstances, runapplyUpdatesToInstances, or set the group&#x27;supdatePolicy.type to PROACTIVE; in those cases,
3568 # existing instances are updated until the `targetSize` for this version is
3569 # reached.
3570 &quot;name&quot;: &quot;A String&quot;, # Name of the version. Unique among all versions in the scope of this
3571 # managed instance group.
3572 &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
3573 # from the template will be equal to:
3574 #
3575 #
3576 # - If expressed as a fixed number, the minimum of either
3577 # targetSize.fixed or
3578 # instanceGroupManager.targetSize is used.
3579 # - if expressed as a percent, the targetSize
3580 # would be (targetSize.percent/100 *
3581 # InstanceGroupManager.targetSize) If there is a remainder, the
3582 # number is rounded.
3583 #
3584 # If unset, this version will update any remaining instances not
3585 # updated by another version. ReadStarting
3586 # a canary update for more information.
3587 &quot;calculated&quot;: 42, # Output only. Absolute value of VM instances calculated based on the specific mode.
3588 #
3589 #
3590 #
3591 # - If the value is fixed, then the calculated
3592 # value is equal to the fixed value.
3593 # - If the value is a percent, then the
3594 # calculated
3595 # value is percent/100 * targetSize. For example,
3596 # the calculated value of a 80% of a managed instance group
3597 # with 150 instances would be (80/100 * 150) = 120 VM instances. If there
3598 # is a remainder, the number is rounded.
3599 &quot;fixed&quot;: 42, # Specifies a fixed number of VM instances. This must be a positive integer.
3600 &quot;percent&quot;: 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For
3601 # example, specify 80 for 80%.
3602 },
3603 },
3604 ],
3605 &quot;zone&quot;: &quot;A String&quot;, # Output only. The URL of azone
3606 # where the managed instance group is located (for zonal resources).
3607 }
3608
3609 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
3610 that if you must retry your request, the server will know to ignore the
3611 request if it has already been completed.
3612
3613 For example, consider a situation where you make an initial request and
3614 the request times out. If you make the request again with the same
3615 request ID, the server can check if original operation with the same
3616 request ID was received, and if so, will ignore the second request. This
3617 prevents clients from accidentally creating duplicate commitments.
3618
3619 The request ID must be
3620 a valid UUID with the exception that zero UUID is not supported
3621 (00000000-0000-0000-0000-000000000000).
3622 x__xgafv: string, V1 error format.
3623 Allowed values
3624 1 - v1 error format
3625 2 - v2 error format
3626
3627 Returns:
3628 An object of the form:
3629
3630 { # Represents an Operation resource.
3631 #
3632 # Google Compute Engine has three Operation resources:
3633 #
3634 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
3635 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
3636 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
3637 #
3638 # You can use an operation resource to manage asynchronous API requests.
3639 # For more information, readHandling
3640 # API responses.
3641 #
3642 # Operations can be global, regional or zonal.
3643 #
3644 # - For global operations, use the `globalOperations`
3645 # resource.
3646 # - For regional operations, use the
3647 # `regionOperations` resource.
3648 # - For zonal operations, use
3649 # the `zoneOperations` resource.
3650 #
3651 #
3652 #
3653 # For more information, read
3654 # Global, Regional, and Zonal Resources.
3655 #
3656 # Note that completed Operation resources have a limited
3657 # retention period.
3658 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
3659 # Not present otherwise.
3660 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
3661 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
3662 # set when the operation is created.
3663 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
3664 # text format.
3665 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
3666 # this field will be populated.
3667 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
3668 # operation.
3669 {
3670 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
3671 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
3672 # details. There is a set of defined message types to use for providing
3673 # details.The syntax depends on the error code. For example,
3674 # QuotaExceededInfo will have details when the error code is
3675 # QUOTA_EXCEEDED.
3676 {
3677 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
3678 #
3679 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
3680 # is not enabled:
3681 #
3682 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
3683 # &quot;domain&quot;: &quot;googleapis.com&quot;
3684 # &quot;metadata&quot;: {
3685 # &quot;resource&quot;: &quot;projects/123&quot;,
3686 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
3687 # }
3688 # }
3689 #
3690 # This response indicates that the pubsub.googleapis.com API is not enabled.
3691 #
3692 # Example of an error that is returned when attempting to create a Spanner
3693 # instance in a region that is out of stock:
3694 #
3695 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
3696 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
3697 # &quot;metadata&quot;: {
3698 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
3699 # }
3700 # }
3701 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
3702 # is typically the registered service name of the tool or product that
3703 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
3704 # generated by some common infrastructure, the error domain must be a
3705 # globally unique value that identifies the infrastructure. For Google API
3706 # infrastructure, the error domain is &quot;googleapis.com&quot;.
3707 &quot;metadatas&quot;: { # Additional structured details about this error.
3708 #
3709 # Keys must match a regular expression of `a-z+` but should
3710 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
3711 # length. When identifying the current value of an exceeded limit, the units
3712 # should be contained in the key, not the value. For example, rather than
3713 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
3714 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
3715 # instances that can be created in a single (batch) request.
3716 &quot;a_key&quot;: &quot;A String&quot;,
3717 },
3718 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
3719 # proximate cause of the error. Error reasons are unique within a particular
3720 # domain of errors. This should be at most 63 characters and match a
3721 # regular expression of `A-Z+[A-Z0-9]`, which represents
3722 # UPPER_SNAKE_CASE.
3723 },
3724 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
3725 #
3726 # For example, if a quota check failed with an error indicating the calling
3727 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
3728 # directly to the right place in the developer console to flip the bit.
3729 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
3730 { # Describes a URL link.
3731 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
3732 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
3733 },
3734 ],
3735 },
3736 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
3737 # which can be attached to an RPC error.
3738 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
3739 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
3740 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
3741 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
3742 },
3743 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
3744 &quot;dimensions&quot;: { # The map holding related quota dimensions.
3745 &quot;a_key&quot;: &quot;A String&quot;,
3746 },
3747 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
3748 # type or metric.
3749 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
3750 # or metric.
3751 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
3752 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
3753 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
3754 },
3755 },
3756 ],
3757 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
3758 # This property is optional.
3759 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
3760 },
3761 ],
3762 },
3763 &quot;getVersionOperationMetadata&quot;: {
3764 &quot;inlineSbomInfo&quot;: {
3765 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
3766 # appropriate identifiers.
3767 &quot;a_key&quot;: &quot;A String&quot;,
3768 },
3769 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
3770 # identifiers.
3771 &quot;a_key&quot;: &quot;A String&quot;,
3772 },
3773 },
3774 },
3775 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
3776 # message that was returned, such as `NOT FOUND`.
3777 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
3778 # status code that was returned. For example, a `404` means the
3779 # resource was not found.
3780 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
3781 # defined by the server.
3782 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
3783 # This value is inRFC3339
3784 # text format.
3785 &quot;instancesBulkInsertOperationMetadata&quot;: {
3786 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
3787 # Example key: zones/us-central1-a
3788 &quot;a_key&quot;: {
3789 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
3790 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
3791 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
3792 # error.
3793 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
3794 # if the flow is rolling forward or rolling back.
3795 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
3796 },
3797 },
3798 },
3799 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
3800 # Operation resources.
3801 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
3802 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
3803 # group of operations results from a `bulkInsert` API request.
3804 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
3805 # `update`, or `delete`, and so on.
3806 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
3807 # There is no requirement that this be linear or support any granularity of
3808 # operations. This should not be used to guess when the operation will be
3809 # complete. This number should monotonically increase as the operation
3810 # progresses.
3811 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
3812 # applicable when performing regional operations.
3813 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
3814 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
3815 # this field will contain information on all underlying zonal actions and
3816 # their state.
3817 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
3818 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
3819 # Example key: zones/us-central1-a
3820 &quot;a_key&quot;: {
3821 &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
3822 # populated.
3823 # different programming environments, including REST APIs and RPC APIs. It is
3824 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
3825 # three pieces of data: error code, error message, and error details.
3826 #
3827 # You can find out more about this error model and how to work with it in the
3828 # [API Design Guide](https://cloud.google.com/apis/design/errors).
3829 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
3830 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
3831 # message types for APIs to use.
3832 {
3833 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
3834 },
3835 ],
3836 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
3837 # user-facing error message should be localized and sent in the
3838 # google.rpc.Status.details field, or localized by the client.
3839 },
3840 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
3841 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
3842 },
3843 },
3844 },
3845 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
3846 # This value is inRFC3339
3847 # text format.
3848 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
3849 # following:
3850 # `PENDING`, `RUNNING`, or `DONE`.
3851 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
3852 # operation.
3853 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
3854 # of the target resource.
3855 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
3856 # operations related to creating a snapshot, this points to the disk
3857 # that the snapshot was created from.
3858 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
3859 # `[email protected]` or
3860 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
3861 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
3862 # operation, this field will be populated.
3863 {
3864 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
3865 # Engine returns NO_RESULTS_ON_PAGE if there
3866 # are no results in the response.
3867 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
3868 # value format. For example:
3869 #
3870 # &quot;data&quot;: [
3871 # {
3872 # &quot;key&quot;: &quot;scope&quot;,
3873 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
3874 # }
3875 {
3876 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
3877 # returned. For example, for warnings where there are no results in a list
3878 # request for a particular zone, this key might be scope and
3879 # the key value might be the zone name. Other examples might be a key
3880 # indicating a deprecated resource and a suggested replacement, or a
3881 # warning about invalid network settings (for example, if an instance
3882 # attempts to perform IP forwarding but is not enabled for IP forwarding).
3883 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
3884 },
3885 ],
3886 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
3887 },
3888 ],
3889 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
3890 # applicable when performing per-zone operations.
3891 }</pre>
3892 </div>
3893
3894 <div class="method">
3895 <code class="details" id="list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
3896 <pre>Retrieves the list of managed instance groups that are contained
3897 within the specified region.
3898
3899 Args:
3900 project: string, Project ID for this request. (required)
3901 region: string, Name of the region scoping this request. (required)
3902 filter: string, A filter expression that filters resources listed in the response. Most
3903 Compute resources support two types of filter expressions:
3904 expressions that support regular expressions and expressions that follow
3905 API improvement proposal AIP-160.
3906 These two types of filter expressions cannot be mixed in one request.
3907
3908 If you want to use AIP-160, your expression must specify the field name, an
3909 operator, and the value that you want to use for filtering. The value
3910 must be a string, a number, or a boolean. The operator
3911 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
3912
3913 For example, if you are filtering Compute Engine instances, you can
3914 exclude instances named `example-instance` by specifying
3915 `name != example-instance`.
3916
3917 The `:*` comparison can be used to test whether a key has been defined.
3918 For example, to find all objects with `owner` label use:
3919 ```
3920 labels.owner:*
3921 ```
3922
3923 You can also filter nested fields. For example, you could specify
3924 `scheduling.automaticRestart = false` to include instances only
3925 if they are not scheduled for automatic restarts. You can use filtering
3926 on nested fields to filter based onresource labels.
3927
3928 To filter on multiple expressions, provide each separate expression within
3929 parentheses. For example:
3930 ```
3931 (scheduling.automaticRestart = true)
3932 (cpuPlatform = &quot;Intel Skylake&quot;)
3933 ```
3934 By default, each expression is an `AND` expression. However, you
3935 can include `AND` and `OR` expressions explicitly.
3936 For example:
3937 ```
3938 (cpuPlatform = &quot;Intel Skylake&quot;) OR
3939 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
3940 (scheduling.automaticRestart = true)
3941 ```
3942
3943 If you want to use a regular expression, use the `eq` (equal) or `ne`
3944 (not equal) operator against a single un-parenthesized expression with or
3945 without quotes or against multiple parenthesized expressions. Examples:
3946
3947 `fieldname eq unquoted literal`
3948 `fieldname eq &#x27;single quoted literal&#x27;`
3949 `fieldname eq &quot;double quoted literal&quot;`
3950 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
3951
3952 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
3953 The literal value must match the entire field.
3954
3955 For example, to filter for instances that do not end with name &quot;instance&quot;,
3956 you would use `name ne .*instance`.
3957
3958 You cannot combine constraints on multiple fields using regular
3959 expressions.
3960 maxResults: integer, The maximum number of results per page that should be returned.
3961 If the number of available results is larger than `maxResults`,
3962 Compute Engine returns a `nextPageToken` that can be used to get
3963 the next page of results in subsequent list requests. Acceptable values are
3964 `0` to `500`, inclusive. (Default: `500`)
3965 orderBy: string, Sorts list results by a certain order. By default, results
3966 are returned in alphanumerical order based on the resource name.
3967
3968 You can also sort results in descending order based on the creation
3969 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
3970 results based on the `creationTimestamp` field in
3971 reverse chronological order (newest result first). Use this to sort
3972 resources like operations so that the newest operation is returned first.
3973
3974 Currently, only sorting by `name` or
3975 `creationTimestamp desc` is supported.
3976 pageToken: string, Specifies a page token to use. Set `pageToken` to the
3977 `nextPageToken` returned by a previous list request to get
3978 the next page of results.
3979 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
3980 of failure. The default value is false.
3981
3982 For example, when partial success behavior is enabled, aggregatedList for a
3983 single zone scope either returns all resources in the zone or no resources,
3984 with an error code.
3985 x__xgafv: string, V1 error format.
3986 Allowed values
3987 1 - v1 error format
3988 2 - v2 error format
3989
3990 Returns:
3991 An object of the form:
3992
3993 { # Contains a list of managed instance groups.
3994 &quot;id&quot;: &quot;A String&quot;, # Output only. Unique identifier for the resource; defined by the server.
3995 &quot;items&quot;: [ # A list of InstanceGroupManager resources.
3996 { # Represents a Managed Instance Group resource.
3997 #
3998 # An instance group is a collection of VM instances that you can manage as a
3999 # single entity. For more information, readInstance groups.
4000 #
4001 # For zonal Managed Instance Group, use the instanceGroupManagers
4002 # resource.
4003 #
4004 # For regional Managed Instance Group, use theregionInstanceGroupManagers resource.
4005 &quot;allInstancesConfig&quot;: { # Specifies configuration that overrides the instance template configuration
4006 # for the group.
4007 &quot;properties&quot;: { # Represents the change that you want to make to the instance properties. # Properties to set on all instances in the group.
4008 #
4009 # You can add or modify properties using theinstanceGroupManagers.patch orregionInstanceGroupManagers.patch. After settingallInstancesConfig on the group, you must update the group&#x27;s
4010 # instances to apply the configuration. To apply the configuration, set the
4011 # group&#x27;s updatePolicy.type field to use proactive updates or
4012 # use the applyUpdatesToInstances method.
4013 &quot;labels&quot;: { # The label key-value pairs that you want to patch onto the instance.
4014 &quot;a_key&quot;: &quot;A String&quot;,
4015 },
4016 &quot;metadata&quot;: { # The metadata key-value pairs that you want to patch onto the instance. For
4017 # more information, see Project and
4018 # instance metadata.
4019 &quot;a_key&quot;: &quot;A String&quot;,
4020 },
4021 },
4022 },
4023 &quot;autoHealingPolicies&quot;: [ # The autohealing policy for this managed instance group. You can specify
4024 # only one value.
4025 {
4026 &quot;healthCheck&quot;: &quot;A String&quot;, # The URL for the health check that signals autohealing.
4027 &quot;initialDelaySec&quot;: 42, # The initial delay is the number of seconds that a new VM takes to
4028 # initialize and run its startup script. During a VM&#x27;s initial delay
4029 # period, the MIG ignores unsuccessful health checks because the VM might
4030 # be in the startup process. This prevents the MIG from prematurely
4031 # recreating a VM. If the health check receives a healthy response during
4032 # the initial delay, it indicates that the startup process is complete and
4033 # the VM is ready. The value of initial delay must be between 0 and 3600
4034 # seconds. The default value is 0.
4035 },
4036 ],
4037 &quot;baseInstanceName&quot;: &quot;A String&quot;, # The base instance name is a prefix that you want to attach to the names of
4038 # all VMs in a MIG. The maximum character length is 58 and the name must
4039 # comply with RFC1035 format.
4040 #
4041 # When a VM is created in the group, the MIG appends a hyphen and a random
4042 # four-character string to the base instance name. If you want the MIG to
4043 # assign sequential numbers instead of a random string, then end the base
4044 # instance name with a hyphen followed by one or more hash symbols. The hash
4045 # symbols indicate the number of digits. For example, a base instance name of
4046 # &quot;vm-###&quot; results in &quot;vm-001&quot; as a VM name.
4047 # @pattern
4048 # [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,51}-#{1,10}(\\[[0-9]{1,10}\\])?))
4049 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. The creation timestamp for this managed instance group inRFC3339
4050 # text format.
4051 &quot;currentActions&quot;: { # Output only. The list of instance actions and the number of instances
4052 # in this managed instance group that are scheduled for each of those
4053 # actions.
4054 &quot;abandoning&quot;: 42, # Output only. The total number of instances in the managed instance group
4055 # that are scheduled to be abandoned. Abandoning an instance removes it
4056 # from the managed instance group without deleting it.
4057 &quot;creating&quot;: 42, # Output only. The number of instances in the managed instance group that
4058 # are scheduled to be created or are currently being created. If the group
4059 # fails to create any of these instances, it tries again until it creates
4060 # the instance successfully.
4061 #
4062 # If you have disabled creation retries, this field will not be populated;
4063 # instead, the creatingWithoutRetries field will be populated.
4064 &quot;creatingWithoutRetries&quot;: 42, # Output only. The number of instances that the managed instance group
4065 # will attempt to create. The group attempts to create each instance
4066 # only once. If the group fails to create any of these instances, it
4067 # decreases the group&#x27;s targetSize value accordingly.
4068 &quot;deleting&quot;: 42, # Output only. The number of instances in the managed instance group that
4069 # are scheduled to be deleted or are currently being deleted.
4070 &quot;none&quot;: 42, # Output only. The number of instances in the managed instance group that
4071 # are running and have no scheduled actions.
4072 &quot;recreating&quot;: 42, # Output only. The number of instances in the managed instance group that
4073 # are scheduled to be recreated or are currently being being recreated.
4074 # Recreating an instance deletes the existing root persistent disk
4075 # and creates a new disk from the image that is defined in the
4076 # instance template.
4077 &quot;refreshing&quot;: 42, # Output only. The number of instances in the managed instance group that
4078 # are being reconfigured with properties that do not require a restart
4079 # or a recreate action. For example, setting or removing target
4080 # pools for the instance.
4081 &quot;restarting&quot;: 42, # Output only. The number of instances in the managed instance group that
4082 # are scheduled to be restarted or are currently being restarted.
4083 &quot;resuming&quot;: 42, # Output only. The number of instances in the managed instance group that
4084 # are scheduled to be resumed or are currently being resumed.
4085 &quot;starting&quot;: 42, # Output only. The number of instances in the managed instance group that
4086 # are scheduled to be started or are currently being started.
4087 &quot;stopping&quot;: 42, # Output only. The number of instances in the managed instance group that
4088 # are scheduled to be stopped or are currently being stopped.
4089 &quot;suspending&quot;: 42, # Output only. The number of instances in the managed instance group that
4090 # are scheduled to be suspended or are currently being suspended.
4091 &quot;verifying&quot;: 42, # Output only. The number of instances in the managed instance group that
4092 # are being verified. See the managedInstances[].currentAction
4093 # property in the listManagedInstances method documentation.
4094 },
4095 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource.
4096 &quot;distributionPolicy&quot;: { # Policy specifying the intended distribution of managed instances across
4097 # zones in a regional managed instance group.
4098 &quot;targetShape&quot;: &quot;A String&quot;, # The distribution shape to which the group converges either proactively or
4099 # on resize events (depending on the value set inupdatePolicy.instanceRedistributionType).
4100 &quot;zones&quot;: [ # Zones where the regional managed instance group will create and manage
4101 # its instances.
4102 # By default, a regional MIG doesn&#x27;t automatically select an AI zone to create
4103 # instances, even if an AI zone is available in the specified region. To
4104 # create instances in an AI zone in the selected region, you must explicitly
4105 # specify it in the distribution policy together with the other preferred
4106 # zones.
4107 {
4108 &quot;zone&quot;: &quot;A String&quot;, # The URL of thezone.
4109 # The zone must exist in the region where the managed instance group is
4110 # located.
4111 },
4112 ],
4113 },
4114 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. This field may be used in optimistic locking.
4115 # It will be ignored when inserting an InstanceGroupManager. An up-to-date
4116 # fingerprint must be provided in order to update the InstanceGroupManager,
4117 # otherwise the request will fail with error412 conditionNotMet.
4118 #
4119 # To see the latest fingerprint, make a get() request to
4120 # retrieve an InstanceGroupManager.
4121 &quot;id&quot;: &quot;A String&quot;, # Output only. A unique identifier for this resource type. The server
4122 # generates this identifier.
4123 &quot;instanceFlexibilityPolicy&quot;: { # Instance flexibility allowing MIG to create VMs from multiple
4124 # types of machines.
4125 # Instance flexibility configuration on MIG overrides instance
4126 # template configuration.
4127 &quot;instanceSelections&quot;: { # Named instance selections configuring properties that the group will use
4128 # when creating new VMs.
4129 &quot;a_key&quot;: {
4130 &quot;machineTypes&quot;: [ # Full machine-type names, e.g. &quot;n1-standard-16&quot;.
4131 &quot;A String&quot;,
4132 ],
4133 &quot;rank&quot;: 42, # Preference of this instance selection. Lower number means higher
4134 # preference. MIG will first try to create a VM based on the machine-type
4135 # with lowest rank and fallback to next rank based on availability.
4136 # Machine types and instance selections with the same rank have the same
4137 # preference.
4138 },
4139 },
4140 },
4141 &quot;instanceGroup&quot;: &quot;A String&quot;, # Output only. The URL of the Instance Group resource.
4142 &quot;instanceLifecyclePolicy&quot;: { # The repair policy for this managed instance group.
4143 &quot;defaultActionOnFailure&quot;: &quot;A String&quot;, # The action that a MIG performs on a failed VM. If the value of the
4144 # onFailedHealthCheck field is `DEFAULT_ACTION`, then the same action also
4145 # applies to the VMs on which your application fails a health check.
4146 # Valid values are
4147 #
4148 # - REPAIR (default): MIG automatically repairs a failed VM
4149 # by recreating it. For more information, see About
4150 # repairing VMs in a MIG.
4151 # - DO_NOTHING: MIG does not repair a failed VM.
4152 &quot;forceUpdateOnRepair&quot;: &quot;A String&quot;, # A bit indicating whether to forcefully apply the group&#x27;s latest
4153 # configuration when repairing a VM. Valid options are:
4154 #
4155 #
4156 #
4157 # - NO (default): If configuration updates are available, they are not
4158 # forcefully applied during repair. Instead, configuration updates are
4159 # applied according to the group&#x27;s update policy.
4160 #
4161 # - YES: If configuration updates are available, they are applied
4162 # during repair.
4163 &quot;onFailedHealthCheck&quot;: &quot;A String&quot;, # The action that a MIG performs on an unhealthy VM. A VM is marked as
4164 # unhealthy when the application running on that VM fails a health check.
4165 # Valid values are:
4166 #
4167 # - DEFAULT_ACTION (default): MIG uses the same action
4168 # configured for instanceLifecyclePolicy.defaultActionOnFailure field.
4169 # - REPAIR: MIG automatically repairs an unhealthy VM by
4170 # recreating it.
4171 # - DO_NOTHING: MIG doesn&#x27;t repair an unhealthy VM.
4172 # For more information, see
4173 # About repairing VMs in a MIG.
4174 &quot;onRepair&quot;: { # Configuration for VM repairs in the MIG. # Configuration for VM repairs in the MIG.
4175 &quot;allowChangingZone&quot;: &quot;A String&quot;, # Specifies whether the MIG can change a VM&#x27;s zone during a repair.
4176 # Valid values are:
4177 #
4178 # - NO (default): MIG cannot change a VM&#x27;s zone during a
4179 # repair.
4180 # - YES: MIG can select a different zone for the VM during
4181 # a repair.
4182 },
4183 },
4184 &quot;instanceTemplate&quot;: &quot;A String&quot;, # The URL of the instance template that is specified for this managed
4185 # instance group. The group uses this template to create all new instances
4186 # in the managed instance group. The templates for existing instances in the
4187 # group do not change unless you run recreateInstances, runapplyUpdatesToInstances, or set the group&#x27;supdatePolicy.type to PROACTIVE.
4188 &quot;kind&quot;: &quot;compute#instanceGroupManager&quot;, # Output only. The resource type, which is alwayscompute#instanceGroupManager for managed instance groups.
4189 &quot;listManagedInstancesResults&quot;: &quot;A String&quot;, # Pagination behavior of the listManagedInstances API method for
4190 # this managed instance group.
4191 &quot;name&quot;: &quot;A String&quot;, # The name of the managed instance group. The name must be 1-63 characters
4192 # long, and comply withRFC1035.
4193 &quot;namedPorts&quot;: [ # [Output Only] Named ports configured on the Instance Groups complementary
4194 # to this Instance Group Manager.
4195 { # The named port. For example: &lt;&quot;http&quot;, 80&gt;.
4196 &quot;name&quot;: &quot;A String&quot;, # The name for this named port.
4197 # The name must be 1-63 characters long, and comply withRFC1035.
4198 &quot;port&quot;: 42, # The port number, which can be a value between 1 and 65535.
4199 },
4200 ],
4201 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL of theregion
4202 # where the managed instance group resides (for regional resources).
4203 &quot;resourcePolicies&quot;: { # Resource policies for this managed instance group.
4204 &quot;workloadPolicy&quot;: &quot;A String&quot;, # The URL of the workload policy that is specified for this managed
4205 # instance group.
4206 # It can be a full or partial URL. For example, the following are
4207 # all valid URLs to a workload policy:
4208 #
4209 #
4210 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/resourcePolicies/resourcePolicy
4211 # - projects/project/regions/region/resourcePolicies/resourcePolicy
4212 # - regions/region/resourcePolicies/resourcePolicy
4213 },
4214 &quot;satisfiesPzi&quot;: True or False, # Output only. Reserved for future use.
4215 &quot;satisfiesPzs&quot;: True or False, # Output only. Reserved for future use.
4216 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. The URL for this managed instance group. The server defines
4217 # this URL.
4218 &quot;standbyPolicy&quot;: { # Standby policy for stopped and suspended instances.
4219 &quot;initialDelaySec&quot;: 42, # Specifies the number of seconds that the MIG should wait to suspend or
4220 # stop a VM after that VM was created. The initial delay gives the
4221 # initialization script the time to prepare your VM for a quick scale out.
4222 # The value of initial delay must be between 0 and 3600 seconds. The
4223 # default value is 0.
4224 &quot;mode&quot;: &quot;A String&quot;, # Defines how a MIG resumes or starts VMs from a standby pool when the
4225 # group scales out. The default mode is `MANUAL`.
4226 },
4227 &quot;statefulPolicy&quot;: { # Stateful configuration for this Instanced Group Manager
4228 &quot;preservedState&quot;: { # Configuration of preserved resources.
4229 &quot;disks&quot;: { # Disks created on the instances that will be preserved on instance
4230 # delete, update, etc. This map is keyed with the device names of
4231 # the disks.
4232 &quot;a_key&quot;: {
4233 &quot;autoDelete&quot;: &quot;A String&quot;, # These stateful disks will never be deleted during autohealing,
4234 # update or VM instance recreate operations.
4235 # This flag is used to configure if the disk should be deleted after it
4236 # is no longer used by the group, e.g. when the given instance or
4237 # the whole group is deleted. Note: disks attached inREAD_ONLY mode cannot be auto-deleted.
4238 },
4239 },
4240 &quot;externalIPs&quot;: { # External network IPs assigned to the instances that will be preserved on
4241 # instance delete, update, etc. This map is keyed with the network
4242 # interface name.
4243 &quot;a_key&quot;: {
4244 &quot;autoDelete&quot;: &quot;A String&quot;, # These stateful IPs will never be released during autohealing,
4245 # update or VM instance recreate operations.
4246 # This flag is used to configure if the IP reservation should be deleted
4247 # after it is no longer used by the group, e.g. when the given instance
4248 # or the whole group is deleted.
4249 },
4250 },
4251 &quot;internalIPs&quot;: { # Internal network IPs assigned to the instances that will be preserved on
4252 # instance delete, update, etc. This map is keyed with the network
4253 # interface name.
4254 &quot;a_key&quot;: {
4255 &quot;autoDelete&quot;: &quot;A String&quot;, # These stateful IPs will never be released during autohealing,
4256 # update or VM instance recreate operations.
4257 # This flag is used to configure if the IP reservation should be deleted
4258 # after it is no longer used by the group, e.g. when the given instance
4259 # or the whole group is deleted.
4260 },
4261 },
4262 },
4263 },
4264 &quot;status&quot;: { # Output only. The status of this managed instance group.
4265 &quot;allInstancesConfig&quot;: { # Output only. Status of all-instances configuration on the group.
4266 &quot;currentRevision&quot;: &quot;A String&quot;, # Output only. Current all-instances configuration revision.
4267 # This value is in RFC3339 text format.
4268 &quot;effective&quot;: True or False, # Output only. A bit indicating whether this configuration has
4269 # been applied to all managed instances in the group.
4270 },
4271 &quot;appliedAcceleratorTopologies&quot;: [ # Output only. The accelerator topology applied to this MIG.
4272 # Currently only one accelerator topology is supported.
4273 {
4274 &quot;acceleratorTopology&quot;: &quot;A String&quot;, # Output only. Topology in the format of: &quot;16x16&quot;, &quot;4x4x4&quot;, etc.
4275 # The value is the same as configured in the WorkloadPolicy.
4276 &quot;state&quot;: &quot;A String&quot;, # Output only. The state of the accelerator topology.
4277 &quot;stateDetails&quot;: { # Output only. The result of the latest accelerator topology state
4278 # check.
4279 &quot;error&quot;: { # Output only. Encountered errors.
4280 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
4281 # operation.
4282 {
4283 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
4284 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
4285 # details. There is a set of defined message types to use for providing
4286 # details.The syntax depends on the error code. For example,
4287 # QuotaExceededInfo will have details when the error code is
4288 # QUOTA_EXCEEDED.
4289 {
4290 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
4291 #
4292 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
4293 # is not enabled:
4294 #
4295 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
4296 # &quot;domain&quot;: &quot;googleapis.com&quot;
4297 # &quot;metadata&quot;: {
4298 # &quot;resource&quot;: &quot;projects/123&quot;,
4299 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
4300 # }
4301 # }
4302 #
4303 # This response indicates that the pubsub.googleapis.com API is not enabled.
4304 #
4305 # Example of an error that is returned when attempting to create a Spanner
4306 # instance in a region that is out of stock:
4307 #
4308 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
4309 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
4310 # &quot;metadata&quot;: {
4311 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
4312 # }
4313 # }
4314 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
4315 # is typically the registered service name of the tool or product that
4316 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
4317 # generated by some common infrastructure, the error domain must be a
4318 # globally unique value that identifies the infrastructure. For Google API
4319 # infrastructure, the error domain is &quot;googleapis.com&quot;.
4320 &quot;metadatas&quot;: { # Additional structured details about this error.
4321 #
4322 # Keys must match a regular expression of `a-z+` but should
4323 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
4324 # length. When identifying the current value of an exceeded limit, the units
4325 # should be contained in the key, not the value. For example, rather than
4326 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
4327 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
4328 # instances that can be created in a single (batch) request.
4329 &quot;a_key&quot;: &quot;A String&quot;,
4330 },
4331 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
4332 # proximate cause of the error. Error reasons are unique within a particular
4333 # domain of errors. This should be at most 63 characters and match a
4334 # regular expression of `A-Z+[A-Z0-9]`, which represents
4335 # UPPER_SNAKE_CASE.
4336 },
4337 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
4338 #
4339 # For example, if a quota check failed with an error indicating the calling
4340 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
4341 # directly to the right place in the developer console to flip the bit.
4342 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
4343 { # Describes a URL link.
4344 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
4345 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
4346 },
4347 ],
4348 },
4349 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
4350 # which can be attached to an RPC error.
4351 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
4352 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
4353 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
4354 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
4355 },
4356 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
4357 &quot;dimensions&quot;: { # The map holding related quota dimensions.
4358 &quot;a_key&quot;: &quot;A String&quot;,
4359 },
4360 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
4361 # type or metric.
4362 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
4363 # or metric.
4364 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
4365 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
4366 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
4367 },
4368 },
4369 ],
4370 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
4371 # This property is optional.
4372 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
4373 },
4374 ],
4375 },
4376 &quot;timestamp&quot;: &quot;A String&quot;, # Output only. Timestamp is shown only if there is an error. The field
4377 # has // RFC3339 //
4378 # text format.
4379 },
4380 },
4381 ],
4382 &quot;autoscaler&quot;: &quot;A String&quot;, # Output only. The URL of theAutoscaler
4383 # that targets this instance group manager.
4384 &quot;bulkInstanceOperation&quot;: { # Bulk instance operation is the creation of VMs in a MIG when the # Output only. The status of bulk instance operation.
4385 # targetSizePolicy.mode is set to BULK.
4386 &quot;inProgress&quot;: True or False, # Output only. Informs whether bulk instance operation is in progress.
4387 &quot;lastProgressCheck&quot;: { # Output only. Information from the last progress check of bulk instance
4388 # operation.
4389 &quot;error&quot;: { # Output only. Errors encountered during bulk instance operation.
4390 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
4391 # operation.
4392 {
4393 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
4394 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
4395 # details. There is a set of defined message types to use for providing
4396 # details.The syntax depends on the error code. For example,
4397 # QuotaExceededInfo will have details when the error code is
4398 # QUOTA_EXCEEDED.
4399 {
4400 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
4401 #
4402 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
4403 # is not enabled:
4404 #
4405 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
4406 # &quot;domain&quot;: &quot;googleapis.com&quot;
4407 # &quot;metadata&quot;: {
4408 # &quot;resource&quot;: &quot;projects/123&quot;,
4409 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
4410 # }
4411 # }
4412 #
4413 # This response indicates that the pubsub.googleapis.com API is not enabled.
4414 #
4415 # Example of an error that is returned when attempting to create a Spanner
4416 # instance in a region that is out of stock:
4417 #
4418 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
4419 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
4420 # &quot;metadata&quot;: {
4421 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
4422 # }
4423 # }
4424 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
4425 # is typically the registered service name of the tool or product that
4426 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
4427 # generated by some common infrastructure, the error domain must be a
4428 # globally unique value that identifies the infrastructure. For Google API
4429 # infrastructure, the error domain is &quot;googleapis.com&quot;.
4430 &quot;metadatas&quot;: { # Additional structured details about this error.
4431 #
4432 # Keys must match a regular expression of `a-z+` but should
4433 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
4434 # length. When identifying the current value of an exceeded limit, the units
4435 # should be contained in the key, not the value. For example, rather than
4436 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
4437 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
4438 # instances that can be created in a single (batch) request.
4439 &quot;a_key&quot;: &quot;A String&quot;,
4440 },
4441 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
4442 # proximate cause of the error. Error reasons are unique within a particular
4443 # domain of errors. This should be at most 63 characters and match a
4444 # regular expression of `A-Z+[A-Z0-9]`, which represents
4445 # UPPER_SNAKE_CASE.
4446 },
4447 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
4448 #
4449 # For example, if a quota check failed with an error indicating the calling
4450 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
4451 # directly to the right place in the developer console to flip the bit.
4452 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
4453 { # Describes a URL link.
4454 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
4455 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
4456 },
4457 ],
4458 },
4459 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
4460 # which can be attached to an RPC error.
4461 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
4462 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
4463 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
4464 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
4465 },
4466 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
4467 &quot;dimensions&quot;: { # The map holding related quota dimensions.
4468 &quot;a_key&quot;: &quot;A String&quot;,
4469 },
4470 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
4471 # type or metric.
4472 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
4473 # or metric.
4474 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
4475 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
4476 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
4477 },
4478 },
4479 ],
4480 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
4481 # This property is optional.
4482 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
4483 },
4484 ],
4485 },
4486 &quot;timestamp&quot;: &quot;A String&quot;, # Output only. Timestamp of the last progress check of bulk instance
4487 # operation. Timestamp is in RFC3339 text format.
4488 },
4489 },
4490 &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
4491 # in this managed instance group that have the status. Currently only shown
4492 # for TPU MIGs
4493 # instance group that have the status. For more information about how to
4494 # interpret each status check the instance lifecycle documentation.
4495 # Currently only shown for TPU MIGs.
4496 &quot;deprovisioning&quot;: 42, # Output only. The number of instances in the managed instance group
4497 # that have DEPROVISIONING status.
4498 &quot;nonExistent&quot;: 42, # Output only. The number of instances that have not been created yet or
4499 # have been deleted. Includes only instances that would be shown in the
4500 # listManagedInstances method and not all instances that have been
4501 # deleted in the lifetime of the MIG.
4502 # Does not include FlexStart instances that are waiting for the resources
4503 # availability, they are considered as &#x27;pending&#x27;.
4504 &quot;pending&quot;: 42, # Output only. The number of instances in the managed instance group
4505 # that have PENDING status, that is FlexStart instances that are waiting
4506 # for resources. Instances that do not exist because of the other reasons
4507 # are counted as &#x27;non_existent&#x27;.
4508 &quot;pendingStop&quot;: 42, # Output only. The number of instances in the managed instance group
4509 # that have PENDING_STOP status.
4510 &quot;provisioning&quot;: 42, # Output only. The number of instances in the managed instance group
4511 # that have PROVISIONING status.
4512 &quot;repairing&quot;: 42, # Output only. The number of instances in the managed instance group
4513 # that have REPAIRING status.
4514 &quot;running&quot;: 42, # Output only. The number of instances in the managed instance group
4515 # that have RUNNING status.
4516 &quot;staging&quot;: 42, # Output only. The number of instances in the managed instance group
4517 # that have STAGING status.
4518 &quot;stopped&quot;: 42, # Output only. The number of instances in the managed instance group
4519 # that have STOPPED status.
4520 &quot;stopping&quot;: 42, # Output only. The number of instances in the managed instance group
4521 # that have STOPPING status.
4522 &quot;suspended&quot;: 42, # Output only. The number of instances in the managed instance group
4523 # that have SUSPENDED status.
4524 &quot;suspending&quot;: 42, # Output only. The number of instances in the managed instance group
4525 # that have SUSPENDING status.
4526 &quot;terminated&quot;: 42, # Output only. The number of instances in the managed instance group
4527 # that have TERMINATED status.
4528 },
4529 &quot;isStable&quot;: True or False, # Output only. A bit indicating whether the managed instance group is in a
4530 # stable state. A stable state means that: none of the instances in the
4531 # managed instance group is currently undergoing any type of change (for
4532 # example, creation, restart, or deletion); no future changes are scheduled
4533 # for instances in the managed instance group; and the managed instance
4534 # group itself is not being modified.
4535 &quot;stateful&quot;: { # Output only. Stateful status of the given Instance Group Manager.
4536 &quot;hasStatefulConfig&quot;: True or False, # Output only. A bit indicating whether the managed instance group
4537 # has stateful configuration, that is, if you have configured any items
4538 # in a stateful policy or in per-instance configs.
4539 # The group might report that it has no stateful configuration even when
4540 # there is still some preserved state on a managed instance, for example,
4541 # if you have deleted all PICs but not yet applied those deletions.
4542 &quot;perInstanceConfigs&quot;: { # Output only. Status of per-instance configurations on the instances.
4543 &quot;allEffective&quot;: True or False, # Output only. A bit indicating if all of the group&#x27;s per-instance configurations
4544 # (listed in the output of a listPerInstanceConfigs API call) have
4545 # status EFFECTIVE or there are no per-instance-configs.
4546 },
4547 },
4548 &quot;versionTarget&quot;: { # Output only. A status of consistency of Instances&#x27; versions with their
4549 # target version specified by version field on Instance Group
4550 # Manager.
4551 &quot;isReached&quot;: True or False, # Output only. A bit indicating whether version target has been reached
4552 # in this managed instance group, i.e. all instances are in their target
4553 # version. Instances&#x27; target version are specified byversion field on Instance Group Manager.
4554 },
4555 },
4556 &quot;targetPools&quot;: [ # The URLs for all TargetPool resources to which instances in theinstanceGroup field are added. The target pools automatically
4557 # apply to all of the instances in the managed instance group.
4558 &quot;A String&quot;,
4559 ],
4560 &quot;targetSize&quot;: 42, # The target number of running instances for this managed instance group.
4561 # You can reduce this number by using the instanceGroupManager
4562 # deleteInstances or abandonInstances methods. Resizing the group also
4563 # changes this number.
4564 &quot;targetSizePolicy&quot;: { # The policy that specifies how the MIG creates its VMs to achieve the target
4565 # size.
4566 &quot;mode&quot;: &quot;A String&quot;, # The mode of target size policy based on which the MIG creates its VMs
4567 # individually or all at once.
4568 },
4569 &quot;targetStoppedSize&quot;: 42, # The target number of stopped instances for this managed instance group.
4570 # This number changes when you:
4571 #
4572 # - Stop instance using the stopInstances
4573 # method or start instances using the startInstances
4574 # method.
4575 # - Manually change the targetStoppedSize using the update
4576 # method.
4577 &quot;targetSuspendedSize&quot;: 42, # The target number of suspended instances for this managed instance group.
4578 # This number changes when you:
4579 #
4580 # - Suspend instance using the suspendInstances
4581 # method or resume instances using the resumeInstances
4582 # method.
4583 # - Manually change the targetSuspendedSize using the update
4584 # method.
4585 &quot;updatePolicy&quot;: { # The update policy for this managed instance group.
4586 &quot;instanceRedistributionType&quot;: &quot;A String&quot;, # The
4587 # instance redistribution policy for regional managed instance groups.
4588 # Valid values are:
4589 #
4590 # - PROACTIVE (default): The group attempts to maintain an
4591 # even distribution of VM instances across zones in the region.
4592 # - NONE: For non-autoscaled groups, proactive
4593 # redistribution is disabled.
4594 &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
4595 # either a fixed number or, if the group has 10 or more instances, a
4596 # percentage. If you set a percentage, the number of instances is rounded
4597 # if necessary. The default value for maxSurge is a fixed
4598 # value equal to the number of zones in which the managed instance group
4599 # operates.
4600 #
4601 # At least one of either maxSurge ormaxUnavailable must be greater than 0. Learn more about maxSurge.
4602 &quot;calculated&quot;: 42, # Output only. Absolute value of VM instances calculated based on the specific mode.
4603 #
4604 #
4605 #
4606 # - If the value is fixed, then the calculated
4607 # value is equal to the fixed value.
4608 # - If the value is a percent, then the
4609 # calculated
4610 # value is percent/100 * targetSize. For example,
4611 # the calculated value of a 80% of a managed instance group
4612 # with 150 instances would be (80/100 * 150) = 120 VM instances. If there
4613 # is a remainder, the number is rounded.
4614 &quot;fixed&quot;: 42, # Specifies a fixed number of VM instances. This must be a positive integer.
4615 &quot;percent&quot;: 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For
4616 # example, specify 80 for 80%.
4617 },
4618 &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
4619 # process. An instance is considered available if all of the following
4620 # conditions are satisfied:
4621 #
4622 #
4623 #
4624 # - The instance&#x27;s status is
4625 # RUNNING.
4626 # - If there is a health
4627 # check on the instance group, the instance&#x27;s health check status
4628 # must be HEALTHY at least once. If there is no health check
4629 # on the group, then the instance only needs to have a status of
4630 # RUNNING to be considered available.
4631 #
4632 #
4633 # This value can be either a fixed number or, if the group has 10 or more
4634 # instances, a percentage. If you set a percentage, the number of instances
4635 # is rounded if necessary. The default value formaxUnavailable is a fixed value equal to the number of zones
4636 # in which the managed instance group operates.
4637 #
4638 # At least one of either maxSurge ormaxUnavailable must be greater than 0. Learn more about maxUnavailable.
4639 &quot;calculated&quot;: 42, # Output only. Absolute value of VM instances calculated based on the specific mode.
4640 #
4641 #
4642 #
4643 # - If the value is fixed, then the calculated
4644 # value is equal to the fixed value.
4645 # - If the value is a percent, then the
4646 # calculated
4647 # value is percent/100 * targetSize. For example,
4648 # the calculated value of a 80% of a managed instance group
4649 # with 150 instances would be (80/100 * 150) = 120 VM instances. If there
4650 # is a remainder, the number is rounded.
4651 &quot;fixed&quot;: 42, # Specifies a fixed number of VM instances. This must be a positive integer.
4652 &quot;percent&quot;: 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For
4653 # example, specify 80 for 80%.
4654 },
4655 &quot;minimalAction&quot;: &quot;A String&quot;, # Minimal action to be taken on an instance. Use this option to minimize
4656 # disruption as much as possible or to apply a more disruptive action than
4657 # is necessary.
4658 #
4659 # - To limit disruption as much as possible, set the minimal action toREFRESH. If your update requires a more disruptive action,
4660 # Compute Engine performs the necessary action to execute the update.
4661 # - To apply a more disruptive action than is strictly necessary, set the
4662 # minimal action to RESTART or REPLACE. For
4663 # example, Compute Engine does not need to restart a VM to change its
4664 # metadata. But if your application reads instance metadata only when a VM
4665 # is restarted, you can set the minimal action to RESTART in
4666 # order to pick up metadata changes.
4667 &quot;mostDisruptiveAllowedAction&quot;: &quot;A String&quot;, # Most disruptive action that is allowed to be taken on an instance.
4668 # You can specify either NONE to forbid any actions,REFRESH to avoid restarting the VM and to limit disruption
4669 # as much as possible. RESTART to allow actions that can be
4670 # applied without instance replacing or REPLACE to allow all
4671 # possible actions. If the Updater determines that the minimal update
4672 # action needed is more disruptive than most disruptive allowed action you
4673 # specify it will not perform the update at all.
4674 &quot;replacementMethod&quot;: &quot;A String&quot;, # What action should be used to replace instances.
4675 # See minimal_action.REPLACE
4676 &quot;type&quot;: &quot;A String&quot;, # The type
4677 # of update process. You can specify either PROACTIVE so
4678 # that the MIG automatically updates VMs to the latest configurations orOPPORTUNISTIC so that you can select the VMs that you want
4679 # to update.
4680 },
4681 &quot;versions&quot;: [ # Specifies the instance templates used by this managed instance group to
4682 # create instances.
4683 #
4684 # Each version is defined by an instanceTemplate and aname. Every version can appear at most once per instance
4685 # group. This field overrides the top-level instanceTemplate
4686 # field. Read more about therelationships
4687 # between these fields. Exactly one version must leave thetargetSize field unset. That version will be applied to all
4688 # remaining instances. For more information, read aboutcanary
4689 # updates.
4690 {
4691 &quot;instanceTemplate&quot;: &quot;A String&quot;, # The URL of the instance template that is specified for this managed
4692 # instance group. The group uses this template to create new instances in
4693 # the managed instance group until the `targetSize` for this version is
4694 # reached. The templates for existing instances in the group do not change
4695 # unless you run recreateInstances, runapplyUpdatesToInstances, or set the group&#x27;supdatePolicy.type to PROACTIVE; in those cases,
4696 # existing instances are updated until the `targetSize` for this version is
4697 # reached.
4698 &quot;name&quot;: &quot;A String&quot;, # Name of the version. Unique among all versions in the scope of this
4699 # managed instance group.
4700 &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
4701 # from the template will be equal to:
4702 #
4703 #
4704 # - If expressed as a fixed number, the minimum of either
4705 # targetSize.fixed or
4706 # instanceGroupManager.targetSize is used.
4707 # - if expressed as a percent, the targetSize
4708 # would be (targetSize.percent/100 *
4709 # InstanceGroupManager.targetSize) If there is a remainder, the
4710 # number is rounded.
4711 #
4712 # If unset, this version will update any remaining instances not
4713 # updated by another version. ReadStarting
4714 # a canary update for more information.
4715 &quot;calculated&quot;: 42, # Output only. Absolute value of VM instances calculated based on the specific mode.
4716 #
4717 #
4718 #
4719 # - If the value is fixed, then the calculated
4720 # value is equal to the fixed value.
4721 # - If the value is a percent, then the
4722 # calculated
4723 # value is percent/100 * targetSize. For example,
4724 # the calculated value of a 80% of a managed instance group
4725 # with 150 instances would be (80/100 * 150) = 120 VM instances. If there
4726 # is a remainder, the number is rounded.
4727 &quot;fixed&quot;: 42, # Specifies a fixed number of VM instances. This must be a positive integer.
4728 &quot;percent&quot;: 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For
4729 # example, specify 80 for 80%.
4730 },
4731 },
4732 ],
4733 &quot;zone&quot;: &quot;A String&quot;, # Output only. The URL of azone
4734 # where the managed instance group is located (for zonal resources).
4735 },
4736 ],
4737 &quot;kind&quot;: &quot;compute#regionInstanceGroupManagerList&quot;, # Output only. The resource type, which is always compute#instanceGroupManagerList for a
4738 # list of managed instance groups that exist in th regional scope.
4739 &quot;nextPageToken&quot;: &quot;A String&quot;, # Output only. This token allows you to get the next page of results for
4740 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
4741 # the query parameter pageToken in the next list request.
4742 # Subsequent list requests will have their own nextPageToken to
4743 # continue paging through the results.
4744 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. Server-defined URL for this resource.
4745 &quot;warning&quot;: { # Output only. Informational warning message.
4746 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
4747 # Engine returns NO_RESULTS_ON_PAGE if there
4748 # are no results in the response.
4749 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
4750 # value format. For example:
4751 #
4752 # &quot;data&quot;: [
4753 # {
4754 # &quot;key&quot;: &quot;scope&quot;,
4755 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
4756 # }
4757 {
4758 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
4759 # returned. For example, for warnings where there are no results in a list
4760 # request for a particular zone, this key might be scope and
4761 # the key value might be the zone name. Other examples might be a key
4762 # indicating a deprecated resource and a suggested replacement, or a
4763 # warning about invalid network settings (for example, if an instance
4764 # attempts to perform IP forwarding but is not enabled for IP forwarding).
4765 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
4766 },
4767 ],
4768 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
4769 },
4770 }</pre>
4771 </div>
4772
4773 <div class="method">
4774 <code class="details" id="listErrors">listErrors(project, region, instanceGroupManager, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
4775 <pre>Lists all errors thrown by actions on instances for a given regional
4776 managed instance group. The filter andorderBy query parameters are not supported.
4777
4778 Args:
4779 project: string, Project ID for this request. (required)
4780 region: string, Name of the region scoping this request.
4781 This should conform to RFC1035. (required)
4782 instanceGroupManager: string, The name of the managed instance group.
4783 It must be a string that meets the requirements in RFC1035, or an
4784 unsigned long integer: must match regexp pattern:
4785 (?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)|1-9{0,19}. (required)
4786 filter: string, A filter expression that filters resources listed in the response. Most
4787 Compute resources support two types of filter expressions:
4788 expressions that support regular expressions and expressions that follow
4789 API improvement proposal AIP-160.
4790 These two types of filter expressions cannot be mixed in one request.
4791
4792 If you want to use AIP-160, your expression must specify the field name, an
4793 operator, and the value that you want to use for filtering. The value
4794 must be a string, a number, or a boolean. The operator
4795 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
4796
4797 For example, if you are filtering Compute Engine instances, you can
4798 exclude instances named `example-instance` by specifying
4799 `name != example-instance`.
4800
4801 The `:*` comparison can be used to test whether a key has been defined.
4802 For example, to find all objects with `owner` label use:
4803 ```
4804 labels.owner:*
4805 ```
4806
4807 You can also filter nested fields. For example, you could specify
4808 `scheduling.automaticRestart = false` to include instances only
4809 if they are not scheduled for automatic restarts. You can use filtering
4810 on nested fields to filter based onresource labels.
4811
4812 To filter on multiple expressions, provide each separate expression within
4813 parentheses. For example:
4814 ```
4815 (scheduling.automaticRestart = true)
4816 (cpuPlatform = &quot;Intel Skylake&quot;)
4817 ```
4818 By default, each expression is an `AND` expression. However, you
4819 can include `AND` and `OR` expressions explicitly.
4820 For example:
4821 ```
4822 (cpuPlatform = &quot;Intel Skylake&quot;) OR
4823 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
4824 (scheduling.automaticRestart = true)
4825 ```
4826
4827 If you want to use a regular expression, use the `eq` (equal) or `ne`
4828 (not equal) operator against a single un-parenthesized expression with or
4829 without quotes or against multiple parenthesized expressions. Examples:
4830
4831 `fieldname eq unquoted literal`
4832 `fieldname eq &#x27;single quoted literal&#x27;`
4833 `fieldname eq &quot;double quoted literal&quot;`
4834 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
4835
4836 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
4837 The literal value must match the entire field.
4838
4839 For example, to filter for instances that do not end with name &quot;instance&quot;,
4840 you would use `name ne .*instance`.
4841
4842 You cannot combine constraints on multiple fields using regular
4843 expressions.
4844 maxResults: integer, The maximum number of results per page that should be returned.
4845 If the number of available results is larger than `maxResults`,
4846 Compute Engine returns a `nextPageToken` that can be used to get
4847 the next page of results in subsequent list requests. Acceptable values are
4848 `0` to `500`, inclusive. (Default: `500`)
4849 orderBy: string, Sorts list results by a certain order. By default, results
4850 are returned in alphanumerical order based on the resource name.
4851
4852 You can also sort results in descending order based on the creation
4853 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
4854 results based on the `creationTimestamp` field in
4855 reverse chronological order (newest result first). Use this to sort
4856 resources like operations so that the newest operation is returned first.
4857
4858 Currently, only sorting by `name` or
4859 `creationTimestamp desc` is supported.
4860 pageToken: string, Specifies a page token to use. Set `pageToken` to the
4861 `nextPageToken` returned by a previous list request to get
4862 the next page of results.
4863 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
4864 of failure. The default value is false.
4865
4866 For example, when partial success behavior is enabled, aggregatedList for a
4867 single zone scope either returns all resources in the zone or no resources,
4868 with an error code.
4869 x__xgafv: string, V1 error format.
4870 Allowed values
4871 1 - v1 error format
4872 2 - v2 error format
4873
4874 Returns:
4875 An object of the form:
4876
4877 {
4878 &quot;items&quot;: [ # [Output Only] The list of errors of the managed instance group.
4879 {
4880 &quot;error&quot;: { # Output only. Contents of the error.
4881 &quot;code&quot;: &quot;A String&quot;, # Output only. Error code.
4882 &quot;message&quot;: &quot;A String&quot;, # Output only. Error message.
4883 },
4884 &quot;instanceActionDetails&quot;: { # Output only. Details of the instance action that triggered this error.
4885 # May be null, if the error was not caused by an action on an instance.
4886 # This field is optional.
4887 &quot;action&quot;: &quot;A String&quot;, # Output only. Action that managed instance group was executing on the instance when the
4888 # error occurred. Possible values:
4889 &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
4890 # yet been created.
4891 &quot;version&quot;: { # Output only. Version this instance was created from, or was being
4892 # created from, but the creation failed. Corresponds to one of the versions
4893 # that were set on the Instance Group Manager resource at the time this
4894 # instance was being created.
4895 &quot;instanceTemplate&quot;: &quot;A String&quot;, # Output only. [Output Only] The intended template of the instance. This field is empty
4896 # when current_action is one of { DELETING, ABANDONING }.
4897 &quot;name&quot;: &quot;A String&quot;, # Output only. [Output Only] Name of the version.
4898 },
4899 },
4900 &quot;timestamp&quot;: &quot;A String&quot;, # Output only. The time that this error occurred. This value is in RFC3339 text format.
4901 },
4902 ],
4903 &quot;nextPageToken&quot;: &quot;A String&quot;, # Output only. [Output Only] This token allows you to get the next page of results for
4904 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
4905 # the query parameter pageToken in the next list request.
4906 # Subsequent list requests will have their own nextPageToken to
4907 # continue paging through the results.
4908 }</pre>
4909 </div>
4910
4911 <div class="method">
4912 <code class="details" id="listErrors_next">listErrors_next()</code>
4913 <pre>Retrieves the next page of results.
4914
4915 Args:
4916 previous_request: The request for the previous page. (required)
4917 previous_response: The response from the request for the previous page. (required)
4918
4919 Returns:
4920 A request object that you can call &#x27;execute()&#x27; on to request the next
4921 page. Returns None if there are no more items in the collection.
4922 </pre>
4923 </div>
4924
4925 <div class="method">
4926 <code class="details" id="listManagedInstances">listManagedInstances(project, region, instanceGroupManager, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
4927 <pre>Lists the instances in the managed instance group and instances that are
4928 scheduled to be created. The list includes any current actions
4929 that the group has scheduled for its instances. The orderBy
4930 query parameter is not supported. The `pageToken` query parameter is
4931 supported only if the group&#x27;s `listManagedInstancesResults` field is set
4932 to `PAGINATED`.
4933
4934 Args:
4935 project: string, Project ID for this request. (required)
4936 region: string, Name of the region scoping this request. (required)
4937 instanceGroupManager: string, The name of the managed instance group. (required)
4938 filter: string, A filter expression that filters resources listed in the response. Most
4939 Compute resources support two types of filter expressions:
4940 expressions that support regular expressions and expressions that follow
4941 API improvement proposal AIP-160.
4942 These two types of filter expressions cannot be mixed in one request.
4943
4944 If you want to use AIP-160, your expression must specify the field name, an
4945 operator, and the value that you want to use for filtering. The value
4946 must be a string, a number, or a boolean. The operator
4947 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
4948
4949 For example, if you are filtering Compute Engine instances, you can
4950 exclude instances named `example-instance` by specifying
4951 `name != example-instance`.
4952
4953 The `:*` comparison can be used to test whether a key has been defined.
4954 For example, to find all objects with `owner` label use:
4955 ```
4956 labels.owner:*
4957 ```
4958
4959 You can also filter nested fields. For example, you could specify
4960 `scheduling.automaticRestart = false` to include instances only
4961 if they are not scheduled for automatic restarts. You can use filtering
4962 on nested fields to filter based onresource labels.
4963
4964 To filter on multiple expressions, provide each separate expression within
4965 parentheses. For example:
4966 ```
4967 (scheduling.automaticRestart = true)
4968 (cpuPlatform = &quot;Intel Skylake&quot;)
4969 ```
4970 By default, each expression is an `AND` expression. However, you
4971 can include `AND` and `OR` expressions explicitly.
4972 For example:
4973 ```
4974 (cpuPlatform = &quot;Intel Skylake&quot;) OR
4975 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
4976 (scheduling.automaticRestart = true)
4977 ```
4978
4979 If you want to use a regular expression, use the `eq` (equal) or `ne`
4980 (not equal) operator against a single un-parenthesized expression with or
4981 without quotes or against multiple parenthesized expressions. Examples:
4982
4983 `fieldname eq unquoted literal`
4984 `fieldname eq &#x27;single quoted literal&#x27;`
4985 `fieldname eq &quot;double quoted literal&quot;`
4986 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
4987
4988 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
4989 The literal value must match the entire field.
4990
4991 For example, to filter for instances that do not end with name &quot;instance&quot;,
4992 you would use `name ne .*instance`.
4993
4994 You cannot combine constraints on multiple fields using regular
4995 expressions.
4996 maxResults: integer, The maximum number of results per page that should be returned.
4997 If the number of available results is larger than `maxResults`,
4998 Compute Engine returns a `nextPageToken` that can be used to get
4999 the next page of results in subsequent list requests. Acceptable values are
5000 `0` to `500`, inclusive. (Default: `500`)
5001 orderBy: string, Sorts list results by a certain order. By default, results
5002 are returned in alphanumerical order based on the resource name.
5003
5004 You can also sort results in descending order based on the creation
5005 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
5006 results based on the `creationTimestamp` field in
5007 reverse chronological order (newest result first). Use this to sort
5008 resources like operations so that the newest operation is returned first.
5009
5010 Currently, only sorting by `name` or
5011 `creationTimestamp desc` is supported.
5012 pageToken: string, Specifies a page token to use. Set `pageToken` to the
5013 `nextPageToken` returned by a previous list request to get
5014 the next page of results.
5015 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
5016 of failure. The default value is false.
5017
5018 For example, when partial success behavior is enabled, aggregatedList for a
5019 single zone scope either returns all resources in the zone or no resources,
5020 with an error code.
5021 x__xgafv: string, V1 error format.
5022 Allowed values
5023 1 - v1 error format
5024 2 - v2 error format
5025
5026 Returns:
5027 An object of the form:
5028
5029 {
5030 &quot;managedInstances&quot;: [ # A list of managed instances.
5031 { # A Managed Instance resource.
5032 &quot;currentAction&quot;: &quot;A String&quot;, # Output only. [Output Only] The current action that the managed instance group has
5033 # scheduled for the instance. Possible values:
5034 #
5035 # - NONE The instance is running, and the managed
5036 # instance group does not have any scheduled actions for this instance.
5037 # - CREATING The managed instance group is creating this
5038 # instance. If the group fails to create this instance, it will try again
5039 # until it is successful.
5040 # - CREATING_WITHOUT_RETRIES The managed instance group
5041 # is attempting to create this instance only once. If the group fails
5042 # to create this instance, it does not try again and the group&#x27;stargetSize value is decreased instead.
5043 # - RECREATING The managed instance group is recreating
5044 # this instance.
5045 # - DELETING The managed instance group is permanently
5046 # deleting this instance.
5047 # - ABANDONING The managed instance group is abandoning
5048 # this instance. The instance will be removed from the instance group
5049 # and from any target pools that are associated with this group.
5050 # - RESTARTING The managed instance group is restarting
5051 # the instance.
5052 # - REFRESHING The managed instance group is applying
5053 # configuration changes to the instance without stopping it. For example,
5054 # the group can update the target pool list for an instance without
5055 # stopping that instance.
5056 # - VERIFYING The managed instance group has created the
5057 # instance and it is in the process of being verified.
5058 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output only] The unique identifier for this resource. This field is empty
5059 # when instance does not exist.
5060 &quot;instance&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL of the instance. The URL can exist even if the
5061 # instance has not yet been created.
5062 &quot;instanceHealth&quot;: [ # Output only. [Output Only] Health state of the instance per health-check.
5063 {
5064 &quot;detailedHealthState&quot;: &quot;A String&quot;, # Output only. [Output Only] The current detailed instance health state.
5065 &quot;healthCheck&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL for the health check that verifies whether the
5066 # instance is healthy.
5067 },
5068 ],
5069 &quot;instanceStatus&quot;: &quot;A String&quot;, # Output only. [Output Only] The status of the instance. This field is empty when
5070 # the instance does not exist.
5071 &quot;lastAttempt&quot;: { # Output only. [Output Only] Information about the last attempt to create or delete
5072 # the instance.
5073 &quot;errors&quot;: { # Output only. [Output Only] Encountered errors during the last attempt to create or
5074 # delete the instance.
5075 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
5076 # operation.
5077 {
5078 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
5079 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
5080 # details. There is a set of defined message types to use for providing
5081 # details.The syntax depends on the error code. For example,
5082 # QuotaExceededInfo will have details when the error code is
5083 # QUOTA_EXCEEDED.
5084 {
5085 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
5086 #
5087 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
5088 # is not enabled:
5089 #
5090 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
5091 # &quot;domain&quot;: &quot;googleapis.com&quot;
5092 # &quot;metadata&quot;: {
5093 # &quot;resource&quot;: &quot;projects/123&quot;,
5094 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
5095 # }
5096 # }
5097 #
5098 # This response indicates that the pubsub.googleapis.com API is not enabled.
5099 #
5100 # Example of an error that is returned when attempting to create a Spanner
5101 # instance in a region that is out of stock:
5102 #
5103 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
5104 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
5105 # &quot;metadata&quot;: {
5106 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
5107 # }
5108 # }
5109 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
5110 # is typically the registered service name of the tool or product that
5111 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
5112 # generated by some common infrastructure, the error domain must be a
5113 # globally unique value that identifies the infrastructure. For Google API
5114 # infrastructure, the error domain is &quot;googleapis.com&quot;.
5115 &quot;metadatas&quot;: { # Additional structured details about this error.
5116 #
5117 # Keys must match a regular expression of `a-z+` but should
5118 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
5119 # length. When identifying the current value of an exceeded limit, the units
5120 # should be contained in the key, not the value. For example, rather than
5121 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
5122 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
5123 # instances that can be created in a single (batch) request.
5124 &quot;a_key&quot;: &quot;A String&quot;,
5125 },
5126 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
5127 # proximate cause of the error. Error reasons are unique within a particular
5128 # domain of errors. This should be at most 63 characters and match a
5129 # regular expression of `A-Z+[A-Z0-9]`, which represents
5130 # UPPER_SNAKE_CASE.
5131 },
5132 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
5133 #
5134 # For example, if a quota check failed with an error indicating the calling
5135 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
5136 # directly to the right place in the developer console to flip the bit.
5137 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
5138 { # Describes a URL link.
5139 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
5140 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
5141 },
5142 ],
5143 },
5144 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
5145 # which can be attached to an RPC error.
5146 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
5147 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
5148 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
5149 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
5150 },
5151 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
5152 &quot;dimensions&quot;: { # The map holding related quota dimensions.
5153 &quot;a_key&quot;: &quot;A String&quot;,
5154 },
5155 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
5156 # type or metric.
5157 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
5158 # or metric.
5159 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
5160 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
5161 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
5162 },
5163 },
5164 ],
5165 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
5166 # This property is optional.
5167 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
5168 },
5169 ],
5170 },
5171 },
5172 &quot;name&quot;: &quot;A String&quot;, # Output only. [Output Only] The name of the instance. The name always exists even if the
5173 # instance has not yet been created.
5174 &quot;preservedStateFromConfig&quot;: { # Preserved state for a given instance. # Output only. [Output Only] Preserved state applied from per-instance config
5175 # for this instance.
5176 &quot;disks&quot;: { # Preserved disks defined for this instance.
5177 # This map is keyed with the device names of the disks.
5178 &quot;a_key&quot;: {
5179 &quot;autoDelete&quot;: &quot;A String&quot;, # These stateful disks will never be deleted during autohealing,
5180 # update, instance recreate operations. This flag is used to configure
5181 # if the disk should be deleted after it is no longer used by the group,
5182 # e.g. when the given instance or the whole MIG is deleted.
5183 # Note: disks attached in READ_ONLY mode cannot be
5184 # auto-deleted.
5185 &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
5186 # disk in READ_WRITE mode.
5187 &quot;source&quot;: &quot;A String&quot;, # The URL of the disk resource that is stateful and should be attached
5188 # to the VM instance.
5189 },
5190 },
5191 &quot;externalIPs&quot;: { # Preserved external IPs defined for this instance.
5192 # This map is keyed with the name of the network interface.
5193 &quot;a_key&quot;: {
5194 &quot;autoDelete&quot;: &quot;A String&quot;, # These stateful IPs will never be released during autohealing,
5195 # update or VM instance recreate operations.
5196 # This flag is used to configure if the IP reservation should be deleted
5197 # after it is no longer used by the group, e.g. when the given instance
5198 # or the whole group is deleted.
5199 &quot;ipAddress&quot;: { # Ip address representation
5200 &quot;address&quot;: &quot;A String&quot;, # The URL of the reservation for this IP address.
5201 &quot;literal&quot;: &quot;A String&quot;, # An IPv4 internal network address to assign to the instance for this
5202 # network interface.
5203 },
5204 },
5205 },
5206 &quot;internalIPs&quot;: { # Preserved internal IPs defined for this instance.
5207 # This map is keyed with the name of the network interface.
5208 &quot;a_key&quot;: {
5209 &quot;autoDelete&quot;: &quot;A String&quot;, # These stateful IPs will never be released during autohealing,
5210 # update or VM instance recreate operations.
5211 # This flag is used to configure if the IP reservation should be deleted
5212 # after it is no longer used by the group, e.g. when the given instance
5213 # or the whole group is deleted.
5214 &quot;ipAddress&quot;: { # Ip address representation
5215 &quot;address&quot;: &quot;A String&quot;, # The URL of the reservation for this IP address.
5216 &quot;literal&quot;: &quot;A String&quot;, # An IPv4 internal network address to assign to the instance for this
5217 # network interface.
5218 },
5219 },
5220 },
5221 &quot;metadata&quot;: { # Preserved metadata defined for this instance.
5222 &quot;a_key&quot;: &quot;A String&quot;,
5223 },
5224 },
5225 &quot;preservedStateFromPolicy&quot;: { # Preserved state for a given instance. # Output only. [Output Only] Preserved state generated based on stateful policy
5226 # for this instance.
5227 &quot;disks&quot;: { # Preserved disks defined for this instance.
5228 # This map is keyed with the device names of the disks.
5229 &quot;a_key&quot;: {
5230 &quot;autoDelete&quot;: &quot;A String&quot;, # These stateful disks will never be deleted during autohealing,
5231 # update, instance recreate operations. This flag is used to configure
5232 # if the disk should be deleted after it is no longer used by the group,
5233 # e.g. when the given instance or the whole MIG is deleted.
5234 # Note: disks attached in READ_ONLY mode cannot be
5235 # auto-deleted.
5236 &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
5237 # disk in READ_WRITE mode.
5238 &quot;source&quot;: &quot;A String&quot;, # The URL of the disk resource that is stateful and should be attached
5239 # to the VM instance.
5240 },
5241 },
5242 &quot;externalIPs&quot;: { # Preserved external IPs defined for this instance.
5243 # This map is keyed with the name of the network interface.
5244 &quot;a_key&quot;: {
5245 &quot;autoDelete&quot;: &quot;A String&quot;, # These stateful IPs will never be released during autohealing,
5246 # update or VM instance recreate operations.
5247 # This flag is used to configure if the IP reservation should be deleted
5248 # after it is no longer used by the group, e.g. when the given instance
5249 # or the whole group is deleted.
5250 &quot;ipAddress&quot;: { # Ip address representation
5251 &quot;address&quot;: &quot;A String&quot;, # The URL of the reservation for this IP address.
5252 &quot;literal&quot;: &quot;A String&quot;, # An IPv4 internal network address to assign to the instance for this
5253 # network interface.
5254 },
5255 },
5256 },
5257 &quot;internalIPs&quot;: { # Preserved internal IPs defined for this instance.
5258 # This map is keyed with the name of the network interface.
5259 &quot;a_key&quot;: {
5260 &quot;autoDelete&quot;: &quot;A String&quot;, # These stateful IPs will never be released during autohealing,
5261 # update or VM instance recreate operations.
5262 # This flag is used to configure if the IP reservation should be deleted
5263 # after it is no longer used by the group, e.g. when the given instance
5264 # or the whole group is deleted.
5265 &quot;ipAddress&quot;: { # Ip address representation
5266 &quot;address&quot;: &quot;A String&quot;, # The URL of the reservation for this IP address.
5267 &quot;literal&quot;: &quot;A String&quot;, # An IPv4 internal network address to assign to the instance for this
5268 # network interface.
5269 },
5270 },
5271 },
5272 &quot;metadata&quot;: { # Preserved metadata defined for this instance.
5273 &quot;a_key&quot;: &quot;A String&quot;,
5274 },
5275 },
5276 &quot;propertiesFromFlexibilityPolicy&quot;: { # Output only. [Output Only] Instance properties selected for this instance resulting from
5277 # InstanceFlexibilityPolicy.
5278 &quot;machineType&quot;: &quot;A String&quot;, # Output only. The machine type to be used for this instance.
5279 },
5280 &quot;version&quot;: { # Output only. [Output Only] Intended version of this instance.
5281 &quot;instanceTemplate&quot;: &quot;A String&quot;, # Output only. [Output Only] The intended template of the instance. This field is empty
5282 # when current_action is one of { DELETING, ABANDONING }.
5283 &quot;name&quot;: &quot;A String&quot;, # Output only. [Output Only] Name of the version.
5284 },
5285 },
5286 ],
5287 &quot;nextPageToken&quot;: &quot;A String&quot;, # Output only. [Output Only] This token allows you to get the next page of results for
5288 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
5289 # the query parameter pageToken in the next list request.
5290 # Subsequent list requests will have their own nextPageToken to
5291 # continue paging through the results.
5292 }</pre>
5293 </div>
5294
5295 <div class="method">
5296 <code class="details" id="listManagedInstances_next">listManagedInstances_next()</code>
5297 <pre>Retrieves the next page of results.
5298
5299 Args:
5300 previous_request: The request for the previous page. (required)
5301 previous_response: The response from the request for the previous page. (required)
5302
5303 Returns:
5304 A request object that you can call &#x27;execute()&#x27; on to request the next
5305 page. Returns None if there are no more items in the collection.
5306 </pre>
5307 </div>
5308
5309 <div class="method">
5310 <code class="details" id="listPerInstanceConfigs">listPerInstanceConfigs(project, region, instanceGroupManager, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
5311 <pre>Lists all of the per-instance configurations defined for the managed
5312 instance group. The orderBy query parameter is not supported.
5313
5314 Args:
5315 project: string, Project ID for this request. (required)
5316 region: string, Name of the region scoping this request, should conform to RFC1035. (required)
5317 instanceGroupManager: string, The name of the managed instance group. It should conform to RFC1035. (required)
5318 filter: string, A filter expression that filters resources listed in the response. Most
5319 Compute resources support two types of filter expressions:
5320 expressions that support regular expressions and expressions that follow
5321 API improvement proposal AIP-160.
5322 These two types of filter expressions cannot be mixed in one request.
5323
5324 If you want to use AIP-160, your expression must specify the field name, an
5325 operator, and the value that you want to use for filtering. The value
5326 must be a string, a number, or a boolean. The operator
5327 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
5328
5329 For example, if you are filtering Compute Engine instances, you can
5330 exclude instances named `example-instance` by specifying
5331 `name != example-instance`.
5332
5333 The `:*` comparison can be used to test whether a key has been defined.
5334 For example, to find all objects with `owner` label use:
5335 ```
5336 labels.owner:*
5337 ```
5338
5339 You can also filter nested fields. For example, you could specify
5340 `scheduling.automaticRestart = false` to include instances only
5341 if they are not scheduled for automatic restarts. You can use filtering
5342 on nested fields to filter based onresource labels.
5343
5344 To filter on multiple expressions, provide each separate expression within
5345 parentheses. For example:
5346 ```
5347 (scheduling.automaticRestart = true)
5348 (cpuPlatform = &quot;Intel Skylake&quot;)
5349 ```
5350 By default, each expression is an `AND` expression. However, you
5351 can include `AND` and `OR` expressions explicitly.
5352 For example:
5353 ```
5354 (cpuPlatform = &quot;Intel Skylake&quot;) OR
5355 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
5356 (scheduling.automaticRestart = true)
5357 ```
5358
5359 If you want to use a regular expression, use the `eq` (equal) or `ne`
5360 (not equal) operator against a single un-parenthesized expression with or
5361 without quotes or against multiple parenthesized expressions. Examples:
5362
5363 `fieldname eq unquoted literal`
5364 `fieldname eq &#x27;single quoted literal&#x27;`
5365 `fieldname eq &quot;double quoted literal&quot;`
5366 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
5367
5368 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
5369 The literal value must match the entire field.
5370
5371 For example, to filter for instances that do not end with name &quot;instance&quot;,
5372 you would use `name ne .*instance`.
5373
5374 You cannot combine constraints on multiple fields using regular
5375 expressions.
5376 maxResults: integer, The maximum number of results per page that should be returned.
5377 If the number of available results is larger than `maxResults`,
5378 Compute Engine returns a `nextPageToken` that can be used to get
5379 the next page of results in subsequent list requests. Acceptable values are
5380 `0` to `500`, inclusive. (Default: `500`)
5381 orderBy: string, Sorts list results by a certain order. By default, results
5382 are returned in alphanumerical order based on the resource name.
5383
5384 You can also sort results in descending order based on the creation
5385 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
5386 results based on the `creationTimestamp` field in
5387 reverse chronological order (newest result first). Use this to sort
5388 resources like operations so that the newest operation is returned first.
5389
5390 Currently, only sorting by `name` or
5391 `creationTimestamp desc` is supported.
5392 pageToken: string, Specifies a page token to use. Set `pageToken` to the
5393 `nextPageToken` returned by a previous list request to get
5394 the next page of results.
5395 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
5396 of failure. The default value is false.
5397
5398 For example, when partial success behavior is enabled, aggregatedList for a
5399 single zone scope either returns all resources in the zone or no resources,
5400 with an error code.
5401 x__xgafv: string, V1 error format.
5402 Allowed values
5403 1 - v1 error format
5404 2 - v2 error format
5405
5406 Returns:
5407 An object of the form:
5408
5409 {
5410 &quot;items&quot;: [ # Output only. [Output Only] The list of PerInstanceConfig.
5411 {
5412 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this per-instance config. This field can be used in
5413 # optimistic locking. It is ignored when inserting a per-instance
5414 # config. An up-to-date fingerprint must be provided in order to update an
5415 # existing per-instance configuration or the field needs to be unset.
5416 &quot;name&quot;: &quot;A String&quot;, # The name of a per-instance configuration and its corresponding instance.
5417 # Serves as a merge key during UpdatePerInstanceConfigs
5418 # operations, that is, if a per-instance configuration with the same name
5419 # exists then it will be updated, otherwise a new one will be created for the
5420 # VM instance with the same name. An attempt to create a per-instance
5421 # configuration for a VM instance that either doesn&#x27;t exist or is not part
5422 # of the group will result in an error.
5423 &quot;preservedState&quot;: { # Preserved state for a given instance. # The intended preserved state for the given instance. Does not contain
5424 # preserved state generated from a stateful policy.
5425 &quot;disks&quot;: { # Preserved disks defined for this instance.
5426 # This map is keyed with the device names of the disks.
5427 &quot;a_key&quot;: {
5428 &quot;autoDelete&quot;: &quot;A String&quot;, # These stateful disks will never be deleted during autohealing,
5429 # update, instance recreate operations. This flag is used to configure
5430 # if the disk should be deleted after it is no longer used by the group,
5431 # e.g. when the given instance or the whole MIG is deleted.
5432 # Note: disks attached in READ_ONLY mode cannot be
5433 # auto-deleted.
5434 &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
5435 # disk in READ_WRITE mode.
5436 &quot;source&quot;: &quot;A String&quot;, # The URL of the disk resource that is stateful and should be attached
5437 # to the VM instance.
5438 },
5439 },
5440 &quot;externalIPs&quot;: { # Preserved external IPs defined for this instance.
5441 # This map is keyed with the name of the network interface.
5442 &quot;a_key&quot;: {
5443 &quot;autoDelete&quot;: &quot;A String&quot;, # These stateful IPs will never be released during autohealing,
5444 # update or VM instance recreate operations.
5445 # This flag is used to configure if the IP reservation should be deleted
5446 # after it is no longer used by the group, e.g. when the given instance
5447 # or the whole group is deleted.
5448 &quot;ipAddress&quot;: { # Ip address representation
5449 &quot;address&quot;: &quot;A String&quot;, # The URL of the reservation for this IP address.
5450 &quot;literal&quot;: &quot;A String&quot;, # An IPv4 internal network address to assign to the instance for this
5451 # network interface.
5452 },
5453 },
5454 },
5455 &quot;internalIPs&quot;: { # Preserved internal IPs defined for this instance.
5456 # This map is keyed with the name of the network interface.
5457 &quot;a_key&quot;: {
5458 &quot;autoDelete&quot;: &quot;A String&quot;, # These stateful IPs will never be released during autohealing,
5459 # update or VM instance recreate operations.
5460 # This flag is used to configure if the IP reservation should be deleted
5461 # after it is no longer used by the group, e.g. when the given instance
5462 # or the whole group is deleted.
5463 &quot;ipAddress&quot;: { # Ip address representation
5464 &quot;address&quot;: &quot;A String&quot;, # The URL of the reservation for this IP address.
5465 &quot;literal&quot;: &quot;A String&quot;, # An IPv4 internal network address to assign to the instance for this
5466 # network interface.
5467 },
5468 },
5469 },
5470 &quot;metadata&quot;: { # Preserved metadata defined for this instance.
5471 &quot;a_key&quot;: &quot;A String&quot;,
5472 },
5473 },
5474 &quot;status&quot;: &quot;A String&quot;, # The status of applying this per-instance configuration on the corresponding
5475 # managed instance.
5476 },
5477 ],
5478 &quot;nextPageToken&quot;: &quot;A String&quot;, # Output only. [Output Only] This token allows you to get the next page of results for
5479 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
5480 # the query parameter pageToken in the next list request.
5481 # Subsequent list requests will have their own nextPageToken to
5482 # continue paging through the results.
5483 &quot;warning&quot;: { # Output only. [Output Only] Informational warning message.
5484 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
5485 # Engine returns NO_RESULTS_ON_PAGE if there
5486 # are no results in the response.
5487 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
5488 # value format. For example:
5489 #
5490 # &quot;data&quot;: [
5491 # {
5492 # &quot;key&quot;: &quot;scope&quot;,
5493 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
5494 # }
5495 {
5496 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
5497 # returned. For example, for warnings where there are no results in a list
5498 # request for a particular zone, this key might be scope and
5499 # the key value might be the zone name. Other examples might be a key
5500 # indicating a deprecated resource and a suggested replacement, or a
5501 # warning about invalid network settings (for example, if an instance
5502 # attempts to perform IP forwarding but is not enabled for IP forwarding).
5503 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
5504 },
5505 ],
5506 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
5507 },
5508 }</pre>
5509 </div>
5510
5511 <div class="method">
5512 <code class="details" id="listPerInstanceConfigs_next">listPerInstanceConfigs_next()</code>
5513 <pre>Retrieves the next page of results.
5514
5515 Args:
5516 previous_request: The request for the previous page. (required)
5517 previous_response: The response from the request for the previous page. (required)
5518
5519 Returns:
5520 A request object that you can call &#x27;execute()&#x27; on to request the next
5521 page. Returns None if there are no more items in the collection.
5522 </pre>
5523 </div>
5524
5525 <div class="method">
5526 <code class="details" id="list_next">list_next()</code>
5527 <pre>Retrieves the next page of results.
5528
5529 Args:
5530 previous_request: The request for the previous page. (required)
5531 previous_response: The response from the request for the previous page. (required)
5532
5533 Returns:
5534 A request object that you can call &#x27;execute()&#x27; on to request the next
5535 page. Returns None if there are no more items in the collection.
5536 </pre>
5537 </div>
5538
5539 <div class="method">
5540 <code class="details" id="patch">patch(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
5541 <pre>Updates a managed instance group using the information that you specify
5542 in the request.
5543 This operation is marked as DONE when the group is patched
5544 even if the instances in the group are still in the process of being
5545 patched. You must separately verify the status of the individual instances
5546 with the listmanagedinstances
5547 method. This method supportsPATCH
5548 semantics and uses theJSON merge
5549 patch format and processing rules.
5550
5551 If you update your group to specify a new template or instance
5552 configuration, it&#x27;s possible that your intended specification for each VM
5553 in the group is different from the current state of that VM. To learn how
5554 to apply an updated configuration to the VMs in a MIG, seeUpdating instances in
5555 a MIG.
5556
5557 Args:
5558 project: string, Project ID for this request. (required)
5559 region: string, Name of the region scoping this request. (required)
5560 instanceGroupManager: string, The name of the instance group manager. (required)
5561 body: object, The request body.
5562 The object takes the form of:
5563
5564 { # Represents a Managed Instance Group resource.
5565 #
5566 # An instance group is a collection of VM instances that you can manage as a
5567 # single entity. For more information, readInstance groups.
5568 #
5569 # For zonal Managed Instance Group, use the instanceGroupManagers
5570 # resource.
5571 #
5572 # For regional Managed Instance Group, use theregionInstanceGroupManagers resource.
5573 &quot;allInstancesConfig&quot;: { # Specifies configuration that overrides the instance template configuration
5574 # for the group.
5575 &quot;properties&quot;: { # Represents the change that you want to make to the instance properties. # Properties to set on all instances in the group.
5576 #
5577 # You can add or modify properties using theinstanceGroupManagers.patch orregionInstanceGroupManagers.patch. After settingallInstancesConfig on the group, you must update the group&#x27;s
5578 # instances to apply the configuration. To apply the configuration, set the
5579 # group&#x27;s updatePolicy.type field to use proactive updates or
5580 # use the applyUpdatesToInstances method.
5581 &quot;labels&quot;: { # The label key-value pairs that you want to patch onto the instance.
5582 &quot;a_key&quot;: &quot;A String&quot;,
5583 },
5584 &quot;metadata&quot;: { # The metadata key-value pairs that you want to patch onto the instance. For
5585 # more information, see Project and
5586 # instance metadata.
5587 &quot;a_key&quot;: &quot;A String&quot;,
5588 },
5589 },
5590 },
5591 &quot;autoHealingPolicies&quot;: [ # The autohealing policy for this managed instance group. You can specify
5592 # only one value.
5593 {
5594 &quot;healthCheck&quot;: &quot;A String&quot;, # The URL for the health check that signals autohealing.
5595 &quot;initialDelaySec&quot;: 42, # The initial delay is the number of seconds that a new VM takes to
5596 # initialize and run its startup script. During a VM&#x27;s initial delay
5597 # period, the MIG ignores unsuccessful health checks because the VM might
5598 # be in the startup process. This prevents the MIG from prematurely
5599 # recreating a VM. If the health check receives a healthy response during
5600 # the initial delay, it indicates that the startup process is complete and
5601 # the VM is ready. The value of initial delay must be between 0 and 3600
5602 # seconds. The default value is 0.
5603 },
5604 ],
5605 &quot;baseInstanceName&quot;: &quot;A String&quot;, # The base instance name is a prefix that you want to attach to the names of
5606 # all VMs in a MIG. The maximum character length is 58 and the name must
5607 # comply with RFC1035 format.
5608 #
5609 # When a VM is created in the group, the MIG appends a hyphen and a random
5610 # four-character string to the base instance name. If you want the MIG to
5611 # assign sequential numbers instead of a random string, then end the base
5612 # instance name with a hyphen followed by one or more hash symbols. The hash
5613 # symbols indicate the number of digits. For example, a base instance name of
5614 # &quot;vm-###&quot; results in &quot;vm-001&quot; as a VM name.
5615 # @pattern
5616 # [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,51}-#{1,10}(\\[[0-9]{1,10}\\])?))
5617 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. The creation timestamp for this managed instance group inRFC3339
5618 # text format.
5619 &quot;currentActions&quot;: { # Output only. The list of instance actions and the number of instances
5620 # in this managed instance group that are scheduled for each of those
5621 # actions.
5622 &quot;abandoning&quot;: 42, # Output only. The total number of instances in the managed instance group
5623 # that are scheduled to be abandoned. Abandoning an instance removes it
5624 # from the managed instance group without deleting it.
5625 &quot;creating&quot;: 42, # Output only. The number of instances in the managed instance group that
5626 # are scheduled to be created or are currently being created. If the group
5627 # fails to create any of these instances, it tries again until it creates
5628 # the instance successfully.
5629 #
5630 # If you have disabled creation retries, this field will not be populated;
5631 # instead, the creatingWithoutRetries field will be populated.
5632 &quot;creatingWithoutRetries&quot;: 42, # Output only. The number of instances that the managed instance group
5633 # will attempt to create. The group attempts to create each instance
5634 # only once. If the group fails to create any of these instances, it
5635 # decreases the group&#x27;s targetSize value accordingly.
5636 &quot;deleting&quot;: 42, # Output only. The number of instances in the managed instance group that
5637 # are scheduled to be deleted or are currently being deleted.
5638 &quot;none&quot;: 42, # Output only. The number of instances in the managed instance group that
5639 # are running and have no scheduled actions.
5640 &quot;recreating&quot;: 42, # Output only. The number of instances in the managed instance group that
5641 # are scheduled to be recreated or are currently being being recreated.
5642 # Recreating an instance deletes the existing root persistent disk
5643 # and creates a new disk from the image that is defined in the
5644 # instance template.
5645 &quot;refreshing&quot;: 42, # Output only. The number of instances in the managed instance group that
5646 # are being reconfigured with properties that do not require a restart
5647 # or a recreate action. For example, setting or removing target
5648 # pools for the instance.
5649 &quot;restarting&quot;: 42, # Output only. The number of instances in the managed instance group that
5650 # are scheduled to be restarted or are currently being restarted.
5651 &quot;resuming&quot;: 42, # Output only. The number of instances in the managed instance group that
5652 # are scheduled to be resumed or are currently being resumed.
5653 &quot;starting&quot;: 42, # Output only. The number of instances in the managed instance group that
5654 # are scheduled to be started or are currently being started.
5655 &quot;stopping&quot;: 42, # Output only. The number of instances in the managed instance group that
5656 # are scheduled to be stopped or are currently being stopped.
5657 &quot;suspending&quot;: 42, # Output only. The number of instances in the managed instance group that
5658 # are scheduled to be suspended or are currently being suspended.
5659 &quot;verifying&quot;: 42, # Output only. The number of instances in the managed instance group that
5660 # are being verified. See the managedInstances[].currentAction
5661 # property in the listManagedInstances method documentation.
5662 },
5663 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource.
5664 &quot;distributionPolicy&quot;: { # Policy specifying the intended distribution of managed instances across
5665 # zones in a regional managed instance group.
5666 &quot;targetShape&quot;: &quot;A String&quot;, # The distribution shape to which the group converges either proactively or
5667 # on resize events (depending on the value set inupdatePolicy.instanceRedistributionType).
5668 &quot;zones&quot;: [ # Zones where the regional managed instance group will create and manage
5669 # its instances.
5670 # By default, a regional MIG doesn&#x27;t automatically select an AI zone to create
5671 # instances, even if an AI zone is available in the specified region. To
5672 # create instances in an AI zone in the selected region, you must explicitly
5673 # specify it in the distribution policy together with the other preferred
5674 # zones.
5675 {
5676 &quot;zone&quot;: &quot;A String&quot;, # The URL of thezone.
5677 # The zone must exist in the region where the managed instance group is
5678 # located.
5679 },
5680 ],
5681 },
5682 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. This field may be used in optimistic locking.
5683 # It will be ignored when inserting an InstanceGroupManager. An up-to-date
5684 # fingerprint must be provided in order to update the InstanceGroupManager,
5685 # otherwise the request will fail with error412 conditionNotMet.
5686 #
5687 # To see the latest fingerprint, make a get() request to
5688 # retrieve an InstanceGroupManager.
5689 &quot;id&quot;: &quot;A String&quot;, # Output only. A unique identifier for this resource type. The server
5690 # generates this identifier.
5691 &quot;instanceFlexibilityPolicy&quot;: { # Instance flexibility allowing MIG to create VMs from multiple
5692 # types of machines.
5693 # Instance flexibility configuration on MIG overrides instance
5694 # template configuration.
5695 &quot;instanceSelections&quot;: { # Named instance selections configuring properties that the group will use
5696 # when creating new VMs.
5697 &quot;a_key&quot;: {
5698 &quot;machineTypes&quot;: [ # Full machine-type names, e.g. &quot;n1-standard-16&quot;.
5699 &quot;A String&quot;,
5700 ],
5701 &quot;rank&quot;: 42, # Preference of this instance selection. Lower number means higher
5702 # preference. MIG will first try to create a VM based on the machine-type
5703 # with lowest rank and fallback to next rank based on availability.
5704 # Machine types and instance selections with the same rank have the same
5705 # preference.
5706 },
5707 },
5708 },
5709 &quot;instanceGroup&quot;: &quot;A String&quot;, # Output only. The URL of the Instance Group resource.
5710 &quot;instanceLifecyclePolicy&quot;: { # The repair policy for this managed instance group.
5711 &quot;defaultActionOnFailure&quot;: &quot;A String&quot;, # The action that a MIG performs on a failed VM. If the value of the
5712 # onFailedHealthCheck field is `DEFAULT_ACTION`, then the same action also
5713 # applies to the VMs on which your application fails a health check.
5714 # Valid values are
5715 #
5716 # - REPAIR (default): MIG automatically repairs a failed VM
5717 # by recreating it. For more information, see About
5718 # repairing VMs in a MIG.
5719 # - DO_NOTHING: MIG does not repair a failed VM.
5720 &quot;forceUpdateOnRepair&quot;: &quot;A String&quot;, # A bit indicating whether to forcefully apply the group&#x27;s latest
5721 # configuration when repairing a VM. Valid options are:
5722 #
5723 #
5724 #
5725 # - NO (default): If configuration updates are available, they are not
5726 # forcefully applied during repair. Instead, configuration updates are
5727 # applied according to the group&#x27;s update policy.
5728 #
5729 # - YES: If configuration updates are available, they are applied
5730 # during repair.
5731 &quot;onFailedHealthCheck&quot;: &quot;A String&quot;, # The action that a MIG performs on an unhealthy VM. A VM is marked as
5732 # unhealthy when the application running on that VM fails a health check.
5733 # Valid values are:
5734 #
5735 # - DEFAULT_ACTION (default): MIG uses the same action
5736 # configured for instanceLifecyclePolicy.defaultActionOnFailure field.
5737 # - REPAIR: MIG automatically repairs an unhealthy VM by
5738 # recreating it.
5739 # - DO_NOTHING: MIG doesn&#x27;t repair an unhealthy VM.
5740 # For more information, see
5741 # About repairing VMs in a MIG.
5742 &quot;onRepair&quot;: { # Configuration for VM repairs in the MIG. # Configuration for VM repairs in the MIG.
5743 &quot;allowChangingZone&quot;: &quot;A String&quot;, # Specifies whether the MIG can change a VM&#x27;s zone during a repair.
5744 # Valid values are:
5745 #
5746 # - NO (default): MIG cannot change a VM&#x27;s zone during a
5747 # repair.
5748 # - YES: MIG can select a different zone for the VM during
5749 # a repair.
5750 },
5751 },
5752 &quot;instanceTemplate&quot;: &quot;A String&quot;, # The URL of the instance template that is specified for this managed
5753 # instance group. The group uses this template to create all new instances
5754 # in the managed instance group. The templates for existing instances in the
5755 # group do not change unless you run recreateInstances, runapplyUpdatesToInstances, or set the group&#x27;supdatePolicy.type to PROACTIVE.
5756 &quot;kind&quot;: &quot;compute#instanceGroupManager&quot;, # Output only. The resource type, which is alwayscompute#instanceGroupManager for managed instance groups.
5757 &quot;listManagedInstancesResults&quot;: &quot;A String&quot;, # Pagination behavior of the listManagedInstances API method for
5758 # this managed instance group.
5759 &quot;name&quot;: &quot;A String&quot;, # The name of the managed instance group. The name must be 1-63 characters
5760 # long, and comply withRFC1035.
5761 &quot;namedPorts&quot;: [ # [Output Only] Named ports configured on the Instance Groups complementary
5762 # to this Instance Group Manager.
5763 { # The named port. For example: &lt;&quot;http&quot;, 80&gt;.
5764 &quot;name&quot;: &quot;A String&quot;, # The name for this named port.
5765 # The name must be 1-63 characters long, and comply withRFC1035.
5766 &quot;port&quot;: 42, # The port number, which can be a value between 1 and 65535.
5767 },
5768 ],
5769 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL of theregion
5770 # where the managed instance group resides (for regional resources).
5771 &quot;resourcePolicies&quot;: { # Resource policies for this managed instance group.
5772 &quot;workloadPolicy&quot;: &quot;A String&quot;, # The URL of the workload policy that is specified for this managed
5773 # instance group.
5774 # It can be a full or partial URL. For example, the following are
5775 # all valid URLs to a workload policy:
5776 #
5777 #
5778 # - https://www.googleapis.com/compute/v1/projects/project/regions/region/resourcePolicies/resourcePolicy
5779 # - projects/project/regions/region/resourcePolicies/resourcePolicy
5780 # - regions/region/resourcePolicies/resourcePolicy
5781 },
5782 &quot;satisfiesPzi&quot;: True or False, # Output only. Reserved for future use.
5783 &quot;satisfiesPzs&quot;: True or False, # Output only. Reserved for future use.
5784 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. The URL for this managed instance group. The server defines
5785 # this URL.
5786 &quot;standbyPolicy&quot;: { # Standby policy for stopped and suspended instances.
5787 &quot;initialDelaySec&quot;: 42, # Specifies the number of seconds that the MIG should wait to suspend or
5788 # stop a VM after that VM was created. The initial delay gives the
5789 # initialization script the time to prepare your VM for a quick scale out.
5790 # The value of initial delay must be between 0 and 3600 seconds. The
5791 # default value is 0.
5792 &quot;mode&quot;: &quot;A String&quot;, # Defines how a MIG resumes or starts VMs from a standby pool when the
5793 # group scales out. The default mode is `MANUAL`.
5794 },
5795 &quot;statefulPolicy&quot;: { # Stateful configuration for this Instanced Group Manager
5796 &quot;preservedState&quot;: { # Configuration of preserved resources.
5797 &quot;disks&quot;: { # Disks created on the instances that will be preserved on instance
5798 # delete, update, etc. This map is keyed with the device names of
5799 # the disks.
5800 &quot;a_key&quot;: {
5801 &quot;autoDelete&quot;: &quot;A String&quot;, # These stateful disks will never be deleted during autohealing,
5802 # update or VM instance recreate operations.
5803 # This flag is used to configure if the disk should be deleted after it
5804 # is no longer used by the group, e.g. when the given instance or
5805 # the whole group is deleted. Note: disks attached inREAD_ONLY mode cannot be auto-deleted.
5806 },
5807 },
5808 &quot;externalIPs&quot;: { # External network IPs assigned to the instances that will be preserved on
5809 # instance delete, update, etc. This map is keyed with the network
5810 # interface name.
5811 &quot;a_key&quot;: {
5812 &quot;autoDelete&quot;: &quot;A String&quot;, # These stateful IPs will never be released during autohealing,
5813 # update or VM instance recreate operations.
5814 # This flag is used to configure if the IP reservation should be deleted
5815 # after it is no longer used by the group, e.g. when the given instance
5816 # or the whole group is deleted.
5817 },
5818 },
5819 &quot;internalIPs&quot;: { # Internal network IPs assigned to the instances that will be preserved on
5820 # instance delete, update, etc. This map is keyed with the network
5821 # interface name.
5822 &quot;a_key&quot;: {
5823 &quot;autoDelete&quot;: &quot;A String&quot;, # These stateful IPs will never be released during autohealing,
5824 # update or VM instance recreate operations.
5825 # This flag is used to configure if the IP reservation should be deleted
5826 # after it is no longer used by the group, e.g. when the given instance
5827 # or the whole group is deleted.
5828 },
5829 },
5830 },
5831 },
5832 &quot;status&quot;: { # Output only. The status of this managed instance group.
5833 &quot;allInstancesConfig&quot;: { # Output only. Status of all-instances configuration on the group.
5834 &quot;currentRevision&quot;: &quot;A String&quot;, # Output only. Current all-instances configuration revision.
5835 # This value is in RFC3339 text format.
5836 &quot;effective&quot;: True or False, # Output only. A bit indicating whether this configuration has
5837 # been applied to all managed instances in the group.
5838 },
5839 &quot;appliedAcceleratorTopologies&quot;: [ # Output only. The accelerator topology applied to this MIG.
5840 # Currently only one accelerator topology is supported.
5841 {
5842 &quot;acceleratorTopology&quot;: &quot;A String&quot;, # Output only. Topology in the format of: &quot;16x16&quot;, &quot;4x4x4&quot;, etc.
5843 # The value is the same as configured in the WorkloadPolicy.
5844 &quot;state&quot;: &quot;A String&quot;, # Output only. The state of the accelerator topology.
5845 &quot;stateDetails&quot;: { # Output only. The result of the latest accelerator topology state
5846 # check.
5847 &quot;error&quot;: { # Output only. Encountered errors.
5848 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
5849 # operation.
5850 {
5851 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
5852 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
5853 # details. There is a set of defined message types to use for providing
5854 # details.The syntax depends on the error code. For example,
5855 # QuotaExceededInfo will have details when the error code is
5856 # QUOTA_EXCEEDED.
5857 {
5858 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
5859 #
5860 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
5861 # is not enabled:
5862 #
5863 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
5864 # &quot;domain&quot;: &quot;googleapis.com&quot;
5865 # &quot;metadata&quot;: {
5866 # &quot;resource&quot;: &quot;projects/123&quot;,
5867 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
5868 # }
5869 # }
5870 #
5871 # This response indicates that the pubsub.googleapis.com API is not enabled.
5872 #
5873 # Example of an error that is returned when attempting to create a Spanner
5874 # instance in a region that is out of stock:
5875 #
5876 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
5877 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
5878 # &quot;metadata&quot;: {
5879 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
5880 # }
5881 # }
5882 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
5883 # is typically the registered service name of the tool or product that
5884 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
5885 # generated by some common infrastructure, the error domain must be a
5886 # globally unique value that identifies the infrastructure. For Google API
5887 # infrastructure, the error domain is &quot;googleapis.com&quot;.
5888 &quot;metadatas&quot;: { # Additional structured details about this error.
5889 #
5890 # Keys must match a regular expression of `a-z+` but should
5891 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
5892 # length. When identifying the current value of an exceeded limit, the units
5893 # should be contained in the key, not the value. For example, rather than
5894 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
5895 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
5896 # instances that can be created in a single (batch) request.
5897 &quot;a_key&quot;: &quot;A String&quot;,
5898 },
5899 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
5900 # proximate cause of the error. Error reasons are unique within a particular
5901 # domain of errors. This should be at most 63 characters and match a
5902 # regular expression of `A-Z+[A-Z0-9]`, which represents
5903 # UPPER_SNAKE_CASE.
5904 },
5905 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
5906 #
5907 # For example, if a quota check failed with an error indicating the calling
5908 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
5909 # directly to the right place in the developer console to flip the bit.
5910 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
5911 { # Describes a URL link.
5912 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
5913 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
5914 },
5915 ],
5916 },
5917 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
5918 # which can be attached to an RPC error.
5919 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
5920 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
5921 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
5922 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
5923 },
5924 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
5925 &quot;dimensions&quot;: { # The map holding related quota dimensions.
5926 &quot;a_key&quot;: &quot;A String&quot;,
5927 },
5928 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
5929 # type or metric.
5930 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
5931 # or metric.
5932 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
5933 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
5934 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
5935 },
5936 },
5937 ],
5938 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
5939 # This property is optional.
5940 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
5941 },
5942 ],
5943 },
5944 &quot;timestamp&quot;: &quot;A String&quot;, # Output only. Timestamp is shown only if there is an error. The field
5945 # has // RFC3339 //
5946 # text format.
5947 },
5948 },
5949 ],
5950 &quot;autoscaler&quot;: &quot;A String&quot;, # Output only. The URL of theAutoscaler
5951 # that targets this instance group manager.
5952 &quot;bulkInstanceOperation&quot;: { # Bulk instance operation is the creation of VMs in a MIG when the # Output only. The status of bulk instance operation.
5953 # targetSizePolicy.mode is set to BULK.
5954 &quot;inProgress&quot;: True or False, # Output only. Informs whether bulk instance operation is in progress.
5955 &quot;lastProgressCheck&quot;: { # Output only. Information from the last progress check of bulk instance
5956 # operation.
5957 &quot;error&quot;: { # Output only. Errors encountered during bulk instance operation.
5958 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
5959 # operation.
5960 {
5961 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
5962 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
5963 # details. There is a set of defined message types to use for providing
5964 # details.The syntax depends on the error code. For example,
5965 # QuotaExceededInfo will have details when the error code is
5966 # QUOTA_EXCEEDED.
5967 {
5968 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
5969 #
5970 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
5971 # is not enabled:
5972 #
5973 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
5974 # &quot;domain&quot;: &quot;googleapis.com&quot;
5975 # &quot;metadata&quot;: {
5976 # &quot;resource&quot;: &quot;projects/123&quot;,
5977 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
5978 # }
5979 # }
5980 #
5981 # This response indicates that the pubsub.googleapis.com API is not enabled.
5982 #
5983 # Example of an error that is returned when attempting to create a Spanner
5984 # instance in a region that is out of stock:
5985 #
5986 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
5987 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
5988 # &quot;metadata&quot;: {
5989 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
5990 # }
5991 # }
5992 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
5993 # is typically the registered service name of the tool or product that
5994 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
5995 # generated by some common infrastructure, the error domain must be a
5996 # globally unique value that identifies the infrastructure. For Google API
5997 # infrastructure, the error domain is &quot;googleapis.com&quot;.
5998 &quot;metadatas&quot;: { # Additional structured details about this error.
5999 #
6000 # Keys must match a regular expression of `a-z+` but should
6001 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
6002 # length. When identifying the current value of an exceeded limit, the units
6003 # should be contained in the key, not the value. For example, rather than
6004 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
6005 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
6006 # instances that can be created in a single (batch) request.
6007 &quot;a_key&quot;: &quot;A String&quot;,
6008 },
6009 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
6010 # proximate cause of the error. Error reasons are unique within a particular
6011 # domain of errors. This should be at most 63 characters and match a
6012 # regular expression of `A-Z+[A-Z0-9]`, which represents
6013 # UPPER_SNAKE_CASE.
6014 },
6015 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
6016 #
6017 # For example, if a quota check failed with an error indicating the calling
6018 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
6019 # directly to the right place in the developer console to flip the bit.
6020 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
6021 { # Describes a URL link.
6022 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
6023 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
6024 },
6025 ],
6026 },
6027 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
6028 # which can be attached to an RPC error.
6029 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
6030 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
6031 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
6032 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
6033 },
6034 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
6035 &quot;dimensions&quot;: { # The map holding related quota dimensions.
6036 &quot;a_key&quot;: &quot;A String&quot;,
6037 },
6038 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
6039 # type or metric.
6040 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
6041 # or metric.
6042 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
6043 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
6044 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
6045 },
6046 },
6047 ],
6048 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
6049 # This property is optional.
6050 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
6051 },
6052 ],
6053 },
6054 &quot;timestamp&quot;: &quot;A String&quot;, # Output only. Timestamp of the last progress check of bulk instance
6055 # operation. Timestamp is in RFC3339 text format.
6056 },
6057 },
6058 &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
6059 # in this managed instance group that have the status. Currently only shown
6060 # for TPU MIGs
6061 # instance group that have the status. For more information about how to
6062 # interpret each status check the instance lifecycle documentation.
6063 # Currently only shown for TPU MIGs.
6064 &quot;deprovisioning&quot;: 42, # Output only. The number of instances in the managed instance group
6065 # that have DEPROVISIONING status.
6066 &quot;nonExistent&quot;: 42, # Output only. The number of instances that have not been created yet or
6067 # have been deleted. Includes only instances that would be shown in the
6068 # listManagedInstances method and not all instances that have been
6069 # deleted in the lifetime of the MIG.
6070 # Does not include FlexStart instances that are waiting for the resources
6071 # availability, they are considered as &#x27;pending&#x27;.
6072 &quot;pending&quot;: 42, # Output only. The number of instances in the managed instance group
6073 # that have PENDING status, that is FlexStart instances that are waiting
6074 # for resources. Instances that do not exist because of the other reasons
6075 # are counted as &#x27;non_existent&#x27;.
6076 &quot;pendingStop&quot;: 42, # Output only. The number of instances in the managed instance group
6077 # that have PENDING_STOP status.
6078 &quot;provisioning&quot;: 42, # Output only. The number of instances in the managed instance group
6079 # that have PROVISIONING status.
6080 &quot;repairing&quot;: 42, # Output only. The number of instances in the managed instance group
6081 # that have REPAIRING status.
6082 &quot;running&quot;: 42, # Output only. The number of instances in the managed instance group
6083 # that have RUNNING status.
6084 &quot;staging&quot;: 42, # Output only. The number of instances in the managed instance group
6085 # that have STAGING status.
6086 &quot;stopped&quot;: 42, # Output only. The number of instances in the managed instance group
6087 # that have STOPPED status.
6088 &quot;stopping&quot;: 42, # Output only. The number of instances in the managed instance group
6089 # that have STOPPING status.
6090 &quot;suspended&quot;: 42, # Output only. The number of instances in the managed instance group
6091 # that have SUSPENDED status.
6092 &quot;suspending&quot;: 42, # Output only. The number of instances in the managed instance group
6093 # that have SUSPENDING status.
6094 &quot;terminated&quot;: 42, # Output only. The number of instances in the managed instance group
6095 # that have TERMINATED status.
6096 },
6097 &quot;isStable&quot;: True or False, # Output only. A bit indicating whether the managed instance group is in a
6098 # stable state. A stable state means that: none of the instances in the
6099 # managed instance group is currently undergoing any type of change (for
6100 # example, creation, restart, or deletion); no future changes are scheduled
6101 # for instances in the managed instance group; and the managed instance
6102 # group itself is not being modified.
6103 &quot;stateful&quot;: { # Output only. Stateful status of the given Instance Group Manager.
6104 &quot;hasStatefulConfig&quot;: True or False, # Output only. A bit indicating whether the managed instance group
6105 # has stateful configuration, that is, if you have configured any items
6106 # in a stateful policy or in per-instance configs.
6107 # The group might report that it has no stateful configuration even when
6108 # there is still some preserved state on a managed instance, for example,
6109 # if you have deleted all PICs but not yet applied those deletions.
6110 &quot;perInstanceConfigs&quot;: { # Output only. Status of per-instance configurations on the instances.
6111 &quot;allEffective&quot;: True or False, # Output only. A bit indicating if all of the group&#x27;s per-instance configurations
6112 # (listed in the output of a listPerInstanceConfigs API call) have
6113 # status EFFECTIVE or there are no per-instance-configs.
6114 },
6115 },
6116 &quot;versionTarget&quot;: { # Output only. A status of consistency of Instances&#x27; versions with their
6117 # target version specified by version field on Instance Group
6118 # Manager.
6119 &quot;isReached&quot;: True or False, # Output only. A bit indicating whether version target has been reached
6120 # in this managed instance group, i.e. all instances are in their target
6121 # version. Instances&#x27; target version are specified byversion field on Instance Group Manager.
6122 },
6123 },
6124 &quot;targetPools&quot;: [ # The URLs for all TargetPool resources to which instances in theinstanceGroup field are added. The target pools automatically
6125 # apply to all of the instances in the managed instance group.
6126 &quot;A String&quot;,
6127 ],
6128 &quot;targetSize&quot;: 42, # The target number of running instances for this managed instance group.
6129 # You can reduce this number by using the instanceGroupManager
6130 # deleteInstances or abandonInstances methods. Resizing the group also
6131 # changes this number.
6132 &quot;targetSizePolicy&quot;: { # The policy that specifies how the MIG creates its VMs to achieve the target
6133 # size.
6134 &quot;mode&quot;: &quot;A String&quot;, # The mode of target size policy based on which the MIG creates its VMs
6135 # individually or all at once.
6136 },
6137 &quot;targetStoppedSize&quot;: 42, # The target number of stopped instances for this managed instance group.
6138 # This number changes when you:
6139 #
6140 # - Stop instance using the stopInstances
6141 # method or start instances using the startInstances
6142 # method.
6143 # - Manually change the targetStoppedSize using the update
6144 # method.
6145 &quot;targetSuspendedSize&quot;: 42, # The target number of suspended instances for this managed instance group.
6146 # This number changes when you:
6147 #
6148 # - Suspend instance using the suspendInstances
6149 # method or resume instances using the resumeInstances
6150 # method.
6151 # - Manually change the targetSuspendedSize using the update
6152 # method.
6153 &quot;updatePolicy&quot;: { # The update policy for this managed instance group.
6154 &quot;instanceRedistributionType&quot;: &quot;A String&quot;, # The
6155 # instance redistribution policy for regional managed instance groups.
6156 # Valid values are:
6157 #
6158 # - PROACTIVE (default): The group attempts to maintain an
6159 # even distribution of VM instances across zones in the region.
6160 # - NONE: For non-autoscaled groups, proactive
6161 # redistribution is disabled.
6162 &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
6163 # either a fixed number or, if the group has 10 or more instances, a
6164 # percentage. If you set a percentage, the number of instances is rounded
6165 # if necessary. The default value for maxSurge is a fixed
6166 # value equal to the number of zones in which the managed instance group
6167 # operates.
6168 #
6169 # At least one of either maxSurge ormaxUnavailable must be greater than 0. Learn more about maxSurge.
6170 &quot;calculated&quot;: 42, # Output only. Absolute value of VM instances calculated based on the specific mode.
6171 #
6172 #
6173 #
6174 # - If the value is fixed, then the calculated
6175 # value is equal to the fixed value.
6176 # - If the value is a percent, then the
6177 # calculated
6178 # value is percent/100 * targetSize. For example,
6179 # the calculated value of a 80% of a managed instance group
6180 # with 150 instances would be (80/100 * 150) = 120 VM instances. If there
6181 # is a remainder, the number is rounded.
6182 &quot;fixed&quot;: 42, # Specifies a fixed number of VM instances. This must be a positive integer.
6183 &quot;percent&quot;: 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For
6184 # example, specify 80 for 80%.
6185 },
6186 &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
6187 # process. An instance is considered available if all of the following
6188 # conditions are satisfied:
6189 #
6190 #
6191 #
6192 # - The instance&#x27;s status is
6193 # RUNNING.
6194 # - If there is a health
6195 # check on the instance group, the instance&#x27;s health check status
6196 # must be HEALTHY at least once. If there is no health check
6197 # on the group, then the instance only needs to have a status of
6198 # RUNNING to be considered available.
6199 #
6200 #
6201 # This value can be either a fixed number or, if the group has 10 or more
6202 # instances, a percentage. If you set a percentage, the number of instances
6203 # is rounded if necessary. The default value formaxUnavailable is a fixed value equal to the number of zones
6204 # in which the managed instance group operates.
6205 #
6206 # At least one of either maxSurge ormaxUnavailable must be greater than 0. Learn more about maxUnavailable.
6207 &quot;calculated&quot;: 42, # Output only. Absolute value of VM instances calculated based on the specific mode.
6208 #
6209 #
6210 #
6211 # - If the value is fixed, then the calculated
6212 # value is equal to the fixed value.
6213 # - If the value is a percent, then the
6214 # calculated
6215 # value is percent/100 * targetSize. For example,
6216 # the calculated value of a 80% of a managed instance group
6217 # with 150 instances would be (80/100 * 150) = 120 VM instances. If there
6218 # is a remainder, the number is rounded.
6219 &quot;fixed&quot;: 42, # Specifies a fixed number of VM instances. This must be a positive integer.
6220 &quot;percent&quot;: 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For
6221 # example, specify 80 for 80%.
6222 },
6223 &quot;minimalAction&quot;: &quot;A String&quot;, # Minimal action to be taken on an instance. Use this option to minimize
6224 # disruption as much as possible or to apply a more disruptive action than
6225 # is necessary.
6226 #
6227 # - To limit disruption as much as possible, set the minimal action toREFRESH. If your update requires a more disruptive action,
6228 # Compute Engine performs the necessary action to execute the update.
6229 # - To apply a more disruptive action than is strictly necessary, set the
6230 # minimal action to RESTART or REPLACE. For
6231 # example, Compute Engine does not need to restart a VM to change its
6232 # metadata. But if your application reads instance metadata only when a VM
6233 # is restarted, you can set the minimal action to RESTART in
6234 # order to pick up metadata changes.
6235 &quot;mostDisruptiveAllowedAction&quot;: &quot;A String&quot;, # Most disruptive action that is allowed to be taken on an instance.
6236 # You can specify either NONE to forbid any actions,REFRESH to avoid restarting the VM and to limit disruption
6237 # as much as possible. RESTART to allow actions that can be
6238 # applied without instance replacing or REPLACE to allow all
6239 # possible actions. If the Updater determines that the minimal update
6240 # action needed is more disruptive than most disruptive allowed action you
6241 # specify it will not perform the update at all.
6242 &quot;replacementMethod&quot;: &quot;A String&quot;, # What action should be used to replace instances.
6243 # See minimal_action.REPLACE
6244 &quot;type&quot;: &quot;A String&quot;, # The type
6245 # of update process. You can specify either PROACTIVE so
6246 # that the MIG automatically updates VMs to the latest configurations orOPPORTUNISTIC so that you can select the VMs that you want
6247 # to update.
6248 },
6249 &quot;versions&quot;: [ # Specifies the instance templates used by this managed instance group to
6250 # create instances.
6251 #
6252 # Each version is defined by an instanceTemplate and aname. Every version can appear at most once per instance
6253 # group. This field overrides the top-level instanceTemplate
6254 # field. Read more about therelationships
6255 # between these fields. Exactly one version must leave thetargetSize field unset. That version will be applied to all
6256 # remaining instances. For more information, read aboutcanary
6257 # updates.
6258 {
6259 &quot;instanceTemplate&quot;: &quot;A String&quot;, # The URL of the instance template that is specified for this managed
6260 # instance group. The group uses this template to create new instances in
6261 # the managed instance group until the `targetSize` for this version is
6262 # reached. The templates for existing instances in the group do not change
6263 # unless you run recreateInstances, runapplyUpdatesToInstances, or set the group&#x27;supdatePolicy.type to PROACTIVE; in those cases,
6264 # existing instances are updated until the `targetSize` for this version is
6265 # reached.
6266 &quot;name&quot;: &quot;A String&quot;, # Name of the version. Unique among all versions in the scope of this
6267 # managed instance group.
6268 &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
6269 # from the template will be equal to:
6270 #
6271 #
6272 # - If expressed as a fixed number, the minimum of either
6273 # targetSize.fixed or
6274 # instanceGroupManager.targetSize is used.
6275 # - if expressed as a percent, the targetSize
6276 # would be (targetSize.percent/100 *
6277 # InstanceGroupManager.targetSize) If there is a remainder, the
6278 # number is rounded.
6279 #
6280 # If unset, this version will update any remaining instances not
6281 # updated by another version. ReadStarting
6282 # a canary update for more information.
6283 &quot;calculated&quot;: 42, # Output only. Absolute value of VM instances calculated based on the specific mode.
6284 #
6285 #
6286 #
6287 # - If the value is fixed, then the calculated
6288 # value is equal to the fixed value.
6289 # - If the value is a percent, then the
6290 # calculated
6291 # value is percent/100 * targetSize. For example,
6292 # the calculated value of a 80% of a managed instance group
6293 # with 150 instances would be (80/100 * 150) = 120 VM instances. If there
6294 # is a remainder, the number is rounded.
6295 &quot;fixed&quot;: 42, # Specifies a fixed number of VM instances. This must be a positive integer.
6296 &quot;percent&quot;: 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For
6297 # example, specify 80 for 80%.
6298 },
6299 },
6300 ],
6301 &quot;zone&quot;: &quot;A String&quot;, # Output only. The URL of azone
6302 # where the managed instance group is located (for zonal resources).
6303 }
6304
6305 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
6306 that if you must retry your request, the server will know to ignore the
6307 request if it has already been completed.
6308
6309 For example, consider a situation where you make an initial request and
6310 the request times out. If you make the request again with the same
6311 request ID, the server can check if original operation with the same
6312 request ID was received, and if so, will ignore the second request. This
6313 prevents clients from accidentally creating duplicate commitments.
6314
6315 The request ID must be
6316 a valid UUID with the exception that zero UUID is not supported
6317 (00000000-0000-0000-0000-000000000000).
6318 x__xgafv: string, V1 error format.
6319 Allowed values
6320 1 - v1 error format
6321 2 - v2 error format
6322
6323 Returns:
6324 An object of the form:
6325
6326 { # Represents an Operation resource.
6327 #
6328 # Google Compute Engine has three Operation resources:
6329 #
6330 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
6331 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
6332 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
6333 #
6334 # You can use an operation resource to manage asynchronous API requests.
6335 # For more information, readHandling
6336 # API responses.
6337 #
6338 # Operations can be global, regional or zonal.
6339 #
6340 # - For global operations, use the `globalOperations`
6341 # resource.
6342 # - For regional operations, use the
6343 # `regionOperations` resource.
6344 # - For zonal operations, use
6345 # the `zoneOperations` resource.
6346 #
6347 #
6348 #
6349 # For more information, read
6350 # Global, Regional, and Zonal Resources.
6351 #
6352 # Note that completed Operation resources have a limited
6353 # retention period.
6354 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
6355 # Not present otherwise.
6356 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
6357 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
6358 # set when the operation is created.
6359 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
6360 # text format.
6361 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
6362 # this field will be populated.
6363 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
6364 # operation.
6365 {
6366 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
6367 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
6368 # details. There is a set of defined message types to use for providing
6369 # details.The syntax depends on the error code. For example,
6370 # QuotaExceededInfo will have details when the error code is
6371 # QUOTA_EXCEEDED.
6372 {
6373 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
6374 #
6375 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
6376 # is not enabled:
6377 #
6378 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
6379 # &quot;domain&quot;: &quot;googleapis.com&quot;
6380 # &quot;metadata&quot;: {
6381 # &quot;resource&quot;: &quot;projects/123&quot;,
6382 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
6383 # }
6384 # }
6385 #
6386 # This response indicates that the pubsub.googleapis.com API is not enabled.
6387 #
6388 # Example of an error that is returned when attempting to create a Spanner
6389 # instance in a region that is out of stock:
6390 #
6391 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
6392 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
6393 # &quot;metadata&quot;: {
6394 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
6395 # }
6396 # }
6397 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
6398 # is typically the registered service name of the tool or product that
6399 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
6400 # generated by some common infrastructure, the error domain must be a
6401 # globally unique value that identifies the infrastructure. For Google API
6402 # infrastructure, the error domain is &quot;googleapis.com&quot;.
6403 &quot;metadatas&quot;: { # Additional structured details about this error.
6404 #
6405 # Keys must match a regular expression of `a-z+` but should
6406 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
6407 # length. When identifying the current value of an exceeded limit, the units
6408 # should be contained in the key, not the value. For example, rather than
6409 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
6410 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
6411 # instances that can be created in a single (batch) request.
6412 &quot;a_key&quot;: &quot;A String&quot;,
6413 },
6414 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
6415 # proximate cause of the error. Error reasons are unique within a particular
6416 # domain of errors. This should be at most 63 characters and match a
6417 # regular expression of `A-Z+[A-Z0-9]`, which represents
6418 # UPPER_SNAKE_CASE.
6419 },
6420 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
6421 #
6422 # For example, if a quota check failed with an error indicating the calling
6423 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
6424 # directly to the right place in the developer console to flip the bit.
6425 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
6426 { # Describes a URL link.
6427 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
6428 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
6429 },
6430 ],
6431 },
6432 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
6433 # which can be attached to an RPC error.
6434 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
6435 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
6436 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
6437 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
6438 },
6439 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
6440 &quot;dimensions&quot;: { # The map holding related quota dimensions.
6441 &quot;a_key&quot;: &quot;A String&quot;,
6442 },
6443 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
6444 # type or metric.
6445 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
6446 # or metric.
6447 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
6448 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
6449 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
6450 },
6451 },
6452 ],
6453 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
6454 # This property is optional.
6455 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
6456 },
6457 ],
6458 },
6459 &quot;getVersionOperationMetadata&quot;: {
6460 &quot;inlineSbomInfo&quot;: {
6461 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
6462 # appropriate identifiers.
6463 &quot;a_key&quot;: &quot;A String&quot;,
6464 },
6465 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
6466 # identifiers.
6467 &quot;a_key&quot;: &quot;A String&quot;,
6468 },
6469 },
6470 },
6471 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
6472 # message that was returned, such as `NOT FOUND`.
6473 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
6474 # status code that was returned. For example, a `404` means the
6475 # resource was not found.
6476 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
6477 # defined by the server.
6478 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
6479 # This value is inRFC3339
6480 # text format.
6481 &quot;instancesBulkInsertOperationMetadata&quot;: {
6482 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
6483 # Example key: zones/us-central1-a
6484 &quot;a_key&quot;: {
6485 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
6486 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
6487 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
6488 # error.
6489 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
6490 # if the flow is rolling forward or rolling back.
6491 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
6492 },
6493 },
6494 },
6495 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
6496 # Operation resources.
6497 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
6498 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
6499 # group of operations results from a `bulkInsert` API request.
6500 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
6501 # `update`, or `delete`, and so on.
6502 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
6503 # There is no requirement that this be linear or support any granularity of
6504 # operations. This should not be used to guess when the operation will be
6505 # complete. This number should monotonically increase as the operation
6506 # progresses.
6507 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
6508 # applicable when performing regional operations.
6509 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
6510 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
6511 # this field will contain information on all underlying zonal actions and
6512 # their state.
6513 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
6514 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
6515 # Example key: zones/us-central1-a
6516 &quot;a_key&quot;: {
6517 &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
6518 # populated.
6519 # different programming environments, including REST APIs and RPC APIs. It is
6520 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
6521 # three pieces of data: error code, error message, and error details.
6522 #
6523 # You can find out more about this error model and how to work with it in the
6524 # [API Design Guide](https://cloud.google.com/apis/design/errors).
6525 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
6526 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
6527 # message types for APIs to use.
6528 {
6529 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
6530 },
6531 ],
6532 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
6533 # user-facing error message should be localized and sent in the
6534 # google.rpc.Status.details field, or localized by the client.
6535 },
6536 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
6537 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
6538 },
6539 },
6540 },
6541 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
6542 # This value is inRFC3339
6543 # text format.
6544 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
6545 # following:
6546 # `PENDING`, `RUNNING`, or `DONE`.
6547 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
6548 # operation.
6549 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
6550 # of the target resource.
6551 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
6552 # operations related to creating a snapshot, this points to the disk
6553 # that the snapshot was created from.
6554 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
6555 # `[email protected]` or
6556 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
6557 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
6558 # operation, this field will be populated.
6559 {
6560 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
6561 # Engine returns NO_RESULTS_ON_PAGE if there
6562 # are no results in the response.
6563 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
6564 # value format. For example:
6565 #
6566 # &quot;data&quot;: [
6567 # {
6568 # &quot;key&quot;: &quot;scope&quot;,
6569 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
6570 # }
6571 {
6572 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
6573 # returned. For example, for warnings where there are no results in a list
6574 # request for a particular zone, this key might be scope and
6575 # the key value might be the zone name. Other examples might be a key
6576 # indicating a deprecated resource and a suggested replacement, or a
6577 # warning about invalid network settings (for example, if an instance
6578 # attempts to perform IP forwarding but is not enabled for IP forwarding).
6579 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
6580 },
6581 ],
6582 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
6583 },
6584 ],
6585 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
6586 # applicable when performing per-zone operations.
6587 }</pre>
6588 </div>
6589
6590 <div class="method">
6591 <code class="details" id="patchPerInstanceConfigs">patchPerInstanceConfigs(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
6592 <pre>Inserts or patches per-instance configurations for the managed instance
6593 group. perInstanceConfig.name serves as a key used to
6594 distinguish whether to perform insert or patch.
6595
6596 Args:
6597 project: string, Project ID for this request. (required)
6598 region: string, Name of the region scoping this request, should conform to RFC1035. (required)
6599 instanceGroupManager: string, The name of the managed instance group.
6600 It should conform to RFC1035. (required)
6601 body: object, The request body.
6602 The object takes the form of:
6603
6604 { # RegionInstanceGroupManagers.patchPerInstanceConfigs
6605 &quot;perInstanceConfigs&quot;: [ # The list of per-instance configurations to insert or patch on this managed
6606 # instance group.
6607 {
6608 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this per-instance config. This field can be used in
6609 # optimistic locking. It is ignored when inserting a per-instance
6610 # config. An up-to-date fingerprint must be provided in order to update an
6611 # existing per-instance configuration or the field needs to be unset.
6612 &quot;name&quot;: &quot;A String&quot;, # The name of a per-instance configuration and its corresponding instance.
6613 # Serves as a merge key during UpdatePerInstanceConfigs
6614 # operations, that is, if a per-instance configuration with the same name
6615 # exists then it will be updated, otherwise a new one will be created for the
6616 # VM instance with the same name. An attempt to create a per-instance
6617 # configuration for a VM instance that either doesn&#x27;t exist or is not part
6618 # of the group will result in an error.
6619 &quot;preservedState&quot;: { # Preserved state for a given instance. # The intended preserved state for the given instance. Does not contain
6620 # preserved state generated from a stateful policy.
6621 &quot;disks&quot;: { # Preserved disks defined for this instance.
6622 # This map is keyed with the device names of the disks.
6623 &quot;a_key&quot;: {
6624 &quot;autoDelete&quot;: &quot;A String&quot;, # These stateful disks will never be deleted during autohealing,
6625 # update, instance recreate operations. This flag is used to configure
6626 # if the disk should be deleted after it is no longer used by the group,
6627 # e.g. when the given instance or the whole MIG is deleted.
6628 # Note: disks attached in READ_ONLY mode cannot be
6629 # auto-deleted.
6630 &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
6631 # disk in READ_WRITE mode.
6632 &quot;source&quot;: &quot;A String&quot;, # The URL of the disk resource that is stateful and should be attached
6633 # to the VM instance.
6634 },
6635 },
6636 &quot;externalIPs&quot;: { # Preserved external IPs defined for this instance.
6637 # This map is keyed with the name of the network interface.
6638 &quot;a_key&quot;: {
6639 &quot;autoDelete&quot;: &quot;A String&quot;, # These stateful IPs will never be released during autohealing,
6640 # update or VM instance recreate operations.
6641 # This flag is used to configure if the IP reservation should be deleted
6642 # after it is no longer used by the group, e.g. when the given instance
6643 # or the whole group is deleted.
6644 &quot;ipAddress&quot;: { # Ip address representation
6645 &quot;address&quot;: &quot;A String&quot;, # The URL of the reservation for this IP address.
6646 &quot;literal&quot;: &quot;A String&quot;, # An IPv4 internal network address to assign to the instance for this
6647 # network interface.
6648 },
6649 },
6650 },
6651 &quot;internalIPs&quot;: { # Preserved internal IPs defined for this instance.
6652 # This map is keyed with the name of the network interface.
6653 &quot;a_key&quot;: {
6654 &quot;autoDelete&quot;: &quot;A String&quot;, # These stateful IPs will never be released during autohealing,
6655 # update or VM instance recreate operations.
6656 # This flag is used to configure if the IP reservation should be deleted
6657 # after it is no longer used by the group, e.g. when the given instance
6658 # or the whole group is deleted.
6659 &quot;ipAddress&quot;: { # Ip address representation
6660 &quot;address&quot;: &quot;A String&quot;, # The URL of the reservation for this IP address.
6661 &quot;literal&quot;: &quot;A String&quot;, # An IPv4 internal network address to assign to the instance for this
6662 # network interface.
6663 },
6664 },
6665 },
6666 &quot;metadata&quot;: { # Preserved metadata defined for this instance.
6667 &quot;a_key&quot;: &quot;A String&quot;,
6668 },
6669 },
6670 &quot;status&quot;: &quot;A String&quot;, # The status of applying this per-instance configuration on the corresponding
6671 # managed instance.
6672 },
6673 ],
6674 }
6675
6676 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
6677 that if you must retry your request, the server will know to ignore the
6678 request if it has already been completed.
6679
6680 For example, consider a situation where you make an initial request and
6681 the request times out. If you make the request again with the same
6682 request ID, the server can check if original operation with the same
6683 request ID was received, and if so, will ignore the second request. This
6684 prevents clients from accidentally creating duplicate commitments.
6685
6686 The request ID must be
6687 a valid UUID with the exception that zero UUID is not supported
6688 (00000000-0000-0000-0000-000000000000).
6689 x__xgafv: string, V1 error format.
6690 Allowed values
6691 1 - v1 error format
6692 2 - v2 error format
6693
6694 Returns:
6695 An object of the form:
6696
6697 { # Represents an Operation resource.
6698 #
6699 # Google Compute Engine has three Operation resources:
6700 #
6701 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
6702 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
6703 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
6704 #
6705 # You can use an operation resource to manage asynchronous API requests.
6706 # For more information, readHandling
6707 # API responses.
6708 #
6709 # Operations can be global, regional or zonal.
6710 #
6711 # - For global operations, use the `globalOperations`
6712 # resource.
6713 # - For regional operations, use the
6714 # `regionOperations` resource.
6715 # - For zonal operations, use
6716 # the `zoneOperations` resource.
6717 #
6718 #
6719 #
6720 # For more information, read
6721 # Global, Regional, and Zonal Resources.
6722 #
6723 # Note that completed Operation resources have a limited
6724 # retention period.
6725 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
6726 # Not present otherwise.
6727 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
6728 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
6729 # set when the operation is created.
6730 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
6731 # text format.
6732 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
6733 # this field will be populated.
6734 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
6735 # operation.
6736 {
6737 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
6738 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
6739 # details. There is a set of defined message types to use for providing
6740 # details.The syntax depends on the error code. For example,
6741 # QuotaExceededInfo will have details when the error code is
6742 # QUOTA_EXCEEDED.
6743 {
6744 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
6745 #
6746 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
6747 # is not enabled:
6748 #
6749 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
6750 # &quot;domain&quot;: &quot;googleapis.com&quot;
6751 # &quot;metadata&quot;: {
6752 # &quot;resource&quot;: &quot;projects/123&quot;,
6753 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
6754 # }
6755 # }
6756 #
6757 # This response indicates that the pubsub.googleapis.com API is not enabled.
6758 #
6759 # Example of an error that is returned when attempting to create a Spanner
6760 # instance in a region that is out of stock:
6761 #
6762 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
6763 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
6764 # &quot;metadata&quot;: {
6765 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
6766 # }
6767 # }
6768 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
6769 # is typically the registered service name of the tool or product that
6770 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
6771 # generated by some common infrastructure, the error domain must be a
6772 # globally unique value that identifies the infrastructure. For Google API
6773 # infrastructure, the error domain is &quot;googleapis.com&quot;.
6774 &quot;metadatas&quot;: { # Additional structured details about this error.
6775 #
6776 # Keys must match a regular expression of `a-z+` but should
6777 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
6778 # length. When identifying the current value of an exceeded limit, the units
6779 # should be contained in the key, not the value. For example, rather than
6780 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
6781 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
6782 # instances that can be created in a single (batch) request.
6783 &quot;a_key&quot;: &quot;A String&quot;,
6784 },
6785 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
6786 # proximate cause of the error. Error reasons are unique within a particular
6787 # domain of errors. This should be at most 63 characters and match a
6788 # regular expression of `A-Z+[A-Z0-9]`, which represents
6789 # UPPER_SNAKE_CASE.
6790 },
6791 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
6792 #
6793 # For example, if a quota check failed with an error indicating the calling
6794 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
6795 # directly to the right place in the developer console to flip the bit.
6796 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
6797 { # Describes a URL link.
6798 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
6799 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
6800 },
6801 ],
6802 },
6803 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
6804 # which can be attached to an RPC error.
6805 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
6806 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
6807 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
6808 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
6809 },
6810 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
6811 &quot;dimensions&quot;: { # The map holding related quota dimensions.
6812 &quot;a_key&quot;: &quot;A String&quot;,
6813 },
6814 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
6815 # type or metric.
6816 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
6817 # or metric.
6818 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
6819 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
6820 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
6821 },
6822 },
6823 ],
6824 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
6825 # This property is optional.
6826 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
6827 },
6828 ],
6829 },
6830 &quot;getVersionOperationMetadata&quot;: {
6831 &quot;inlineSbomInfo&quot;: {
6832 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
6833 # appropriate identifiers.
6834 &quot;a_key&quot;: &quot;A String&quot;,
6835 },
6836 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
6837 # identifiers.
6838 &quot;a_key&quot;: &quot;A String&quot;,
6839 },
6840 },
6841 },
6842 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
6843 # message that was returned, such as `NOT FOUND`.
6844 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
6845 # status code that was returned. For example, a `404` means the
6846 # resource was not found.
6847 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
6848 # defined by the server.
6849 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
6850 # This value is inRFC3339
6851 # text format.
6852 &quot;instancesBulkInsertOperationMetadata&quot;: {
6853 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
6854 # Example key: zones/us-central1-a
6855 &quot;a_key&quot;: {
6856 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
6857 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
6858 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
6859 # error.
6860 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
6861 # if the flow is rolling forward or rolling back.
6862 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
6863 },
6864 },
6865 },
6866 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
6867 # Operation resources.
6868 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
6869 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
6870 # group of operations results from a `bulkInsert` API request.
6871 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
6872 # `update`, or `delete`, and so on.
6873 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
6874 # There is no requirement that this be linear or support any granularity of
6875 # operations. This should not be used to guess when the operation will be
6876 # complete. This number should monotonically increase as the operation
6877 # progresses.
6878 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
6879 # applicable when performing regional operations.
6880 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
6881 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
6882 # this field will contain information on all underlying zonal actions and
6883 # their state.
6884 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
6885 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
6886 # Example key: zones/us-central1-a
6887 &quot;a_key&quot;: {
6888 &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
6889 # populated.
6890 # different programming environments, including REST APIs and RPC APIs. It is
6891 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
6892 # three pieces of data: error code, error message, and error details.
6893 #
6894 # You can find out more about this error model and how to work with it in the
6895 # [API Design Guide](https://cloud.google.com/apis/design/errors).
6896 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
6897 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
6898 # message types for APIs to use.
6899 {
6900 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
6901 },
6902 ],
6903 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
6904 # user-facing error message should be localized and sent in the
6905 # google.rpc.Status.details field, or localized by the client.
6906 },
6907 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
6908 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
6909 },
6910 },
6911 },
6912 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
6913 # This value is inRFC3339
6914 # text format.
6915 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
6916 # following:
6917 # `PENDING`, `RUNNING`, or `DONE`.
6918 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
6919 # operation.
6920 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
6921 # of the target resource.
6922 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
6923 # operations related to creating a snapshot, this points to the disk
6924 # that the snapshot was created from.
6925 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
6926 # `[email protected]` or
6927 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
6928 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
6929 # operation, this field will be populated.
6930 {
6931 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
6932 # Engine returns NO_RESULTS_ON_PAGE if there
6933 # are no results in the response.
6934 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
6935 # value format. For example:
6936 #
6937 # &quot;data&quot;: [
6938 # {
6939 # &quot;key&quot;: &quot;scope&quot;,
6940 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
6941 # }
6942 {
6943 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
6944 # returned. For example, for warnings where there are no results in a list
6945 # request for a particular zone, this key might be scope and
6946 # the key value might be the zone name. Other examples might be a key
6947 # indicating a deprecated resource and a suggested replacement, or a
6948 # warning about invalid network settings (for example, if an instance
6949 # attempts to perform IP forwarding but is not enabled for IP forwarding).
6950 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
6951 },
6952 ],
6953 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
6954 },
6955 ],
6956 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
6957 # applicable when performing per-zone operations.
6958 }</pre>
6959 </div>
6960
6961 <div class="method">
6962 <code class="details" id="recreateInstances">recreateInstances(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
6963 <pre>Flags the specified VM instances in the managed instance group to be
6964 immediately recreated. Each instance is recreated using the group&#x27;s current
6965 configuration. This operation is marked as DONE when the flag
6966 is set even if the instances have not yet been recreated. You must
6967 separately verify the status of each instance by checking itscurrentAction field; for more information, see Checking
6968 the status of managed instances.
6969
6970 If the group is part of a backend
6971 service that has enabled
6972 connection draining, it can take up to 60 seconds after the connection
6973 draining duration has elapsed before the VM instance is removed or deleted.
6974
6975 You can specify a maximum of 1000 instances with this method per request.
6976
6977 Args:
6978 project: string, Project ID for this request. (required)
6979 region: string, Name of the region scoping this request. (required)
6980 instanceGroupManager: string, Name of the managed instance group. (required)
6981 body: object, The request body.
6982 The object takes the form of:
6983
6984 {
6985 &quot;instances&quot;: [ # The URLs of one or more instances to recreate. This can be a full URL or
6986 # a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].
6987 &quot;A String&quot;,
6988 ],
6989 }
6990
6991 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
6992 that if you must retry your request, the server will know to ignore the
6993 request if it has already been completed.
6994
6995 For example, consider a situation where you make an initial request and
6996 the request times out. If you make the request again with the same
6997 request ID, the server can check if original operation with the same
6998 request ID was received, and if so, will ignore the second request. This
6999 prevents clients from accidentally creating duplicate commitments.
7000
7001 The request ID must be
7002 a valid UUID with the exception that zero UUID is not supported
7003 (00000000-0000-0000-0000-000000000000).
7004 x__xgafv: string, V1 error format.
7005 Allowed values
7006 1 - v1 error format
7007 2 - v2 error format
7008
7009 Returns:
7010 An object of the form:
7011
7012 { # Represents an Operation resource.
7013 #
7014 # Google Compute Engine has three Operation resources:
7015 #
7016 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
7017 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
7018 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
7019 #
7020 # You can use an operation resource to manage asynchronous API requests.
7021 # For more information, readHandling
7022 # API responses.
7023 #
7024 # Operations can be global, regional or zonal.
7025 #
7026 # - For global operations, use the `globalOperations`
7027 # resource.
7028 # - For regional operations, use the
7029 # `regionOperations` resource.
7030 # - For zonal operations, use
7031 # the `zoneOperations` resource.
7032 #
7033 #
7034 #
7035 # For more information, read
7036 # Global, Regional, and Zonal Resources.
7037 #
7038 # Note that completed Operation resources have a limited
7039 # retention period.
7040 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
7041 # Not present otherwise.
7042 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
7043 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
7044 # set when the operation is created.
7045 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
7046 # text format.
7047 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
7048 # this field will be populated.
7049 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
7050 # operation.
7051 {
7052 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
7053 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
7054 # details. There is a set of defined message types to use for providing
7055 # details.The syntax depends on the error code. For example,
7056 # QuotaExceededInfo will have details when the error code is
7057 # QUOTA_EXCEEDED.
7058 {
7059 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
7060 #
7061 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
7062 # is not enabled:
7063 #
7064 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
7065 # &quot;domain&quot;: &quot;googleapis.com&quot;
7066 # &quot;metadata&quot;: {
7067 # &quot;resource&quot;: &quot;projects/123&quot;,
7068 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
7069 # }
7070 # }
7071 #
7072 # This response indicates that the pubsub.googleapis.com API is not enabled.
7073 #
7074 # Example of an error that is returned when attempting to create a Spanner
7075 # instance in a region that is out of stock:
7076 #
7077 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
7078 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
7079 # &quot;metadata&quot;: {
7080 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
7081 # }
7082 # }
7083 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
7084 # is typically the registered service name of the tool or product that
7085 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
7086 # generated by some common infrastructure, the error domain must be a
7087 # globally unique value that identifies the infrastructure. For Google API
7088 # infrastructure, the error domain is &quot;googleapis.com&quot;.
7089 &quot;metadatas&quot;: { # Additional structured details about this error.
7090 #
7091 # Keys must match a regular expression of `a-z+` but should
7092 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
7093 # length. When identifying the current value of an exceeded limit, the units
7094 # should be contained in the key, not the value. For example, rather than
7095 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
7096 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
7097 # instances that can be created in a single (batch) request.
7098 &quot;a_key&quot;: &quot;A String&quot;,
7099 },
7100 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
7101 # proximate cause of the error. Error reasons are unique within a particular
7102 # domain of errors. This should be at most 63 characters and match a
7103 # regular expression of `A-Z+[A-Z0-9]`, which represents
7104 # UPPER_SNAKE_CASE.
7105 },
7106 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
7107 #
7108 # For example, if a quota check failed with an error indicating the calling
7109 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
7110 # directly to the right place in the developer console to flip the bit.
7111 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
7112 { # Describes a URL link.
7113 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
7114 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
7115 },
7116 ],
7117 },
7118 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
7119 # which can be attached to an RPC error.
7120 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
7121 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
7122 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
7123 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
7124 },
7125 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
7126 &quot;dimensions&quot;: { # The map holding related quota dimensions.
7127 &quot;a_key&quot;: &quot;A String&quot;,
7128 },
7129 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
7130 # type or metric.
7131 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
7132 # or metric.
7133 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
7134 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
7135 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
7136 },
7137 },
7138 ],
7139 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
7140 # This property is optional.
7141 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
7142 },
7143 ],
7144 },
7145 &quot;getVersionOperationMetadata&quot;: {
7146 &quot;inlineSbomInfo&quot;: {
7147 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
7148 # appropriate identifiers.
7149 &quot;a_key&quot;: &quot;A String&quot;,
7150 },
7151 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
7152 # identifiers.
7153 &quot;a_key&quot;: &quot;A String&quot;,
7154 },
7155 },
7156 },
7157 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
7158 # message that was returned, such as `NOT FOUND`.
7159 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
7160 # status code that was returned. For example, a `404` means the
7161 # resource was not found.
7162 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
7163 # defined by the server.
7164 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
7165 # This value is inRFC3339
7166 # text format.
7167 &quot;instancesBulkInsertOperationMetadata&quot;: {
7168 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
7169 # Example key: zones/us-central1-a
7170 &quot;a_key&quot;: {
7171 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
7172 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
7173 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
7174 # error.
7175 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
7176 # if the flow is rolling forward or rolling back.
7177 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
7178 },
7179 },
7180 },
7181 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
7182 # Operation resources.
7183 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
7184 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
7185 # group of operations results from a `bulkInsert` API request.
7186 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
7187 # `update`, or `delete`, and so on.
7188 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
7189 # There is no requirement that this be linear or support any granularity of
7190 # operations. This should not be used to guess when the operation will be
7191 # complete. This number should monotonically increase as the operation
7192 # progresses.
7193 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
7194 # applicable when performing regional operations.
7195 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
7196 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
7197 # this field will contain information on all underlying zonal actions and
7198 # their state.
7199 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
7200 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
7201 # Example key: zones/us-central1-a
7202 &quot;a_key&quot;: {
7203 &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
7204 # populated.
7205 # different programming environments, including REST APIs and RPC APIs. It is
7206 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
7207 # three pieces of data: error code, error message, and error details.
7208 #
7209 # You can find out more about this error model and how to work with it in the
7210 # [API Design Guide](https://cloud.google.com/apis/design/errors).
7211 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
7212 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
7213 # message types for APIs to use.
7214 {
7215 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
7216 },
7217 ],
7218 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
7219 # user-facing error message should be localized and sent in the
7220 # google.rpc.Status.details field, or localized by the client.
7221 },
7222 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
7223 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
7224 },
7225 },
7226 },
7227 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
7228 # This value is inRFC3339
7229 # text format.
7230 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
7231 # following:
7232 # `PENDING`, `RUNNING`, or `DONE`.
7233 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
7234 # operation.
7235 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
7236 # of the target resource.
7237 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
7238 # operations related to creating a snapshot, this points to the disk
7239 # that the snapshot was created from.
7240 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
7241 # `[email protected]` or
7242 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
7243 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
7244 # operation, this field will be populated.
7245 {
7246 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
7247 # Engine returns NO_RESULTS_ON_PAGE if there
7248 # are no results in the response.
7249 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
7250 # value format. For example:
7251 #
7252 # &quot;data&quot;: [
7253 # {
7254 # &quot;key&quot;: &quot;scope&quot;,
7255 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
7256 # }
7257 {
7258 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
7259 # returned. For example, for warnings where there are no results in a list
7260 # request for a particular zone, this key might be scope and
7261 # the key value might be the zone name. Other examples might be a key
7262 # indicating a deprecated resource and a suggested replacement, or a
7263 # warning about invalid network settings (for example, if an instance
7264 # attempts to perform IP forwarding but is not enabled for IP forwarding).
7265 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
7266 },
7267 ],
7268 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
7269 },
7270 ],
7271 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
7272 # applicable when performing per-zone operations.
7273 }</pre>
7274 </div>
7275
7276 <div class="method">
7277 <code class="details" id="resize">resize(project, region, instanceGroupManager, size, requestId=None, x__xgafv=None)</code>
7278 <pre>Changes the intended size of the managed instance group. If you increase
7279 the size, the group creates new instances using the current instance
7280 template. If you decrease the size, the group deletes one or more
7281 instances.
7282
7283 The resize operation is marked DONE if theresize request is successful. The underlying actions take
7284 additional time. You must separately verify the status of thecreating or deleting actions with thelistmanagedinstances
7285 method.
7286
7287 If the group is part of a backend
7288 service that has enabled
7289 connection draining, it can take up to 60 seconds after the connection
7290 draining duration has elapsed before the VM instance is removed or deleted.
7291
7292 Args:
7293 project: string, Project ID for this request. (required)
7294 region: string, Name of the region scoping this request. (required)
7295 instanceGroupManager: string, Name of the managed instance group. (required)
7296 size: integer, Number of instances that should exist in this instance group
7297 manager. (required)
7298 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
7299 that if you must retry your request, the server will know to ignore the
7300 request if it has already been completed.
7301
7302 For example, consider a situation where you make an initial request and
7303 the request times out. If you make the request again with the same
7304 request ID, the server can check if original operation with the same
7305 request ID was received, and if so, will ignore the second request. This
7306 prevents clients from accidentally creating duplicate commitments.
7307
7308 The request ID must be
7309 a valid UUID with the exception that zero UUID is not supported
7310 (00000000-0000-0000-0000-000000000000).
7311 x__xgafv: string, V1 error format.
7312 Allowed values
7313 1 - v1 error format
7314 2 - v2 error format
7315
7316 Returns:
7317 An object of the form:
7318
7319 { # Represents an Operation resource.
7320 #
7321 # Google Compute Engine has three Operation resources:
7322 #
7323 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
7324 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
7325 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
7326 #
7327 # You can use an operation resource to manage asynchronous API requests.
7328 # For more information, readHandling
7329 # API responses.
7330 #
7331 # Operations can be global, regional or zonal.
7332 #
7333 # - For global operations, use the `globalOperations`
7334 # resource.
7335 # - For regional operations, use the
7336 # `regionOperations` resource.
7337 # - For zonal operations, use
7338 # the `zoneOperations` resource.
7339 #
7340 #
7341 #
7342 # For more information, read
7343 # Global, Regional, and Zonal Resources.
7344 #
7345 # Note that completed Operation resources have a limited
7346 # retention period.
7347 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
7348 # Not present otherwise.
7349 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
7350 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
7351 # set when the operation is created.
7352 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
7353 # text format.
7354 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
7355 # this field will be populated.
7356 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
7357 # operation.
7358 {
7359 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
7360 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
7361 # details. There is a set of defined message types to use for providing
7362 # details.The syntax depends on the error code. For example,
7363 # QuotaExceededInfo will have details when the error code is
7364 # QUOTA_EXCEEDED.
7365 {
7366 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
7367 #
7368 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
7369 # is not enabled:
7370 #
7371 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
7372 # &quot;domain&quot;: &quot;googleapis.com&quot;
7373 # &quot;metadata&quot;: {
7374 # &quot;resource&quot;: &quot;projects/123&quot;,
7375 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
7376 # }
7377 # }
7378 #
7379 # This response indicates that the pubsub.googleapis.com API is not enabled.
7380 #
7381 # Example of an error that is returned when attempting to create a Spanner
7382 # instance in a region that is out of stock:
7383 #
7384 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
7385 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
7386 # &quot;metadata&quot;: {
7387 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
7388 # }
7389 # }
7390 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
7391 # is typically the registered service name of the tool or product that
7392 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
7393 # generated by some common infrastructure, the error domain must be a
7394 # globally unique value that identifies the infrastructure. For Google API
7395 # infrastructure, the error domain is &quot;googleapis.com&quot;.
7396 &quot;metadatas&quot;: { # Additional structured details about this error.
7397 #
7398 # Keys must match a regular expression of `a-z+` but should
7399 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
7400 # length. When identifying the current value of an exceeded limit, the units
7401 # should be contained in the key, not the value. For example, rather than
7402 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
7403 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
7404 # instances that can be created in a single (batch) request.
7405 &quot;a_key&quot;: &quot;A String&quot;,
7406 },
7407 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
7408 # proximate cause of the error. Error reasons are unique within a particular
7409 # domain of errors. This should be at most 63 characters and match a
7410 # regular expression of `A-Z+[A-Z0-9]`, which represents
7411 # UPPER_SNAKE_CASE.
7412 },
7413 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
7414 #
7415 # For example, if a quota check failed with an error indicating the calling
7416 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
7417 # directly to the right place in the developer console to flip the bit.
7418 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
7419 { # Describes a URL link.
7420 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
7421 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
7422 },
7423 ],
7424 },
7425 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
7426 # which can be attached to an RPC error.
7427 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
7428 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
7429 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
7430 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
7431 },
7432 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
7433 &quot;dimensions&quot;: { # The map holding related quota dimensions.
7434 &quot;a_key&quot;: &quot;A String&quot;,
7435 },
7436 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
7437 # type or metric.
7438 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
7439 # or metric.
7440 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
7441 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
7442 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
7443 },
7444 },
7445 ],
7446 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
7447 # This property is optional.
7448 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
7449 },
7450 ],
7451 },
7452 &quot;getVersionOperationMetadata&quot;: {
7453 &quot;inlineSbomInfo&quot;: {
7454 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
7455 # appropriate identifiers.
7456 &quot;a_key&quot;: &quot;A String&quot;,
7457 },
7458 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
7459 # identifiers.
7460 &quot;a_key&quot;: &quot;A String&quot;,
7461 },
7462 },
7463 },
7464 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
7465 # message that was returned, such as `NOT FOUND`.
7466 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
7467 # status code that was returned. For example, a `404` means the
7468 # resource was not found.
7469 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
7470 # defined by the server.
7471 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
7472 # This value is inRFC3339
7473 # text format.
7474 &quot;instancesBulkInsertOperationMetadata&quot;: {
7475 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
7476 # Example key: zones/us-central1-a
7477 &quot;a_key&quot;: {
7478 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
7479 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
7480 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
7481 # error.
7482 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
7483 # if the flow is rolling forward or rolling back.
7484 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
7485 },
7486 },
7487 },
7488 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
7489 # Operation resources.
7490 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
7491 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
7492 # group of operations results from a `bulkInsert` API request.
7493 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
7494 # `update`, or `delete`, and so on.
7495 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
7496 # There is no requirement that this be linear or support any granularity of
7497 # operations. This should not be used to guess when the operation will be
7498 # complete. This number should monotonically increase as the operation
7499 # progresses.
7500 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
7501 # applicable when performing regional operations.
7502 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
7503 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
7504 # this field will contain information on all underlying zonal actions and
7505 # their state.
7506 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
7507 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
7508 # Example key: zones/us-central1-a
7509 &quot;a_key&quot;: {
7510 &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
7511 # populated.
7512 # different programming environments, including REST APIs and RPC APIs. It is
7513 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
7514 # three pieces of data: error code, error message, and error details.
7515 #
7516 # You can find out more about this error model and how to work with it in the
7517 # [API Design Guide](https://cloud.google.com/apis/design/errors).
7518 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
7519 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
7520 # message types for APIs to use.
7521 {
7522 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
7523 },
7524 ],
7525 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
7526 # user-facing error message should be localized and sent in the
7527 # google.rpc.Status.details field, or localized by the client.
7528 },
7529 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
7530 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
7531 },
7532 },
7533 },
7534 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
7535 # This value is inRFC3339
7536 # text format.
7537 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
7538 # following:
7539 # `PENDING`, `RUNNING`, or `DONE`.
7540 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
7541 # operation.
7542 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
7543 # of the target resource.
7544 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
7545 # operations related to creating a snapshot, this points to the disk
7546 # that the snapshot was created from.
7547 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
7548 # `[email protected]` or
7549 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
7550 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
7551 # operation, this field will be populated.
7552 {
7553 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
7554 # Engine returns NO_RESULTS_ON_PAGE if there
7555 # are no results in the response.
7556 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
7557 # value format. For example:
7558 #
7559 # &quot;data&quot;: [
7560 # {
7561 # &quot;key&quot;: &quot;scope&quot;,
7562 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
7563 # }
7564 {
7565 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
7566 # returned. For example, for warnings where there are no results in a list
7567 # request for a particular zone, this key might be scope and
7568 # the key value might be the zone name. Other examples might be a key
7569 # indicating a deprecated resource and a suggested replacement, or a
7570 # warning about invalid network settings (for example, if an instance
7571 # attempts to perform IP forwarding but is not enabled for IP forwarding).
7572 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
7573 },
7574 ],
7575 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
7576 },
7577 ],
7578 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
7579 # applicable when performing per-zone operations.
7580 }</pre>
7581 </div>
7582
7583 <div class="method">
7584 <code class="details" id="resumeInstances">resumeInstances(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
7585 <pre>Flags the specified instances in the managed instance group to be
7586 resumed. This method increases thetargetSize and decreases the targetSuspendedSize
7587 of the managed instance group by the number of instances that you resume.
7588 The resumeInstances operation is marked DONE if
7589 the resumeInstances request is successful. The underlying
7590 actions take additional time. You must separately verify the status of theRESUMING action with thelistmanagedinstances
7591 method.
7592
7593 In this request, you can only specify instances that are suspended. For
7594 example, if an instance was previously suspended using the suspendInstances
7595 method, it can be resumed using the resumeInstances method.
7596
7597 If a health check is attached to the managed instance group, the specified
7598 instances will be verified as healthy after they are resumed.
7599
7600 You can specify a maximum of 1000 instances with this method per request.
7601
7602 Args:
7603 project: string, Project ID for this request. (required)
7604 region: string, Name of the region scoping this request. (required)
7605 instanceGroupManager: string, Name of the managed instance group. (required)
7606 body: object, The request body.
7607 The object takes the form of:
7608
7609 {
7610 &quot;instances&quot;: [ # The URLs of one or more instances to resume. This can be a full URL or
7611 # a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].
7612 &quot;A String&quot;,
7613 ],
7614 }
7615
7616 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
7617 that if you must retry your request, the server will know to ignore the
7618 request if it has already been completed.
7619
7620 For example, consider a situation where you make an initial request and
7621 the request times out. If you make the request again with the same
7622 request ID, the server can check if original operation with the same
7623 request ID was received, and if so, will ignore the second request. This
7624 prevents clients from accidentally creating duplicate commitments.
7625
7626 The request ID must be
7627 a valid UUID with the exception that zero UUID is not supported
7628 (00000000-0000-0000-0000-000000000000).
7629 x__xgafv: string, V1 error format.
7630 Allowed values
7631 1 - v1 error format
7632 2 - v2 error format
7633
7634 Returns:
7635 An object of the form:
7636
7637 { # Represents an Operation resource.
7638 #
7639 # Google Compute Engine has three Operation resources:
7640 #
7641 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
7642 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
7643 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
7644 #
7645 # You can use an operation resource to manage asynchronous API requests.
7646 # For more information, readHandling
7647 # API responses.
7648 #
7649 # Operations can be global, regional or zonal.
7650 #
7651 # - For global operations, use the `globalOperations`
7652 # resource.
7653 # - For regional operations, use the
7654 # `regionOperations` resource.
7655 # - For zonal operations, use
7656 # the `zoneOperations` resource.
7657 #
7658 #
7659 #
7660 # For more information, read
7661 # Global, Regional, and Zonal Resources.
7662 #
7663 # Note that completed Operation resources have a limited
7664 # retention period.
7665 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
7666 # Not present otherwise.
7667 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
7668 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
7669 # set when the operation is created.
7670 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
7671 # text format.
7672 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
7673 # this field will be populated.
7674 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
7675 # operation.
7676 {
7677 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
7678 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
7679 # details. There is a set of defined message types to use for providing
7680 # details.The syntax depends on the error code. For example,
7681 # QuotaExceededInfo will have details when the error code is
7682 # QUOTA_EXCEEDED.
7683 {
7684 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
7685 #
7686 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
7687 # is not enabled:
7688 #
7689 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
7690 # &quot;domain&quot;: &quot;googleapis.com&quot;
7691 # &quot;metadata&quot;: {
7692 # &quot;resource&quot;: &quot;projects/123&quot;,
7693 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
7694 # }
7695 # }
7696 #
7697 # This response indicates that the pubsub.googleapis.com API is not enabled.
7698 #
7699 # Example of an error that is returned when attempting to create a Spanner
7700 # instance in a region that is out of stock:
7701 #
7702 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
7703 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
7704 # &quot;metadata&quot;: {
7705 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
7706 # }
7707 # }
7708 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
7709 # is typically the registered service name of the tool or product that
7710 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
7711 # generated by some common infrastructure, the error domain must be a
7712 # globally unique value that identifies the infrastructure. For Google API
7713 # infrastructure, the error domain is &quot;googleapis.com&quot;.
7714 &quot;metadatas&quot;: { # Additional structured details about this error.
7715 #
7716 # Keys must match a regular expression of `a-z+` but should
7717 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
7718 # length. When identifying the current value of an exceeded limit, the units
7719 # should be contained in the key, not the value. For example, rather than
7720 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
7721 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
7722 # instances that can be created in a single (batch) request.
7723 &quot;a_key&quot;: &quot;A String&quot;,
7724 },
7725 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
7726 # proximate cause of the error. Error reasons are unique within a particular
7727 # domain of errors. This should be at most 63 characters and match a
7728 # regular expression of `A-Z+[A-Z0-9]`, which represents
7729 # UPPER_SNAKE_CASE.
7730 },
7731 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
7732 #
7733 # For example, if a quota check failed with an error indicating the calling
7734 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
7735 # directly to the right place in the developer console to flip the bit.
7736 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
7737 { # Describes a URL link.
7738 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
7739 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
7740 },
7741 ],
7742 },
7743 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
7744 # which can be attached to an RPC error.
7745 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
7746 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
7747 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
7748 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
7749 },
7750 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
7751 &quot;dimensions&quot;: { # The map holding related quota dimensions.
7752 &quot;a_key&quot;: &quot;A String&quot;,
7753 },
7754 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
7755 # type or metric.
7756 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
7757 # or metric.
7758 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
7759 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
7760 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
7761 },
7762 },
7763 ],
7764 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
7765 # This property is optional.
7766 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
7767 },
7768 ],
7769 },
7770 &quot;getVersionOperationMetadata&quot;: {
7771 &quot;inlineSbomInfo&quot;: {
7772 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
7773 # appropriate identifiers.
7774 &quot;a_key&quot;: &quot;A String&quot;,
7775 },
7776 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
7777 # identifiers.
7778 &quot;a_key&quot;: &quot;A String&quot;,
7779 },
7780 },
7781 },
7782 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
7783 # message that was returned, such as `NOT FOUND`.
7784 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
7785 # status code that was returned. For example, a `404` means the
7786 # resource was not found.
7787 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
7788 # defined by the server.
7789 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
7790 # This value is inRFC3339
7791 # text format.
7792 &quot;instancesBulkInsertOperationMetadata&quot;: {
7793 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
7794 # Example key: zones/us-central1-a
7795 &quot;a_key&quot;: {
7796 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
7797 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
7798 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
7799 # error.
7800 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
7801 # if the flow is rolling forward or rolling back.
7802 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
7803 },
7804 },
7805 },
7806 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
7807 # Operation resources.
7808 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
7809 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
7810 # group of operations results from a `bulkInsert` API request.
7811 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
7812 # `update`, or `delete`, and so on.
7813 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
7814 # There is no requirement that this be linear or support any granularity of
7815 # operations. This should not be used to guess when the operation will be
7816 # complete. This number should monotonically increase as the operation
7817 # progresses.
7818 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
7819 # applicable when performing regional operations.
7820 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
7821 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
7822 # this field will contain information on all underlying zonal actions and
7823 # their state.
7824 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
7825 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
7826 # Example key: zones/us-central1-a
7827 &quot;a_key&quot;: {
7828 &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
7829 # populated.
7830 # different programming environments, including REST APIs and RPC APIs. It is
7831 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
7832 # three pieces of data: error code, error message, and error details.
7833 #
7834 # You can find out more about this error model and how to work with it in the
7835 # [API Design Guide](https://cloud.google.com/apis/design/errors).
7836 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
7837 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
7838 # message types for APIs to use.
7839 {
7840 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
7841 },
7842 ],
7843 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
7844 # user-facing error message should be localized and sent in the
7845 # google.rpc.Status.details field, or localized by the client.
7846 },
7847 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
7848 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
7849 },
7850 },
7851 },
7852 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
7853 # This value is inRFC3339
7854 # text format.
7855 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
7856 # following:
7857 # `PENDING`, `RUNNING`, or `DONE`.
7858 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
7859 # operation.
7860 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
7861 # of the target resource.
7862 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
7863 # operations related to creating a snapshot, this points to the disk
7864 # that the snapshot was created from.
7865 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
7866 # `[email protected]` or
7867 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
7868 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
7869 # operation, this field will be populated.
7870 {
7871 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
7872 # Engine returns NO_RESULTS_ON_PAGE if there
7873 # are no results in the response.
7874 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
7875 # value format. For example:
7876 #
7877 # &quot;data&quot;: [
7878 # {
7879 # &quot;key&quot;: &quot;scope&quot;,
7880 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
7881 # }
7882 {
7883 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
7884 # returned. For example, for warnings where there are no results in a list
7885 # request for a particular zone, this key might be scope and
7886 # the key value might be the zone name. Other examples might be a key
7887 # indicating a deprecated resource and a suggested replacement, or a
7888 # warning about invalid network settings (for example, if an instance
7889 # attempts to perform IP forwarding but is not enabled for IP forwarding).
7890 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
7891 },
7892 ],
7893 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
7894 },
7895 ],
7896 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
7897 # applicable when performing per-zone operations.
7898 }</pre>
7899 </div>
7900
7901 <div class="method">
7902 <code class="details" id="setInstanceTemplate">setInstanceTemplate(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
7903 <pre>Sets the instance template to use when creating new instances or recreating
7904 instances in this group. Existing instances are not affected.
7905
7906 Args:
7907 project: string, Project ID for this request. (required)
7908 region: string, Name of the region scoping this request. (required)
7909 instanceGroupManager: string, The name of the managed instance group. (required)
7910 body: object, The request body.
7911 The object takes the form of:
7912
7913 {
7914 &quot;instanceTemplate&quot;: &quot;A String&quot;, # URL of the InstanceTemplate resource from which all new instances will be
7915 # created.
7916 }
7917
7918 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
7919 that if you must retry your request, the server will know to ignore the
7920 request if it has already been completed.
7921
7922 For example, consider a situation where you make an initial request and
7923 the request times out. If you make the request again with the same
7924 request ID, the server can check if original operation with the same
7925 request ID was received, and if so, will ignore the second request. This
7926 prevents clients from accidentally creating duplicate commitments.
7927
7928 The request ID must be
7929 a valid UUID with the exception that zero UUID is not supported
7930 (00000000-0000-0000-0000-000000000000).
7931 x__xgafv: string, V1 error format.
7932 Allowed values
7933 1 - v1 error format
7934 2 - v2 error format
7935
7936 Returns:
7937 An object of the form:
7938
7939 { # Represents an Operation resource.
7940 #
7941 # Google Compute Engine has three Operation resources:
7942 #
7943 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
7944 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
7945 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
7946 #
7947 # You can use an operation resource to manage asynchronous API requests.
7948 # For more information, readHandling
7949 # API responses.
7950 #
7951 # Operations can be global, regional or zonal.
7952 #
7953 # - For global operations, use the `globalOperations`
7954 # resource.
7955 # - For regional operations, use the
7956 # `regionOperations` resource.
7957 # - For zonal operations, use
7958 # the `zoneOperations` resource.
7959 #
7960 #
7961 #
7962 # For more information, read
7963 # Global, Regional, and Zonal Resources.
7964 #
7965 # Note that completed Operation resources have a limited
7966 # retention period.
7967 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
7968 # Not present otherwise.
7969 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
7970 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
7971 # set when the operation is created.
7972 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
7973 # text format.
7974 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
7975 # this field will be populated.
7976 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
7977 # operation.
7978 {
7979 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
7980 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
7981 # details. There is a set of defined message types to use for providing
7982 # details.The syntax depends on the error code. For example,
7983 # QuotaExceededInfo will have details when the error code is
7984 # QUOTA_EXCEEDED.
7985 {
7986 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
7987 #
7988 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
7989 # is not enabled:
7990 #
7991 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
7992 # &quot;domain&quot;: &quot;googleapis.com&quot;
7993 # &quot;metadata&quot;: {
7994 # &quot;resource&quot;: &quot;projects/123&quot;,
7995 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
7996 # }
7997 # }
7998 #
7999 # This response indicates that the pubsub.googleapis.com API is not enabled.
8000 #
8001 # Example of an error that is returned when attempting to create a Spanner
8002 # instance in a region that is out of stock:
8003 #
8004 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
8005 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
8006 # &quot;metadata&quot;: {
8007 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
8008 # }
8009 # }
8010 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
8011 # is typically the registered service name of the tool or product that
8012 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
8013 # generated by some common infrastructure, the error domain must be a
8014 # globally unique value that identifies the infrastructure. For Google API
8015 # infrastructure, the error domain is &quot;googleapis.com&quot;.
8016 &quot;metadatas&quot;: { # Additional structured details about this error.
8017 #
8018 # Keys must match a regular expression of `a-z+` but should
8019 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
8020 # length. When identifying the current value of an exceeded limit, the units
8021 # should be contained in the key, not the value. For example, rather than
8022 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
8023 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
8024 # instances that can be created in a single (batch) request.
8025 &quot;a_key&quot;: &quot;A String&quot;,
8026 },
8027 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
8028 # proximate cause of the error. Error reasons are unique within a particular
8029 # domain of errors. This should be at most 63 characters and match a
8030 # regular expression of `A-Z+[A-Z0-9]`, which represents
8031 # UPPER_SNAKE_CASE.
8032 },
8033 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
8034 #
8035 # For example, if a quota check failed with an error indicating the calling
8036 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
8037 # directly to the right place in the developer console to flip the bit.
8038 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
8039 { # Describes a URL link.
8040 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
8041 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
8042 },
8043 ],
8044 },
8045 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
8046 # which can be attached to an RPC error.
8047 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
8048 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
8049 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
8050 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
8051 },
8052 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
8053 &quot;dimensions&quot;: { # The map holding related quota dimensions.
8054 &quot;a_key&quot;: &quot;A String&quot;,
8055 },
8056 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
8057 # type or metric.
8058 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
8059 # or metric.
8060 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
8061 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
8062 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
8063 },
8064 },
8065 ],
8066 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
8067 # This property is optional.
8068 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
8069 },
8070 ],
8071 },
8072 &quot;getVersionOperationMetadata&quot;: {
8073 &quot;inlineSbomInfo&quot;: {
8074 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
8075 # appropriate identifiers.
8076 &quot;a_key&quot;: &quot;A String&quot;,
8077 },
8078 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
8079 # identifiers.
8080 &quot;a_key&quot;: &quot;A String&quot;,
8081 },
8082 },
8083 },
8084 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
8085 # message that was returned, such as `NOT FOUND`.
8086 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
8087 # status code that was returned. For example, a `404` means the
8088 # resource was not found.
8089 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
8090 # defined by the server.
8091 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
8092 # This value is inRFC3339
8093 # text format.
8094 &quot;instancesBulkInsertOperationMetadata&quot;: {
8095 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
8096 # Example key: zones/us-central1-a
8097 &quot;a_key&quot;: {
8098 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
8099 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
8100 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
8101 # error.
8102 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
8103 # if the flow is rolling forward or rolling back.
8104 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
8105 },
8106 },
8107 },
8108 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
8109 # Operation resources.
8110 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
8111 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
8112 # group of operations results from a `bulkInsert` API request.
8113 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
8114 # `update`, or `delete`, and so on.
8115 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
8116 # There is no requirement that this be linear or support any granularity of
8117 # operations. This should not be used to guess when the operation will be
8118 # complete. This number should monotonically increase as the operation
8119 # progresses.
8120 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
8121 # applicable when performing regional operations.
8122 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
8123 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
8124 # this field will contain information on all underlying zonal actions and
8125 # their state.
8126 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
8127 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
8128 # Example key: zones/us-central1-a
8129 &quot;a_key&quot;: {
8130 &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
8131 # populated.
8132 # different programming environments, including REST APIs and RPC APIs. It is
8133 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
8134 # three pieces of data: error code, error message, and error details.
8135 #
8136 # You can find out more about this error model and how to work with it in the
8137 # [API Design Guide](https://cloud.google.com/apis/design/errors).
8138 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
8139 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
8140 # message types for APIs to use.
8141 {
8142 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
8143 },
8144 ],
8145 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
8146 # user-facing error message should be localized and sent in the
8147 # google.rpc.Status.details field, or localized by the client.
8148 },
8149 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
8150 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
8151 },
8152 },
8153 },
8154 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
8155 # This value is inRFC3339
8156 # text format.
8157 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
8158 # following:
8159 # `PENDING`, `RUNNING`, or `DONE`.
8160 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
8161 # operation.
8162 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
8163 # of the target resource.
8164 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
8165 # operations related to creating a snapshot, this points to the disk
8166 # that the snapshot was created from.
8167 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
8168 # `[email protected]` or
8169 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
8170 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
8171 # operation, this field will be populated.
8172 {
8173 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
8174 # Engine returns NO_RESULTS_ON_PAGE if there
8175 # are no results in the response.
8176 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
8177 # value format. For example:
8178 #
8179 # &quot;data&quot;: [
8180 # {
8181 # &quot;key&quot;: &quot;scope&quot;,
8182 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
8183 # }
8184 {
8185 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
8186 # returned. For example, for warnings where there are no results in a list
8187 # request for a particular zone, this key might be scope and
8188 # the key value might be the zone name. Other examples might be a key
8189 # indicating a deprecated resource and a suggested replacement, or a
8190 # warning about invalid network settings (for example, if an instance
8191 # attempts to perform IP forwarding but is not enabled for IP forwarding).
8192 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
8193 },
8194 ],
8195 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
8196 },
8197 ],
8198 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
8199 # applicable when performing per-zone operations.
8200 }</pre>
8201 </div>
8202
8203 <div class="method">
8204 <code class="details" id="setTargetPools">setTargetPools(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
8205 <pre>Modifies the target pools to which all new instances in this group are
8206 assigned. Existing instances in the group are not affected.
8207
8208 Args:
8209 project: string, Project ID for this request. (required)
8210 region: string, Name of the region scoping this request. (required)
8211 instanceGroupManager: string, Name of the managed instance group. (required)
8212 body: object, The request body.
8213 The object takes the form of:
8214
8215 {
8216 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of the target pools information, which is a hash of the
8217 # contents. This field is used for optimistic locking when you update the
8218 # target pool entries. This field is optional.
8219 &quot;targetPools&quot;: [ # The URL of all TargetPool resources to which instances in theinstanceGroup field are added. The target pools automatically
8220 # apply to all of the instances in the managed instance group.
8221 &quot;A String&quot;,
8222 ],
8223 }
8224
8225 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
8226 that if you must retry your request, the server will know to ignore the
8227 request if it has already been completed.
8228
8229 For example, consider a situation where you make an initial request and
8230 the request times out. If you make the request again with the same
8231 request ID, the server can check if original operation with the same
8232 request ID was received, and if so, will ignore the second request. This
8233 prevents clients from accidentally creating duplicate commitments.
8234
8235 The request ID must be
8236 a valid UUID with the exception that zero UUID is not supported
8237 (00000000-0000-0000-0000-000000000000).
8238 x__xgafv: string, V1 error format.
8239 Allowed values
8240 1 - v1 error format
8241 2 - v2 error format
8242
8243 Returns:
8244 An object of the form:
8245
8246 { # Represents an Operation resource.
8247 #
8248 # Google Compute Engine has three Operation resources:
8249 #
8250 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
8251 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
8252 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
8253 #
8254 # You can use an operation resource to manage asynchronous API requests.
8255 # For more information, readHandling
8256 # API responses.
8257 #
8258 # Operations can be global, regional or zonal.
8259 #
8260 # - For global operations, use the `globalOperations`
8261 # resource.
8262 # - For regional operations, use the
8263 # `regionOperations` resource.
8264 # - For zonal operations, use
8265 # the `zoneOperations` resource.
8266 #
8267 #
8268 #
8269 # For more information, read
8270 # Global, Regional, and Zonal Resources.
8271 #
8272 # Note that completed Operation resources have a limited
8273 # retention period.
8274 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
8275 # Not present otherwise.
8276 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
8277 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
8278 # set when the operation is created.
8279 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
8280 # text format.
8281 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
8282 # this field will be populated.
8283 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
8284 # operation.
8285 {
8286 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
8287 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
8288 # details. There is a set of defined message types to use for providing
8289 # details.The syntax depends on the error code. For example,
8290 # QuotaExceededInfo will have details when the error code is
8291 # QUOTA_EXCEEDED.
8292 {
8293 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
8294 #
8295 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
8296 # is not enabled:
8297 #
8298 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
8299 # &quot;domain&quot;: &quot;googleapis.com&quot;
8300 # &quot;metadata&quot;: {
8301 # &quot;resource&quot;: &quot;projects/123&quot;,
8302 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
8303 # }
8304 # }
8305 #
8306 # This response indicates that the pubsub.googleapis.com API is not enabled.
8307 #
8308 # Example of an error that is returned when attempting to create a Spanner
8309 # instance in a region that is out of stock:
8310 #
8311 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
8312 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
8313 # &quot;metadata&quot;: {
8314 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
8315 # }
8316 # }
8317 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
8318 # is typically the registered service name of the tool or product that
8319 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
8320 # generated by some common infrastructure, the error domain must be a
8321 # globally unique value that identifies the infrastructure. For Google API
8322 # infrastructure, the error domain is &quot;googleapis.com&quot;.
8323 &quot;metadatas&quot;: { # Additional structured details about this error.
8324 #
8325 # Keys must match a regular expression of `a-z+` but should
8326 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
8327 # length. When identifying the current value of an exceeded limit, the units
8328 # should be contained in the key, not the value. For example, rather than
8329 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
8330 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
8331 # instances that can be created in a single (batch) request.
8332 &quot;a_key&quot;: &quot;A String&quot;,
8333 },
8334 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
8335 # proximate cause of the error. Error reasons are unique within a particular
8336 # domain of errors. This should be at most 63 characters and match a
8337 # regular expression of `A-Z+[A-Z0-9]`, which represents
8338 # UPPER_SNAKE_CASE.
8339 },
8340 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
8341 #
8342 # For example, if a quota check failed with an error indicating the calling
8343 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
8344 # directly to the right place in the developer console to flip the bit.
8345 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
8346 { # Describes a URL link.
8347 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
8348 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
8349 },
8350 ],
8351 },
8352 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
8353 # which can be attached to an RPC error.
8354 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
8355 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
8356 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
8357 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
8358 },
8359 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
8360 &quot;dimensions&quot;: { # The map holding related quota dimensions.
8361 &quot;a_key&quot;: &quot;A String&quot;,
8362 },
8363 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
8364 # type or metric.
8365 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
8366 # or metric.
8367 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
8368 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
8369 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
8370 },
8371 },
8372 ],
8373 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
8374 # This property is optional.
8375 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
8376 },
8377 ],
8378 },
8379 &quot;getVersionOperationMetadata&quot;: {
8380 &quot;inlineSbomInfo&quot;: {
8381 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
8382 # appropriate identifiers.
8383 &quot;a_key&quot;: &quot;A String&quot;,
8384 },
8385 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
8386 # identifiers.
8387 &quot;a_key&quot;: &quot;A String&quot;,
8388 },
8389 },
8390 },
8391 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
8392 # message that was returned, such as `NOT FOUND`.
8393 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
8394 # status code that was returned. For example, a `404` means the
8395 # resource was not found.
8396 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
8397 # defined by the server.
8398 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
8399 # This value is inRFC3339
8400 # text format.
8401 &quot;instancesBulkInsertOperationMetadata&quot;: {
8402 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
8403 # Example key: zones/us-central1-a
8404 &quot;a_key&quot;: {
8405 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
8406 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
8407 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
8408 # error.
8409 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
8410 # if the flow is rolling forward or rolling back.
8411 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
8412 },
8413 },
8414 },
8415 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
8416 # Operation resources.
8417 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
8418 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
8419 # group of operations results from a `bulkInsert` API request.
8420 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
8421 # `update`, or `delete`, and so on.
8422 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
8423 # There is no requirement that this be linear or support any granularity of
8424 # operations. This should not be used to guess when the operation will be
8425 # complete. This number should monotonically increase as the operation
8426 # progresses.
8427 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
8428 # applicable when performing regional operations.
8429 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
8430 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
8431 # this field will contain information on all underlying zonal actions and
8432 # their state.
8433 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
8434 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
8435 # Example key: zones/us-central1-a
8436 &quot;a_key&quot;: {
8437 &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
8438 # populated.
8439 # different programming environments, including REST APIs and RPC APIs. It is
8440 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
8441 # three pieces of data: error code, error message, and error details.
8442 #
8443 # You can find out more about this error model and how to work with it in the
8444 # [API Design Guide](https://cloud.google.com/apis/design/errors).
8445 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
8446 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
8447 # message types for APIs to use.
8448 {
8449 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
8450 },
8451 ],
8452 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
8453 # user-facing error message should be localized and sent in the
8454 # google.rpc.Status.details field, or localized by the client.
8455 },
8456 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
8457 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
8458 },
8459 },
8460 },
8461 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
8462 # This value is inRFC3339
8463 # text format.
8464 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
8465 # following:
8466 # `PENDING`, `RUNNING`, or `DONE`.
8467 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
8468 # operation.
8469 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
8470 # of the target resource.
8471 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
8472 # operations related to creating a snapshot, this points to the disk
8473 # that the snapshot was created from.
8474 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
8475 # `[email protected]` or
8476 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
8477 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
8478 # operation, this field will be populated.
8479 {
8480 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
8481 # Engine returns NO_RESULTS_ON_PAGE if there
8482 # are no results in the response.
8483 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
8484 # value format. For example:
8485 #
8486 # &quot;data&quot;: [
8487 # {
8488 # &quot;key&quot;: &quot;scope&quot;,
8489 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
8490 # }
8491 {
8492 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
8493 # returned. For example, for warnings where there are no results in a list
8494 # request for a particular zone, this key might be scope and
8495 # the key value might be the zone name. Other examples might be a key
8496 # indicating a deprecated resource and a suggested replacement, or a
8497 # warning about invalid network settings (for example, if an instance
8498 # attempts to perform IP forwarding but is not enabled for IP forwarding).
8499 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
8500 },
8501 ],
8502 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
8503 },
8504 ],
8505 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
8506 # applicable when performing per-zone operations.
8507 }</pre>
8508 </div>
8509
8510 <div class="method">
8511 <code class="details" id="startInstances">startInstances(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
8512 <pre>Flags the specified instances in the managed instance group to be
8513 started. This method increases thetargetSize and decreases the targetStoppedSize
8514 of the managed instance group by the number of instances that you start.
8515 The startInstances operation is marked DONE if
8516 the startInstances request is successful. The underlying
8517 actions take additional time. You must separately verify the status of theSTARTING action with thelistmanagedinstances
8518 method.
8519
8520 In this request, you can only specify instances that are stopped. For
8521 example, if an instance was previously stopped using the stopInstances
8522 method, it can be started using the startInstances method.
8523
8524 If a health check is attached to the managed instance group, the specified
8525 instances will be verified as healthy after they are started.
8526
8527 You can specify a maximum of 1000 instances with this method per request.
8528
8529 Args:
8530 project: string, Project ID for this request. (required)
8531 region: string, Name of the region scoping this request. (required)
8532 instanceGroupManager: string, Name of the managed instance group. (required)
8533 body: object, The request body.
8534 The object takes the form of:
8535
8536 {
8537 &quot;instances&quot;: [ # The URLs of one or more instances to start. This can be a full URL or
8538 # a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].
8539 &quot;A String&quot;,
8540 ],
8541 }
8542
8543 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
8544 that if you must retry your request, the server will know to ignore the
8545 request if it has already been completed.
8546
8547 For example, consider a situation where you make an initial request and
8548 the request times out. If you make the request again with the same
8549 request ID, the server can check if original operation with the same
8550 request ID was received, and if so, will ignore the second request. This
8551 prevents clients from accidentally creating duplicate commitments.
8552
8553 The request ID must be
8554 a valid UUID with the exception that zero UUID is not supported
8555 (00000000-0000-0000-0000-000000000000).
8556 x__xgafv: string, V1 error format.
8557 Allowed values
8558 1 - v1 error format
8559 2 - v2 error format
8560
8561 Returns:
8562 An object of the form:
8563
8564 { # Represents an Operation resource.
8565 #
8566 # Google Compute Engine has three Operation resources:
8567 #
8568 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
8569 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
8570 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
8571 #
8572 # You can use an operation resource to manage asynchronous API requests.
8573 # For more information, readHandling
8574 # API responses.
8575 #
8576 # Operations can be global, regional or zonal.
8577 #
8578 # - For global operations, use the `globalOperations`
8579 # resource.
8580 # - For regional operations, use the
8581 # `regionOperations` resource.
8582 # - For zonal operations, use
8583 # the `zoneOperations` resource.
8584 #
8585 #
8586 #
8587 # For more information, read
8588 # Global, Regional, and Zonal Resources.
8589 #
8590 # Note that completed Operation resources have a limited
8591 # retention period.
8592 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
8593 # Not present otherwise.
8594 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
8595 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
8596 # set when the operation is created.
8597 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
8598 # text format.
8599 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
8600 # this field will be populated.
8601 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
8602 # operation.
8603 {
8604 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
8605 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
8606 # details. There is a set of defined message types to use for providing
8607 # details.The syntax depends on the error code. For example,
8608 # QuotaExceededInfo will have details when the error code is
8609 # QUOTA_EXCEEDED.
8610 {
8611 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
8612 #
8613 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
8614 # is not enabled:
8615 #
8616 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
8617 # &quot;domain&quot;: &quot;googleapis.com&quot;
8618 # &quot;metadata&quot;: {
8619 # &quot;resource&quot;: &quot;projects/123&quot;,
8620 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
8621 # }
8622 # }
8623 #
8624 # This response indicates that the pubsub.googleapis.com API is not enabled.
8625 #
8626 # Example of an error that is returned when attempting to create a Spanner
8627 # instance in a region that is out of stock:
8628 #
8629 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
8630 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
8631 # &quot;metadata&quot;: {
8632 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
8633 # }
8634 # }
8635 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
8636 # is typically the registered service name of the tool or product that
8637 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
8638 # generated by some common infrastructure, the error domain must be a
8639 # globally unique value that identifies the infrastructure. For Google API
8640 # infrastructure, the error domain is &quot;googleapis.com&quot;.
8641 &quot;metadatas&quot;: { # Additional structured details about this error.
8642 #
8643 # Keys must match a regular expression of `a-z+` but should
8644 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
8645 # length. When identifying the current value of an exceeded limit, the units
8646 # should be contained in the key, not the value. For example, rather than
8647 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
8648 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
8649 # instances that can be created in a single (batch) request.
8650 &quot;a_key&quot;: &quot;A String&quot;,
8651 },
8652 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
8653 # proximate cause of the error. Error reasons are unique within a particular
8654 # domain of errors. This should be at most 63 characters and match a
8655 # regular expression of `A-Z+[A-Z0-9]`, which represents
8656 # UPPER_SNAKE_CASE.
8657 },
8658 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
8659 #
8660 # For example, if a quota check failed with an error indicating the calling
8661 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
8662 # directly to the right place in the developer console to flip the bit.
8663 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
8664 { # Describes a URL link.
8665 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
8666 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
8667 },
8668 ],
8669 },
8670 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
8671 # which can be attached to an RPC error.
8672 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
8673 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
8674 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
8675 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
8676 },
8677 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
8678 &quot;dimensions&quot;: { # The map holding related quota dimensions.
8679 &quot;a_key&quot;: &quot;A String&quot;,
8680 },
8681 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
8682 # type or metric.
8683 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
8684 # or metric.
8685 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
8686 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
8687 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
8688 },
8689 },
8690 ],
8691 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
8692 # This property is optional.
8693 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
8694 },
8695 ],
8696 },
8697 &quot;getVersionOperationMetadata&quot;: {
8698 &quot;inlineSbomInfo&quot;: {
8699 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
8700 # appropriate identifiers.
8701 &quot;a_key&quot;: &quot;A String&quot;,
8702 },
8703 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
8704 # identifiers.
8705 &quot;a_key&quot;: &quot;A String&quot;,
8706 },
8707 },
8708 },
8709 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
8710 # message that was returned, such as `NOT FOUND`.
8711 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
8712 # status code that was returned. For example, a `404` means the
8713 # resource was not found.
8714 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
8715 # defined by the server.
8716 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
8717 # This value is inRFC3339
8718 # text format.
8719 &quot;instancesBulkInsertOperationMetadata&quot;: {
8720 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
8721 # Example key: zones/us-central1-a
8722 &quot;a_key&quot;: {
8723 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
8724 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
8725 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
8726 # error.
8727 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
8728 # if the flow is rolling forward or rolling back.
8729 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
8730 },
8731 },
8732 },
8733 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
8734 # Operation resources.
8735 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
8736 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
8737 # group of operations results from a `bulkInsert` API request.
8738 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
8739 # `update`, or `delete`, and so on.
8740 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
8741 # There is no requirement that this be linear or support any granularity of
8742 # operations. This should not be used to guess when the operation will be
8743 # complete. This number should monotonically increase as the operation
8744 # progresses.
8745 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
8746 # applicable when performing regional operations.
8747 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
8748 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
8749 # this field will contain information on all underlying zonal actions and
8750 # their state.
8751 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
8752 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
8753 # Example key: zones/us-central1-a
8754 &quot;a_key&quot;: {
8755 &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
8756 # populated.
8757 # different programming environments, including REST APIs and RPC APIs. It is
8758 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
8759 # three pieces of data: error code, error message, and error details.
8760 #
8761 # You can find out more about this error model and how to work with it in the
8762 # [API Design Guide](https://cloud.google.com/apis/design/errors).
8763 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
8764 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
8765 # message types for APIs to use.
8766 {
8767 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
8768 },
8769 ],
8770 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
8771 # user-facing error message should be localized and sent in the
8772 # google.rpc.Status.details field, or localized by the client.
8773 },
8774 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
8775 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
8776 },
8777 },
8778 },
8779 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
8780 # This value is inRFC3339
8781 # text format.
8782 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
8783 # following:
8784 # `PENDING`, `RUNNING`, or `DONE`.
8785 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
8786 # operation.
8787 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
8788 # of the target resource.
8789 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
8790 # operations related to creating a snapshot, this points to the disk
8791 # that the snapshot was created from.
8792 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
8793 # `[email protected]` or
8794 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
8795 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
8796 # operation, this field will be populated.
8797 {
8798 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
8799 # Engine returns NO_RESULTS_ON_PAGE if there
8800 # are no results in the response.
8801 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
8802 # value format. For example:
8803 #
8804 # &quot;data&quot;: [
8805 # {
8806 # &quot;key&quot;: &quot;scope&quot;,
8807 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
8808 # }
8809 {
8810 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
8811 # returned. For example, for warnings where there are no results in a list
8812 # request for a particular zone, this key might be scope and
8813 # the key value might be the zone name. Other examples might be a key
8814 # indicating a deprecated resource and a suggested replacement, or a
8815 # warning about invalid network settings (for example, if an instance
8816 # attempts to perform IP forwarding but is not enabled for IP forwarding).
8817 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
8818 },
8819 ],
8820 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
8821 },
8822 ],
8823 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
8824 # applicable when performing per-zone operations.
8825 }</pre>
8826 </div>
8827
8828 <div class="method">
8829 <code class="details" id="stopInstances">stopInstances(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
8830 <pre>Flags the specified instances in the managed instance group to be
8831 immediately stopped. You can only specify instances that are running in
8832 this request. This method reduces thetargetSize and increases the targetStoppedSize
8833 of the managed instance group by the number of instances that you stop.
8834 The stopInstances operation is marked DONE if
8835 the stopInstances request is successful. The underlying
8836 actions take additional time. You must separately verify the status of theSTOPPING action with thelistmanagedinstances
8837 method.
8838
8839 If the standbyPolicy.initialDelaySec field is set, the group
8840 delays stopping the instances until initialDelaySec have
8841 passed from instance.creationTimestamp (that is, when the
8842 instance was created). This delay gives your application time to
8843 set itself up and initialize on the instance. If more thaninitialDelaySec seconds have passed sinceinstance.creationTimestamp when this method is called, there
8844 will be zero delay.
8845
8846 If the group is part of a backend
8847 service that has enabled
8848 connection draining, it can take up to 60 seconds after the connection
8849 draining duration has elapsed before the VM instance is stopped.
8850
8851 Stopped instances can be started using the startInstances
8852 method.
8853
8854 You can specify a maximum of 1000 instances with this method per request.
8855
8856 Args:
8857 project: string, Project ID for this request. (required)
8858 region: string, Name of the region scoping this request. (required)
8859 instanceGroupManager: string, The name of the managed instance group. (required)
8860 body: object, The request body.
8861 The object takes the form of:
8862
8863 {
8864 &quot;forceStop&quot;: True or False, # If this flag is set to true, the Instance Group Manager will proceed to
8865 # stop the instances, skipping initialization on them.
8866 &quot;instances&quot;: [ # The URLs of one or more instances to stop. This can be a full URL or
8867 # a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].
8868 &quot;A String&quot;,
8869 ],
8870 }
8871
8872 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
8873 that if you must retry your request, the server will know to ignore the
8874 request if it has already been completed.
8875
8876 For example, consider a situation where you make an initial request and
8877 the request times out. If you make the request again with the same
8878 request ID, the server can check if original operation with the same
8879 request ID was received, and if so, will ignore the second request. This
8880 prevents clients from accidentally creating duplicate commitments.
8881
8882 The request ID must be
8883 a valid UUID with the exception that zero UUID is not supported
8884 (00000000-0000-0000-0000-000000000000).
8885 x__xgafv: string, V1 error format.
8886 Allowed values
8887 1 - v1 error format
8888 2 - v2 error format
8889
8890 Returns:
8891 An object of the form:
8892
8893 { # Represents an Operation resource.
8894 #
8895 # Google Compute Engine has three Operation resources:
8896 #
8897 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
8898 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
8899 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
8900 #
8901 # You can use an operation resource to manage asynchronous API requests.
8902 # For more information, readHandling
8903 # API responses.
8904 #
8905 # Operations can be global, regional or zonal.
8906 #
8907 # - For global operations, use the `globalOperations`
8908 # resource.
8909 # - For regional operations, use the
8910 # `regionOperations` resource.
8911 # - For zonal operations, use
8912 # the `zoneOperations` resource.
8913 #
8914 #
8915 #
8916 # For more information, read
8917 # Global, Regional, and Zonal Resources.
8918 #
8919 # Note that completed Operation resources have a limited
8920 # retention period.
8921 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
8922 # Not present otherwise.
8923 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
8924 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
8925 # set when the operation is created.
8926 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
8927 # text format.
8928 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
8929 # this field will be populated.
8930 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
8931 # operation.
8932 {
8933 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
8934 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
8935 # details. There is a set of defined message types to use for providing
8936 # details.The syntax depends on the error code. For example,
8937 # QuotaExceededInfo will have details when the error code is
8938 # QUOTA_EXCEEDED.
8939 {
8940 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
8941 #
8942 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
8943 # is not enabled:
8944 #
8945 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
8946 # &quot;domain&quot;: &quot;googleapis.com&quot;
8947 # &quot;metadata&quot;: {
8948 # &quot;resource&quot;: &quot;projects/123&quot;,
8949 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
8950 # }
8951 # }
8952 #
8953 # This response indicates that the pubsub.googleapis.com API is not enabled.
8954 #
8955 # Example of an error that is returned when attempting to create a Spanner
8956 # instance in a region that is out of stock:
8957 #
8958 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
8959 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
8960 # &quot;metadata&quot;: {
8961 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
8962 # }
8963 # }
8964 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
8965 # is typically the registered service name of the tool or product that
8966 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
8967 # generated by some common infrastructure, the error domain must be a
8968 # globally unique value that identifies the infrastructure. For Google API
8969 # infrastructure, the error domain is &quot;googleapis.com&quot;.
8970 &quot;metadatas&quot;: { # Additional structured details about this error.
8971 #
8972 # Keys must match a regular expression of `a-z+` but should
8973 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
8974 # length. When identifying the current value of an exceeded limit, the units
8975 # should be contained in the key, not the value. For example, rather than
8976 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
8977 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
8978 # instances that can be created in a single (batch) request.
8979 &quot;a_key&quot;: &quot;A String&quot;,
8980 },
8981 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
8982 # proximate cause of the error. Error reasons are unique within a particular
8983 # domain of errors. This should be at most 63 characters and match a
8984 # regular expression of `A-Z+[A-Z0-9]`, which represents
8985 # UPPER_SNAKE_CASE.
8986 },
8987 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
8988 #
8989 # For example, if a quota check failed with an error indicating the calling
8990 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
8991 # directly to the right place in the developer console to flip the bit.
8992 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
8993 { # Describes a URL link.
8994 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
8995 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
8996 },
8997 ],
8998 },
8999 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
9000 # which can be attached to an RPC error.
9001 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
9002 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
9003 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
9004 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
9005 },
9006 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
9007 &quot;dimensions&quot;: { # The map holding related quota dimensions.
9008 &quot;a_key&quot;: &quot;A String&quot;,
9009 },
9010 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
9011 # type or metric.
9012 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
9013 # or metric.
9014 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
9015 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
9016 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
9017 },
9018 },
9019 ],
9020 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
9021 # This property is optional.
9022 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
9023 },
9024 ],
9025 },
9026 &quot;getVersionOperationMetadata&quot;: {
9027 &quot;inlineSbomInfo&quot;: {
9028 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
9029 # appropriate identifiers.
9030 &quot;a_key&quot;: &quot;A String&quot;,
9031 },
9032 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
9033 # identifiers.
9034 &quot;a_key&quot;: &quot;A String&quot;,
9035 },
9036 },
9037 },
9038 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
9039 # message that was returned, such as `NOT FOUND`.
9040 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
9041 # status code that was returned. For example, a `404` means the
9042 # resource was not found.
9043 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
9044 # defined by the server.
9045 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
9046 # This value is inRFC3339
9047 # text format.
9048 &quot;instancesBulkInsertOperationMetadata&quot;: {
9049 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
9050 # Example key: zones/us-central1-a
9051 &quot;a_key&quot;: {
9052 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
9053 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
9054 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
9055 # error.
9056 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
9057 # if the flow is rolling forward or rolling back.
9058 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
9059 },
9060 },
9061 },
9062 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
9063 # Operation resources.
9064 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
9065 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
9066 # group of operations results from a `bulkInsert` API request.
9067 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
9068 # `update`, or `delete`, and so on.
9069 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
9070 # There is no requirement that this be linear or support any granularity of
9071 # operations. This should not be used to guess when the operation will be
9072 # complete. This number should monotonically increase as the operation
9073 # progresses.
9074 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
9075 # applicable when performing regional operations.
9076 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
9077 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
9078 # this field will contain information on all underlying zonal actions and
9079 # their state.
9080 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
9081 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
9082 # Example key: zones/us-central1-a
9083 &quot;a_key&quot;: {
9084 &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
9085 # populated.
9086 # different programming environments, including REST APIs and RPC APIs. It is
9087 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
9088 # three pieces of data: error code, error message, and error details.
9089 #
9090 # You can find out more about this error model and how to work with it in the
9091 # [API Design Guide](https://cloud.google.com/apis/design/errors).
9092 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
9093 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
9094 # message types for APIs to use.
9095 {
9096 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
9097 },
9098 ],
9099 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
9100 # user-facing error message should be localized and sent in the
9101 # google.rpc.Status.details field, or localized by the client.
9102 },
9103 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
9104 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
9105 },
9106 },
9107 },
9108 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
9109 # This value is inRFC3339
9110 # text format.
9111 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
9112 # following:
9113 # `PENDING`, `RUNNING`, or `DONE`.
9114 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
9115 # operation.
9116 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
9117 # of the target resource.
9118 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
9119 # operations related to creating a snapshot, this points to the disk
9120 # that the snapshot was created from.
9121 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
9122 # `[email protected]` or
9123 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
9124 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
9125 # operation, this field will be populated.
9126 {
9127 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
9128 # Engine returns NO_RESULTS_ON_PAGE if there
9129 # are no results in the response.
9130 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
9131 # value format. For example:
9132 #
9133 # &quot;data&quot;: [
9134 # {
9135 # &quot;key&quot;: &quot;scope&quot;,
9136 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
9137 # }
9138 {
9139 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
9140 # returned. For example, for warnings where there are no results in a list
9141 # request for a particular zone, this key might be scope and
9142 # the key value might be the zone name. Other examples might be a key
9143 # indicating a deprecated resource and a suggested replacement, or a
9144 # warning about invalid network settings (for example, if an instance
9145 # attempts to perform IP forwarding but is not enabled for IP forwarding).
9146 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
9147 },
9148 ],
9149 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
9150 },
9151 ],
9152 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
9153 # applicable when performing per-zone operations.
9154 }</pre>
9155 </div>
9156
9157 <div class="method">
9158 <code class="details" id="suspendInstances">suspendInstances(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
9159 <pre>Flags the specified instances in the managed instance group to be
9160 immediately suspended. You can only specify instances that are running in
9161 this request. This method reduces thetargetSize and increases the targetSuspendedSize
9162 of the managed instance group by the number of instances that you suspend.
9163 The suspendInstances operation is marked DONE if
9164 the suspendInstances request is successful. The underlying
9165 actions take additional time. You must separately verify the status of theSUSPENDING action with thelistmanagedinstances
9166 method.
9167
9168 If the standbyPolicy.initialDelaySec field is set, the group
9169 delays suspension of the instances until initialDelaySec have
9170 passed from instance.creationTimestamp (that is, when the
9171 instance was created). This delay gives your application time to
9172 set itself up and initialize on the instance. If more thaninitialDelaySec seconds have passed sinceinstance.creationTimestamp when this method is called, there
9173 will be zero delay.
9174
9175 If the group is part of a backend
9176 service that has enabled
9177 connection draining, it can take up to 60 seconds after the connection
9178 draining duration has elapsed before the VM instance is suspended.
9179
9180 Suspended instances can be resumed using the resumeInstances
9181 method.
9182
9183 You can specify a maximum of 1000 instances with this method per request.
9184
9185 Args:
9186 project: string, Project ID for this request. (required)
9187 region: string, Name of the region scoping this request. (required)
9188 instanceGroupManager: string, Name of the managed instance group. (required)
9189 body: object, The request body.
9190 The object takes the form of:
9191
9192 {
9193 &quot;forceSuspend&quot;: True or False, # If this flag is set to true, the Instance Group Manager will proceed to
9194 # suspend the instances, skipping initialization on them.
9195 &quot;instances&quot;: [ # The URLs of one or more instances to suspend. This can be a full URL or
9196 # a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].
9197 &quot;A String&quot;,
9198 ],
9199 }
9200
9201 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
9202 that if you must retry your request, the server will know to ignore the
9203 request if it has already been completed.
9204
9205 For example, consider a situation where you make an initial request and
9206 the request times out. If you make the request again with the same
9207 request ID, the server can check if original operation with the same
9208 request ID was received, and if so, will ignore the second request. This
9209 prevents clients from accidentally creating duplicate commitments.
9210
9211 The request ID must be
9212 a valid UUID with the exception that zero UUID is not supported
9213 (00000000-0000-0000-0000-000000000000).
9214 x__xgafv: string, V1 error format.
9215 Allowed values
9216 1 - v1 error format
9217 2 - v2 error format
9218
9219 Returns:
9220 An object of the form:
9221
9222 { # Represents an Operation resource.
9223 #
9224 # Google Compute Engine has three Operation resources:
9225 #
9226 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
9227 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
9228 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
9229 #
9230 # You can use an operation resource to manage asynchronous API requests.
9231 # For more information, readHandling
9232 # API responses.
9233 #
9234 # Operations can be global, regional or zonal.
9235 #
9236 # - For global operations, use the `globalOperations`
9237 # resource.
9238 # - For regional operations, use the
9239 # `regionOperations` resource.
9240 # - For zonal operations, use
9241 # the `zoneOperations` resource.
9242 #
9243 #
9244 #
9245 # For more information, read
9246 # Global, Regional, and Zonal Resources.
9247 #
9248 # Note that completed Operation resources have a limited
9249 # retention period.
9250 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
9251 # Not present otherwise.
9252 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
9253 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
9254 # set when the operation is created.
9255 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
9256 # text format.
9257 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
9258 # this field will be populated.
9259 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
9260 # operation.
9261 {
9262 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
9263 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
9264 # details. There is a set of defined message types to use for providing
9265 # details.The syntax depends on the error code. For example,
9266 # QuotaExceededInfo will have details when the error code is
9267 # QUOTA_EXCEEDED.
9268 {
9269 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
9270 #
9271 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
9272 # is not enabled:
9273 #
9274 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
9275 # &quot;domain&quot;: &quot;googleapis.com&quot;
9276 # &quot;metadata&quot;: {
9277 # &quot;resource&quot;: &quot;projects/123&quot;,
9278 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
9279 # }
9280 # }
9281 #
9282 # This response indicates that the pubsub.googleapis.com API is not enabled.
9283 #
9284 # Example of an error that is returned when attempting to create a Spanner
9285 # instance in a region that is out of stock:
9286 #
9287 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
9288 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
9289 # &quot;metadata&quot;: {
9290 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
9291 # }
9292 # }
9293 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
9294 # is typically the registered service name of the tool or product that
9295 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
9296 # generated by some common infrastructure, the error domain must be a
9297 # globally unique value that identifies the infrastructure. For Google API
9298 # infrastructure, the error domain is &quot;googleapis.com&quot;.
9299 &quot;metadatas&quot;: { # Additional structured details about this error.
9300 #
9301 # Keys must match a regular expression of `a-z+` but should
9302 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
9303 # length. When identifying the current value of an exceeded limit, the units
9304 # should be contained in the key, not the value. For example, rather than
9305 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
9306 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
9307 # instances that can be created in a single (batch) request.
9308 &quot;a_key&quot;: &quot;A String&quot;,
9309 },
9310 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
9311 # proximate cause of the error. Error reasons are unique within a particular
9312 # domain of errors. This should be at most 63 characters and match a
9313 # regular expression of `A-Z+[A-Z0-9]`, which represents
9314 # UPPER_SNAKE_CASE.
9315 },
9316 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
9317 #
9318 # For example, if a quota check failed with an error indicating the calling
9319 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
9320 # directly to the right place in the developer console to flip the bit.
9321 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
9322 { # Describes a URL link.
9323 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
9324 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
9325 },
9326 ],
9327 },
9328 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
9329 # which can be attached to an RPC error.
9330 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
9331 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
9332 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
9333 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
9334 },
9335 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
9336 &quot;dimensions&quot;: { # The map holding related quota dimensions.
9337 &quot;a_key&quot;: &quot;A String&quot;,
9338 },
9339 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
9340 # type or metric.
9341 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
9342 # or metric.
9343 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
9344 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
9345 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
9346 },
9347 },
9348 ],
9349 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
9350 # This property is optional.
9351 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
9352 },
9353 ],
9354 },
9355 &quot;getVersionOperationMetadata&quot;: {
9356 &quot;inlineSbomInfo&quot;: {
9357 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
9358 # appropriate identifiers.
9359 &quot;a_key&quot;: &quot;A String&quot;,
9360 },
9361 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
9362 # identifiers.
9363 &quot;a_key&quot;: &quot;A String&quot;,
9364 },
9365 },
9366 },
9367 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
9368 # message that was returned, such as `NOT FOUND`.
9369 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
9370 # status code that was returned. For example, a `404` means the
9371 # resource was not found.
9372 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
9373 # defined by the server.
9374 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
9375 # This value is inRFC3339
9376 # text format.
9377 &quot;instancesBulkInsertOperationMetadata&quot;: {
9378 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
9379 # Example key: zones/us-central1-a
9380 &quot;a_key&quot;: {
9381 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
9382 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
9383 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
9384 # error.
9385 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
9386 # if the flow is rolling forward or rolling back.
9387 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
9388 },
9389 },
9390 },
9391 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
9392 # Operation resources.
9393 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
9394 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
9395 # group of operations results from a `bulkInsert` API request.
9396 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
9397 # `update`, or `delete`, and so on.
9398 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
9399 # There is no requirement that this be linear or support any granularity of
9400 # operations. This should not be used to guess when the operation will be
9401 # complete. This number should monotonically increase as the operation
9402 # progresses.
9403 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
9404 # applicable when performing regional operations.
9405 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
9406 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
9407 # this field will contain information on all underlying zonal actions and
9408 # their state.
9409 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
9410 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
9411 # Example key: zones/us-central1-a
9412 &quot;a_key&quot;: {
9413 &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
9414 # populated.
9415 # different programming environments, including REST APIs and RPC APIs. It is
9416 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
9417 # three pieces of data: error code, error message, and error details.
9418 #
9419 # You can find out more about this error model and how to work with it in the
9420 # [API Design Guide](https://cloud.google.com/apis/design/errors).
9421 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
9422 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
9423 # message types for APIs to use.
9424 {
9425 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
9426 },
9427 ],
9428 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
9429 # user-facing error message should be localized and sent in the
9430 # google.rpc.Status.details field, or localized by the client.
9431 },
9432 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
9433 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
9434 },
9435 },
9436 },
9437 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
9438 # This value is inRFC3339
9439 # text format.
9440 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
9441 # following:
9442 # `PENDING`, `RUNNING`, or `DONE`.
9443 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
9444 # operation.
9445 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
9446 # of the target resource.
9447 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
9448 # operations related to creating a snapshot, this points to the disk
9449 # that the snapshot was created from.
9450 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
9451 # `[email protected]` or
9452 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
9453 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
9454 # operation, this field will be populated.
9455 {
9456 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
9457 # Engine returns NO_RESULTS_ON_PAGE if there
9458 # are no results in the response.
9459 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
9460 # value format. For example:
9461 #
9462 # &quot;data&quot;: [
9463 # {
9464 # &quot;key&quot;: &quot;scope&quot;,
9465 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
9466 # }
9467 {
9468 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
9469 # returned. For example, for warnings where there are no results in a list
9470 # request for a particular zone, this key might be scope and
9471 # the key value might be the zone name. Other examples might be a key
9472 # indicating a deprecated resource and a suggested replacement, or a
9473 # warning about invalid network settings (for example, if an instance
9474 # attempts to perform IP forwarding but is not enabled for IP forwarding).
9475 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
9476 },
9477 ],
9478 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
9479 },
9480 ],
9481 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
9482 # applicable when performing per-zone operations.
9483 }</pre>
9484 </div>
9485
9486 <div class="method">
9487 <code class="details" id="updatePerInstanceConfigs">updatePerInstanceConfigs(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)</code>
9488 <pre>Inserts or updates per-instance configurations for the managed instance
9489 group. perInstanceConfig.name serves as a key used to
9490 distinguish whether to perform insert or patch.
9491
9492 Args:
9493 project: string, Project ID for this request. (required)
9494 region: string, Name of the region scoping this request, should conform to RFC1035. (required)
9495 instanceGroupManager: string, The name of the managed instance group.
9496 It should conform to RFC1035. (required)
9497 body: object, The request body.
9498 The object takes the form of:
9499
9500 { # RegionInstanceGroupManagers.updatePerInstanceConfigs
9501 &quot;perInstanceConfigs&quot;: [ # The list of per-instance configurations to insert or patch on this managed
9502 # instance group.
9503 {
9504 &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this per-instance config. This field can be used in
9505 # optimistic locking. It is ignored when inserting a per-instance
9506 # config. An up-to-date fingerprint must be provided in order to update an
9507 # existing per-instance configuration or the field needs to be unset.
9508 &quot;name&quot;: &quot;A String&quot;, # The name of a per-instance configuration and its corresponding instance.
9509 # Serves as a merge key during UpdatePerInstanceConfigs
9510 # operations, that is, if a per-instance configuration with the same name
9511 # exists then it will be updated, otherwise a new one will be created for the
9512 # VM instance with the same name. An attempt to create a per-instance
9513 # configuration for a VM instance that either doesn&#x27;t exist or is not part
9514 # of the group will result in an error.
9515 &quot;preservedState&quot;: { # Preserved state for a given instance. # The intended preserved state for the given instance. Does not contain
9516 # preserved state generated from a stateful policy.
9517 &quot;disks&quot;: { # Preserved disks defined for this instance.
9518 # This map is keyed with the device names of the disks.
9519 &quot;a_key&quot;: {
9520 &quot;autoDelete&quot;: &quot;A String&quot;, # These stateful disks will never be deleted during autohealing,
9521 # update, instance recreate operations. This flag is used to configure
9522 # if the disk should be deleted after it is no longer used by the group,
9523 # e.g. when the given instance or the whole MIG is deleted.
9524 # Note: disks attached in READ_ONLY mode cannot be
9525 # auto-deleted.
9526 &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
9527 # disk in READ_WRITE mode.
9528 &quot;source&quot;: &quot;A String&quot;, # The URL of the disk resource that is stateful and should be attached
9529 # to the VM instance.
9530 },
9531 },
9532 &quot;externalIPs&quot;: { # Preserved external IPs defined for this instance.
9533 # This map is keyed with the name of the network interface.
9534 &quot;a_key&quot;: {
9535 &quot;autoDelete&quot;: &quot;A String&quot;, # These stateful IPs will never be released during autohealing,
9536 # update or VM instance recreate operations.
9537 # This flag is used to configure if the IP reservation should be deleted
9538 # after it is no longer used by the group, e.g. when the given instance
9539 # or the whole group is deleted.
9540 &quot;ipAddress&quot;: { # Ip address representation
9541 &quot;address&quot;: &quot;A String&quot;, # The URL of the reservation for this IP address.
9542 &quot;literal&quot;: &quot;A String&quot;, # An IPv4 internal network address to assign to the instance for this
9543 # network interface.
9544 },
9545 },
9546 },
9547 &quot;internalIPs&quot;: { # Preserved internal IPs defined for this instance.
9548 # This map is keyed with the name of the network interface.
9549 &quot;a_key&quot;: {
9550 &quot;autoDelete&quot;: &quot;A String&quot;, # These stateful IPs will never be released during autohealing,
9551 # update or VM instance recreate operations.
9552 # This flag is used to configure if the IP reservation should be deleted
9553 # after it is no longer used by the group, e.g. when the given instance
9554 # or the whole group is deleted.
9555 &quot;ipAddress&quot;: { # Ip address representation
9556 &quot;address&quot;: &quot;A String&quot;, # The URL of the reservation for this IP address.
9557 &quot;literal&quot;: &quot;A String&quot;, # An IPv4 internal network address to assign to the instance for this
9558 # network interface.
9559 },
9560 },
9561 },
9562 &quot;metadata&quot;: { # Preserved metadata defined for this instance.
9563 &quot;a_key&quot;: &quot;A String&quot;,
9564 },
9565 },
9566 &quot;status&quot;: &quot;A String&quot;, # The status of applying this per-instance configuration on the corresponding
9567 # managed instance.
9568 },
9569 ],
9570 }
9571
9572 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
9573 that if you must retry your request, the server will know to ignore the
9574 request if it has already been completed.
9575
9576 For example, consider a situation where you make an initial request and
9577 the request times out. If you make the request again with the same
9578 request ID, the server can check if original operation with the same
9579 request ID was received, and if so, will ignore the second request. This
9580 prevents clients from accidentally creating duplicate commitments.
9581
9582 The request ID must be
9583 a valid UUID with the exception that zero UUID is not supported
9584 (00000000-0000-0000-0000-000000000000).
9585 x__xgafv: string, V1 error format.
9586 Allowed values
9587 1 - v1 error format
9588 2 - v2 error format
9589
9590 Returns:
9591 An object of the form:
9592
9593 { # Represents an Operation resource.
9594 #
9595 # Google Compute Engine has three Operation resources:
9596 #
9597 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
9598 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
9599 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
9600 #
9601 # You can use an operation resource to manage asynchronous API requests.
9602 # For more information, readHandling
9603 # API responses.
9604 #
9605 # Operations can be global, regional or zonal.
9606 #
9607 # - For global operations, use the `globalOperations`
9608 # resource.
9609 # - For regional operations, use the
9610 # `regionOperations` resource.
9611 # - For zonal operations, use
9612 # the `zoneOperations` resource.
9613 #
9614 #
9615 #
9616 # For more information, read
9617 # Global, Regional, and Zonal Resources.
9618 #
9619 # Note that completed Operation resources have a limited
9620 # retention period.
9621 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
9622 # Not present otherwise.
9623 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
9624 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
9625 # set when the operation is created.
9626 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
9627 # text format.
9628 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
9629 # this field will be populated.
9630 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
9631 # operation.
9632 {
9633 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
9634 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
9635 # details. There is a set of defined message types to use for providing
9636 # details.The syntax depends on the error code. For example,
9637 # QuotaExceededInfo will have details when the error code is
9638 # QUOTA_EXCEEDED.
9639 {
9640 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
9641 #
9642 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
9643 # is not enabled:
9644 #
9645 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
9646 # &quot;domain&quot;: &quot;googleapis.com&quot;
9647 # &quot;metadata&quot;: {
9648 # &quot;resource&quot;: &quot;projects/123&quot;,
9649 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
9650 # }
9651 # }
9652 #
9653 # This response indicates that the pubsub.googleapis.com API is not enabled.
9654 #
9655 # Example of an error that is returned when attempting to create a Spanner
9656 # instance in a region that is out of stock:
9657 #
9658 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
9659 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
9660 # &quot;metadata&quot;: {
9661 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
9662 # }
9663 # }
9664 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
9665 # is typically the registered service name of the tool or product that
9666 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
9667 # generated by some common infrastructure, the error domain must be a
9668 # globally unique value that identifies the infrastructure. For Google API
9669 # infrastructure, the error domain is &quot;googleapis.com&quot;.
9670 &quot;metadatas&quot;: { # Additional structured details about this error.
9671 #
9672 # Keys must match a regular expression of `a-z+` but should
9673 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
9674 # length. When identifying the current value of an exceeded limit, the units
9675 # should be contained in the key, not the value. For example, rather than
9676 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
9677 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
9678 # instances that can be created in a single (batch) request.
9679 &quot;a_key&quot;: &quot;A String&quot;,
9680 },
9681 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
9682 # proximate cause of the error. Error reasons are unique within a particular
9683 # domain of errors. This should be at most 63 characters and match a
9684 # regular expression of `A-Z+[A-Z0-9]`, which represents
9685 # UPPER_SNAKE_CASE.
9686 },
9687 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
9688 #
9689 # For example, if a quota check failed with an error indicating the calling
9690 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
9691 # directly to the right place in the developer console to flip the bit.
9692 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
9693 { # Describes a URL link.
9694 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
9695 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
9696 },
9697 ],
9698 },
9699 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
9700 # which can be attached to an RPC error.
9701 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
9702 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
9703 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
9704 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
9705 },
9706 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
9707 &quot;dimensions&quot;: { # The map holding related quota dimensions.
9708 &quot;a_key&quot;: &quot;A String&quot;,
9709 },
9710 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
9711 # type or metric.
9712 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
9713 # or metric.
9714 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
9715 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
9716 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
9717 },
9718 },
9719 ],
9720 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
9721 # This property is optional.
9722 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
9723 },
9724 ],
9725 },
9726 &quot;getVersionOperationMetadata&quot;: {
9727 &quot;inlineSbomInfo&quot;: {
9728 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
9729 # appropriate identifiers.
9730 &quot;a_key&quot;: &quot;A String&quot;,
9731 },
9732 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
9733 # identifiers.
9734 &quot;a_key&quot;: &quot;A String&quot;,
9735 },
9736 },
9737 },
9738 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
9739 # message that was returned, such as `NOT FOUND`.
9740 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
9741 # status code that was returned. For example, a `404` means the
9742 # resource was not found.
9743 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
9744 # defined by the server.
9745 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
9746 # This value is inRFC3339
9747 # text format.
9748 &quot;instancesBulkInsertOperationMetadata&quot;: {
9749 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
9750 # Example key: zones/us-central1-a
9751 &quot;a_key&quot;: {
9752 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
9753 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
9754 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
9755 # error.
9756 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
9757 # if the flow is rolling forward or rolling back.
9758 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
9759 },
9760 },
9761 },
9762 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
9763 # Operation resources.
9764 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
9765 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
9766 # group of operations results from a `bulkInsert` API request.
9767 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
9768 # `update`, or `delete`, and so on.
9769 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
9770 # There is no requirement that this be linear or support any granularity of
9771 # operations. This should not be used to guess when the operation will be
9772 # complete. This number should monotonically increase as the operation
9773 # progresses.
9774 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
9775 # applicable when performing regional operations.
9776 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
9777 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
9778 # this field will contain information on all underlying zonal actions and
9779 # their state.
9780 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
9781 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
9782 # Example key: zones/us-central1-a
9783 &quot;a_key&quot;: {
9784 &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
9785 # populated.
9786 # different programming environments, including REST APIs and RPC APIs. It is
9787 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
9788 # three pieces of data: error code, error message, and error details.
9789 #
9790 # You can find out more about this error model and how to work with it in the
9791 # [API Design Guide](https://cloud.google.com/apis/design/errors).
9792 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
9793 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
9794 # message types for APIs to use.
9795 {
9796 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
9797 },
9798 ],
9799 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
9800 # user-facing error message should be localized and sent in the
9801 # google.rpc.Status.details field, or localized by the client.
9802 },
9803 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
9804 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
9805 },
9806 },
9807 },
9808 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
9809 # This value is inRFC3339
9810 # text format.
9811 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
9812 # following:
9813 # `PENDING`, `RUNNING`, or `DONE`.
9814 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
9815 # operation.
9816 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
9817 # of the target resource.
9818 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
9819 # operations related to creating a snapshot, this points to the disk
9820 # that the snapshot was created from.
9821 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
9822 # `[email protected]` or
9823 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
9824 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
9825 # operation, this field will be populated.
9826 {
9827 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
9828 # Engine returns NO_RESULTS_ON_PAGE if there
9829 # are no results in the response.
9830 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
9831 # value format. For example:
9832 #
9833 # &quot;data&quot;: [
9834 # {
9835 # &quot;key&quot;: &quot;scope&quot;,
9836 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
9837 # }
9838 {
9839 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
9840 # returned. For example, for warnings where there are no results in a list
9841 # request for a particular zone, this key might be scope and
9842 # the key value might be the zone name. Other examples might be a key
9843 # indicating a deprecated resource and a suggested replacement, or a
9844 # warning about invalid network settings (for example, if an instance
9845 # attempts to perform IP forwarding but is not enabled for IP forwarding).
9846 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
9847 },
9848 ],
9849 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
9850 },
9851 ],
9852 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
9853 # applicable when performing per-zone operations.
9854 }</pre>
9855 </div>
9856
9857 </body></html>