File: replicapool_v1beta2.instanceGroupManagers.html

package info (click to toggle)
python-googleapi 1.7.11-4
  • links: PTS
  • area: main
  • in suites: bullseye
  • size: 110,952 kB
  • sloc: python: 7,784; javascript: 249; makefile: 59; sh: 53; xml: 5
file content (741 lines) | stat: -rw-r--r-- 51,083 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="replicapool_v1beta2.html">Google Compute Engine Instance Group Manager API</a> . <a href="replicapool_v1beta2.instanceGroupManagers.html">instanceGroupManagers</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#abandonInstances">abandonInstances(project, zone, instanceGroupManager, body)</a></code></p>
<p class="firstline">Removes the specified instances from the managed instance group, and from any target pools of which they were members, without deleting the instances.</p>
<p class="toc_element">
  <code><a href="#delete">delete(project, zone, instanceGroupManager)</a></code></p>
<p class="firstline">Deletes the instance group manager and all instances contained within. If you'd like to delete the manager without deleting the instances, you must first abandon the instances to remove them from the group.</p>
<p class="toc_element">
  <code><a href="#deleteInstances">deleteInstances(project, zone, instanceGroupManager, body)</a></code></p>
<p class="firstline">Deletes the specified instances. The instances are deleted, then removed from the instance group and any target pools of which they were a member. The targetSize of the instance group manager is reduced by the number of instances deleted.</p>
<p class="toc_element">
  <code><a href="#get">get(project, zone, instanceGroupManager)</a></code></p>
<p class="firstline">Returns the specified Instance Group Manager resource.</p>
<p class="toc_element">
  <code><a href="#insert">insert(project, zone, size, body)</a></code></p>
<p class="firstline">Creates an instance group manager, as well as the instance group and the specified number of instances.</p>
<p class="toc_element">
  <code><a href="#list">list(project, zone, maxResults=None, pageToken=None, filter=None)</a></code></p>
<p class="firstline">Retrieves the list of Instance Group Manager resources contained within the specified zone.</p>
<p class="toc_element">
  <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
  <code><a href="#recreateInstances">recreateInstances(project, zone, instanceGroupManager, body)</a></code></p>
<p class="firstline">Recreates the specified instances. The instances are deleted, then recreated using the instance group manager's current instance template.</p>
<p class="toc_element">
  <code><a href="#resize">resize(project, zone, instanceGroupManager, size)</a></code></p>
<p class="firstline">Resizes the managed instance group up or down. If resized up, new instances are created using the current instance template. If resized down, instances are removed in the order outlined in Resizing a managed instance group.</p>
<p class="toc_element">
  <code><a href="#setInstanceTemplate">setInstanceTemplate(project, zone, instanceGroupManager, body)</a></code></p>
<p class="firstline">Sets the instance template to use when creating new instances in this group. Existing instances are not affected.</p>
<p class="toc_element">
  <code><a href="#setTargetPools">setTargetPools(project, zone, instanceGroupManager, body)</a></code></p>
<p class="firstline">Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="abandonInstances">abandonInstances(project, zone, instanceGroupManager, body)</code>
  <pre>Removes the specified instances from the managed instance group, and from any target pools of which they were members, without deleting the instances.

Args:
  project: string, The Google Developers Console project name. (required)
  zone: string, The name of the zone in which the instance group manager resides. (required)
  instanceGroupManager: string, The name of the instance group manager. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "instances": [ # The names of one or more instances to abandon. For example:
        # { 'instances': [ 'instance-c3po', 'instance-r2d2' ] }
      "A String",
    ],
  }


Returns:
  An object of the form:

    { # An operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
    "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.
    "creationTimestamp": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
    "id": "A String", # [Output Only] Unique identifier for the resource, generated by the server.
    "zone": "A String", # [Output Only] URL of the zone where the operation resides. Only available when performing per-zone operations.
    "operationType": "A String", # [Output only] Type of the operation. Operations include insert, update, and delete.
    "httpErrorMessage": "A String", # [Output only] If operation fails, the HTTP error message returned.
    "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 be monotonically increasing as the operation progresses.
    "httpErrorStatusCode": 42, # [Output only] If operation fails, the HTTP error status code returned.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] Status of the operation.
    "insertTime": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
    "warnings": [ # [Output Only] If there are issues with this operation, a warning is returned.
      {
        "message": "A String", # [Output only] Optional human-readable details for this warning.
        "code": "A String", # [Output only] The warning type identifier for this warning.
        "data": [ # [Output only] Metadata for this warning in key:value format.
          {
            "value": "A String", # [Output Only] Metadata value for this warning.
            "key": "A String", # [Output Only] Metadata key for this warning.
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server, in RFC3339 text format.
    "kind": "replicapool#operation", # [Output only] Type of the resource.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed, in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
    "targetLink": "A String", # [Output only] URL of the resource the operation is mutating.
  }</pre>
</div>

<div class="method">
    <code class="details" id="delete">delete(project, zone, instanceGroupManager)</code>
  <pre>Deletes the instance group manager and all instances contained within. If you'd like to delete the manager without deleting the instances, you must first abandon the instances to remove them from the group.

Args:
  project: string, The Google Developers Console project name. (required)
  zone: string, The name of the zone in which the instance group manager resides. (required)
  instanceGroupManager: string, Name of the Instance Group Manager resource to delete. (required)

Returns:
  An object of the form:

    { # An operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
    "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.
    "creationTimestamp": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
    "id": "A String", # [Output Only] Unique identifier for the resource, generated by the server.
    "zone": "A String", # [Output Only] URL of the zone where the operation resides. Only available when performing per-zone operations.
    "operationType": "A String", # [Output only] Type of the operation. Operations include insert, update, and delete.
    "httpErrorMessage": "A String", # [Output only] If operation fails, the HTTP error message returned.
    "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 be monotonically increasing as the operation progresses.
    "httpErrorStatusCode": 42, # [Output only] If operation fails, the HTTP error status code returned.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] Status of the operation.
    "insertTime": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
    "warnings": [ # [Output Only] If there are issues with this operation, a warning is returned.
      {
        "message": "A String", # [Output only] Optional human-readable details for this warning.
        "code": "A String", # [Output only] The warning type identifier for this warning.
        "data": [ # [Output only] Metadata for this warning in key:value format.
          {
            "value": "A String", # [Output Only] Metadata value for this warning.
            "key": "A String", # [Output Only] Metadata key for this warning.
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server, in RFC3339 text format.
    "kind": "replicapool#operation", # [Output only] Type of the resource.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed, in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
    "targetLink": "A String", # [Output only] URL of the resource the operation is mutating.
  }</pre>
</div>

<div class="method">
    <code class="details" id="deleteInstances">deleteInstances(project, zone, instanceGroupManager, body)</code>
  <pre>Deletes the specified instances. The instances are deleted, then removed from the instance group and any target pools of which they were a member. The targetSize of the instance group manager is reduced by the number of instances deleted.

Args:
  project: string, The Google Developers Console project name. (required)
  zone: string, The name of the zone in which the instance group manager resides. (required)
  instanceGroupManager: string, The name of the instance group manager. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "instances": [ # Names of instances to delete.
        # 
        # Example: 'instance-foo', 'instance-bar'
      "A String",
    ],
  }


Returns:
  An object of the form:

    { # An operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
    "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.
    "creationTimestamp": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
    "id": "A String", # [Output Only] Unique identifier for the resource, generated by the server.
    "zone": "A String", # [Output Only] URL of the zone where the operation resides. Only available when performing per-zone operations.
    "operationType": "A String", # [Output only] Type of the operation. Operations include insert, update, and delete.
    "httpErrorMessage": "A String", # [Output only] If operation fails, the HTTP error message returned.
    "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 be monotonically increasing as the operation progresses.
    "httpErrorStatusCode": 42, # [Output only] If operation fails, the HTTP error status code returned.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] Status of the operation.
    "insertTime": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
    "warnings": [ # [Output Only] If there are issues with this operation, a warning is returned.
      {
        "message": "A String", # [Output only] Optional human-readable details for this warning.
        "code": "A String", # [Output only] The warning type identifier for this warning.
        "data": [ # [Output only] Metadata for this warning in key:value format.
          {
            "value": "A String", # [Output Only] Metadata value for this warning.
            "key": "A String", # [Output Only] Metadata key for this warning.
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server, in RFC3339 text format.
    "kind": "replicapool#operation", # [Output only] Type of the resource.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed, in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
    "targetLink": "A String", # [Output only] URL of the resource the operation is mutating.
  }</pre>
</div>

<div class="method">
    <code class="details" id="get">get(project, zone, instanceGroupManager)</code>
  <pre>Returns the specified Instance Group Manager resource.

Args:
  project: string, The Google Developers Console project name. (required)
  zone: string, The name of the zone in which the instance group manager resides. (required)
  instanceGroupManager: string, Name of the instance resource to return. (required)

Returns:
  An object of the form:

    { # An Instance Group Manager resource.
      "kind": "replicapool#instanceGroupManager", # [Output only] The resource type. Always replicapool#instanceGroupManager.
      "group": "A String", # [Output only] The full URL of the instance group created by the manager. This group contains all of the instances being managed, and cannot contain non-managed instances.
      "description": "A String", # An optional textual description of the instance group manager.
      "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.
        {
          "healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
          "actionType": "A String", # The action to perform when an instance becomes unhealthy. Possible values are RECREATE or REBOOT. RECREATE replaces an unhealthy instance with a new instance that is based on the instance template for this managed instance group. REBOOT performs a soft reboot on an instance. If the instance cannot reboot, the instance performs a hard restart.
        },
      ],
      "targetPools": [ # The full URL of all target pools to which new instances in the group are added. Updating the target pool values does not affect existing instances.
        "A String",
      ],
      "targetSize": 42, # [Output only] The number of instances that the manager is attempting to maintain. Deleting or abandoning instances affects this number, as does resizing the group.
      "name": "A String", # The name of the instance group manager. Must be 1-63 characters long and comply with RFC1035. Supported characters include lowercase letters, numbers, and hyphens.
      "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be a valid RFC1035 name. Supported characters are lowercase letters, numbers, and hyphens (-). Instances are named by appending a hyphen and a random four-character string to the base instance name.
      "fingerprint": "A String", # [Output only] Fingerprint of the instance group manager. This field is used for optimistic locking. An up-to-date fingerprint must be provided in order to modify the Instance Group Manager resource.
      "instanceTemplate": "A String", # The full URL to an instance template from which all new instances will be created.
      "creationTimestamp": "A String", # [Output only] The time the instance group manager was created, in RFC3339 text format.
      "id": "A String", # [Output only] A server-assigned unique identifier for the resource.
      "selfLink": "A String", # [Output only] The fully qualified URL for this resource.
      "currentSize": 42, # [Output only] The number of instances that currently exist and are a part of this group. This includes instances that are starting but are not yet RUNNING, and instances that are in the process of being deleted or abandoned.
    }</pre>
</div>

<div class="method">
    <code class="details" id="insert">insert(project, zone, size, body)</code>
  <pre>Creates an instance group manager, as well as the instance group and the specified number of instances.

Args:
  project: string, The Google Developers Console project name. (required)
  zone: string, The name of the zone in which the instance group manager resides. (required)
  size: integer, Number of instances that should exist. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # An Instance Group Manager resource.
    "kind": "replicapool#instanceGroupManager", # [Output only] The resource type. Always replicapool#instanceGroupManager.
    "group": "A String", # [Output only] The full URL of the instance group created by the manager. This group contains all of the instances being managed, and cannot contain non-managed instances.
    "description": "A String", # An optional textual description of the instance group manager.
    "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.
      {
        "healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
        "actionType": "A String", # The action to perform when an instance becomes unhealthy. Possible values are RECREATE or REBOOT. RECREATE replaces an unhealthy instance with a new instance that is based on the instance template for this managed instance group. REBOOT performs a soft reboot on an instance. If the instance cannot reboot, the instance performs a hard restart.
      },
    ],
    "targetPools": [ # The full URL of all target pools to which new instances in the group are added. Updating the target pool values does not affect existing instances.
      "A String",
    ],
    "targetSize": 42, # [Output only] The number of instances that the manager is attempting to maintain. Deleting or abandoning instances affects this number, as does resizing the group.
    "name": "A String", # The name of the instance group manager. Must be 1-63 characters long and comply with RFC1035. Supported characters include lowercase letters, numbers, and hyphens.
    "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be a valid RFC1035 name. Supported characters are lowercase letters, numbers, and hyphens (-). Instances are named by appending a hyphen and a random four-character string to the base instance name.
    "fingerprint": "A String", # [Output only] Fingerprint of the instance group manager. This field is used for optimistic locking. An up-to-date fingerprint must be provided in order to modify the Instance Group Manager resource.
    "instanceTemplate": "A String", # The full URL to an instance template from which all new instances will be created.
    "creationTimestamp": "A String", # [Output only] The time the instance group manager was created, in RFC3339 text format.
    "id": "A String", # [Output only] A server-assigned unique identifier for the resource.
    "selfLink": "A String", # [Output only] The fully qualified URL for this resource.
    "currentSize": 42, # [Output only] The number of instances that currently exist and are a part of this group. This includes instances that are starting but are not yet RUNNING, and instances that are in the process of being deleted or abandoned.
  }


Returns:
  An object of the form:

    { # An operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
    "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.
    "creationTimestamp": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
    "id": "A String", # [Output Only] Unique identifier for the resource, generated by the server.
    "zone": "A String", # [Output Only] URL of the zone where the operation resides. Only available when performing per-zone operations.
    "operationType": "A String", # [Output only] Type of the operation. Operations include insert, update, and delete.
    "httpErrorMessage": "A String", # [Output only] If operation fails, the HTTP error message returned.
    "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 be monotonically increasing as the operation progresses.
    "httpErrorStatusCode": 42, # [Output only] If operation fails, the HTTP error status code returned.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] Status of the operation.
    "insertTime": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
    "warnings": [ # [Output Only] If there are issues with this operation, a warning is returned.
      {
        "message": "A String", # [Output only] Optional human-readable details for this warning.
        "code": "A String", # [Output only] The warning type identifier for this warning.
        "data": [ # [Output only] Metadata for this warning in key:value format.
          {
            "value": "A String", # [Output Only] Metadata value for this warning.
            "key": "A String", # [Output Only] Metadata key for this warning.
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server, in RFC3339 text format.
    "kind": "replicapool#operation", # [Output only] Type of the resource.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed, in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
    "targetLink": "A String", # [Output only] URL of the resource the operation is mutating.
  }</pre>
</div>

<div class="method">
    <code class="details" id="list">list(project, zone, maxResults=None, pageToken=None, filter=None)</code>
  <pre>Retrieves the list of Instance Group Manager resources contained within the specified zone.

Args:
  project: string, The Google Developers Console project name. (required)
  zone: string, The name of the zone in which the instance group manager resides. (required)
  maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
  pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
  filter: string, Optional. Filter expression for filtering listed resources.

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
    "items": [ # A list of instance resources.
      { # An Instance Group Manager resource.
          "kind": "replicapool#instanceGroupManager", # [Output only] The resource type. Always replicapool#instanceGroupManager.
          "group": "A String", # [Output only] The full URL of the instance group created by the manager. This group contains all of the instances being managed, and cannot contain non-managed instances.
          "description": "A String", # An optional textual description of the instance group manager.
          "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.
            {
              "healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
              "actionType": "A String", # The action to perform when an instance becomes unhealthy. Possible values are RECREATE or REBOOT. RECREATE replaces an unhealthy instance with a new instance that is based on the instance template for this managed instance group. REBOOT performs a soft reboot on an instance. If the instance cannot reboot, the instance performs a hard restart.
            },
          ],
          "targetPools": [ # The full URL of all target pools to which new instances in the group are added. Updating the target pool values does not affect existing instances.
            "A String",
          ],
          "targetSize": 42, # [Output only] The number of instances that the manager is attempting to maintain. Deleting or abandoning instances affects this number, as does resizing the group.
          "name": "A String", # The name of the instance group manager. Must be 1-63 characters long and comply with RFC1035. Supported characters include lowercase letters, numbers, and hyphens.
          "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be a valid RFC1035 name. Supported characters are lowercase letters, numbers, and hyphens (-). Instances are named by appending a hyphen and a random four-character string to the base instance name.
          "fingerprint": "A String", # [Output only] Fingerprint of the instance group manager. This field is used for optimistic locking. An up-to-date fingerprint must be provided in order to modify the Instance Group Manager resource.
          "instanceTemplate": "A String", # The full URL to an instance template from which all new instances will be created.
          "creationTimestamp": "A String", # [Output only] The time the instance group manager was created, in RFC3339 text format.
          "id": "A String", # [Output only] A server-assigned unique identifier for the resource.
          "selfLink": "A String", # [Output only] The fully qualified URL for this resource.
          "currentSize": 42, # [Output only] The number of instances that currently exist and are a part of this group. This includes instances that are starting but are not yet RUNNING, and instances that are in the process of being deleted or abandoned.
        },
    ],
    "kind": "replicapool#instanceGroupManagerList", # Type of resource.
    "id": "A String", # Unique identifier for the resource; defined by the server (output only).
    "selfLink": "A String", # Server defined URL for this resource (output only).
  }</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
  <pre>Retrieves the next page of results.

Args:
  previous_request: The request for the previous page. (required)
  previous_response: The response from the request for the previous page. (required)

Returns:
  A request object that you can call 'execute()' on to request the next
  page. Returns None if there are no more items in the collection.
    </pre>
</div>

<div class="method">
    <code class="details" id="recreateInstances">recreateInstances(project, zone, instanceGroupManager, body)</code>
  <pre>Recreates the specified instances. The instances are deleted, then recreated using the instance group manager's current instance template.

Args:
  project: string, The Google Developers Console project name. (required)
  zone: string, The name of the zone in which the instance group manager resides. (required)
  instanceGroupManager: string, The name of the instance group manager. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "instances": [ # The names of one or more instances to recreate. For example:
        # { 'instances': [ 'instance-c3po', 'instance-r2d2' ] }
      "A String",
    ],
  }


Returns:
  An object of the form:

    { # An operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
    "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.
    "creationTimestamp": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
    "id": "A String", # [Output Only] Unique identifier for the resource, generated by the server.
    "zone": "A String", # [Output Only] URL of the zone where the operation resides. Only available when performing per-zone operations.
    "operationType": "A String", # [Output only] Type of the operation. Operations include insert, update, and delete.
    "httpErrorMessage": "A String", # [Output only] If operation fails, the HTTP error message returned.
    "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 be monotonically increasing as the operation progresses.
    "httpErrorStatusCode": 42, # [Output only] If operation fails, the HTTP error status code returned.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] Status of the operation.
    "insertTime": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
    "warnings": [ # [Output Only] If there are issues with this operation, a warning is returned.
      {
        "message": "A String", # [Output only] Optional human-readable details for this warning.
        "code": "A String", # [Output only] The warning type identifier for this warning.
        "data": [ # [Output only] Metadata for this warning in key:value format.
          {
            "value": "A String", # [Output Only] Metadata value for this warning.
            "key": "A String", # [Output Only] Metadata key for this warning.
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server, in RFC3339 text format.
    "kind": "replicapool#operation", # [Output only] Type of the resource.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed, in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
    "targetLink": "A String", # [Output only] URL of the resource the operation is mutating.
  }</pre>
</div>

<div class="method">
    <code class="details" id="resize">resize(project, zone, instanceGroupManager, size)</code>
  <pre>Resizes the managed instance group up or down. If resized up, new instances are created using the current instance template. If resized down, instances are removed in the order outlined in Resizing a managed instance group.

Args:
  project: string, The Google Developers Console project name. (required)
  zone: string, The name of the zone in which the instance group manager resides. (required)
  instanceGroupManager: string, The name of the instance group manager. (required)
  size: integer, Number of instances that should exist in this Instance Group Manager. (required)

Returns:
  An object of the form:

    { # An operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
    "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.
    "creationTimestamp": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
    "id": "A String", # [Output Only] Unique identifier for the resource, generated by the server.
    "zone": "A String", # [Output Only] URL of the zone where the operation resides. Only available when performing per-zone operations.
    "operationType": "A String", # [Output only] Type of the operation. Operations include insert, update, and delete.
    "httpErrorMessage": "A String", # [Output only] If operation fails, the HTTP error message returned.
    "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 be monotonically increasing as the operation progresses.
    "httpErrorStatusCode": 42, # [Output only] If operation fails, the HTTP error status code returned.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] Status of the operation.
    "insertTime": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
    "warnings": [ # [Output Only] If there are issues with this operation, a warning is returned.
      {
        "message": "A String", # [Output only] Optional human-readable details for this warning.
        "code": "A String", # [Output only] The warning type identifier for this warning.
        "data": [ # [Output only] Metadata for this warning in key:value format.
          {
            "value": "A String", # [Output Only] Metadata value for this warning.
            "key": "A String", # [Output Only] Metadata key for this warning.
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server, in RFC3339 text format.
    "kind": "replicapool#operation", # [Output only] Type of the resource.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed, in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
    "targetLink": "A String", # [Output only] URL of the resource the operation is mutating.
  }</pre>
</div>

<div class="method">
    <code class="details" id="setInstanceTemplate">setInstanceTemplate(project, zone, instanceGroupManager, body)</code>
  <pre>Sets the instance template to use when creating new instances in this group. Existing instances are not affected.

Args:
  project: string, The Google Developers Console project name. (required)
  zone: string, The name of the zone in which the instance group manager resides. (required)
  instanceGroupManager: string, The name of the instance group manager. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "instanceTemplate": "A String", # The full URL to an Instance Template from which all new instances will be created.
  }


Returns:
  An object of the form:

    { # An operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
    "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.
    "creationTimestamp": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
    "id": "A String", # [Output Only] Unique identifier for the resource, generated by the server.
    "zone": "A String", # [Output Only] URL of the zone where the operation resides. Only available when performing per-zone operations.
    "operationType": "A String", # [Output only] Type of the operation. Operations include insert, update, and delete.
    "httpErrorMessage": "A String", # [Output only] If operation fails, the HTTP error message returned.
    "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 be monotonically increasing as the operation progresses.
    "httpErrorStatusCode": 42, # [Output only] If operation fails, the HTTP error status code returned.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] Status of the operation.
    "insertTime": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
    "warnings": [ # [Output Only] If there are issues with this operation, a warning is returned.
      {
        "message": "A String", # [Output only] Optional human-readable details for this warning.
        "code": "A String", # [Output only] The warning type identifier for this warning.
        "data": [ # [Output only] Metadata for this warning in key:value format.
          {
            "value": "A String", # [Output Only] Metadata value for this warning.
            "key": "A String", # [Output Only] Metadata key for this warning.
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server, in RFC3339 text format.
    "kind": "replicapool#operation", # [Output only] Type of the resource.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed, in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
    "targetLink": "A String", # [Output only] URL of the resource the operation is mutating.
  }</pre>
</div>

<div class="method">
    <code class="details" id="setTargetPools">setTargetPools(project, zone, instanceGroupManager, body)</code>
  <pre>Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected.

Args:
  project: string, The Google Developers Console project name. (required)
  zone: string, The name of the zone in which the instance group manager resides. (required)
  instanceGroupManager: string, The name of the instance group manager. (required)
  body: object, The request body. (required)
    The object takes the form of:

{
    "targetPools": [ # A list of fully-qualified URLs to existing Target Pool resources. New instances in the Instance Group Manager will be added to the specified target pools; existing instances are not affected.
      "A String",
    ],
    "fingerprint": "A String", # The current fingerprint of the Instance Group Manager resource. If this does not match the server-side fingerprint of the resource, then the request will be rejected.
  }


Returns:
  An object of the form:

    { # An operation resource, used to manage asynchronous API requests.
    "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
    "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.
    "creationTimestamp": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
    "id": "A String", # [Output Only] Unique identifier for the resource, generated by the server.
    "zone": "A String", # [Output Only] URL of the zone where the operation resides. Only available when performing per-zone operations.
    "operationType": "A String", # [Output only] Type of the operation. Operations include insert, update, and delete.
    "httpErrorMessage": "A String", # [Output only] If operation fails, the HTTP error message returned.
    "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 be monotonically increasing as the operation progresses.
    "httpErrorStatusCode": 42, # [Output only] If operation fails, the HTTP error status code returned.
    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
    "status": "A String", # [Output Only] Status of the operation.
    "insertTime": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
    "warnings": [ # [Output Only] If there are issues with this operation, a warning is returned.
      {
        "message": "A String", # [Output only] Optional human-readable details for this warning.
        "code": "A String", # [Output only] The warning type identifier for this warning.
        "data": [ # [Output only] Metadata for this warning in key:value format.
          {
            "value": "A String", # [Output Only] Metadata value for this warning.
            "key": "A String", # [Output Only] Metadata key for this warning.
          },
        ],
      },
    ],
    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
    "startTime": "A String", # [Output Only] The time that this operation was started by the server, in RFC3339 text format.
    "kind": "replicapool#operation", # [Output only] Type of the resource.
    "name": "A String", # [Output Only] Name of the resource.
    "region": "A String", # [Output Only] URL of the region where the operation resides. Only available when performing regional operations.
    "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
        {
          "message": "A String", # [Output Only] An optional, human-readable error message.
          "code": "A String", # [Output Only] The error type identifier for this error.
          "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
        },
      ],
    },
    "endTime": "A String", # [Output Only] The time that this operation was completed, in RFC3339 text format.
    "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
    "targetLink": "A String", # [Output only] URL of the resource the operation is mutating.
  }</pre>
</div>

</body></html>