Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 85c2c6d80859c466d29946e66ccd6a1c3a2df748 / . / docs / dyn / compute_alpha.instanceGroupManagers.html
blob: 21847ffaa15c22729f3c2ec1ed1a2874f964feaf [file] [log] [blame]
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="compute_alpha.html">Compute Engine API</a> . <a href="compute_alpha.instanceGroupManagers.html">instanceGroupManagers</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#abandonInstances">abandonInstances(project, zone, instanceGroupManager, body)</a></code></p>
79<p class="firstline">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="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
82<p class="firstline">Retrieves the list of managed instance groups and groups them by zone.</p>
83<p class="toc_element">
84 <code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p>
85<p class="firstline">Retrieves the next page of results.</p>
86<p class="toc_element">
87 <code><a href="#delete">delete(project, zone, instanceGroupManager)</a></code></p>
88<p class="firstline">Deletes the specified managed instance group and all of the instances in that group. Note that the instance group must not belong to a backend service. Read Deleting an instance group for more information.</p>
89<p class="toc_element">
90 <code><a href="#deleteInstances">deleteInstances(project, zone, instanceGroupManager, body)</a></code></p>
91<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>
92<p class="toc_element">
93 <code><a href="#get">get(project, zone, instanceGroupManager)</a></code></p>
94<p class="firstline">Returns all of the details about the specified managed instance group. Get a list of available managed instance groups by making a list() request.</p>
95<p class="toc_element">
96 <code><a href="#insert">insert(project, zone, body)</a></code></p>
97<p class="firstline">Creates a managed instance group 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>
98<p class="toc_element">
99 <code><a href="#list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
100<p class="firstline">Retrieves a list of managed instance groups that are contained within the specified project and zone.</p>
101<p class="toc_element">
102 <code><a href="#listManagedInstances">listManagedInstances(project, zone, instanceGroupManager)</a></code></p>
103<p class="firstline">Lists all of the instances in the managed instance group. Each instance in the list has a currentAction, which indicates the action that the managed instance group is performing on the instance. For example, if the group is still creating an instance, the currentAction is CREATING. If a previous action failed, the list displays the errors for that failed action.</p>
104<p class="toc_element">
105 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
106<p class="firstline">Retrieves the next page of results.</p>
107<p class="toc_element">
108 <code><a href="#patch">patch(project, zone, instanceGroupManager, body)</a></code></p>
109<p class="firstline">Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listmanagedinstances method. This method supports patch semantics.</p>
110<p class="toc_element">
111 <code><a href="#recreateInstances">recreateInstances(project, zone, instanceGroupManager, body)</a></code></p>
112<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>
113<p class="toc_element">
114 <code><a href="#resize">resize(project, zone, instanceGroupManager, size)</a></code></p>
115<p class="firstline">Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes 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>
116<p class="toc_element">
117 <code><a href="#resizeAdvanced">resizeAdvanced(project, zone, instanceGroupManager, body)</a></code></p>
118<p class="firstline">Resizes the managed instance group with advanced configuration options like disabling creation retries. This is an extended version of the resize method.</p>
119<p class="toc_element">
120 <code><a href="#setAutoHealingPolicies">setAutoHealingPolicies(project, zone, instanceGroupManager, body)</a></code></p>
121<p class="firstline">Modifies the autohealing policies.</p>
122<p class="toc_element">
123 <code><a href="#setInstanceTemplate">setInstanceTemplate(project, zone, instanceGroupManager, body)</a></code></p>
124<p class="firstline">Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you recreate them.</p>
125<p class="toc_element">
126 <code><a href="#setTargetPools">setTargetPools(project, zone, instanceGroupManager, body)</a></code></p>
127<p class="firstline">Modifies the target pools to which all instances in this managed instance group are assigned. The target pools automatically apply to all of the instances in the managed instance group. This operation is marked DONE when you make the request even if the instances have not yet been added to their target pools. The change might take some time to apply to all of the instances in the group depending on the size of the group.</p>
128<p class="toc_element">
129 <code><a href="#testIamPermissions">testIamPermissions(project, zone, resource, body)</a></code></p>
130<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
131<p class="toc_element">
132 <code><a href="#update">update(project, zone, instanceGroupManager, body)</a></code></p>
133<p class="firstline">Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listmanagedinstances method.</p>
134<h3>Method Details</h3>
135<div class="method">
136 <code class="details" id="abandonInstances">abandonInstances(project, zone, instanceGroupManager, body)</code>
137 <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.
138
139Args:
140 project: string, Project ID for this request. (required)
141 zone: string, The name of the zone where the managed instance group is located. (required)
142 instanceGroupManager: string, The name of the managed instance group. (required)
143 body: object, The request body. (required)
144 The object takes the form of:
145
146{
147 "instances": [ # The URL for one or more instances to abandon from the managed instance group.
148 "A String",
149 ],
150 }
151
152
153Returns:
154 An object of the form:
155
156 { # An Operation resource, used to manage asynchronous API requests.
157 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
158 "clientOperationId": "A String", # [Output Only] Reserved for future use.
159 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
160 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
161 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
162 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
163 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
164 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
165 "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.
166 "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.
167 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
168 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
169 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
170 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
171 {
172 "message": "A String", # [Output Only] A human-readable description of the warning code.
173 "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.
174 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
175 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
176 {
177 "value": "A String", # [Output Only] A warning data value corresponding to the key.
178 "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).
179 },
180 ],
181 },
182 ],
183 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
184 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
185 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
186 "name": "A String", # [Output Only] Name of the resource.
187 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
188 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
189 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
190 {
191 "message": "A String", # [Output Only] An optional, human-readable error message.
192 "code": "A String", # [Output Only] The error type identifier for this error.
193 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
194 },
195 ],
196 },
197 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
198 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
199 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
200 }</pre>
201</div>
202
203<div class="method">
204 <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
205 <pre>Retrieves the list of managed instance groups and groups them by zone.
206
207Args:
208 project: string, Project ID for this request. (required)
209 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
210
211You 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.
212
213Currently, only sorting by name or creationTimestamp desc is supported.
214 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.
215 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.
216 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.
217
218The 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.
219
220For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
221
222You 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.
223
224To 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.
225
226Returns:
227 An object of the form:
228
229 {
230 "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
231 "items": { # [Output Only] A map of filtered managed instance group lists.
232 "a_key": { # [Output Only] The name of the scope that contains this set of managed instance groups.
233 "warning": { # [Output Only] The warning that replaces the list of managed instance groups when the list is empty.
234 "message": "A String", # [Output Only] A human-readable description of the warning code.
235 "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.
236 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
237 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
238 {
239 "value": "A String", # [Output Only] A warning data value corresponding to the key.
240 "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).
241 },
242 ],
243 },
244 "instanceGroupManagers": [ # [Output Only] The list of managed instance groups that are contained in the specified project and zone.
245 { # An Instance Group Manager resource.
246 "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.
247 "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
248 "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.
249 "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.
250 #
251 # If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.
252 "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
253 "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.
254 "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
255 "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.
256 "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.
257 },
258 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
259 "zone": "A String", # [Output Only] The URL of the zone where the managed instance group is located (for zonal resources).
260 "versions": [ # Versions supported by this IGM. User should set this field if they need fine-grained control over how many instances in each version are run by this IGM. Versions are keyed by instanceTemplate. Every instanceTemplate can appear at most once. This field overrides instanceTemplate field. If both instanceTemplate and versions are set, the user receives a warning. "instanceTemplate: X" is semantically equivalent to "versions [ { instanceTemplate: X } ]". Exactly one version must have targetSize field left unset. Size of such a version will be calculated automatically.
261 {
262 "targetSize": { # Encapsulates numeric value that can be either absolute or relative. # Intended number of instances that are created from instanceTemplate. The final number of instances created from instanceTemplate will be equal to: * if expressed as fixed number: min(targetSize.fixed, instanceGroupManager.targetSize), * if expressed as percent: ceiling(targetSize.percent * InstanceGroupManager.targetSize). If unset, this version will handle all the remaining instances.
263 "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
264 "fixed": 42, # fixed must be non-negative.
265 "percent": 42, # percent must belong to [0, 100].
266 },
267 "instanceTemplate": "A String",
268 "tag": "A String", # Tag describing the version. Used to trigger rollout of a target version even if instance_template remains unchanged.
269 },
270 ],
271 "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.
272 {
273 "healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
274 "initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].
275 "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable when auto-healing. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a percent value of 100% is used.
276 "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
277 "fixed": 42, # fixed must be non-negative.
278 "percent": 42, # percent must belong to [0, 100].
279 },
280 },
281 ],
282 "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.
283 "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.
284 "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
285 "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
286 "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.
287 "A String",
288 ],
289 "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.
290 "pendingActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are pending for each of those actions.
291 "recreating": 42, # [Output Only] The number of instances in the managed instance group that are pending to be recreated.
292 "deleting": 42, # [Output Only] The number of instances in the managed instance group that are pending to be deleted.
293 "creating": 42, # [Output Only] The number of instances in the managed instance group that are pending to be created.
294 "restarting": 42, # [Output Only] The number of instances in the managed instance group that are pending to be restarted.
295 },
296 "updatePolicy": { # The update policy for this managed instance group.
297 "type": "A String",
298 "maxSurge": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be created above the InstanceGroupManager.targetSize during the update process. By default, a fixed value of 1 is used. Using maxSurge > 0 will cause instance names to change during the update process. At least one of { maxSurge, maxUnavailable } must be greater than 0.
299 "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
300 "fixed": 42, # fixed must be non-negative.
301 "percent": 42, # percent must belong to [0, 100].
302 },
303 "minimalAction": "A String", # Minimal action to be taken on an instance. The order of action types is: RESTART < REPLACE.
304 "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable during the update process. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a fixed value of 1 is used. At least one of { maxSurge, maxUnavailable } must be greater than 0.
305 "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
306 "fixed": 42, # fixed must be non-negative.
307 "percent": 42, # percent must belong to [0, 100].
308 },
309 "minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600].
310 },
311 "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.
312 "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).
313 "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.
314 "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
315 { # The named port. For example: .
316 "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
317 "port": 42, # The port number, which can be a value between 1 and 65535.
318 },
319 ],
320 "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
321 "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
322 "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
323 "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.
324 },
325 ],
326 },
327 },
328 "kind": "compute#instanceGroupManagerAggregatedList", # [Output Only] The resource type, which is always compute#instanceGroupManagerAggregatedList for an aggregated list of managed instance groups.
329 "id": "A String", # [Output Only] A unique identifier for this aggregated list of managed instance groups. The server generates this identifier.
330 "selfLink": "A String", # [Output Only] The URL for this resource type. The server generates this URL.
331 }</pre>
332</div>
333
334<div class="method">
335 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
336 <pre>Retrieves the next page of results.
337
338Args:
339 previous_request: The request for the previous page. (required)
340 previous_response: The response from the request for the previous page. (required)
341
342Returns:
343 A request object that you can call 'execute()' on to request the next
344 page. Returns None if there are no more items in the collection.
345 </pre>
346</div>
347
348<div class="method">
349 <code class="details" id="delete">delete(project, zone, instanceGroupManager)</code>
350 <pre>Deletes the specified managed instance group and all of the instances in that group. Note that the instance group must not belong to a backend service. Read Deleting an instance group for more information.
351
352Args:
353 project: string, Project ID for this request. (required)
354 zone: string, The name of the zone where the managed instance group is located. (required)
355 instanceGroupManager: string, The name of the managed instance group to delete. (required)
356
357Returns:
358 An object of the form:
359
360 { # An Operation resource, used to manage asynchronous API requests.
361 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
362 "clientOperationId": "A String", # [Output Only] Reserved for future use.
363 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
364 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
365 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
366 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
367 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
368 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
369 "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.
370 "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.
371 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
372 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
373 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
374 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
375 {
376 "message": "A String", # [Output Only] A human-readable description of the warning code.
377 "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.
378 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
379 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
380 {
381 "value": "A String", # [Output Only] A warning data value corresponding to the key.
382 "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).
383 },
384 ],
385 },
386 ],
387 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
388 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
389 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
390 "name": "A String", # [Output Only] Name of the resource.
391 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
392 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
393 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
394 {
395 "message": "A String", # [Output Only] An optional, human-readable error message.
396 "code": "A String", # [Output Only] The error type identifier for this error.
397 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
398 },
399 ],
400 },
401 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
402 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
403 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
404 }</pre>
405</div>
406
407<div class="method">
408 <code class="details" id="deleteInstances">deleteInstances(project, zone, instanceGroupManager, body)</code>
409 <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.
410
411Args:
412 project: string, Project ID for this request. (required)
413 zone: string, The name of the zone where the managed instance group is located. (required)
414 instanceGroupManager: string, The name of the managed instance group. (required)
415 body: object, The request body. (required)
416 The object takes the form of:
417
418{
419 "instances": [ # The list of instances to delete from this managed instance group. Specify one or more instance URLs.
420 "A String",
421 ],
422 }
423
424
425Returns:
426 An object of the form:
427
428 { # An Operation resource, used to manage asynchronous API requests.
429 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
430 "clientOperationId": "A String", # [Output Only] Reserved for future use.
431 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
432 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
433 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
434 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
435 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
436 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
437 "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.
438 "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.
439 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
440 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
441 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
442 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
443 {
444 "message": "A String", # [Output Only] A human-readable description of the warning code.
445 "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.
446 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
447 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
448 {
449 "value": "A String", # [Output Only] A warning data value corresponding to the key.
450 "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).
451 },
452 ],
453 },
454 ],
455 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
456 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
457 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
458 "name": "A String", # [Output Only] Name of the resource.
459 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
460 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
461 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
462 {
463 "message": "A String", # [Output Only] An optional, human-readable error message.
464 "code": "A String", # [Output Only] The error type identifier for this error.
465 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
466 },
467 ],
468 },
469 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
470 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
471 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
472 }</pre>
473</div>
474
475<div class="method">
476 <code class="details" id="get">get(project, zone, instanceGroupManager)</code>
477 <pre>Returns all of the details about the specified managed instance group. Get a list of available managed instance groups by making a list() request.
478
479Args:
480 project: string, Project ID for this request. (required)
481 zone: string, The name of the zone where the managed instance group is located. (required)
482 instanceGroupManager: string, The name of the managed instance group. (required)
483
484Returns:
485 An object of the form:
486
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 "versions": [ # Versions supported by this IGM. User should set this field if they need fine-grained control over how many instances in each version are run by this IGM. Versions are keyed by instanceTemplate. Every instanceTemplate can appear at most once. This field overrides instanceTemplate field. If both instanceTemplate and versions are set, the user receives a warning. "instanceTemplate: X" is semantically equivalent to "versions [ { instanceTemplate: X } ]". Exactly one version must have targetSize field left unset. Size of such a version will be calculated automatically.
503 {
504 "targetSize": { # Encapsulates numeric value that can be either absolute or relative. # Intended number of instances that are created from instanceTemplate. The final number of instances created from instanceTemplate will be equal to: * if expressed as fixed number: min(targetSize.fixed, instanceGroupManager.targetSize), * if expressed as percent: ceiling(targetSize.percent * InstanceGroupManager.targetSize). If unset, this version will handle all the remaining instances.
505 "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
506 "fixed": 42, # fixed must be non-negative.
507 "percent": 42, # percent must belong to [0, 100].
508 },
509 "instanceTemplate": "A String",
510 "tag": "A String", # Tag describing the version. Used to trigger rollout of a target version even if instance_template remains unchanged.
511 },
512 ],
513 "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.
514 {
515 "healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
516 "initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].
517 "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable when auto-healing. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a percent value of 100% is used.
518 "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
519 "fixed": 42, # fixed must be non-negative.
520 "percent": 42, # percent must belong to [0, 100].
521 },
522 },
523 ],
524 "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.
525 "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.
526 "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
527 "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
528 "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.
529 "A String",
530 ],
531 "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.
532 "pendingActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are pending for each of those actions.
533 "recreating": 42, # [Output Only] The number of instances in the managed instance group that are pending to be recreated.
534 "deleting": 42, # [Output Only] The number of instances in the managed instance group that are pending to be deleted.
535 "creating": 42, # [Output Only] The number of instances in the managed instance group that are pending to be created.
536 "restarting": 42, # [Output Only] The number of instances in the managed instance group that are pending to be restarted.
537 },
538 "updatePolicy": { # The update policy for this managed instance group.
539 "type": "A String",
540 "maxSurge": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be created above the InstanceGroupManager.targetSize during the update process. By default, a fixed value of 1 is used. Using maxSurge > 0 will cause instance names to change during the update process. At least one of { maxSurge, maxUnavailable } must be greater than 0.
541 "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
542 "fixed": 42, # fixed must be non-negative.
543 "percent": 42, # percent must belong to [0, 100].
544 },
545 "minimalAction": "A String", # Minimal action to be taken on an instance. The order of action types is: RESTART < REPLACE.
546 "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable during the update process. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a fixed value of 1 is used. At least one of { maxSurge, maxUnavailable } must be greater than 0.
547 "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
548 "fixed": 42, # fixed must be non-negative.
549 "percent": 42, # percent must belong to [0, 100].
550 },
551 "minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600].
552 },
553 "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.
554 "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).
555 "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.
556 "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
557 { # The named port. For example: .
558 "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
559 "port": 42, # The port number, which can be a value between 1 and 65535.
560 },
561 ],
562 "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
563 "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
564 "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
565 "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.
566 }</pre>
567</div>
568
569<div class="method">
570 <code class="details" id="insert">insert(project, zone, body)</code>
571 <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.
572
573Args:
574 project: string, Project ID for this request. (required)
575 zone: string, The name of the zone where you want to create the managed instance group. (required)
576 body: object, The request body. (required)
577 The object takes the form of:
578
579{ # An Instance Group Manager resource.
580 "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.
581 "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
582 "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.
583 "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.
584 #
585 # If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.
586 "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
587 "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.
588 "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
589 "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.
590 "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.
591 },
592 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
593 "zone": "A String", # [Output Only] The URL of the zone where the managed instance group is located (for zonal resources).
594 "versions": [ # Versions supported by this IGM. User should set this field if they need fine-grained control over how many instances in each version are run by this IGM. Versions are keyed by instanceTemplate. Every instanceTemplate can appear at most once. This field overrides instanceTemplate field. If both instanceTemplate and versions are set, the user receives a warning. "instanceTemplate: X" is semantically equivalent to "versions [ { instanceTemplate: X } ]". Exactly one version must have targetSize field left unset. Size of such a version will be calculated automatically.
595 {
596 "targetSize": { # Encapsulates numeric value that can be either absolute or relative. # Intended number of instances that are created from instanceTemplate. The final number of instances created from instanceTemplate will be equal to: * if expressed as fixed number: min(targetSize.fixed, instanceGroupManager.targetSize), * if expressed as percent: ceiling(targetSize.percent * InstanceGroupManager.targetSize). If unset, this version will handle all the remaining instances.
597 "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
598 "fixed": 42, # fixed must be non-negative.
599 "percent": 42, # percent must belong to [0, 100].
600 },
601 "instanceTemplate": "A String",
602 "tag": "A String", # Tag describing the version. Used to trigger rollout of a target version even if instance_template remains unchanged.
603 },
604 ],
605 "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.
606 {
607 "healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
608 "initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].
609 "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable when auto-healing. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a percent value of 100% is used.
610 "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
611 "fixed": 42, # fixed must be non-negative.
612 "percent": 42, # percent must belong to [0, 100].
613 },
614 },
615 ],
616 "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.
617 "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.
618 "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
619 "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
620 "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.
621 "A String",
622 ],
623 "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.
624 "pendingActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are pending for each of those actions.
625 "recreating": 42, # [Output Only] The number of instances in the managed instance group that are pending to be recreated.
626 "deleting": 42, # [Output Only] The number of instances in the managed instance group that are pending to be deleted.
627 "creating": 42, # [Output Only] The number of instances in the managed instance group that are pending to be created.
628 "restarting": 42, # [Output Only] The number of instances in the managed instance group that are pending to be restarted.
629 },
630 "updatePolicy": { # The update policy for this managed instance group.
631 "type": "A String",
632 "maxSurge": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be created above the InstanceGroupManager.targetSize during the update process. By default, a fixed value of 1 is used. Using maxSurge > 0 will cause instance names to change during the update process. At least one of { maxSurge, maxUnavailable } must be greater than 0.
633 "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
634 "fixed": 42, # fixed must be non-negative.
635 "percent": 42, # percent must belong to [0, 100].
636 },
637 "minimalAction": "A String", # Minimal action to be taken on an instance. The order of action types is: RESTART < REPLACE.
638 "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable during the update process. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a fixed value of 1 is used. At least one of { maxSurge, maxUnavailable } must be greater than 0.
639 "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
640 "fixed": 42, # fixed must be non-negative.
641 "percent": 42, # percent must belong to [0, 100].
642 },
643 "minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600].
644 },
645 "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.
646 "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).
647 "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.
648 "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
649 { # The named port. For example: .
650 "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
651 "port": 42, # The port number, which can be a value between 1 and 65535.
652 },
653 ],
654 "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
655 "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
656 "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
657 "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.
658 }
659
660
661Returns:
662 An object of the form:
663
664 { # An Operation resource, used to manage asynchronous API requests.
665 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
666 "clientOperationId": "A String", # [Output Only] Reserved for future use.
667 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
668 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
669 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
670 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
671 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
672 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
673 "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.
674 "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.
675 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
676 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
677 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
678 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
679 {
680 "message": "A String", # [Output Only] A human-readable description of the warning code.
681 "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.
682 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
683 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
684 {
685 "value": "A String", # [Output Only] A warning data value corresponding to the key.
686 "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).
687 },
688 ],
689 },
690 ],
691 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
692 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
693 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
694 "name": "A String", # [Output Only] Name of the resource.
695 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
696 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
697 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
698 {
699 "message": "A String", # [Output Only] An optional, human-readable error message.
700 "code": "A String", # [Output Only] The error type identifier for this error.
701 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
702 },
703 ],
704 },
705 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
706 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
707 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
708 }</pre>
709</div>
710
711<div class="method">
712 <code class="details" id="list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
713 <pre>Retrieves a list of managed instance groups that are contained within the specified project and zone.
714
715Args:
716 project: string, Project ID for this request. (required)
717 zone: string, The name of the zone where the managed instance group is located. (required)
718 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
719
720You 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.
721
722Currently, only sorting by name or creationTimestamp desc is supported.
723 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.
724 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.
725 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.
726
727The 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.
728
729For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
730
731You 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.
732
733To 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.
734
735Returns:
736 An object of the form:
737
738 { # [Output Only] A list of managed instance groups.
739 "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
740 "items": [ # [Output Only] A list of managed instance groups.
741 { # An Instance Group Manager resource.
742 "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.
743 "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
744 "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.
745 "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.
746 #
747 # If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.
748 "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
749 "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.
750 "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
751 "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.
752 "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.
753 },
754 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
755 "zone": "A String", # [Output Only] The URL of the zone where the managed instance group is located (for zonal resources).
756 "versions": [ # Versions supported by this IGM. User should set this field if they need fine-grained control over how many instances in each version are run by this IGM. Versions are keyed by instanceTemplate. Every instanceTemplate can appear at most once. This field overrides instanceTemplate field. If both instanceTemplate and versions are set, the user receives a warning. "instanceTemplate: X" is semantically equivalent to "versions [ { instanceTemplate: X } ]". Exactly one version must have targetSize field left unset. Size of such a version will be calculated automatically.
757 {
758 "targetSize": { # Encapsulates numeric value that can be either absolute or relative. # Intended number of instances that are created from instanceTemplate. The final number of instances created from instanceTemplate will be equal to: * if expressed as fixed number: min(targetSize.fixed, instanceGroupManager.targetSize), * if expressed as percent: ceiling(targetSize.percent * InstanceGroupManager.targetSize). If unset, this version will handle all the remaining instances.
759 "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
760 "fixed": 42, # fixed must be non-negative.
761 "percent": 42, # percent must belong to [0, 100].
762 },
763 "instanceTemplate": "A String",
764 "tag": "A String", # Tag describing the version. Used to trigger rollout of a target version even if instance_template remains unchanged.
765 },
766 ],
767 "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.
768 {
769 "healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
770 "initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].
771 "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable when auto-healing. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a percent value of 100% is used.
772 "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
773 "fixed": 42, # fixed must be non-negative.
774 "percent": 42, # percent must belong to [0, 100].
775 },
776 },
777 ],
778 "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.
779 "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.
780 "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
781 "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
782 "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.
783 "A String",
784 ],
785 "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.
786 "pendingActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are pending for each of those actions.
787 "recreating": 42, # [Output Only] The number of instances in the managed instance group that are pending to be recreated.
788 "deleting": 42, # [Output Only] The number of instances in the managed instance group that are pending to be deleted.
789 "creating": 42, # [Output Only] The number of instances in the managed instance group that are pending to be created.
790 "restarting": 42, # [Output Only] The number of instances in the managed instance group that are pending to be restarted.
791 },
792 "updatePolicy": { # The update policy for this managed instance group.
793 "type": "A String",
794 "maxSurge": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be created above the InstanceGroupManager.targetSize during the update process. By default, a fixed value of 1 is used. Using maxSurge > 0 will cause instance names to change during the update process. At least one of { maxSurge, maxUnavailable } must be greater than 0.
795 "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
796 "fixed": 42, # fixed must be non-negative.
797 "percent": 42, # percent must belong to [0, 100].
798 },
799 "minimalAction": "A String", # Minimal action to be taken on an instance. The order of action types is: RESTART < REPLACE.
800 "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable during the update process. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a fixed value of 1 is used. At least one of { maxSurge, maxUnavailable } must be greater than 0.
801 "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
802 "fixed": 42, # fixed must be non-negative.
803 "percent": 42, # percent must belong to [0, 100].
804 },
805 "minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600].
806 },
807 "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.
808 "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).
809 "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.
810 "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
811 { # The named port. For example: .
812 "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
813 "port": 42, # The port number, which can be a value between 1 and 65535.
814 },
815 ],
816 "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
817 "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
818 "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
819 "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.
820 },
821 ],
822 "kind": "compute#instanceGroupManagerList", # [Output Only] The resource type, which is always compute#instanceGroupManagerList for a list of managed instance groups.
823 "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
824 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
825 }</pre>
826</div>
827
828<div class="method">
829 <code class="details" id="listManagedInstances">listManagedInstances(project, zone, instanceGroupManager)</code>
830 <pre>Lists all of the instances in the managed instance group. Each instance in the list has a currentAction, which indicates the action that the managed instance group is performing on the instance. For example, if the group is still creating an instance, the currentAction is CREATING. If a previous action failed, the list displays the errors for that failed action.
831
832Args:
833 project: string, Project ID for this request. (required)
834 zone: string, The name of the zone where the managed instance group is located. (required)
835 instanceGroupManager: string, The name of the managed instance group. (required)
836
837Returns:
838 An object of the form:
839
840 {
841 "managedInstances": [ # [Output Only] The list of instances in the managed instance group.
842 {
843 "instanceStatus": "A String", # [Output Only] The status of the instance. This field is empty when the instance does not exist.
844 "lastAttempt": { # [Output Only] Information about the last attempt to create or delete the instance.
845 "errors": { # [Output Only] Encountered errors during the last attempt to create or delete the instance.
846 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
847 {
848 "message": "A String", # [Output Only] An optional, human-readable error message.
849 "code": "A String", # [Output Only] The error type identifier for this error.
850 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
851 },
852 ],
853 },
854 },
855 "tag": "A String", # [Output Only] Tag describing the version.
856 "instance": "A String", # [Output Only] The URL of the instance. The URL can exist even if the instance has not yet been created.
857 "instanceTemplate": "A String", # [Output Only] The intended template of the instance. This field is empty when current_action is one of { DELETING, ABANDONING }.
858 "standbyMode": "A String", # [Output Only] Standby mode of the instance. This field is non-empty iff the instance is a standby.
859 "currentAction": "A String", # [Output Only] The current action that the managed instance group has scheduled for the instance. Possible values:
860 # - NONE The instance is running, and the managed instance group does not have any scheduled actions for this instance.
861 # - 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.
862 # - 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.
863 # - RECREATING The managed instance group is recreating this instance.
864 # - DELETING The managed instance group is permanently deleting this instance.
865 # - 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.
866 # - RESTARTING The managed instance group is restarting the instance.
867 # - 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.
868 "id": "A String", # [Output only] The unique identifier for this resource. This field is empty when instance does not exist.
869 },
870 ],
871 }</pre>
872</div>
873
874<div class="method">
875 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
876 <pre>Retrieves the next page of results.
877
878Args:
879 previous_request: The request for the previous page. (required)
880 previous_response: The response from the request for the previous page. (required)
881
882Returns:
883 A request object that you can call 'execute()' on to request the next
884 page. Returns None if there are no more items in the collection.
885 </pre>
886</div>
887
888<div class="method">
889 <code class="details" id="patch">patch(project, zone, instanceGroupManager, body)</code>
890 <pre>Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listmanagedinstances method. This method supports patch semantics.
891
892Args:
893 project: string, Project ID for this request. (required)
894 zone: string, The name of the zone where you want to create the managed instance group. (required)
895 instanceGroupManager: string, The name of the instance group manager. (required)
896 body: object, The request body. (required)
897 The object takes the form of:
898
899{ # An Instance Group Manager resource.
900 "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.
901 "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
902 "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.
903 "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.
904 #
905 # If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.
906 "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
907 "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.
908 "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
909 "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.
910 "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.
911 },
912 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
913 "zone": "A String", # [Output Only] The URL of the zone where the managed instance group is located (for zonal resources).
914 "versions": [ # Versions supported by this IGM. User should set this field if they need fine-grained control over how many instances in each version are run by this IGM. Versions are keyed by instanceTemplate. Every instanceTemplate can appear at most once. This field overrides instanceTemplate field. If both instanceTemplate and versions are set, the user receives a warning. "instanceTemplate: X" is semantically equivalent to "versions [ { instanceTemplate: X } ]". Exactly one version must have targetSize field left unset. Size of such a version will be calculated automatically.
915 {
916 "targetSize": { # Encapsulates numeric value that can be either absolute or relative. # Intended number of instances that are created from instanceTemplate. The final number of instances created from instanceTemplate will be equal to: * if expressed as fixed number: min(targetSize.fixed, instanceGroupManager.targetSize), * if expressed as percent: ceiling(targetSize.percent * InstanceGroupManager.targetSize). If unset, this version will handle all the remaining instances.
917 "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
918 "fixed": 42, # fixed must be non-negative.
919 "percent": 42, # percent must belong to [0, 100].
920 },
921 "instanceTemplate": "A String",
922 "tag": "A String", # Tag describing the version. Used to trigger rollout of a target version even if instance_template remains unchanged.
923 },
924 ],
925 "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.
926 {
927 "healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
928 "initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].
929 "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable when auto-healing. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a percent value of 100% is used.
930 "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
931 "fixed": 42, # fixed must be non-negative.
932 "percent": 42, # percent must belong to [0, 100].
933 },
934 },
935 ],
936 "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.
937 "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.
938 "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
939 "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
940 "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.
941 "A String",
942 ],
943 "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.
944 "pendingActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are pending for each of those actions.
945 "recreating": 42, # [Output Only] The number of instances in the managed instance group that are pending to be recreated.
946 "deleting": 42, # [Output Only] The number of instances in the managed instance group that are pending to be deleted.
947 "creating": 42, # [Output Only] The number of instances in the managed instance group that are pending to be created.
948 "restarting": 42, # [Output Only] The number of instances in the managed instance group that are pending to be restarted.
949 },
950 "updatePolicy": { # The update policy for this managed instance group.
951 "type": "A String",
952 "maxSurge": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be created above the InstanceGroupManager.targetSize during the update process. By default, a fixed value of 1 is used. Using maxSurge > 0 will cause instance names to change during the update process. At least one of { maxSurge, maxUnavailable } must be greater than 0.
953 "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
954 "fixed": 42, # fixed must be non-negative.
955 "percent": 42, # percent must belong to [0, 100].
956 },
957 "minimalAction": "A String", # Minimal action to be taken on an instance. The order of action types is: RESTART < REPLACE.
958 "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable during the update process. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a fixed value of 1 is used. At least one of { maxSurge, maxUnavailable } must be greater than 0.
959 "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
960 "fixed": 42, # fixed must be non-negative.
961 "percent": 42, # percent must belong to [0, 100].
962 },
963 "minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600].
964 },
965 "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.
966 "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).
967 "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.
968 "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
969 { # The named port. For example: .
970 "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
971 "port": 42, # The port number, which can be a value between 1 and 65535.
972 },
973 ],
974 "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
975 "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
976 "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
977 "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.
978 }
979
980
981Returns:
982 An object of the form:
983
984 { # An Operation resource, used to manage asynchronous API requests.
985 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
986 "clientOperationId": "A String", # [Output Only] Reserved for future use.
987 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
988 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
989 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
990 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
991 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
992 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
993 "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.
994 "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.
995 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
996 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
997 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
998 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
999 {
1000 "message": "A String", # [Output Only] A human-readable description of the warning code.
1001 "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.
1002 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
1003 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
1004 {
1005 "value": "A String", # [Output Only] A warning data value corresponding to the key.
1006 "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).
1007 },
1008 ],
1009 },
1010 ],
1011 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
1012 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
1013 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
1014 "name": "A String", # [Output Only] Name of the resource.
1015 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
1016 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
1017 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
1018 {
1019 "message": "A String", # [Output Only] An optional, human-readable error message.
1020 "code": "A String", # [Output Only] The error type identifier for this error.
1021 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
1022 },
1023 ],
1024 },
1025 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
1026 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
1027 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
1028 }</pre>
1029</div>
1030
1031<div class="method">
1032 <code class="details" id="recreateInstances">recreateInstances(project, zone, instanceGroupManager, body)</code>
1033 <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.
1034
1035Args:
1036 project: string, Project ID for this request. (required)
1037 zone: string, The name of the zone where the managed instance group is located. (required)
1038 instanceGroupManager: string, The name of the managed instance group. (required)
1039 body: object, The request body. (required)
1040 The object takes the form of:
1041
1042{
1043 "instances": [ # The URL for one or more instances to recreate.
1044 "A String",
1045 ],
1046 }
1047
1048
1049Returns:
1050 An object of the form:
1051
1052 { # An Operation resource, used to manage asynchronous API requests.
1053 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
1054 "clientOperationId": "A String", # [Output Only] Reserved for future use.
1055 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
1056 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
1057 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
1058 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
1059 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
1060 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
1061 "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.
1062 "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.
1063 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
1064 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
1065 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
1066 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
1067 {
1068 "message": "A String", # [Output Only] A human-readable description of the warning code.
1069 "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.
1070 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
1071 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
1072 {
1073 "value": "A String", # [Output Only] A warning data value corresponding to the key.
1074 "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).
1075 },
1076 ],
1077 },
1078 ],
1079 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
1080 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
1081 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
1082 "name": "A String", # [Output Only] Name of the resource.
1083 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
1084 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
1085 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
1086 {
1087 "message": "A String", # [Output Only] An optional, human-readable error message.
1088 "code": "A String", # [Output Only] The error type identifier for this error.
1089 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
1090 },
1091 ],
1092 },
1093 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
1094 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
1095 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
1096 }</pre>
1097</div>
1098
1099<div class="method">
1100 <code class="details" id="resize">resize(project, zone, instanceGroupManager, size)</code>
1101 <pre>Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes 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.
1102
1103Args:
1104 project: string, Project ID for this request. (required)
1105 zone: string, The name of the zone where the managed instance group is located. (required)
1106 instanceGroupManager: string, The name of the managed instance group. (required)
1107 size: integer, The number of running instances that the managed instance group should maintain at any given time. The group automatically adds or removes instances to maintain the number of instances specified by this parameter. (required)
1108
1109Returns:
1110 An object of the form:
1111
1112 { # An Operation resource, used to manage asynchronous API requests.
1113 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
1114 "clientOperationId": "A String", # [Output Only] Reserved for future use.
1115 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
1116 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
1117 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
1118 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
1119 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
1120 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
1121 "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.
1122 "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.
1123 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
1124 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
1125 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
1126 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
1127 {
1128 "message": "A String", # [Output Only] A human-readable description of the warning code.
1129 "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.
1130 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
1131 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
1132 {
1133 "value": "A String", # [Output Only] A warning data value corresponding to the key.
1134 "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).
1135 },
1136 ],
1137 },
1138 ],
1139 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
1140 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
1141 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
1142 "name": "A String", # [Output Only] Name of the resource.
1143 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
1144 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
1145 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
1146 {
1147 "message": "A String", # [Output Only] An optional, human-readable error message.
1148 "code": "A String", # [Output Only] The error type identifier for this error.
1149 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
1150 },
1151 ],
1152 },
1153 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
1154 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
1155 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
1156 }</pre>
1157</div>
1158
1159<div class="method">
1160 <code class="details" id="resizeAdvanced">resizeAdvanced(project, zone, instanceGroupManager, body)</code>
1161 <pre>Resizes the managed instance group with advanced configuration options like disabling creation retries. This is an extended version of the resize method.
1162
1163If you increase the size of the instance group, the group creates new instances using the current instance template. If you decrease the size, the group deletes 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, creatingWithoutRetries, or deleting actions with the get or listmanagedinstances method.
1164
1165Args:
1166 project: string, Project ID for this request. (required)
1167 zone: string, The name of the zone where the managed instance group is located. (required)
1168 instanceGroupManager: string, The name of the managed instance group. (required)
1169 body: object, The request body. (required)
1170 The object takes the form of:
1171
1172{
1173 "noCreationRetries": True or False, # If this flag is true, the managed instance group attempts to create all instances initiated by this resize request only once. If there is an error during creation, the managed instance group does not retry create this instance, and we will decrease the targetSize of the request instead. If the flag is false, the group attemps to recreate each instance continuously until it succeeds.
1174 #
1175 # This flag matters only in the first attempt of creation of an instance. After an instance is successfully created while this flag is enabled, the instance behaves the same way as all the other instances created with a regular resize request. In particular, if a running instance dies unexpectedly at a later time and needs to be recreated, this mode does not affect the recreation behavior in that scenario.
1176 #
1177 # This flag is applicable only to the current resize request. It does not influence other resize requests in any way.
1178 #
1179 # You can see which instances is being creating in which mode by calling the get or listManagedInstances API.
1180 "targetSize": 42, # The number of running instances that the managed instance group should maintain at any given time. The group automatically adds or removes instances to maintain the number of instances specified by this parameter.
1181 }
1182
1183
1184Returns:
1185 An object of the form:
1186
1187 { # An Operation resource, used to manage asynchronous API requests.
1188 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
1189 "clientOperationId": "A String", # [Output Only] Reserved for future use.
1190 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
1191 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
1192 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
1193 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
1194 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
1195 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
1196 "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.
1197 "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.
1198 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
1199 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
1200 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
1201 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
1202 {
1203 "message": "A String", # [Output Only] A human-readable description of the warning code.
1204 "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.
1205 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
1206 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
1207 {
1208 "value": "A String", # [Output Only] A warning data value corresponding to the key.
1209 "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).
1210 },
1211 ],
1212 },
1213 ],
1214 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
1215 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
1216 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
1217 "name": "A String", # [Output Only] Name of the resource.
1218 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
1219 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
1220 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
1221 {
1222 "message": "A String", # [Output Only] An optional, human-readable error message.
1223 "code": "A String", # [Output Only] The error type identifier for this error.
1224 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
1225 },
1226 ],
1227 },
1228 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
1229 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
1230 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
1231 }</pre>
1232</div>
1233
1234<div class="method">
1235 <code class="details" id="setAutoHealingPolicies">setAutoHealingPolicies(project, zone, instanceGroupManager, body)</code>
1236 <pre>Modifies the autohealing policies.
1237
1238Args:
1239 project: string, Project ID for this request. (required)
1240 zone: string, The name of the zone where the managed instance group is located. (required)
1241 instanceGroupManager: string, The name of the instance group manager. (required)
1242 body: object, The request body. (required)
1243 The object takes the form of:
1244
1245{
1246 "autoHealingPolicies": [
1247 {
1248 "healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
1249 "initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].
1250 "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable when auto-healing. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a percent value of 100% is used.
1251 "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
1252 "fixed": 42, # fixed must be non-negative.
1253 "percent": 42, # percent must belong to [0, 100].
1254 },
1255 },
1256 ],
1257 }
1258
1259
1260Returns:
1261 An object of the form:
1262
1263 { # An Operation resource, used to manage asynchronous API requests.
1264 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
1265 "clientOperationId": "A String", # [Output Only] Reserved for future use.
1266 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
1267 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
1268 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
1269 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
1270 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
1271 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
1272 "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.
1273 "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.
1274 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
1275 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
1276 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
1277 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
1278 {
1279 "message": "A String", # [Output Only] A human-readable description of the warning code.
1280 "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.
1281 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
1282 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
1283 {
1284 "value": "A String", # [Output Only] A warning data value corresponding to the key.
1285 "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).
1286 },
1287 ],
1288 },
1289 ],
1290 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
1291 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
1292 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
1293 "name": "A String", # [Output Only] Name of the resource.
1294 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
1295 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
1296 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
1297 {
1298 "message": "A String", # [Output Only] An optional, human-readable error message.
1299 "code": "A String", # [Output Only] The error type identifier for this error.
1300 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
1301 },
1302 ],
1303 },
1304 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
1305 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
1306 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
1307 }</pre>
1308</div>
1309
1310<div class="method">
1311 <code class="details" id="setInstanceTemplate">setInstanceTemplate(project, zone, instanceGroupManager, body)</code>
1312 <pre>Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you recreate them.
1313
1314Args:
1315 project: string, Project ID for this request. (required)
1316 zone: string, The name of the zone where the managed instance group is located. (required)
1317 instanceGroupManager: string, The name of the managed instance group. (required)
1318 body: object, The request body. (required)
1319 The object takes the form of:
1320
1321{
1322 "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.
1323 }
1324
1325
1326Returns:
1327 An object of the form:
1328
1329 { # An Operation resource, used to manage asynchronous API requests.
1330 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
1331 "clientOperationId": "A String", # [Output Only] Reserved for future use.
1332 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
1333 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
1334 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
1335 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
1336 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
1337 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
1338 "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.
1339 "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.
1340 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
1341 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
1342 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
1343 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
1344 {
1345 "message": "A String", # [Output Only] A human-readable description of the warning code.
1346 "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.
1347 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
1348 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
1349 {
1350 "value": "A String", # [Output Only] A warning data value corresponding to the key.
1351 "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).
1352 },
1353 ],
1354 },
1355 ],
1356 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
1357 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
1358 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
1359 "name": "A String", # [Output Only] Name of the resource.
1360 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
1361 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
1362 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
1363 {
1364 "message": "A String", # [Output Only] An optional, human-readable error message.
1365 "code": "A String", # [Output Only] The error type identifier for this error.
1366 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
1367 },
1368 ],
1369 },
1370 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
1371 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
1372 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
1373 }</pre>
1374</div>
1375
1376<div class="method">
1377 <code class="details" id="setTargetPools">setTargetPools(project, zone, instanceGroupManager, body)</code>
1378 <pre>Modifies the target pools to which all instances in this managed instance group are assigned. The target pools automatically apply to all of the instances in the managed instance group. This operation is marked DONE when you make the request even if the instances have not yet been added to their target pools. The change might take some time to apply to all of the instances in the group depending on the size of the group.
1379
1380Args:
1381 project: string, Project ID for this request. (required)
1382 zone: string, The name of the zone where the managed instance group is located. (required)
1383 instanceGroupManager: string, The name of the managed instance group. (required)
1384 body: object, The request body. (required)
1385 The object takes the form of:
1386
1387{
1388 "targetPools": [ # The list of target pool URLs that instances in this managed instance group belong to. The managed instance group applies these target pools to all of the instances in the group. Existing instances and new instances in the group all receive these target pool settings.
1389 "A String",
1390 ],
1391 "fingerprint": "A String", # The fingerprint of the target pools information. Use this optional property to prevent conflicts when multiple users change the target pools settings concurrently. Obtain the fingerprint with the instanceGroupManagers.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request.
1392 }
1393
1394
1395Returns:
1396 An object of the form:
1397
1398 { # An Operation resource, used to manage asynchronous API requests.
1399 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
1400 "clientOperationId": "A String", # [Output Only] Reserved for future use.
1401 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
1402 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
1403 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
1404 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
1405 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
1406 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
1407 "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.
1408 "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.
1409 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
1410 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
1411 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
1412 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
1413 {
1414 "message": "A String", # [Output Only] A human-readable description of the warning code.
1415 "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.
1416 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
1417 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
1418 {
1419 "value": "A String", # [Output Only] A warning data value corresponding to the key.
1420 "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).
1421 },
1422 ],
1423 },
1424 ],
1425 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
1426 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
1427 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
1428 "name": "A String", # [Output Only] Name of the resource.
1429 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
1430 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
1431 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
1432 {
1433 "message": "A String", # [Output Only] An optional, human-readable error message.
1434 "code": "A String", # [Output Only] The error type identifier for this error.
1435 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
1436 },
1437 ],
1438 },
1439 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
1440 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
1441 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
1442 }</pre>
1443</div>
1444
1445<div class="method">
1446 <code class="details" id="testIamPermissions">testIamPermissions(project, zone, resource, body)</code>
1447 <pre>Returns permissions that a caller has on the specified resource.
1448
1449Args:
1450 project: string, Project ID for this request. (required)
1451 zone: string, The name of the zone for this request. (required)
1452 resource: string, Name of the resource for this request. (required)
1453 body: object, The request body. (required)
1454 The object takes the form of:
1455
1456{
1457 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
1458 "A String",
1459 ],
1460 }
1461
1462
1463Returns:
1464 An object of the form:
1465
1466 {
1467 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
1468 "A String",
1469 ],
1470 }</pre>
1471</div>
1472
1473<div class="method">
1474 <code class="details" id="update">update(project, zone, instanceGroupManager, body)</code>
1475 <pre>Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is updated even if the instances in the group have not yet been updated. You must separately verify the status of the individual instances with the listmanagedinstances method.
1476
1477Args:
1478 project: string, Project ID for this request. (required)
1479 zone: string, The name of the zone where you want to create the managed instance group. (required)
1480 instanceGroupManager: string, The name of the instance group manager. (required)
1481 body: object, The request body. (required)
1482 The object takes the form of:
1483
1484{ # An Instance Group Manager resource.
1485 "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.
1486 "none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
1487 "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.
1488 "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.
1489 #
1490 # If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.
1491 "restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
1492 "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.
1493 "deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
1494 "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.
1495 "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.
1496 },
1497 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
1498 "zone": "A String", # [Output Only] The URL of the zone where the managed instance group is located (for zonal resources).
1499 "versions": [ # Versions supported by this IGM. User should set this field if they need fine-grained control over how many instances in each version are run by this IGM. Versions are keyed by instanceTemplate. Every instanceTemplate can appear at most once. This field overrides instanceTemplate field. If both instanceTemplate and versions are set, the user receives a warning. "instanceTemplate: X" is semantically equivalent to "versions [ { instanceTemplate: X } ]". Exactly one version must have targetSize field left unset. Size of such a version will be calculated automatically.
1500 {
1501 "targetSize": { # Encapsulates numeric value that can be either absolute or relative. # Intended number of instances that are created from instanceTemplate. The final number of instances created from instanceTemplate will be equal to: * if expressed as fixed number: min(targetSize.fixed, instanceGroupManager.targetSize), * if expressed as percent: ceiling(targetSize.percent * InstanceGroupManager.targetSize). If unset, this version will handle all the remaining instances.
1502 "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
1503 "fixed": 42, # fixed must be non-negative.
1504 "percent": 42, # percent must belong to [0, 100].
1505 },
1506 "instanceTemplate": "A String",
1507 "tag": "A String", # Tag describing the version. Used to trigger rollout of a target version even if instance_template remains unchanged.
1508 },
1509 ],
1510 "autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.
1511 {
1512 "healthCheck": "A String", # The URL for the HealthCheck that signals autohealing.
1513 "initialDelaySec": 42, # The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].
1514 "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable when auto-healing. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a percent value of 100% is used.
1515 "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
1516 "fixed": 42, # fixed must be non-negative.
1517 "percent": 42, # percent must belong to [0, 100].
1518 },
1519 },
1520 ],
1521 "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.
1522 "failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.
1523 "instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
1524 "kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
1525 "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.
1526 "A String",
1527 ],
1528 "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.
1529 "pendingActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are pending for each of those actions.
1530 "recreating": 42, # [Output Only] The number of instances in the managed instance group that are pending to be recreated.
1531 "deleting": 42, # [Output Only] The number of instances in the managed instance group that are pending to be deleted.
1532 "creating": 42, # [Output Only] The number of instances in the managed instance group that are pending to be created.
1533 "restarting": 42, # [Output Only] The number of instances in the managed instance group that are pending to be restarted.
1534 },
1535 "updatePolicy": { # The update policy for this managed instance group.
1536 "type": "A String",
1537 "maxSurge": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be created above the InstanceGroupManager.targetSize during the update process. By default, a fixed value of 1 is used. Using maxSurge > 0 will cause instance names to change during the update process. At least one of { maxSurge, maxUnavailable } must be greater than 0.
1538 "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
1539 "fixed": 42, # fixed must be non-negative.
1540 "percent": 42, # percent must belong to [0, 100].
1541 },
1542 "minimalAction": "A String", # Minimal action to be taken on an instance. The order of action types is: RESTART < REPLACE.
1543 "maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # Maximum number of instances that can be unavailable during the update process. The instance is considered available if all of the following conditions are satisfied: 1. instance's status is RUNNING 2. instance's liveness health check result was observed to be HEALTHY at least once By default, a fixed value of 1 is used. At least one of { maxSurge, maxUnavailable } must be greater than 0.
1544 "calculated": 42, # [Output Only] Absolute value calculated based on mode: mode = fixed -> calculated = fixed = percent -> calculated = ceiling(percent/100 * base_value)
1545 "fixed": 42, # fixed must be non-negative.
1546 "percent": 42, # percent must belong to [0, 100].
1547 },
1548 "minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600].
1549 },
1550 "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.
1551 "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).
1552 "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.
1553 "namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
1554 { # The named port. For example: .
1555 "name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
1556 "port": 42, # The port number, which can be a value between 1 and 65535.
1557 },
1558 ],
1559 "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
1560 "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
1561 "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
1562 "name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.
1563 }
1564
1565
1566Returns:
1567 An object of the form:
1568
1569 { # An Operation resource, used to manage asynchronous API requests.
1570 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
1571 "clientOperationId": "A String", # [Output Only] Reserved for future use.
1572 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
1573 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
1574 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
1575 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
1576 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
1577 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
1578 "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.
1579 "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.
1580 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
1581 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
1582 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
1583 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
1584 {
1585 "message": "A String", # [Output Only] A human-readable description of the warning code.
1586 "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.
1587 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
1588 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
1589 {
1590 "value": "A String", # [Output Only] A warning data value corresponding to the key.
1591 "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).
1592 },
1593 ],
1594 },
1595 ],
1596 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
1597 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
1598 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
1599 "name": "A String", # [Output Only] Name of the resource.
1600 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
1601 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
1602 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
1603 {
1604 "message": "A String", # [Output Only] An optional, human-readable error message.
1605 "code": "A String", # [Output Only] The error type identifier for this error.
1606 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
1607 },
1608 ],
1609 },
1610 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
1611 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
1612 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. If creating a persistent disk snapshot, this points to the persistent disk that the snapshot was created from.
1613 }</pre>
1614</div>
1615
1616</body></html>