Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c30d2b5d4478b230246dcaaa9f1c533ca3304387 / . / docs / dyn / compute_v1.regionInstanceGroupManagers.html
blob: 14e32c5ad800673168986508d9110bfd48fe966a [file] [log] [blame]
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[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.regionInstanceGroupManagers.html">regionInstanceGroupManagers</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#abandonInstances">abandonInstances(project, region, instanceGroupManager, body)</a></code></p>
79<p class="firstline">Schedules a group action to remove the specified instances from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method.</p>
80<p class="toc_element">
81 <code><a href="#delete">delete(project, region, instanceGroupManager)</a></code></p>
82<p class="firstline">Deletes the specified managed instance group and all of the instances in that group.</p>
83<p class="toc_element">
84 <code><a href="#deleteInstances">deleteInstances(project, region, instanceGroupManager, body)</a></code></p>
85<p class="firstline">Schedules a group action to delete the specified instances in the managed instance group. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method.</p>
86<p class="toc_element">
87 <code><a href="#get">get(project, region, instanceGroupManager)</a></code></p>
88<p class="firstline">Returns all of the details about the specified managed instance group.</p>
89<p class="toc_element">
90 <code><a href="#insert">insert(project, region, body)</a></code></p>
91<p class="firstline">Creates a managed instance group using the information that you specify in the request. After the group is created, it schedules an action to create instances in the group using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method.</p>
92<p class="toc_element">
93 <code><a href="#list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
94<p class="firstline">Retrieves the list of managed instance groups that are contained within the specified region.</p>
95<p class="toc_element">
96 <code><a href="#listManagedInstances">listManagedInstances(project, region, instanceGroupManager, order_by=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
97<p class="firstline">Lists the instances in the managed instance group and instances that are scheduled to be created. The list includes any current actions that the group has scheduled for its instances.</p>
98<p class="toc_element">
99 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
100<p class="firstline">Retrieves the next page of results.</p>
101<p class="toc_element">
102 <code><a href="#recreateInstances">recreateInstances(project, region, instanceGroupManager, body)</a></code></p>
103<p class="firstline">Schedules a group action to recreate the specified instances in the managed instance group. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the action is scheduled even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method.</p>
104<p class="toc_element">
105 <code><a href="#resize">resize(project, region, instanceGroupManager, size)</a></code></p>
106<p class="firstline">Changes the intended size for the managed instance group. If you increase the size, the group schedules actions to create new instances using the current instance template. If you decrease the size, the group schedules delete actions on one or more instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.</p>
107<p class="toc_element">
108 <code><a href="#setInstanceTemplate">setInstanceTemplate(project, region, instanceGroupManager, body)</a></code></p>
109<p class="firstline">Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected.</p>
110<p class="toc_element">
111 <code><a href="#setTargetPools">setTargetPools(project, region, instanceGroupManager, body)</a></code></p>
112<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>
113<h3>Method Details</h3>
114<div class="method">
115 <code class="details" id="abandonInstances">abandonInstances(project, region, instanceGroupManager, body)</code>
116 <pre>Schedules a group action to remove the specified instances from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method.
117
118Args:
119 project: string, Project ID for this request. (required)
120 region: string, Name of the region scoping this request. (required)
121 instanceGroupManager: string, Name of the managed instance group. (required)
122 body: object, The request body. (required)
123 The object takes the form of:
124
125{
126 "instances": [ # The names of one or more instances to abandon.
127 "A String",
128 ],
129 }
130
131
132Returns:
133 An object of the form:
134
135 { # An Operation resource, used to manage asynchronous API requests.
136 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
137 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]138 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]139 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
140 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
141 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
142 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
143 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
144 "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 when the operation will be complete. This number should monotonically increase as the operation progresses.
145 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
146 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
147 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
148 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
149 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
150 {
151 "message": "A String", # [Output Only] A human-readable description of the warning code.
152 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
153 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
154 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
155 {
156 "value": "A String", # [Output Only] A warning data value corresponding to the key.
157 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
158 },
159 ],
160 },
161 ],
162 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
163 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
164 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
165 "name": "A String", # [Output Only] Name of the resource.
166 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
167 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
168 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
169 {
170 "message": "A String", # [Output Only] An optional, human-readable error message.
171 "code": "A String", # [Output Only] The error type identifier for this error.
172 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
173 },
174 ],
175 },
176 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
177 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
178 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
179 }</pre>
180</div>
181
182<div class="method">
183 <code class="details" id="delete">delete(project, region, instanceGroupManager)</code>
184 <pre>Deletes the specified managed instance group and all of the instances in that group.
185
186Args:
187 project: string, Project ID for this request. (required)
188 region: string, Name of the region scoping this request. (required)
189 instanceGroupManager: string, Name of the managed instance group to delete. (required)
190
191Returns:
192 An object of the form:
193
194 { # An Operation resource, used to manage asynchronous API requests.
195 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
196 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]197 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]198 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
199 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
200 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
201 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
202 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
203 "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 when the operation will be complete. This number should monotonically increase as the operation progresses.
204 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
205 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
206 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
207 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
208 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
209 {
210 "message": "A String", # [Output Only] A human-readable description of the warning code.
211 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
212 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
213 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
214 {
215 "value": "A String", # [Output Only] A warning data value corresponding to the key.
216 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
217 },
218 ],
219 },
220 ],
221 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
222 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
223 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
224 "name": "A String", # [Output Only] Name of the resource.
225 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
226 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
227 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
228 {
229 "message": "A String", # [Output Only] An optional, human-readable error message.
230 "code": "A String", # [Output Only] The error type identifier for this error.
231 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
232 },
233 ],
234 },
235 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
236 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
237 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
238 }</pre>
239</div>
240
241<div class="method">
242 <code class="details" id="deleteInstances">deleteInstances(project, region, instanceGroupManager, body)</code>
243 <pre>Schedules a group action to delete the specified instances in the managed instance group. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method.
244
245Args:
246 project: string, Project ID for this request. (required)
247 region: string, Name of the region scoping this request. (required)
248 instanceGroupManager: string, Name of the managed instance group. (required)
249 body: object, The request body. (required)
250 The object takes the form of:
251
252{
253 "instances": [ # The names of one or more instances to delete.
254 "A String",
255 ],
256 }
257
258
259Returns:
260 An object of the form:
261
262 { # An Operation resource, used to manage asynchronous API requests.
263 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
264 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]265 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]266 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
267 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
268 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
269 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
270 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
271 "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 when the operation will be complete. This number should monotonically increase as the operation progresses.
272 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
273 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
274 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
275 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
276 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
277 {
278 "message": "A String", # [Output Only] A human-readable description of the warning code.
279 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
280 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
281 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
282 {
283 "value": "A String", # [Output Only] A warning data value corresponding to the key.
284 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
285 },
286 ],
287 },
288 ],
289 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
290 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
291 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
292 "name": "A String", # [Output Only] Name of the resource.
293 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
294 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
295 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
296 {
297 "message": "A String", # [Output Only] An optional, human-readable error message.
298 "code": "A String", # [Output Only] The error type identifier for this error.
299 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
300 },
301 ],
302 },
303 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
304 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
305 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
306 }</pre>
307</div>
308
309<div class="method">
310 <code class="details" id="get">get(project, region, instanceGroupManager)</code>
311 <pre>Returns all of the details about the specified managed instance group.
312
313Args:
314 project: string, Project ID for this request. (required)
315 region: string, Name of the region scoping this request. (required)
316 instanceGroupManager: string, Name of the managed instance group to return. (required)
317
318Returns:
319 An object of the form:
320
321 { # An Instance Group Manager resource.
322 "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.
323 "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
324 "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.
325 "creating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully.
326 #
327 # If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.
328 "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
329 "abandoning": 42, # [Output Only] The 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.
330 "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
331 "creatingWithoutRetries": 42, # [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly.
332 "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.
333 },
334 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
335 "zone": "A String", # [Output Only] The URL of the zone where the managed instance group is located (for zonal resources).
336 "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.
337 "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).
338 "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
339 "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
340 "targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
341 "A String",
342 ],
343 "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.
344 "fingerprint": "A String", # [Output Only] The fingerprint of the resource data. You can use this optional field for optimistic locking when you update the resource.
345 "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.
346 "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
347 { # The named port. For example: .
348 "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
349 "port": 42, # The port number, which can be a value between 1 and 65535.
350 },
351 ],
352 "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
353 "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
354 "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
355 "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.
356 }</pre>
357</div>
358
359<div class="method">
360 <code class="details" id="insert">insert(project, region, body)</code>
361 <pre>Creates a managed instance group using the information that you specify in the request. After the group is created, it schedules an action to create instances in the group using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method.
362
363Args:
364 project: string, Project ID for this request. (required)
365 region: string, Name of the region scoping this request. (required)
366 body: object, The request body. (required)
367 The object takes the form of:
368
369{ # An Instance Group Manager resource.
370 "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.
371 "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
372 "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.
373 "creating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully.
374 #
375 # If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.
376 "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
377 "abandoning": 42, # [Output Only] The 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.
378 "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
379 "creatingWithoutRetries": 42, # [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly.
380 "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.
381 },
382 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
383 "zone": "A String", # [Output Only] The URL of the zone where the managed instance group is located (for zonal resources).
384 "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.
385 "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).
386 "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
387 "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
388 "targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
389 "A String",
390 ],
391 "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.
392 "fingerprint": "A String", # [Output Only] The fingerprint of the resource data. You can use this optional field for optimistic locking when you update the resource.
393 "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.
394 "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
395 { # The named port. For example: .
396 "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
397 "port": 42, # The port number, which can be a value between 1 and 65535.
398 },
399 ],
400 "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
401 "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
402 "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
403 "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.
404 }
405
406
407Returns:
408 An object of the form:
409
410 { # An Operation resource, used to manage asynchronous API requests.
411 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
412 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]413 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]414 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
415 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
416 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
417 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
418 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
419 "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 when the operation will be complete. This number should monotonically increase as the operation progresses.
420 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
421 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
422 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
423 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
424 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
425 {
426 "message": "A String", # [Output Only] A human-readable description of the warning code.
427 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
428 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
429 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
430 {
431 "value": "A String", # [Output Only] A warning data value corresponding to the key.
432 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
433 },
434 ],
435 },
436 ],
437 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
438 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
439 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
440 "name": "A String", # [Output Only] Name of the resource.
441 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
442 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
443 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
444 {
445 "message": "A String", # [Output Only] An optional, human-readable error message.
446 "code": "A String", # [Output Only] The error type identifier for this error.
447 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
448 },
449 ],
450 },
451 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
452 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
453 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
454 }</pre>
455</div>
456
457<div class="method">
458 <code class="details" id="list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
459 <pre>Retrieves the list of managed instance groups that are contained within the specified region.
460
461Args:
462 project: string, Project ID for this request. (required)
463 region: string, Name of the region scoping this request. (required)
464 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
465
466You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
467
468Currently, only sorting by name or creationTimestamp desc is supported.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]469 maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]470 pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
471 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.
472
473The 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 you are filtering by (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.
474
475For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
476
477You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
478
479To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
480
481Returns:
482 An object of the form:
483
484 { # Contains a list of managed instance groups.
485 "nextPageToken": "A String", # [Output only] A token used to continue a truncated list request.
486 "items": [ # A list of managed instance groups.
487 { # An Instance Group Manager resource.
488 "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.
489 "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
490 "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.
491 "creating": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully.
492 #
493 # If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.
494 "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
495 "abandoning": 42, # [Output Only] The 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.
496 "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
497 "creatingWithoutRetries": 42, # [Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly.
498 "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.
499 },
500 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
501 "zone": "A String", # [Output Only] The URL of the zone where the managed instance group is located (for zonal resources).
502 "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.
503 "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).
504 "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
505 "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
506 "targetPools": [ # The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
507 "A String",
508 ],
509 "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.
510 "fingerprint": "A String", # [Output Only] The fingerprint of the resource data. You can use this optional field for optimistic locking when you update the resource.
511 "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.
512 "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
513 { # The named port. For example: .
514 "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
515 "port": 42, # The port number, which can be a value between 1 and 65535.
516 },
517 ],
518 "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
519 "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
520 "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
521 "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.
522 },
523 ],
524 "kind": "compute#regionInstanceGroupManagerList", # [Output Only] The resource type, which is always compute#instanceGroupManagerList for a list of managed instance groups that exist in th regional scope.
525 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
526 "selfLink": "A String", # [Output only] The URL for this resource type. The server generates this URL.
527 }</pre>
528</div>
529
530<div class="method">
531 <code class="details" id="listManagedInstances">listManagedInstances(project, region, instanceGroupManager, order_by=None, maxResults=None, pageToken=None, filter=None)</code>
532 <pre>Lists the instances in the managed instance group and instances that are scheduled to be created. The list includes any current actions that the group has scheduled for its instances.
533
534Args:
535 project: string, Project ID for this request. (required)
536 region: string, Name of the region scoping this request. (required)
537 instanceGroupManager: string, The name of the managed instance group. (required)
538 order_by: string, A parameter
539 maxResults: integer, A parameter
540 pageToken: string, A parameter
541 filter: string, A parameter
542
543Returns:
544 An object of the form:
545
546 {
547 "managedInstances": [ # List of managed instances.
548 {
549 "currentAction": "A String", # [Output Only] The current action that the managed instance group has scheduled for the instance. Possible values:
550 # - NONE The instance is running, and the managed instance group does not have any scheduled actions for this instance.
551 # - CREATING The managed instance group is creating this instance. If the group fails to create this instance, it will try again until it is successful.
552 # - CREATING_WITHOUT_RETRIES The managed instance group is attempting to create this instance only once. If the group fails to create this instance, it does not try again and the group's targetSize value is decreased instead.
553 # - RECREATING The managed instance group is recreating this instance.
554 # - DELETING The managed instance group is permanently deleting this instance.
555 # - ABANDONING The managed instance group is abandoning this instance. The instance will be removed from the instance group and from any target pools that are associated with this group.
556 # - RESTARTING The managed instance group is restarting the instance.
557 # - REFRESHING The managed instance group is applying configuration changes to the instance without stopping it. For example, the group can update the target pool list for an instance without stopping that instance.
558 "instance": "A String", # [Output Only] The URL of the instance. The URL can exist even if the instance has not yet been created.
559 "lastAttempt": { # [Output Only] Information about the last attempt to create or delete the instance.
560 "errors": { # [Output Only] Encountered errors during the last attempt to create or delete the instance.
561 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
562 {
563 "message": "A String", # [Output Only] An optional, human-readable error message.
564 "code": "A String", # [Output Only] The error type identifier for this error.
565 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
566 },
567 ],
568 },
569 },
570 "id": "A String", # [Output only] The unique identifier for this resource. This field is empty when instance does not exist.
571 "instanceStatus": "A String", # [Output Only] The status of the instance. This field is empty when the instance does not exist.
572 },
573 ],
574 }</pre>
575</div>
576
577<div class="method">
578 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
579 <pre>Retrieves the next page of results.
580
581Args:
582 previous_request: The request for the previous page. (required)
583 previous_response: The response from the request for the previous page. (required)
584
585Returns:
586 A request object that you can call 'execute()' on to request the next
587 page. Returns None if there are no more items in the collection.
588 </pre>
589</div>
590
591<div class="method">
592 <code class="details" id="recreateInstances">recreateInstances(project, region, instanceGroupManager, body)</code>
593 <pre>Schedules a group action to recreate the specified instances in the managed instance group. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the action is scheduled even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method.
594
595Args:
596 project: string, Project ID for this request. (required)
597 region: string, Name of the region scoping this request. (required)
598 instanceGroupManager: string, Name of the managed instance group. (required)
599 body: object, The request body. (required)
600 The object takes the form of:
601
602{
603 "instances": [ # The URL for one or more instances to recreate.
604 "A String",
605 ],
606 }
607
608
609Returns:
610 An object of the form:
611
612 { # An Operation resource, used to manage asynchronous API requests.
613 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
614 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]615 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]616 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
617 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
618 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
619 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
620 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
621 "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 when the operation will be complete. This number should monotonically increase as the operation progresses.
622 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
623 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
624 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
625 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
626 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
627 {
628 "message": "A String", # [Output Only] A human-readable description of the warning code.
629 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
630 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
631 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
632 {
633 "value": "A String", # [Output Only] A warning data value corresponding to the key.
634 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
635 },
636 ],
637 },
638 ],
639 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
640 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
641 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
642 "name": "A String", # [Output Only] Name of the resource.
643 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
644 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
645 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
646 {
647 "message": "A String", # [Output Only] An optional, human-readable error message.
648 "code": "A String", # [Output Only] The error type identifier for this error.
649 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
650 },
651 ],
652 },
653 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
654 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
655 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
656 }</pre>
657</div>
658
659<div class="method">
660 <code class="details" id="resize">resize(project, region, instanceGroupManager, size)</code>
661 <pre>Changes the intended size for the managed instance group. If you increase the size, the group schedules actions to create new instances using the current instance template. If you decrease the size, the group schedules delete actions on one or more instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.
662
663Args:
664 project: string, Project ID for this request. (required)
665 region: string, Name of the region scoping this request. (required)
666 instanceGroupManager: string, Name of the managed instance group. (required)
667 size: integer, Number of instances that should exist in this instance group manager. (required)
668
669Returns:
670 An object of the form:
671
672 { # An Operation resource, used to manage asynchronous API requests.
673 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
674 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]675 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]676 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
677 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
678 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
679 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
680 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
681 "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 when the operation will be complete. This number should monotonically increase as the operation progresses.
682 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
683 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
684 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
685 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
686 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
687 {
688 "message": "A String", # [Output Only] A human-readable description of the warning code.
689 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
690 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
691 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
692 {
693 "value": "A String", # [Output Only] A warning data value corresponding to the key.
694 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
695 },
696 ],
697 },
698 ],
699 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
700 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
701 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
702 "name": "A String", # [Output Only] Name of the resource.
703 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
704 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
705 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
706 {
707 "message": "A String", # [Output Only] An optional, human-readable error message.
708 "code": "A String", # [Output Only] The error type identifier for this error.
709 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
710 },
711 ],
712 },
713 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
714 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
715 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
716 }</pre>
717</div>
718
719<div class="method">
720 <code class="details" id="setInstanceTemplate">setInstanceTemplate(project, region, instanceGroupManager, body)</code>
721 <pre>Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected.
722
723Args:
724 project: string, Project ID for this request. (required)
725 region: string, Name of the region scoping this request. (required)
726 instanceGroupManager: string, The name of the managed instance group. (required)
727 body: object, The request body. (required)
728 The object takes the form of:
729
730{
731 "instanceTemplate": "A String", # URL of the InstanceTemplate resource from which all new instances will be created.
732 }
733
734
735Returns:
736 An object of the form:
737
738 { # An Operation resource, used to manage asynchronous API requests.
739 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
740 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]741 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]742 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
743 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
744 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
745 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
746 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
747 "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 when the operation will be complete. This number should monotonically increase as the operation progresses.
748 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
749 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
750 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
751 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
752 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
753 {
754 "message": "A String", # [Output Only] A human-readable description of the warning code.
755 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
756 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
757 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
758 {
759 "value": "A String", # [Output Only] A warning data value corresponding to the key.
760 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
761 },
762 ],
763 },
764 ],
765 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
766 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
767 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
768 "name": "A String", # [Output Only] Name of the resource.
769 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
770 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
771 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
772 {
773 "message": "A String", # [Output Only] An optional, human-readable error message.
774 "code": "A String", # [Output Only] The error type identifier for this error.
775 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
776 },
777 ],
778 },
779 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
780 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
781 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
782 }</pre>
783</div>
784
785<div class="method">
786 <code class="details" id="setTargetPools">setTargetPools(project, region, instanceGroupManager, body)</code>
787 <pre>Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected.
788
789Args:
790 project: string, Project ID for this request. (required)
791 region: string, Name of the region scoping this request. (required)
792 instanceGroupManager: string, Name of the managed instance group. (required)
793 body: object, The request body. (required)
794 The object takes the form of:
795
796{
797 "targetPools": [ # The URL of all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
798 "A String",
799 ],
800 "fingerprint": "A String", # Fingerprint of the target pools information, which is a hash of the contents. This field is used for optimistic locking when you update the target pool entries. This field is optional.
801 }
802
803
804Returns:
805 An object of the form:
806
807 { # An Operation resource, used to manage asynchronous API requests.
808 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
809 "clientOperationId": "A String", # [Output Only] Reserved for future use.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]810 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]811 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
812 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
813 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
814 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
815 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
816 "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 when the operation will be complete. This number should monotonically increase as the operation progresses.
817 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
818 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
819 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
820 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
821 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
822 {
823 "message": "A String", # [Output Only] A human-readable description of the warning code.
824 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
825 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
826 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
827 {
828 "value": "A String", # [Output Only] A warning data value corresponding to the key.
829 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
830 },
831 ],
832 },
833 ],
834 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
835 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
836 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
837 "name": "A String", # [Output Only] Name of the resource.
838 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
839 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
840 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
841 {
842 "message": "A String", # [Output Only] An optional, human-readable error message.
843 "code": "A String", # [Output Only] The error type identifier for this error.
844 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
845 },
846 ],
847 },
848 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
849 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
850 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
851 }</pre>
852</div>
853
854</body></html>