Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 0669410c6b2c48884ae31671b9d710a9ff6346c6 / . / docs / dyn / compute_v1.instanceGroupManagers.html
blob: 0c0ca8a0d4d9ae1484e094bc34bfb2ccdf688e95 [file] [log] [blame]
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame^]1<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="compute_v1.html">Compute Engine API</a> . <a href="compute_v1.instanceGroupManagers.html">instanceGroupManagers</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#abandonInstances">abandonInstances(project, zone, instanceGroupManager, body)</a></code></p>
79<p class="firstline">Removes the specified instances from the managed instance group, and from any target pools where they are a member. The instances are not deleted. The managed instance group automatically reduces its targetSize value by the number of instances that you abandon from the group.</p>
80<p class="toc_element">
81 <code><a href="#aggregatedList">aggregatedList(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
82<p class="firstline">Retrieves the list of managed instance groups, and groups them by project and zone.</p>
83<p class="toc_element">
84 <code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p>
85<p class="firstline">Retrieves the next page of results.</p>
86<p class="toc_element">
87 <code><a href="#delete">delete(project, zone, instanceGroupManager)</a></code></p>
88<p class="firstline">Deletes the specified managed instance group resource.</p>
89<p class="toc_element">
90 <code><a href="#deleteInstances">deleteInstances(project, zone, instanceGroupManager, body)</a></code></p>
91<p class="firstline">Deletes the specified instances. The instances are deleted and removed from the instance group and any target pools where they are a member. The managed instance group automatically reduces its targetSize value by the number of instances that you delete.</p>
92<p class="toc_element">
93 <code><a href="#get">get(project, zone, instanceGroupManager)</a></code></p>
94<p class="firstline">Returns the specified managed instance group resource.</p>
95<p class="toc_element">
96 <code><a href="#insert">insert(project, zone, body)</a></code></p>
97<p class="firstline">Creates a managed instance group resource in the specified project using the data that is included in the request.</p>
98<p class="toc_element">
99 <code><a href="#list">list(project, zone, maxResults=None, pageToken=None, filter=None)</a></code></p>
100<p class="firstline">Retrieves a list of managed instance groups that are contained within the specified project and zone.</p>
101<p class="toc_element">
102 <code><a href="#listManagedInstances">listManagedInstances(project, zone, instanceGroupManager)</a></code></p>
103<p class="firstline">Lists managed instances.</p>
104<p class="toc_element">
105 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
106<p class="firstline">Retrieves the next page of results.</p>
107<p class="toc_element">
108 <code><a href="#recreateInstances">recreateInstances(project, zone, instanceGroupManager, body)</a></code></p>
109<p class="firstline">Recreates the specified instances. The instances are deleted, then recreated using the managed instance group's current instance template.</p>
110<p class="toc_element">
111 <code><a href="#resize">resize(project, zone, instanceGroupManager, size)</a></code></p>
112<p class="firstline">Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group removes instances in the order that is outlined in Resizing a managed instance group.</p>
113<p class="toc_element">
114 <code><a href="#setInstanceTemplate">setInstanceTemplate(project, zone, instanceGroupManager, body)</a></code></p>
115<p class="firstline">Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you recreate them.</p>
116<p class="toc_element">
117 <code><a href="#setTargetPools">setTargetPools(project, zone, instanceGroupManager, body)</a></code></p>
118<p class="firstline">Modifies the target pools to which all new instances in this group are assigned. The target pools for existing instances in the group do not change unless you recreate them.</p>
119<h3>Method Details</h3>
120<div class="method">
121 <code class="details" id="abandonInstances">abandonInstances(project, zone, instanceGroupManager, body)</code>
122 <pre>Removes the specified instances from the managed instance group, and from any target pools where they are a member. The instances are not deleted. The managed instance group automatically reduces its targetSize value by the number of instances that you abandon from the group.
123
124Args:
125 project: string, The project ID for this request. (required)
126 zone: string, The URL of the zone where the managed instance group is located. (required)
127 instanceGroupManager: string, The name of the instance group manager. (required)
128 body: object, The request body. (required)
129 The object takes the form of:
130
131{
132 "instances": [ # The names of instances to abandon from the managed instance group.
133 "A String",
134 ],
135 }
136
137
138Returns:
139 An object of the form:
140
141 { # An Operation resource, used to manage asynchronous API requests.
142 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
143 "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project.
144 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
145 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
146 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
147 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
148 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
149 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should monotonically increase as the operation progresses.
150 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
151 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
152 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
153 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
154 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
155 {
156 "message": "A String", # [Output Only] Optional human-readable details for this warning.
157 "code": "A String", # [Output Only] The warning type identifier for this warning.
158 "data": [ # [Output Only] Metadata for this warning in key: value format.
159 {
160 "value": "A String", # [Output Only] A warning data value corresponding to the key.
161 "key": "A String", # [Output Only] A key for the warning data.
162 },
163 ],
164 },
165 ],
166 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
167 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
168 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
169 "name": "A String", # [Output Only] Name of the resource.
170 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
171 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
172 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
173 {
174 "message": "A String", # [Output Only] An optional, human-readable error message.
175 "code": "A String", # [Output Only] The error type identifier for this error.
176 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
177 },
178 ],
179 },
180 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
181 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
182 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
183 }</pre>
184</div>
185
186<div class="method">
187 <code class="details" id="aggregatedList">aggregatedList(project, maxResults=None, pageToken=None, filter=None)</code>
188 <pre>Retrieves the list of managed instance groups, and groups them by project and zone.
189
190Args:
191 project: string, The project ID for this request. (required)
192 maxResults: integer, Maximum count of results to be returned.
193 pageToken: string, Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.
194 filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.
195
196The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
197
198For example, filter=name ne example-instance.
199
200Returns:
201 An object of the form:
202
203 {
204 "nextPageToken": "A String", # [Output Only] A token that is used to continue a truncated list request.
205 "items": { # A map of filtered managed instance group lists.
206 "a_key": { # The name of the scope that contains this set of managed instance groups.
207 "warning": { # [Output Only] The warning that replaces the list of managed instance groups when the list is empty.
208 "message": "A String", # [Output Only] Optional human-readable details for this warning.
209 "code": "A String", # [Output Only] The warning type identifier for this warning.
210 "data": [ # [Output Only] Metadata for this warning in key: value format.
211 {
212 "value": "A String", # [Output Only] A warning data value corresponding to the key.
213 "key": "A String", # [Output Only] A key for the warning data.
214 },
215 ],
216 },
217 "instanceGroupManagers": [ # [Output Only] The list of managed instance groups that are contained in the specified project and zone.
218 { # InstanceGroupManagers
219 #
220 # Next available tag: 19
221 "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for those actions.
222 "none": 42, # [Output Only] The number of instances in the managed instance group that currently have no scheduled actions.
223 "recreating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.
224 "creating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created.
225 "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
226 "abandoning": 42, # [Output Only] Total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.
227 "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
228 "refreshing": 42, # [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.
229 },
230 "description": "A String", # An optional text description for the managed instance group.
231 "zone": "A String", # The URL of the zone where the managed instance group is located.
232 "targetSize": 42, # The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.
233 "instanceGroup": "A String", # [Output Only] The URL of the InstanceGroup resource.
234 "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
235 "targetPools": [ # The URLs of all TargetPool resources to which new instances in the instanceGroup field are added. Updating the target pool values does not affect existing instances.
236 "A String",
237 ],
238 "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.
239 "fingerprint": "A String", # [Output Only] The fingerprint of the target pools information, which is a hash of the contents. This field is used for optimistic locking when updating the target pool entries.
240 "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.
241 "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
242 "id": "A String", # [Output Only] A unique identifier for this managed instance group. The server defines this identifier.
243 "selfLink": "A String", # [Output Only] Server-defined URL for this managed instance group.
244 "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.
245 },
246 ],
247 },
248 },
249 "kind": "compute#instanceGroupManagerAggregatedList", # [Output Only] Type of the resource. Always compute#instanceGroupManagerAggregatedList for an aggregated list of managed instance groups.
250 "id": "A String", # [Output Only] A unique identifier for this aggregated list of managed instance groups. The server defines this identifier.
251 "selfLink": "A String", # [Output Only] The URL for this aggregated list of managed instance groups. The server defines this URL.
252 }</pre>
253</div>
254
255<div class="method">
256 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
257 <pre>Retrieves the next page of results.
258
259Args:
260 previous_request: The request for the previous page. (required)
261 previous_response: The response from the request for the previous page. (required)
262
263Returns:
264 A request object that you can call 'execute()' on to request the next
265 page. Returns None if there are no more items in the collection.
266 </pre>
267</div>
268
269<div class="method">
270 <code class="details" id="delete">delete(project, zone, instanceGroupManager)</code>
271 <pre>Deletes the specified managed instance group resource.
272
273Args:
274 project: string, The project ID for this request. (required)
275 zone: string, The URL of the zone where the managed instance group is located. (required)
276 instanceGroupManager: string, The name of the instance group manager to delete. (required)
277
278Returns:
279 An object of the form:
280
281 { # An Operation resource, used to manage asynchronous API requests.
282 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
283 "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project.
284 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
285 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
286 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
287 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
288 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
289 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should monotonically increase as the operation progresses.
290 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
291 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
292 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
293 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
294 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
295 {
296 "message": "A String", # [Output Only] Optional human-readable details for this warning.
297 "code": "A String", # [Output Only] The warning type identifier for this warning.
298 "data": [ # [Output Only] Metadata for this warning in key: value format.
299 {
300 "value": "A String", # [Output Only] A warning data value corresponding to the key.
301 "key": "A String", # [Output Only] A key for the warning data.
302 },
303 ],
304 },
305 ],
306 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
307 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
308 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
309 "name": "A String", # [Output Only] Name of the resource.
310 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
311 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
312 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
313 {
314 "message": "A String", # [Output Only] An optional, human-readable error message.
315 "code": "A String", # [Output Only] The error type identifier for this error.
316 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
317 },
318 ],
319 },
320 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
321 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
322 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
323 }</pre>
324</div>
325
326<div class="method">
327 <code class="details" id="deleteInstances">deleteInstances(project, zone, instanceGroupManager, body)</code>
328 <pre>Deletes the specified instances. The instances are deleted and removed from the instance group and any target pools where they are a member. The managed instance group automatically reduces its targetSize value by the number of instances that you delete.
329
330Args:
331 project: string, The project ID for this request. (required)
332 zone: string, The URL of the zone where the managed instance group is located. (required)
333 instanceGroupManager: string, The name of the instance group manager. (required)
334 body: object, The request body. (required)
335 The object takes the form of:
336
337{
338 "instances": [ # The names of one or more instances to delete.
339 "A String",
340 ],
341 }
342
343
344Returns:
345 An object of the form:
346
347 { # An Operation resource, used to manage asynchronous API requests.
348 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
349 "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project.
350 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
351 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
352 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
353 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
354 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
355 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should monotonically increase as the operation progresses.
356 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
357 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
358 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
359 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
360 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
361 {
362 "message": "A String", # [Output Only] Optional human-readable details for this warning.
363 "code": "A String", # [Output Only] The warning type identifier for this warning.
364 "data": [ # [Output Only] Metadata for this warning in key: value format.
365 {
366 "value": "A String", # [Output Only] A warning data value corresponding to the key.
367 "key": "A String", # [Output Only] A key for the warning data.
368 },
369 ],
370 },
371 ],
372 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
373 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
374 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
375 "name": "A String", # [Output Only] Name of the resource.
376 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
377 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
378 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
379 {
380 "message": "A String", # [Output Only] An optional, human-readable error message.
381 "code": "A String", # [Output Only] The error type identifier for this error.
382 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
383 },
384 ],
385 },
386 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
387 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
388 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
389 }</pre>
390</div>
391
392<div class="method">
393 <code class="details" id="get">get(project, zone, instanceGroupManager)</code>
394 <pre>Returns the specified managed instance group resource.
395
396Args:
397 project: string, The project ID for this request. (required)
398 zone: string, The URL of the zone where the managed instance group is located. (required)
399 instanceGroupManager: string, The name of the instance group manager resource. (required)
400
401Returns:
402 An object of the form:
403
404 { # InstanceGroupManagers
405 #
406 # Next available tag: 19
407 "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for those actions.
408 "none": 42, # [Output Only] The number of instances in the managed instance group that currently have no scheduled actions.
409 "recreating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.
410 "creating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created.
411 "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
412 "abandoning": 42, # [Output Only] Total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.
413 "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
414 "refreshing": 42, # [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.
415 },
416 "description": "A String", # An optional text description for the managed instance group.
417 "zone": "A String", # The URL of the zone where the managed instance group is located.
418 "targetSize": 42, # The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.
419 "instanceGroup": "A String", # [Output Only] The URL of the InstanceGroup resource.
420 "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
421 "targetPools": [ # The URLs of all TargetPool resources to which new instances in the instanceGroup field are added. Updating the target pool values does not affect existing instances.
422 "A String",
423 ],
424 "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.
425 "fingerprint": "A String", # [Output Only] The fingerprint of the target pools information, which is a hash of the contents. This field is used for optimistic locking when updating the target pool entries.
426 "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.
427 "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
428 "id": "A String", # [Output Only] A unique identifier for this managed instance group. The server defines this identifier.
429 "selfLink": "A String", # [Output Only] Server-defined URL for this managed instance group.
430 "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.
431 }</pre>
432</div>
433
434<div class="method">
435 <code class="details" id="insert">insert(project, zone, body)</code>
436 <pre>Creates a managed instance group resource in the specified project using the data that is included in the request.
437
438Args:
439 project: string, The project ID for this request. (required)
440 zone: string, The URL of the zone where the managed instance group is located. (required)
441 body: object, The request body. (required)
442 The object takes the form of:
443
444{ # InstanceGroupManagers
445 #
446 # Next available tag: 19
447 "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for those actions.
448 "none": 42, # [Output Only] The number of instances in the managed instance group that currently have no scheduled actions.
449 "recreating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.
450 "creating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created.
451 "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
452 "abandoning": 42, # [Output Only] Total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.
453 "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
454 "refreshing": 42, # [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.
455 },
456 "description": "A String", # An optional text description for the managed instance group.
457 "zone": "A String", # The URL of the zone where the managed instance group is located.
458 "targetSize": 42, # The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.
459 "instanceGroup": "A String", # [Output Only] The URL of the InstanceGroup resource.
460 "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
461 "targetPools": [ # The URLs of all TargetPool resources to which new instances in the instanceGroup field are added. Updating the target pool values does not affect existing instances.
462 "A String",
463 ],
464 "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.
465 "fingerprint": "A String", # [Output Only] The fingerprint of the target pools information, which is a hash of the contents. This field is used for optimistic locking when updating the target pool entries.
466 "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.
467 "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
468 "id": "A String", # [Output Only] A unique identifier for this managed instance group. The server defines this identifier.
469 "selfLink": "A String", # [Output Only] Server-defined URL for this managed instance group.
470 "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.
471 }
472
473
474Returns:
475 An object of the form:
476
477 { # An Operation resource, used to manage asynchronous API requests.
478 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
479 "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project.
480 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
481 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
482 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
483 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
484 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
485 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should monotonically increase as the operation progresses.
486 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
487 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
488 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
489 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
490 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
491 {
492 "message": "A String", # [Output Only] Optional human-readable details for this warning.
493 "code": "A String", # [Output Only] The warning type identifier for this warning.
494 "data": [ # [Output Only] Metadata for this warning in key: value format.
495 {
496 "value": "A String", # [Output Only] A warning data value corresponding to the key.
497 "key": "A String", # [Output Only] A key for the warning data.
498 },
499 ],
500 },
501 ],
502 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
503 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
504 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
505 "name": "A String", # [Output Only] Name of the resource.
506 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
507 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
508 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
509 {
510 "message": "A String", # [Output Only] An optional, human-readable error message.
511 "code": "A String", # [Output Only] The error type identifier for this error.
512 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
513 },
514 ],
515 },
516 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
517 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
518 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
519 }</pre>
520</div>
521
522<div class="method">
523 <code class="details" id="list">list(project, zone, maxResults=None, pageToken=None, filter=None)</code>
524 <pre>Retrieves a list of managed instance groups that are contained within the specified project and zone.
525
526Args:
527 project: string, The project ID for this request. (required)
528 zone: string, The URL of the zone where the managed instance group is located. (required)
529 maxResults: integer, Maximum count of results to be returned.
530 pageToken: string, Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.
531 filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.
532
533The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
534
535For example, filter=name ne example-instance.
536
537Returns:
538 An object of the form:
539
540 { # [Output Only] A list of InstanceGroupManager resources.
541 "nextPageToken": "A String", # [Output Only] A token that is used to continue a truncated list request.
542 "items": [ # [Output Only] A list of managed instance group resources.
543 { # InstanceGroupManagers
544 #
545 # Next available tag: 19
546 "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for those actions.
547 "none": 42, # [Output Only] The number of instances in the managed instance group that currently have no scheduled actions.
548 "recreating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.
549 "creating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created.
550 "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
551 "abandoning": 42, # [Output Only] Total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.
552 "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
553 "refreshing": 42, # [Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.
554 },
555 "description": "A String", # An optional text description for the managed instance group.
556 "zone": "A String", # The URL of the zone where the managed instance group is located.
557 "targetSize": 42, # The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.
558 "instanceGroup": "A String", # [Output Only] The URL of the InstanceGroup resource.
559 "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
560 "targetPools": [ # The URLs of all TargetPool resources to which new instances in the instanceGroup field are added. Updating the target pool values does not affect existing instances.
561 "A String",
562 ],
563 "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.
564 "fingerprint": "A String", # [Output Only] The fingerprint of the target pools information, which is a hash of the contents. This field is used for optimistic locking when updating the target pool entries.
565 "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.
566 "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
567 "id": "A String", # [Output Only] A unique identifier for this managed instance group. The server defines this identifier.
568 "selfLink": "A String", # [Output Only] Server-defined URL for this managed instance group.
569 "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.
570 },
571 ],
572 "kind": "compute#instanceGroupManagerList", # [Output Only] Type of the resource. Always compute#instanceGroupManagerList for a list of managed instance group resources.
573 "id": "A String", # [Output Only] A unique identifier for this managed instance group. The server defines this identifier.
574 "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
575 }</pre>
576</div>
577
578<div class="method">
579 <code class="details" id="listManagedInstances">listManagedInstances(project, zone, instanceGroupManager)</code>
580 <pre>Lists managed instances.
581
582Args:
583 project: string, The project ID for this request. (required)
584 zone: string, The URL of the zone where the managed instance group is located. (required)
585 instanceGroupManager: string, The name of the managed instance group. (required)
586
587Returns:
588 An object of the form:
589
590 {
591 "managedInstances": [ # List of managed instances. If empty - all instances are listed.
592 {
593 "currentAction": "A String", # The current action that the managed instance group has scheduled for the instance.
594 "instance": "A String", # The URL of the instance (set even though instance does not exist yet).
595 "lastAttempt": { # Information about the last attempt to create or delete the instance.
596 "errors": { # Encountered errors during the last attempt to create or delete the instance.
597 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
598 {
599 "message": "A String", # [Output Only] An optional, human-readable error message.
600 "code": "A String", # [Output Only] The error type identifier for this error.
601 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
602 },
603 ],
604 },
605 },
606 "id": "A String", # The unique identifier for this resource (empty when instance does not exist).
607 "instanceStatus": "A String", # The status of the instance (empty when instance does not exist).
608 },
609 ],
610 }</pre>
611</div>
612
613<div class="method">
614 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
615 <pre>Retrieves the next page of results.
616
617Args:
618 previous_request: The request for the previous page. (required)
619 previous_response: The response from the request for the previous page. (required)
620
621Returns:
622 A request object that you can call 'execute()' on to request the next
623 page. Returns None if there are no more items in the collection.
624 </pre>
625</div>
626
627<div class="method">
628 <code class="details" id="recreateInstances">recreateInstances(project, zone, instanceGroupManager, body)</code>
629 <pre>Recreates the specified instances. The instances are deleted, then recreated using the managed instance group's current instance template.
630
631Args:
632 project: string, The project ID for this request. (required)
633 zone: string, The URL of the zone where the managed instance group is located. (required)
634 instanceGroupManager: string, The name of the instance group manager. (required)
635 body: object, The request body. (required)
636 The object takes the form of:
637
638{
639 "instances": [ # The names of one or more instances to recreate.
640 "A String",
641 ],
642 }
643
644
645Returns:
646 An object of the form:
647
648 { # An Operation resource, used to manage asynchronous API requests.
649 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
650 "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project.
651 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
652 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
653 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
654 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
655 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
656 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should monotonically increase as the operation progresses.
657 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
658 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
659 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
660 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
661 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
662 {
663 "message": "A String", # [Output Only] Optional human-readable details for this warning.
664 "code": "A String", # [Output Only] The warning type identifier for this warning.
665 "data": [ # [Output Only] Metadata for this warning in key: value format.
666 {
667 "value": "A String", # [Output Only] A warning data value corresponding to the key.
668 "key": "A String", # [Output Only] A key for the warning data.
669 },
670 ],
671 },
672 ],
673 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
674 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
675 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
676 "name": "A String", # [Output Only] Name of the resource.
677 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
678 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
679 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
680 {
681 "message": "A String", # [Output Only] An optional, human-readable error message.
682 "code": "A String", # [Output Only] The error type identifier for this error.
683 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
684 },
685 ],
686 },
687 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
688 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
689 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
690 }</pre>
691</div>
692
693<div class="method">
694 <code class="details" id="resize">resize(project, zone, instanceGroupManager, size)</code>
695 <pre>Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group removes instances in the order that is outlined in Resizing a managed instance group.
696
697Args:
698 project: string, The project ID for this request. (required)
699 zone: string, The URL of the zone where the managed instance group is located. (required)
700 instanceGroupManager: string, The name of the instance group manager. (required)
701 size: integer, The number of running instances that the managed instance group should maintain at any given time. The group automatically adds or removes instances to maintain the number of instances specified by this parameter. (required)
702
703Returns:
704 An object of the form:
705
706 { # An Operation resource, used to manage asynchronous API requests.
707 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
708 "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project.
709 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
710 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
711 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
712 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
713 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
714 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should monotonically increase as the operation progresses.
715 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
716 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
717 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
718 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
719 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
720 {
721 "message": "A String", # [Output Only] Optional human-readable details for this warning.
722 "code": "A String", # [Output Only] The warning type identifier for this warning.
723 "data": [ # [Output Only] Metadata for this warning in key: value format.
724 {
725 "value": "A String", # [Output Only] A warning data value corresponding to the key.
726 "key": "A String", # [Output Only] A key for the warning data.
727 },
728 ],
729 },
730 ],
731 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
732 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
733 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
734 "name": "A String", # [Output Only] Name of the resource.
735 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
736 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
737 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
738 {
739 "message": "A String", # [Output Only] An optional, human-readable error message.
740 "code": "A String", # [Output Only] The error type identifier for this error.
741 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
742 },
743 ],
744 },
745 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
746 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
747 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
748 }</pre>
749</div>
750
751<div class="method">
752 <code class="details" id="setInstanceTemplate">setInstanceTemplate(project, zone, instanceGroupManager, body)</code>
753 <pre>Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you recreate them.
754
755Args:
756 project: string, The project ID for this request. (required)
757 zone: string, The URL of the zone where the managed instance group is located. (required)
758 instanceGroupManager: string, The name of the instance group manager. (required)
759 body: object, The request body. (required)
760 The object takes the form of:
761
762{
763 "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.
764 }
765
766
767Returns:
768 An object of the form:
769
770 { # An Operation resource, used to manage asynchronous API requests.
771 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
772 "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project.
773 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
774 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
775 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
776 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
777 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
778 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should monotonically increase as the operation progresses.
779 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
780 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
781 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
782 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
783 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
784 {
785 "message": "A String", # [Output Only] Optional human-readable details for this warning.
786 "code": "A String", # [Output Only] The warning type identifier for this warning.
787 "data": [ # [Output Only] Metadata for this warning in key: value format.
788 {
789 "value": "A String", # [Output Only] A warning data value corresponding to the key.
790 "key": "A String", # [Output Only] A key for the warning data.
791 },
792 ],
793 },
794 ],
795 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
796 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
797 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
798 "name": "A String", # [Output Only] Name of the resource.
799 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
800 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
801 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
802 {
803 "message": "A String", # [Output Only] An optional, human-readable error message.
804 "code": "A String", # [Output Only] The error type identifier for this error.
805 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
806 },
807 ],
808 },
809 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
810 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
811 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
812 }</pre>
813</div>
814
815<div class="method">
816 <code class="details" id="setTargetPools">setTargetPools(project, zone, instanceGroupManager, body)</code>
817 <pre>Modifies the target pools to which all new instances in this group are assigned. The target pools for existing instances in the group do not change unless you recreate them.
818
819Args:
820 project: string, The project ID for this request. (required)
821 zone: string, The URL of the zone where the managed instance group is located. (required)
822 instanceGroupManager: string, The name of the instance group manager. (required)
823 body: object, The request body. (required)
824 The object takes the form of:
825
826{
827 "targetPools": [ # The list of target pool URLs that instances in this managed instance group belong to. When the managed instance group creates new instances, the group automatically adds those instances to the target pools that are specified in this parameter. Changing the value of this parameter does not change the target pools of existing instances in this managed instance group.
828 "A String",
829 ],
830 "fingerprint": "A String", # The fingerprint of the target pools information, which is a hash of the contents. This field is used for optimistic locking when updating the target pool entries.
831 }
832
833
834Returns:
835 An object of the form:
836
837 { # An Operation resource, used to manage asynchronous API requests.
838 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
839 "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project.
840 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
841 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
842 "zone": "A String", # [Output Only] URL of the zone where the operation resides.
843 "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
844 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
845 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should monotonically increase as the operation progresses.
846 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as 404.
847 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
848 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
849 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
850 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
851 {
852 "message": "A String", # [Output Only] Optional human-readable details for this warning.
853 "code": "A String", # [Output Only] The warning type identifier for this warning.
854 "data": [ # [Output Only] Metadata for this warning in key: value format.
855 {
856 "value": "A String", # [Output Only] A warning data value corresponding to the key.
857 "key": "A String", # [Output Only] A key for the warning data.
858 },
859 ],
860 },
861 ],
862 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
863 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC3339 text format.
864 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
865 "name": "A String", # [Output Only] Name of the resource.
866 "region": "A String", # [Output Only] URL of the region where the operation resides. Only applicable for regional resources.
867 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
868 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
869 {
870 "message": "A String", # [Output Only] An optional, human-readable error message.
871 "code": "A String", # [Output Only] The error type identifier for this error.
872 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
873 },
874 ],
875 },
876 "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
877 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
878 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
879 }</pre>
880</div>
881
882</body></html>