Blame - docs/dyn/compute_beta.regionInstanceGroupManagers.html - platform/external/python/google-api-python-client

blob: e59649e368736028a2a7981a11c709f135f64130 [file] [log] [blame]

Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	1	<html><body>
				2	<style>
				3
				4	body, h1, h2, h3, div, span, p, pre, a {
				5	margin: 0;
				6	padding: 0;
				7	border: 0;
				8	font-weight: inherit;
				9	font-style: inherit;
				10	font-size: 100%;
				11	font-family: inherit;
				12	vertical-align: baseline;
				13	}
				14
				15	body {
				16	font-size: 13px;
				17	padding: 1em;
				18	}
				19
				20	h1 {
				21	font-size: 26px;
				22	margin-bottom: 1em;
				23	}
				24
				25	h2 {
				26	font-size: 24px;
				27	margin-bottom: 1em;
				28	}
				29
				30	h3 {
				31	font-size: 20px;
				32	margin-bottom: 1em;
				33	margin-top: 1em;
				34	}
				35
				36	pre, code {
				37	line-height: 1.5;
				38	font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
				39	}
				40
				41	pre {
				42	margin-top: 0.5em;
				43	}
				44
				45	h1, h2, h3, p {
				46	font-family: Arial, sans serif;
				47	}
				48
				49	h1, h2, h3 {
				50	border-bottom: solid #CCC 1px;
				51	}
				52
				53	.toc_element {
				54	margin-top: 0.5em;
				55	}
				56
				57	.firstline {
				58	margin-left: 2 em;
				59	}
				60
				61	.method {
				62	margin-top: 1em;
				63	border: solid 1px #CCC;
				64	padding: 1em;
				65	background: #EEE;
				66	}
				67
				68	.details {
				69	font-weight: bold;
				70	font-size: 14px;
				71	}
				72
				73	</style>
				74
				75	<h1><a href="compute_beta.html">Compute Engine API</a> . <a href="compute_beta.regionInstanceGroupManagers.html">regionInstanceGroupManagers</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	78	<code><a href="#abandonInstances">abandonInstances(project, region, instanceGroupManager, body=None, requestId=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	79	<p class="firstline">Flags the specified instances to be immediately removed 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>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	80	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	81	<code><a href="#applyUpdatesToInstances">applyUpdatesToInstances(project, region, instanceGroupManager, body=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	82	<p class="firstline">Apply updates to selected instances the managed instance group.</p>
				83	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	84	<code><a href="#close">close()</a></code></p>
				85	<p class="firstline">Close httplib2 connections.</p>
				86	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	87	<code><a href="#createInstances">createInstances(project, region, instanceGroupManager, body=None, requestId=None)</a></code></p>
				88	<p class="firstline">Creates instances with per-instance configs in this regional managed instance group. Instances are created using the current instance template. The create instances operation is marked DONE if the createInstances request is successful. The underlying actions take additional time. You must separately verify the status of the creating or actions with the listmanagedinstances method.</p>
				89	<p class="toc_element">
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	90	<code><a href="#delete">delete(project, region, instanceGroupManager, requestId=None)</a></code></p>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	91	<p class="firstline">Deletes the specified managed instance group and all of the instances in that group.</p>
				92	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	93	<code><a href="#deleteInstances">deleteInstances(project, region, instanceGroupManager, body=None, requestId=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	94	<p class="firstline">Flags the specified instances in the managed instance group to be immediately deleted. 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. The deleteInstances operation is marked DONE if the deleteInstances request is successful. The underlying actions take additional time. You must separately verify the status of the deleting action with the listmanagedinstances method.</p>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	95	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	96	<code><a href="#deletePerInstanceConfigs">deletePerInstanceConfigs(project, region, instanceGroupManager, body=None)</a></code></p>
				97	<p class="firstline">Deletes selected per-instance configs for the managed instance group.</p>
				98	<p class="toc_element">
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	99	<code><a href="#get">get(project, region, instanceGroupManager)</a></code></p>
				100	<p class="firstline">Returns all of the details about the specified managed instance group.</p>
				101	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	102	<code><a href="#insert">insert(project, region, body=None, requestId=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	103	<p class="firstline">Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created 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>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	104	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	105	<code><a href="#list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</a></code></p>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	106	<p class="firstline">Retrieves the list of managed instance groups that are contained within the specified region.</p>
				107	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	108	<code><a href="#listErrors">listErrors(project, region, instanceGroupManager, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</a></code></p>
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	109	<p class="firstline">Lists all errors thrown by actions on instances for a given regional managed instance group. The filter and orderBy query parameters are not supported.</p>
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	110	<p class="toc_element">
				111	<code><a href="#listErrors_next">listErrors_next(previous_request, previous_response)</a></code></p>
				112	<p class="firstline">Retrieves the next page of results.</p>
				113	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	114	<code><a href="#listManagedInstances">listManagedInstances(project, region, instanceGroupManager, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</a></code></p>
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	115	<p class="firstline">Lists the instances in the managed instance group and instances that are scheduled to be created. The list includes any current actions that the group has scheduled for its instances. The orderBy query parameter is not supported.</p>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	116	<p class="toc_element">
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	117	<code><a href="#listManagedInstances_next">listManagedInstances_next(previous_request, previous_response)</a></code></p>
				118	<p class="firstline">Retrieves the next page of results.</p>
				119	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	120	<code><a href="#listPerInstanceConfigs">listPerInstanceConfigs(project, region, instanceGroupManager, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</a></code></p>
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	121	<p class="firstline">Lists all of the per-instance configs defined for the managed instance group. The orderBy query parameter is not supported.</p>
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	122	<p class="toc_element">
				123	<code><a href="#listPerInstanceConfigs_next">listPerInstanceConfigs_next(previous_request, previous_response)</a></code></p>
				124	<p class="firstline">Retrieves the next page of results.</p>
				125	<p class="toc_element">
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	126	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				127	<p class="firstline">Retrieves the next page of results.</p>
				128	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	129	<code><a href="#patch">patch(project, region, instanceGroupManager, body=None, requestId=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	130	<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 patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listmanagedinstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.</p>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	131	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	132	<code><a href="#patchPerInstanceConfigs">patchPerInstanceConfigs(project, region, instanceGroupManager, body=None, requestId=None)</a></code></p>
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	133	<p class="firstline">Inserts or patches per-instance configs for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.</p>
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	134	<p class="toc_element">
				135	<code><a href="#recreateInstances">recreateInstances(project, region, instanceGroupManager, body=None, requestId=None)</a></code></p>
Anthonios Partheniou	10f4b67	2021-04-13 14:47:53 -0400	[diff] [blame]	136	<p class="firstline">Flags the specified VM instances in the managed instance group to be immediately recreated. Each instance is recreated using the group's current configuration. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of each instance by checking its currentAction field; for more information, see Checking the status of managed instances.</p>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	137	<p class="toc_element">
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	138	<code><a href="#resize">resize(project, region, instanceGroupManager, size, requestId=None)</a></code></p>
				139	<p class="firstline">Changes the intended size of 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 one or more instances.</p>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	140	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	141	<code><a href="#setAutoHealingPolicies">setAutoHealingPolicies(project, region, instanceGroupManager, body=None, requestId=None)</a></code></p>
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	142	<p class="firstline">Modifies the autohealing policy for the instances in this managed instance group. [Deprecated] This method is deprecated. Use regionInstanceGroupManagers.patch instead.</p>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	143	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	144	<code><a href="#setInstanceTemplate">setInstanceTemplate(project, region, instanceGroupManager, body=None, requestId=None)</a></code></p>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	145	<p class="firstline">Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected.</p>
				146	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	147	<code><a href="#setTargetPools">setTargetPools(project, region, instanceGroupManager, body=None, requestId=None)</a></code></p>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	148	<p class="firstline">Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected.</p>
				149	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	150	<code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body=None)</a></code></p>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	151	<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
				152	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	153	<code><a href="#update">update(project, region, instanceGroupManager, body=None, requestId=None)</a></code></p>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	154	<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>
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	155	<p class="toc_element">
				156	<code><a href="#updatePerInstanceConfigs">updatePerInstanceConfigs(project, region, instanceGroupManager, body=None, requestId=None)</a></code></p>
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	157	<p class="firstline">Inserts or updates per-instance configs for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.</p>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	158	<h3>Method Details</h3>
				159	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	160	<code class="details" id="abandonInstances">abandonInstances(project, region, instanceGroupManager, body=None, requestId=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	161	<pre>Flags the specified instances to be immediately removed 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.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	162
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	163	If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.
				164
				165	You can specify a maximum of 1000 instances with this method per request.
				166
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	167	Args:
				168	project: string, Project ID for this request. (required)
				169	region: string, Name of the region scoping this request. (required)
				170	instanceGroupManager: string, Name of the managed instance group. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	171	body: object, The request body.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	172	The object takes the form of:
				173
				174	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	175	"instances": [ # The URLs of one or more instances to abandon. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].
				176	"A String",
				177	],
				178	}
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	179
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	180	requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
				181
				182	For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
				183
				184	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	185
				186	Returns:
				187	An object of the form:
				188
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	189	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	190	#
				191	# Google Compute Engine has three Operation resources:
				192	#
				193	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				194	#
				195	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				196	#
				197	# Operations can be global, regional or zonal.
				198	# - For global operations, use the `globalOperations` resource.
				199	# - For regional operations, use the `regionOperations` resource.
				200	# - For zonal operations, use the `zonalOperations` resource.
				201	#
				202	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				203	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				204	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				205	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				206	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				207	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				208	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	209	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	210	"code": "A String", # [Output Only] The error type identifier for this error.
				211	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				212	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	213	},
				214	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	215	},
				216	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				217	"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.
				218	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				219	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				220	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				221	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	222	"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	223	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				224	"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.
				225	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				226	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				227	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				228	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				229	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				230	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				231	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
				232	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				233	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				234	{
				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	"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).
				240	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				241	},
				242	],
				243	"message": "A String", # [Output Only] A human-readable description of the warning code.
				244	},
				245	],
				246	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				247	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	248	</div>
				249
				250	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	251	<code class="details" id="applyUpdatesToInstances">applyUpdatesToInstances(project, region, instanceGroupManager, body=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	252	<pre>Apply updates to selected instances the managed instance group.
				253
				254	Args:
				255	project: string, Project ID for this request. (required)
				256	region: string, Name of the region scoping this request, should conform to RFC1035. (required)
				257	instanceGroupManager: string, The name of the managed instance group, should conform to RFC1035. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	258	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	259	The object takes the form of:
				260
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	261	{ # RegionInstanceGroupManagers.applyUpdatesToInstances
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	262	"allInstances": True or False, # Flag to update all instances instead of specified list of ?instances?. If the flag is set to true then the instances may not be specified in the request.
				263	"instances": [ # The list of URLs of one or more instances for which you want to apply updates. Each URL can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].
				264	"A String",
				265	],
				266	"minimalAction": "A String", # The minimal action that you want to perform on each instance during the update:
				267	# - REPLACE: At minimum, delete the instance and create it again.
				268	# - RESTART: Stop the instance and start it again.
				269	# - REFRESH: Do not stop the instance.
				270	# - NONE: Do not disrupt the instance at all. By default, the minimum action is NONE. If your update requires a more disruptive action than you set with this flag, the necessary action is performed to execute the update.
				271	"mostDisruptiveAllowedAction": "A String", # The most disruptive action that you want to perform on each instance during the update:
				272	# - REPLACE: Delete the instance and create it again.
				273	# - RESTART: Stop the instance and start it again.
				274	# - REFRESH: Do not stop the instance.
				275	# - NONE: Do not disrupt the instance at all. By default, the most disruptive allowed action is REPLACE. If your update requires a more disruptive action than you set with this flag, the update request will fail.
				276	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	277
				278
				279	Returns:
				280	An object of the form:
				281
				282	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	283	#
				284	# Google Compute Engine has three Operation resources:
				285	#
				286	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				287	#
				288	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				289	#
				290	# Operations can be global, regional or zonal.
				291	# - For global operations, use the `globalOperations` resource.
				292	# - For regional operations, use the `regionOperations` resource.
				293	# - For zonal operations, use the `zonalOperations` resource.
				294	#
				295	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				296	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				297	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				298	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				299	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				300	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				301	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	302	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	303	"code": "A String", # [Output Only] The error type identifier for this error.
				304	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				305	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	306	},
				307	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	308	},
				309	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				310	"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.
				311	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				312	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				313	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				314	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	315	"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	316	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				317	"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.
				318	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				319	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				320	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				321	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				322	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				323	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				324	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
				325	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				326	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				327	{
				328	"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.
				329	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				330	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				331	{
				332	"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).
				333	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				334	},
				335	],
				336	"message": "A String", # [Output Only] A human-readable description of the warning code.
				337	},
				338	],
				339	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				340	}</pre>
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	341	</div>
				342
				343	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	344	<code class="details" id="close">close()</code>
				345	<pre>Close httplib2 connections.</pre>
				346	</div>
				347
				348	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	349	<code class="details" id="createInstances">createInstances(project, region, instanceGroupManager, body=None, requestId=None)</code>
				350	<pre>Creates instances with per-instance configs in this regional managed instance group. Instances are created using the current instance template. The create instances operation is marked DONE if the createInstances request is successful. The underlying actions take additional time. You must separately verify the status of the creating or actions with the listmanagedinstances method.
				351
				352	Args:
				353	project: string, Project ID for this request. (required)
				354	region: string, The name of the region where the managed instance group is located. It should conform to RFC1035. (required)
				355	instanceGroupManager: string, The name of the managed instance group. It should conform to RFC1035. (required)
				356	body: object, The request body.
				357	The object takes the form of:
				358
				359	{ # RegionInstanceGroupManagers.createInstances
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	360	"instances": [ # [Required] List of specifications of per-instance configs.
				361	{
				362	"fingerprint": "A String", # Fingerprint of this per-instance config. This field can be used in optimistic locking. It is ignored when inserting a per-instance config. An up-to-date fingerprint must be provided in order to update an existing per-instance config or the field needs to be unset.
				363	"name": "A String", # The name of a per-instance config and its corresponding instance. Serves as a merge key during UpdatePerInstanceConfigs operations, that is, if a per-instance config with the same name exists then it will be updated, otherwise a new one will be created for the VM instance with the same name. An attempt to create a per-instance config for a VM instance that either doesn't exist or is not part of the group will result in an error.
				364	"preservedState": { # Preserved state for a given instance. # The intended preserved state for the given instance. Does not contain preserved state generated from a stateful policy.
				365	"disks": { # Preserved disks defined for this instance. This map is keyed with the device names of the disks.
				366	"a_key": {
				367	"autoDelete": "A String", # These stateful disks will never be deleted during autohealing, update, instance recreate operations. This flag is used to configure if the disk should be deleted after it is no longer used by the group, e.g. when the given instance or the whole MIG is deleted. Note: disks attached in READ_ONLY mode cannot be auto-deleted.
				368	"mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
				369	"source": "A String", # The URL of the disk resource that is stateful and should be attached to the VM instance.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	370	},
				371	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	372	"metadata": { # Preserved metadata defined for this instance.
				373	"a_key": "A String",
				374	},
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	375	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	376	"status": "A String", # The status of applying this per-instance config on the corresponding managed instance.
				377	},
				378	],
				379	}
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	380
				381	requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
				382
				383	For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request.
				384
				385	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
				386
				387	Returns:
				388	An object of the form:
				389
				390	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	391	#
				392	# Google Compute Engine has three Operation resources:
				393	#
				394	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				395	#
				396	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				397	#
				398	# Operations can be global, regional or zonal.
				399	# - For global operations, use the `globalOperations` resource.
				400	# - For regional operations, use the `regionOperations` resource.
				401	# - For zonal operations, use the `zonalOperations` resource.
				402	#
				403	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				404	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				405	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				406	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				407	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				408	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				409	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	410	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	411	"code": "A String", # [Output Only] The error type identifier for this error.
				412	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				413	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	414	},
				415	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	416	},
				417	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				418	"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.
				419	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				420	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				421	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				422	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	423	"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	424	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				425	"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.
				426	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				427	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				428	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				429	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				430	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				431	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				432	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
				433	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				434	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				435	{
				436	"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.
				437	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				438	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				439	{
				440	"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).
				441	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				442	},
				443	],
				444	"message": "A String", # [Output Only] A human-readable description of the warning code.
				445	},
				446	],
				447	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				448	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	449	</div>
				450
				451	<div class="method">
				452	<code class="details" id="delete">delete(project, region, instanceGroupManager, requestId=None)</code>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	453	<pre>Deletes the specified managed instance group and all of the instances in that group.
				454
				455	Args:
				456	project: string, Project ID for this request. (required)
				457	region: string, Name of the region scoping this request. (required)
				458	instanceGroupManager: string, Name of the managed instance group to delete. (required)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	459	requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
				460
				461	For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
				462
				463	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	464
				465	Returns:
				466	An object of the form:
				467
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	468	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	469	#
				470	# Google Compute Engine has three Operation resources:
				471	#
				472	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				473	#
				474	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				475	#
				476	# Operations can be global, regional or zonal.
				477	# - For global operations, use the `globalOperations` resource.
				478	# - For regional operations, use the `regionOperations` resource.
				479	# - For zonal operations, use the `zonalOperations` resource.
				480	#
				481	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				482	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				483	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				484	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				485	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				486	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				487	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	488	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	489	"code": "A String", # [Output Only] The error type identifier for this error.
				490	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				491	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	492	},
				493	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	494	},
				495	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				496	"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.
				497	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				498	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				499	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				500	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	501	"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	502	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				503	"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.
				504	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				505	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				506	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				507	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				508	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				509	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				510	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
				511	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				512	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				513	{
				514	"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.
				515	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				516	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				517	{
				518	"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).
				519	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				520	},
				521	],
				522	"message": "A String", # [Output Only] A human-readable description of the warning code.
				523	},
				524	],
				525	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				526	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	527	</div>
				528
				529	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	530	<code class="details" id="deleteInstances">deleteInstances(project, region, instanceGroupManager, body=None, requestId=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	531	<pre>Flags the specified instances in the managed instance group to be immediately deleted. 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. The deleteInstances operation is marked DONE if the deleteInstances request is successful. The underlying actions take additional time. You must separately verify the status of the deleting action with the listmanagedinstances method.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	532
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	533	If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.
				534
				535	You can specify a maximum of 1000 instances with this method per request.
				536
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	537	Args:
				538	project: string, Project ID for this request. (required)
				539	region: string, Name of the region scoping this request. (required)
				540	instanceGroupManager: string, Name of the managed instance group. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	541	body: object, The request body.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	542	The object takes the form of:
				543
				544	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	545	"instances": [ # The URLs of one or more instances to delete. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].
				546	"A String",
				547	],
				548	}
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	549
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	550	requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
				551
				552	For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
				553
				554	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	555
				556	Returns:
				557	An object of the form:
				558
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	559	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	560	#
				561	# Google Compute Engine has three Operation resources:
				562	#
				563	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				564	#
				565	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				566	#
				567	# Operations can be global, regional or zonal.
				568	# - For global operations, use the `globalOperations` resource.
				569	# - For regional operations, use the `regionOperations` resource.
				570	# - For zonal operations, use the `zonalOperations` resource.
				571	#
				572	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				573	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				574	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				575	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				576	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				577	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				578	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	579	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	580	"code": "A String", # [Output Only] The error type identifier for this error.
				581	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				582	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	583	},
				584	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	585	},
				586	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				587	"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.
				588	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				589	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				590	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				591	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	592	"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	593	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				594	"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.
				595	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				596	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				597	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				598	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				599	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				600	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				601	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
				602	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				603	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				604	{
				605	"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.
				606	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				607	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				608	{
				609	"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).
				610	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				611	},
				612	],
				613	"message": "A String", # [Output Only] A human-readable description of the warning code.
				614	},
				615	],
				616	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				617	}</pre>
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	618	</div>
				619
				620	<div class="method">
				621	<code class="details" id="deletePerInstanceConfigs">deletePerInstanceConfigs(project, region, instanceGroupManager, body=None)</code>
				622	<pre>Deletes selected per-instance configs for the managed instance group.
				623
				624	Args:
				625	project: string, Project ID for this request. (required)
				626	region: string, Name of the region scoping this request, should conform to RFC1035. (required)
				627	instanceGroupManager: string, The name of the managed instance group. It should conform to RFC1035. (required)
				628	body: object, The request body.
				629	The object takes the form of:
				630
				631	{ # RegionInstanceGroupManagers.deletePerInstanceConfigs
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	632	"names": [ # The list of instance names for which we want to delete per-instance configs on this managed instance group.
				633	"A String",
				634	],
				635	}
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	636
				637
				638	Returns:
				639	An object of the form:
				640
				641	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	642	#
				643	# Google Compute Engine has three Operation resources:
				644	#
				645	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				646	#
				647	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				648	#
				649	# Operations can be global, regional or zonal.
				650	# - For global operations, use the `globalOperations` resource.
				651	# - For regional operations, use the `regionOperations` resource.
				652	# - For zonal operations, use the `zonalOperations` resource.
				653	#
				654	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				655	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				656	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				657	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				658	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				659	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				660	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	661	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	662	"code": "A String", # [Output Only] The error type identifier for this error.
				663	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				664	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	665	},
				666	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	667	},
				668	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				669	"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.
				670	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				671	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				672	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				673	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	674	"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	675	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				676	"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.
				677	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				678	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				679	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				680	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				681	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				682	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				683	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
				684	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				685	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				686	{
				687	"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.
				688	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				689	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				690	{
				691	"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).
				692	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				693	},
				694	],
				695	"message": "A String", # [Output Only] A human-readable description of the warning code.
				696	},
				697	],
				698	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				699	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	700	</div>
				701
				702	<div class="method">
				703	<code class="details" id="get">get(project, region, instanceGroupManager)</code>
				704	<pre>Returns all of the details about the specified managed instance group.
				705
				706	Args:
				707	project: string, Project ID for this request. (required)
				708	region: string, Name of the region scoping this request. (required)
				709	instanceGroupManager: string, Name of the managed instance group to return. (required)
				710
				711	Returns:
				712	An object of the form:
				713
yoshi-code-bot	c2cd326	2021-05-16 02:16:04 -0700	[diff] [blame]	714	{ # Whether the instance is a standby. Properties of a standby instance comparing to the regular instance: ========================================================================= \| regular \| standby ========================================================================= managed by IGM? \| yes \| yes added to the IG? \| yes \| yes counts towards IGM's target size? \| yes \| no taken into account by Autoscaler? \| yes \| no receives traffic from LB? \| yes \| no =========================================================================
				715	#
				716	# Represents a Managed Instance Group resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	717	#
				718	# An instance group is a collection of VM instances that you can manage as a single entity. For more information, read Instance groups.
				719	#
				720	# For zonal Managed Instance Group, use the instanceGroupManagers resource.
				721	#
				722	# For regional Managed Instance Group, use the regionInstanceGroupManagers resource. (== resource_for {$api_version}.instanceGroupManagers ==) (== resource_for {$api_version}.regionInstanceGroupManagers ==)
				723	"autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.
				724	{
				725	"healthCheck": "A String", # The URL for the health check that signals autohealing.
				726	"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].
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	727	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	728	],
				729	"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.
				730	"creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
				731	"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.
				732	"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.
				733	"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.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	734	#
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	735	# If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.
				736	"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.
				737	"deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
				738	"none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
				739	"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.
				740	"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.
				741	"restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
				742	"verifying": 42, # [Output Only] The number of instances in the managed instance group that are being verified. See the managedInstances[].currentAction property in the listManagedInstances method documentation.
				743	},
				744	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				745	"distributionPolicy": { # Policy specifying the intended distribution of managed instances across zones in a regional managed instance group.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	746	"targetShape": "A String", # The distribution shape to which the group converges either proactively or on resize events (depending on the value set in updatePolicy.instanceRedistributionType).
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	747	"zones": [ # Zones where the regional managed instance group will create and manage its instances.
				748	{
				749	"zone": "A String", # The URL of the zone. The zone must exist in the region where the managed instance group is located.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	750	},
				751	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	752	},
				753	"failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.
				754	"fingerprint": "A String", # Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet.
				755	#
				756	# To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager.
				757	"id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
				758	"instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
				759	"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. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE.
				760	"kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
				761	"name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.
				762	"namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
				763	{ # The named port. For example: .
				764	"name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
				765	"port": 42, # The port number, which can be a value between 1 and 65535.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	766	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	767	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	768	"region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).
				769	"selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
				770	"serviceAccount": "A String", # The service account to be used as credentials for all operations performed by the managed instance group on instances. The service accounts needs all permissions required to create and delete instances. By default, the service account {projectNumber}@cloudservices.gserviceaccount.com is used.
				771	"statefulPolicy": { # Stateful configuration for this Instanced Group Manager
				772	"preservedState": { # Configuration of preserved resources.
				773	"disks": { # Disks created on the instances that will be preserved on instance delete, update, etc. This map is keyed with the device names of the disks.
				774	"a_key": {
				775	"autoDelete": "A String", # These stateful disks will never be deleted during autohealing, update or VM instance recreate operations. This flag is used to configure if the disk should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted. Note: disks attached in READ_ONLY mode cannot be auto-deleted.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	776	},
				777	},
				778	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	779	},
				780	"status": { # [Output Only] The status of this managed instance group.
				781	"autoscaler": "A String", # [Output Only] The URL of the Autoscaler that targets this instance group manager.
				782	"isStable": True or False, # [Output Only] A bit indicating whether the managed instance group is in a stable state. A stable state means that: none of the instances in the managed instance group is currently undergoing any type of change (for example, creation, restart, or deletion); no future changes are scheduled for instances in the managed instance group; and the managed instance group itself is not being modified.
				783	"stateful": { # [Output Only] Stateful status of the given Instance Group Manager.
				784	"hasStatefulConfig": True or False, # [Output Only] A bit indicating whether the managed instance group has stateful configuration, that is, if you have configured any items in a stateful policy or in per-instance configs. The group might report that it has no stateful config even when there is still some preserved state on a managed instance, for example, if you have deleted all PICs but not yet applied those deletions.
				785	"isStateful": True or False, # [Output Only] A bit indicating whether the managed instance group has stateful configuration, that is, if you have configured any items in a stateful policy or in per-instance configs. The group might report that it has no stateful config even when there is still some preserved state on a managed instance, for example, if you have deleted all PICs but not yet applied those deletions. This field is deprecated in favor of has_stateful_config.
				786	"perInstanceConfigs": { # [Output Only] Status of per-instance configs on the instance.
				787	"allEffective": True or False, # A bit indicating if all of the group's per-instance configs (listed in the output of a listPerInstanceConfigs API call) have status EFFECTIVE or there are no per-instance-configs.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	788	},
				789	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	790	"versionTarget": { # [Output Only] A status of consistency of Instances' versions with their target version specified by version field on Instance Group Manager.
				791	"isReached": True or False, # [Output Only] A bit indicating whether version target has been reached in this managed instance group, i.e. all instances are in their target version. Instances' target version are specified by version field on Instance Group Manager.
				792	},
				793	},
				794	"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.
				795	"A String",
				796	],
				797	"targetSize": 42, # The target number of running instances for this managed instance group. You can reduce this number by using the instanceGroupManager deleteInstances or abandonInstances methods. Resizing the group also changes this number.
				798	"updatePolicy": { # The update policy for this managed instance group.
				799	"instanceRedistributionType": "A String", # The instance redistribution policy for regional managed instance groups. Valid values are:
				800	# - PROACTIVE (default): The group attempts to maintain an even distribution of VM instances across zones in the region.
				801	# - NONE: For non-autoscaled groups, proactive redistribution is disabled.
yoshi-code-bot	73a0aa3	2021-05-25 00:30:03 -0700	[diff] [blame]	802	"maxSurge": { # Encapsulates numeric value that can be either absolute or relative. # The maximum number of instances that can be created above the specified targetSize during the update process. This value can be either a fixed number or, if the group has 10 or more instances, a percentage. If you set a percentage, the number of instances is rounded if necessary. The default value for maxSurge is a fixed value equal to the number of zones in which the managed instance group operates.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	803	#
				804	# At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxSurge.
				805	"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	806	#
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	807	#
				808	# - If the value is fixed, then the calculated value is equal to the fixed value.
yoshi-code-bot	73a0aa3	2021-05-25 00:30:03 -0700	[diff] [blame]	809	# - If the value is a percent, then the calculated value is percent/100 * targetSize. For example, the calculated value of a 80% of a managed instance group with 150 instances would be (80/100 * 150) = 120 VM instances. If there is a remainder, the number is rounded.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	810	"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.
				811	"percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.
				812	},
				813	"maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # The maximum number of instances that can be unavailable during the update process. An instance is considered available if all of the following conditions are satisfied:
				814	#
				815	#
				816	# - The instance's status is RUNNING.
yoshi-code-bot	73a0aa3	2021-05-25 00:30:03 -0700	[diff] [blame]	817	# - If there is a health check on the instance group, the instance's health check status must be HEALTHY at least once. If there is no health check on the group, then the instance only needs to have a status of RUNNING to be considered available. This value can be either a fixed number or, if the group has 10 or more instances, a percentage. If you set a percentage, the number of instances is rounded if necessary. The default value for maxUnavailable is a fixed value equal to the number of zones in which the managed instance group operates.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	818	#
				819	# At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxUnavailable.
				820	"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.
				821	#
				822	#
				823	# - If the value is fixed, then the calculated value is equal to the fixed value.
yoshi-code-bot	73a0aa3	2021-05-25 00:30:03 -0700	[diff] [blame]	824	# - If the value is a percent, then the calculated value is percent/100 * targetSize. For example, the calculated value of a 80% of a managed instance group with 150 instances would be (80/100 * 150) = 120 VM instances. If there is a remainder, the number is rounded.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	825	"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.
				826	"percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.
				827	},
				828	"minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600].
				829	"minimalAction": "A String", # Minimal action to be taken on an instance. You can specify either RESTART to restart existing instances or REPLACE to delete and create new instances from the target template. If you specify a RESTART, the Updater will attempt to perform that action only. However, if the Updater determines that the minimal action you specify is not enough to perform the update, it might perform a more disruptive action.
Anthonios Partheniou	10f4b67	2021-04-13 14:47:53 -0400	[diff] [blame]	830	"mostDisruptiveAllowedAction": "A String", # Most disruptive action that is allowed to be taken on an instance. You can specify either NONE to forbid any actions, REFRESH to allow actions that do not need instance restart, RESTART to allow actions that can be applied without instance replacing or REPLACE to allow all possible actions. If the Updater determines that the minimal update action needed is more disruptive than most disruptive allowed action you specify it will not perform the update at all.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	831	"replacementMethod": "A String", # What action should be used to replace instances. See minimal_action.REPLACE
				832	"type": "A String", # The type of update process. You can specify either PROACTIVE so that the instance group manager proactively executes actions in order to bring instances to their target versions or OPPORTUNISTIC so that no action is proactively executed but the update will be performed as part of other actions (for example, resizes or recreateInstances calls).
				833	},
				834	"versions": [ # Specifies the instance templates used by this managed instance group to create instances.
				835	#
				836	# Each version is defined by an instanceTemplate and a name. Every version can appear at most once per instance group. This field overrides the top-level instanceTemplate field. Read more about the relationships between these fields. Exactly one version must leave the targetSize field unset. That version will be applied to all remaining instances. For more information, read about canary updates.
				837	{
				838	"instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create new instances in the managed instance group until the `targetSize` for this version is reached. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE; in those cases, existing instances are updated until the `targetSize` for this version is reached.
				839	"name": "A String", # Name of the version. Unique among all versions in the scope of this managed instance group.
				840	"targetSize": { # Encapsulates numeric value that can be either absolute or relative. # Specifies the intended number of instances to be created from the instanceTemplate. The final number of instances created from the template will be equal to:
				841	# - If expressed as a fixed number, the minimum of either targetSize.fixed or instanceGroupManager.targetSize is used.
yoshi-code-bot	73a0aa3	2021-05-25 00:30:03 -0700	[diff] [blame]	842	# - if expressed as a percent, the targetSize would be (targetSize.percent/100 * InstanceGroupManager.targetSize) If there is a remainder, the number is rounded. If unset, this version will update any remaining instances not updated by another version. Read Starting a canary update for more information.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	843	"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.
				844	#
				845	#
				846	# - If the value is fixed, then the calculated value is equal to the fixed value.
yoshi-code-bot	73a0aa3	2021-05-25 00:30:03 -0700	[diff] [blame]	847	# - If the value is a percent, then the calculated value is percent/100 * targetSize. For example, the calculated value of a 80% of a managed instance group with 150 instances would be (80/100 * 150) = 120 VM instances. If there is a remainder, the number is rounded.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	848	"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.
				849	"percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.
				850	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	851	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	852	],
				853	"zone": "A String", # [Output Only] The URL of a zone where the managed instance group is located (for zonal resources).
				854	}</pre>
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	855	</div>
				856
				857	<div class="method">
				858	<code class="details" id="insert">insert(project, region, body=None, requestId=None)</code>
				859	<pre>Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created 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.
				860
				861	A regional managed instance group can contain up to 2000 instances.
				862
				863	Args:
				864	project: string, Project ID for this request. (required)
				865	region: string, Name of the region scoping this request. (required)
				866	body: object, The request body.
				867	The object takes the form of:
				868
yoshi-code-bot	c2cd326	2021-05-16 02:16:04 -0700	[diff] [blame]	869	{ # Whether the instance is a standby. Properties of a standby instance comparing to the regular instance: ========================================================================= \| regular \| standby ========================================================================= managed by IGM? \| yes \| yes added to the IG? \| yes \| yes counts towards IGM's target size? \| yes \| no taken into account by Autoscaler? \| yes \| no receives traffic from LB? \| yes \| no =========================================================================
				870	#
				871	# Represents a Managed Instance Group resource.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	872	#
				873	# An instance group is a collection of VM instances that you can manage as a single entity. For more information, read Instance groups.
				874	#
				875	# For zonal Managed Instance Group, use the instanceGroupManagers resource.
				876	#
				877	# For regional Managed Instance Group, use the regionInstanceGroupManagers resource. (== resource_for {$api_version}.instanceGroupManagers ==) (== resource_for {$api_version}.regionInstanceGroupManagers ==)
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	878	"autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	879	{
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	880	"healthCheck": "A String", # The URL for the health check that signals autohealing.
				881	"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].
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	882	},
				883	],
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	884	"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.
				885	"creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
				886	"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.
				887	"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.
				888	"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.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	889	#
				890	# If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	891	"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.
				892	"deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
				893	"none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
				894	"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.
				895	"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.
				896	"restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
				897	"verifying": 42, # [Output Only] The number of instances in the managed instance group that are being verified. See the managedInstances[].currentAction property in the listManagedInstances method documentation.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	898	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	899	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	900	"distributionPolicy": { # Policy specifying the intended distribution of managed instances across zones in a regional managed instance group.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	901	"targetShape": "A String", # The distribution shape to which the group converges either proactively or on resize events (depending on the value set in updatePolicy.instanceRedistributionType).
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	902	"zones": [ # Zones where the regional managed instance group will create and manage its instances.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	903	{
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	904	"zone": "A String", # The URL of the zone. The zone must exist in the region where the managed instance group is located.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	905	},
				906	],
				907	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	908	"failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.
				909	"fingerprint": "A String", # Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet.
				910	#
				911	# To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager.
				912	"id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
				913	"instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	914	"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. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	915	"kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
				916	"name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.
				917	"namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
				918	{ # The named port. For example: .
				919	"name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
				920	"port": 42, # The port number, which can be a value between 1 and 65535.
				921	},
				922	],
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	923	"region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).
				924	"selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
				925	"serviceAccount": "A String", # The service account to be used as credentials for all operations performed by the managed instance group on instances. The service accounts needs all permissions required to create and delete instances. By default, the service account {projectNumber}@cloudservices.gserviceaccount.com is used.
				926	"statefulPolicy": { # Stateful configuration for this Instanced Group Manager
				927	"preservedState": { # Configuration of preserved resources.
				928	"disks": { # Disks created on the instances that will be preserved on instance delete, update, etc. This map is keyed with the device names of the disks.
				929	"a_key": {
				930	"autoDelete": "A String", # These stateful disks will never be deleted during autohealing, update or VM instance recreate operations. This flag is used to configure if the disk should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted. Note: disks attached in READ_ONLY mode cannot be auto-deleted.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	931	},
				932	},
				933	},
				934	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	935	"status": { # [Output Only] The status of this managed instance group.
				936	"autoscaler": "A String", # [Output Only] The URL of the Autoscaler that targets this instance group manager.
				937	"isStable": True or False, # [Output Only] A bit indicating whether the managed instance group is in a stable state. A stable state means that: none of the instances in the managed instance group is currently undergoing any type of change (for example, creation, restart, or deletion); no future changes are scheduled for instances in the managed instance group; and the managed instance group itself is not being modified.
				938	"stateful": { # [Output Only] Stateful status of the given Instance Group Manager.
				939	"hasStatefulConfig": True or False, # [Output Only] A bit indicating whether the managed instance group has stateful configuration, that is, if you have configured any items in a stateful policy or in per-instance configs. The group might report that it has no stateful config even when there is still some preserved state on a managed instance, for example, if you have deleted all PICs but not yet applied those deletions.
				940	"isStateful": True or False, # [Output Only] A bit indicating whether the managed instance group has stateful configuration, that is, if you have configured any items in a stateful policy or in per-instance configs. The group might report that it has no stateful config even when there is still some preserved state on a managed instance, for example, if you have deleted all PICs but not yet applied those deletions. This field is deprecated in favor of has_stateful_config.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	941	"perInstanceConfigs": { # [Output Only] Status of per-instance configs on the instance.
				942	"allEffective": True or False, # A bit indicating if all of the group's per-instance configs (listed in the output of a listPerInstanceConfigs API call) have status EFFECTIVE or there are no per-instance-configs.
				943	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	944	},
				945	"versionTarget": { # [Output Only] A status of consistency of Instances' versions with their target version specified by version field on Instance Group Manager.
				946	"isReached": True or False, # [Output Only] A bit indicating whether version target has been reached in this managed instance group, i.e. all instances are in their target version. Instances' target version are specified by version field on Instance Group Manager.
				947	},
				948	},
				949	"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.
				950	"A String",
				951	],
				952	"targetSize": 42, # The target number of running instances for this managed instance group. You can reduce this number by using the instanceGroupManager deleteInstances or abandonInstances methods. Resizing the group also changes this number.
				953	"updatePolicy": { # The update policy for this managed instance group.
				954	"instanceRedistributionType": "A String", # The instance redistribution policy for regional managed instance groups. Valid values are:
				955	# - PROACTIVE (default): The group attempts to maintain an even distribution of VM instances across zones in the region.
				956	# - NONE: For non-autoscaled groups, proactive redistribution is disabled.
yoshi-code-bot	73a0aa3	2021-05-25 00:30:03 -0700	[diff] [blame]	957	"maxSurge": { # Encapsulates numeric value that can be either absolute or relative. # The maximum number of instances that can be created above the specified targetSize during the update process. This value can be either a fixed number or, if the group has 10 or more instances, a percentage. If you set a percentage, the number of instances is rounded if necessary. The default value for maxSurge is a fixed value equal to the number of zones in which the managed instance group operates.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	958	#
				959	# At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxSurge.
				960	"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.
				961	#
				962	#
				963	# - If the value is fixed, then the calculated value is equal to the fixed value.
yoshi-code-bot	73a0aa3	2021-05-25 00:30:03 -0700	[diff] [blame]	964	# - If the value is a percent, then the calculated value is percent/100 * targetSize. For example, the calculated value of a 80% of a managed instance group with 150 instances would be (80/100 * 150) = 120 VM instances. If there is a remainder, the number is rounded.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	965	"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.
				966	"percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.
				967	},
				968	"maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # The maximum number of instances that can be unavailable during the update process. An instance is considered available if all of the following conditions are satisfied:
				969	#
				970	#
				971	# - The instance's status is RUNNING.
yoshi-code-bot	73a0aa3	2021-05-25 00:30:03 -0700	[diff] [blame]	972	# - If there is a health check on the instance group, the instance's health check status must be HEALTHY at least once. If there is no health check on the group, then the instance only needs to have a status of RUNNING to be considered available. This value can be either a fixed number or, if the group has 10 or more instances, a percentage. If you set a percentage, the number of instances is rounded if necessary. The default value for maxUnavailable is a fixed value equal to the number of zones in which the managed instance group operates.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	973	#
				974	# At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxUnavailable.
				975	"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.
				976	#
				977	#
				978	# - If the value is fixed, then the calculated value is equal to the fixed value.
yoshi-code-bot	73a0aa3	2021-05-25 00:30:03 -0700	[diff] [blame]	979	# - If the value is a percent, then the calculated value is percent/100 * targetSize. For example, the calculated value of a 80% of a managed instance group with 150 instances would be (80/100 * 150) = 120 VM instances. If there is a remainder, the number is rounded.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	980	"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.
				981	"percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.
				982	},
				983	"minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600].
				984	"minimalAction": "A String", # Minimal action to be taken on an instance. You can specify either RESTART to restart existing instances or REPLACE to delete and create new instances from the target template. If you specify a RESTART, the Updater will attempt to perform that action only. However, if the Updater determines that the minimal action you specify is not enough to perform the update, it might perform a more disruptive action.
Anthonios Partheniou	10f4b67	2021-04-13 14:47:53 -0400	[diff] [blame]	985	"mostDisruptiveAllowedAction": "A String", # Most disruptive action that is allowed to be taken on an instance. You can specify either NONE to forbid any actions, REFRESH to allow actions that do not need instance restart, RESTART to allow actions that can be applied without instance replacing or REPLACE to allow all possible actions. If the Updater determines that the minimal update action needed is more disruptive than most disruptive allowed action you specify it will not perform the update at all.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	986	"replacementMethod": "A String", # What action should be used to replace instances. See minimal_action.REPLACE
				987	"type": "A String", # The type of update process. You can specify either PROACTIVE so that the instance group manager proactively executes actions in order to bring instances to their target versions or OPPORTUNISTIC so that no action is proactively executed but the update will be performed as part of other actions (for example, resizes or recreateInstances calls).
				988	},
				989	"versions": [ # Specifies the instance templates used by this managed instance group to create instances.
				990	#
				991	# Each version is defined by an instanceTemplate and a name. Every version can appear at most once per instance group. This field overrides the top-level instanceTemplate field. Read more about the relationships between these fields. Exactly one version must leave the targetSize field unset. That version will be applied to all remaining instances. For more information, read about canary updates.
				992	{
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	993	"instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create new instances in the managed instance group until the `targetSize` for this version is reached. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE; in those cases, existing instances are updated until the `targetSize` for this version is reached.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	994	"name": "A String", # Name of the version. Unique among all versions in the scope of this managed instance group.
				995	"targetSize": { # Encapsulates numeric value that can be either absolute or relative. # Specifies the intended number of instances to be created from the instanceTemplate. The final number of instances created from the template will be equal to:
				996	# - If expressed as a fixed number, the minimum of either targetSize.fixed or instanceGroupManager.targetSize is used.
yoshi-code-bot	73a0aa3	2021-05-25 00:30:03 -0700	[diff] [blame]	997	# - if expressed as a percent, the targetSize would be (targetSize.percent/100 * InstanceGroupManager.targetSize) If there is a remainder, the number is rounded. If unset, this version will update any remaining instances not updated by another version. Read Starting a canary update for more information.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	998	"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.
				999	#
				1000	#
				1001	# - If the value is fixed, then the calculated value is equal to the fixed value.
yoshi-code-bot	73a0aa3	2021-05-25 00:30:03 -0700	[diff] [blame]	1002	# - If the value is a percent, then the calculated value is percent/100 * targetSize. For example, the calculated value of a 80% of a managed instance group with 150 instances would be (80/100 * 150) = 120 VM instances. If there is a remainder, the number is rounded.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1003	"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.
				1004	"percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.
				1005	},
				1006	},
				1007	],
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	1008	"zone": "A String", # [Output Only] The URL of a zone where the managed instance group is located (for zonal resources).
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	1009	}
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	1010
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	1011	requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
				1012
				1013	For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
				1014
				1015	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	1016
				1017	Returns:
				1018	An object of the form:
				1019
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	1020	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1021	#
				1022	# Google Compute Engine has three Operation resources:
				1023	#
				1024	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				1025	#
				1026	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				1027	#
				1028	# Operations can be global, regional or zonal.
				1029	# - For global operations, use the `globalOperations` resource.
				1030	# - For regional operations, use the `regionOperations` resource.
				1031	# - For zonal operations, use the `zonalOperations` resource.
				1032	#
				1033	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				1034	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				1035	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				1036	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				1037	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				1038	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				1039	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1040	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1041	"code": "A String", # [Output Only] The error type identifier for this error.
				1042	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				1043	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1044	},
				1045	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1046	},
				1047	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				1048	"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.
				1049	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				1050	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				1051	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				1052	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1053	"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1054	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				1055	"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.
				1056	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				1057	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				1058	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				1059	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				1060	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				1061	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				1062	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
				1063	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				1064	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				1065	{
				1066	"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.
				1067	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				1068	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				1069	{
				1070	"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).
				1071	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				1072	},
				1073	],
				1074	"message": "A String", # [Output Only] A human-readable description of the warning code.
				1075	},
				1076	],
				1077	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				1078	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	1079	</div>
				1080
				1081	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	1082	<code class="details" id="list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	1083	<pre>Retrieves the list of managed instance groups that are contained within the specified region.
				1084
				1085	Args:
				1086	project: string, Project ID for this request. (required)
				1087	region: string, Name of the region scoping this request. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	1088	filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	1089
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	1090	For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	1091
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	1092	You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	1093
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1094	To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```
				1095	maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
				1096	orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
				1097
				1098	You 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.
				1099
				1100	Currently, only sorting by `name` or `creationTimestamp desc` is supported.
				1101	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.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1102	returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	1103
				1104	Returns:
				1105	An object of the form:
				1106
				1107	{ # Contains a list of managed instance groups.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1108	"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
				1109	"items": [ # A list of InstanceGroupManager resources.
yoshi-code-bot	c2cd326	2021-05-16 02:16:04 -0700	[diff] [blame]	1110	{ # Whether the instance is a standby. Properties of a standby instance comparing to the regular instance: ========================================================================= \| regular \| standby ========================================================================= managed by IGM? \| yes \| yes added to the IG? \| yes \| yes counts towards IGM's target size? \| yes \| no taken into account by Autoscaler? \| yes \| no receives traffic from LB? \| yes \| no =========================================================================
				1111	#
				1112	# Represents a Managed Instance Group resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1113	#
				1114	# An instance group is a collection of VM instances that you can manage as a single entity. For more information, read Instance groups.
				1115	#
				1116	# For zonal Managed Instance Group, use the instanceGroupManagers resource.
				1117	#
				1118	# For regional Managed Instance Group, use the regionInstanceGroupManagers resource. (== resource_for {$api_version}.instanceGroupManagers ==) (== resource_for {$api_version}.regionInstanceGroupManagers ==)
				1119	"autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	1120	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1121	"healthCheck": "A String", # The URL for the health check that signals autohealing.
				1122	"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].
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	1123	},
				1124	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1125	"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.
				1126	"creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
				1127	"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.
				1128	"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.
				1129	"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.
				1130	#
				1131	# If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.
				1132	"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.
				1133	"deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
				1134	"none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
				1135	"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.
				1136	"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.
				1137	"restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
				1138	"verifying": 42, # [Output Only] The number of instances in the managed instance group that are being verified. See the managedInstances[].currentAction property in the listManagedInstances method documentation.
				1139	},
				1140	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				1141	"distributionPolicy": { # Policy specifying the intended distribution of managed instances across zones in a regional managed instance group.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1142	"targetShape": "A String", # The distribution shape to which the group converges either proactively or on resize events (depending on the value set in updatePolicy.instanceRedistributionType).
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1143	"zones": [ # Zones where the regional managed instance group will create and manage its instances.
				1144	{
				1145	"zone": "A String", # The URL of the zone. The zone must exist in the region where the managed instance group is located.
				1146	},
				1147	],
				1148	},
				1149	"failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.
				1150	"fingerprint": "A String", # Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet.
				1151	#
				1152	# To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager.
				1153	"id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
				1154	"instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
				1155	"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. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE.
				1156	"kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
				1157	"name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.
				1158	"namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
				1159	{ # The named port. For example: .
				1160	"name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
				1161	"port": 42, # The port number, which can be a value between 1 and 65535.
				1162	},
				1163	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1164	"region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).
				1165	"selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
				1166	"serviceAccount": "A String", # The service account to be used as credentials for all operations performed by the managed instance group on instances. The service accounts needs all permissions required to create and delete instances. By default, the service account {projectNumber}@cloudservices.gserviceaccount.com is used.
				1167	"statefulPolicy": { # Stateful configuration for this Instanced Group Manager
				1168	"preservedState": { # Configuration of preserved resources.
				1169	"disks": { # Disks created on the instances that will be preserved on instance delete, update, etc. This map is keyed with the device names of the disks.
				1170	"a_key": {
				1171	"autoDelete": "A String", # These stateful disks will never be deleted during autohealing, update or VM instance recreate operations. This flag is used to configure if the disk should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted. Note: disks attached in READ_ONLY mode cannot be auto-deleted.
				1172	},
				1173	},
				1174	},
				1175	},
				1176	"status": { # [Output Only] The status of this managed instance group.
				1177	"autoscaler": "A String", # [Output Only] The URL of the Autoscaler that targets this instance group manager.
				1178	"isStable": True or False, # [Output Only] A bit indicating whether the managed instance group is in a stable state. A stable state means that: none of the instances in the managed instance group is currently undergoing any type of change (for example, creation, restart, or deletion); no future changes are scheduled for instances in the managed instance group; and the managed instance group itself is not being modified.
				1179	"stateful": { # [Output Only] Stateful status of the given Instance Group Manager.
				1180	"hasStatefulConfig": True or False, # [Output Only] A bit indicating whether the managed instance group has stateful configuration, that is, if you have configured any items in a stateful policy or in per-instance configs. The group might report that it has no stateful config even when there is still some preserved state on a managed instance, for example, if you have deleted all PICs but not yet applied those deletions.
				1181	"isStateful": True or False, # [Output Only] A bit indicating whether the managed instance group has stateful configuration, that is, if you have configured any items in a stateful policy or in per-instance configs. The group might report that it has no stateful config even when there is still some preserved state on a managed instance, for example, if you have deleted all PICs but not yet applied those deletions. This field is deprecated in favor of has_stateful_config.
				1182	"perInstanceConfigs": { # [Output Only] Status of per-instance configs on the instance.
				1183	"allEffective": True or False, # A bit indicating if all of the group's per-instance configs (listed in the output of a listPerInstanceConfigs API call) have status EFFECTIVE or there are no per-instance-configs.
				1184	},
				1185	},
				1186	"versionTarget": { # [Output Only] A status of consistency of Instances' versions with their target version specified by version field on Instance Group Manager.
				1187	"isReached": True or False, # [Output Only] A bit indicating whether version target has been reached in this managed instance group, i.e. all instances are in their target version. Instances' target version are specified by version field on Instance Group Manager.
				1188	},
				1189	},
				1190	"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.
				1191	"A String",
				1192	],
				1193	"targetSize": 42, # The target number of running instances for this managed instance group. You can reduce this number by using the instanceGroupManager deleteInstances or abandonInstances methods. Resizing the group also changes this number.
				1194	"updatePolicy": { # The update policy for this managed instance group.
				1195	"instanceRedistributionType": "A String", # The instance redistribution policy for regional managed instance groups. Valid values are:
				1196	# - PROACTIVE (default): The group attempts to maintain an even distribution of VM instances across zones in the region.
				1197	# - NONE: For non-autoscaled groups, proactive redistribution is disabled.
yoshi-code-bot	73a0aa3	2021-05-25 00:30:03 -0700	[diff] [blame]	1198	"maxSurge": { # Encapsulates numeric value that can be either absolute or relative. # The maximum number of instances that can be created above the specified targetSize during the update process. This value can be either a fixed number or, if the group has 10 or more instances, a percentage. If you set a percentage, the number of instances is rounded if necessary. The default value for maxSurge is a fixed value equal to the number of zones in which the managed instance group operates.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1199	#
				1200	# At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxSurge.
				1201	"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.
				1202	#
				1203	#
				1204	# - If the value is fixed, then the calculated value is equal to the fixed value.
yoshi-code-bot	73a0aa3	2021-05-25 00:30:03 -0700	[diff] [blame]	1205	# - If the value is a percent, then the calculated value is percent/100 * targetSize. For example, the calculated value of a 80% of a managed instance group with 150 instances would be (80/100 * 150) = 120 VM instances. If there is a remainder, the number is rounded.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1206	"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.
				1207	"percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.
				1208	},
				1209	"maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # The maximum number of instances that can be unavailable during the update process. An instance is considered available if all of the following conditions are satisfied:
				1210	#
				1211	#
				1212	# - The instance's status is RUNNING.
yoshi-code-bot	73a0aa3	2021-05-25 00:30:03 -0700	[diff] [blame]	1213	# - If there is a health check on the instance group, the instance's health check status must be HEALTHY at least once. If there is no health check on the group, then the instance only needs to have a status of RUNNING to be considered available. This value can be either a fixed number or, if the group has 10 or more instances, a percentage. If you set a percentage, the number of instances is rounded if necessary. The default value for maxUnavailable is a fixed value equal to the number of zones in which the managed instance group operates.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1214	#
				1215	# At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxUnavailable.
				1216	"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.
				1217	#
				1218	#
				1219	# - If the value is fixed, then the calculated value is equal to the fixed value.
yoshi-code-bot	73a0aa3	2021-05-25 00:30:03 -0700	[diff] [blame]	1220	# - If the value is a percent, then the calculated value is percent/100 * targetSize. For example, the calculated value of a 80% of a managed instance group with 150 instances would be (80/100 * 150) = 120 VM instances. If there is a remainder, the number is rounded.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1221	"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.
				1222	"percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.
				1223	},
				1224	"minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600].
				1225	"minimalAction": "A String", # Minimal action to be taken on an instance. You can specify either RESTART to restart existing instances or REPLACE to delete and create new instances from the target template. If you specify a RESTART, the Updater will attempt to perform that action only. However, if the Updater determines that the minimal action you specify is not enough to perform the update, it might perform a more disruptive action.
Anthonios Partheniou	10f4b67	2021-04-13 14:47:53 -0400	[diff] [blame]	1226	"mostDisruptiveAllowedAction": "A String", # Most disruptive action that is allowed to be taken on an instance. You can specify either NONE to forbid any actions, REFRESH to allow actions that do not need instance restart, RESTART to allow actions that can be applied without instance replacing or REPLACE to allow all possible actions. If the Updater determines that the minimal update action needed is more disruptive than most disruptive allowed action you specify it will not perform the update at all.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1227	"replacementMethod": "A String", # What action should be used to replace instances. See minimal_action.REPLACE
				1228	"type": "A String", # The type of update process. You can specify either PROACTIVE so that the instance group manager proactively executes actions in order to bring instances to their target versions or OPPORTUNISTIC so that no action is proactively executed but the update will be performed as part of other actions (for example, resizes or recreateInstances calls).
				1229	},
				1230	"versions": [ # Specifies the instance templates used by this managed instance group to create instances.
				1231	#
				1232	# Each version is defined by an instanceTemplate and a name. Every version can appear at most once per instance group. This field overrides the top-level instanceTemplate field. Read more about the relationships between these fields. Exactly one version must leave the targetSize field unset. That version will be applied to all remaining instances. For more information, read about canary updates.
				1233	{
				1234	"instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create new instances in the managed instance group until the `targetSize` for this version is reached. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE; in those cases, existing instances are updated until the `targetSize` for this version is reached.
				1235	"name": "A String", # Name of the version. Unique among all versions in the scope of this managed instance group.
				1236	"targetSize": { # Encapsulates numeric value that can be either absolute or relative. # Specifies the intended number of instances to be created from the instanceTemplate. The final number of instances created from the template will be equal to:
				1237	# - If expressed as a fixed number, the minimum of either targetSize.fixed or instanceGroupManager.targetSize is used.
yoshi-code-bot	73a0aa3	2021-05-25 00:30:03 -0700	[diff] [blame]	1238	# - if expressed as a percent, the targetSize would be (targetSize.percent/100 * InstanceGroupManager.targetSize) If there is a remainder, the number is rounded. If unset, this version will update any remaining instances not updated by another version. Read Starting a canary update for more information.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1239	"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.
				1240	#
				1241	#
				1242	# - If the value is fixed, then the calculated value is equal to the fixed value.
yoshi-code-bot	73a0aa3	2021-05-25 00:30:03 -0700	[diff] [blame]	1243	# - If the value is a percent, then the calculated value is percent/100 * targetSize. For example, the calculated value of a 80% of a managed instance group with 150 instances would be (80/100 * 150) = 120 VM instances. If there is a remainder, the number is rounded.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1244	"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.
				1245	"percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.
				1246	},
				1247	},
				1248	],
				1249	"zone": "A String", # [Output Only] The URL of a zone where the managed instance group is located (for zonal resources).
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	1250	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1251	],
				1252	"kind": "compute#regionInstanceGroupManagerList", # [Output Only] The resource type, which is always compute#instanceGroupManagerList for a list of managed instance groups that exist in th regional scope.
				1253	"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.
				1254	"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
				1255	"warning": { # [Output Only] Informational warning message.
				1256	"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.
				1257	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				1258	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				1259	{
				1260	"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).
				1261	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				1262	},
				1263	],
				1264	"message": "A String", # [Output Only] A human-readable description of the warning code.
				1265	},
				1266	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	1267	</div>
				1268
				1269	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	1270	<code class="details" id="listErrors">listErrors(project, region, instanceGroupManager, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	1271	<pre>Lists all errors thrown by actions on instances for a given regional managed instance group. The filter and orderBy query parameters are not supported.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	1272
				1273	Args:
				1274	project: string, Project ID for this request. (required)
				1275	region: string, Name of the region scoping this request. This should conform to RFC1035. (required)
				1276	instanceGroupManager: string, The name of the managed instance group. It must be a string that meets the requirements in RFC1035, or an unsigned long integer: must match regexp pattern: (?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)\|[1-9][0-9]{0,19}. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	1277	filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`.
				1278
				1279	For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
				1280
				1281	You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.
				1282
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1283	To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```
				1284	maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
				1285	orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
				1286
				1287	You 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.
				1288
				1289	Currently, only sorting by `name` or `creationTimestamp desc` is supported.
				1290	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.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1291	returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	1292
				1293	Returns:
				1294	An object of the form:
				1295
				1296	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1297	"items": [ # [Output Only] The list of errors of the managed instance group.
				1298	{
				1299	"error": { # [Output Only] Contents of the error.
				1300	"code": "A String", # [Output Only] Error code.
				1301	"message": "A String", # [Output Only] Error message.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	1302	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1303	"instanceActionDetails": { # [Output Only] Details of the instance action that triggered this error. May be null, if the error was not caused by an action on an instance. This field is optional.
				1304	"action": "A String", # [Output Only] Action that managed instance group was executing on the instance when the error occurred. Possible values:
				1305	"instance": "A String", # [Output Only] The URL of the instance. The URL can be set even if the instance has not yet been created.
				1306	"version": { # [Output Only] Version this instance was created from, or was being created from, but the creation failed. Corresponds to one of the versions that were set on the Instance Group Manager resource at the time this instance was being created.
				1307	"instanceTemplate": "A String", # [Output Only] The intended template of the instance. This field is empty when current_action is one of { DELETING, ABANDONING }.
				1308	"name": "A String", # [Output Only] Name of the version.
				1309	},
				1310	},
				1311	"timestamp": "A String", # [Output Only] The time that this error occurred. This value is in RFC3339 text format.
				1312	},
				1313	],
				1314	"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.
				1315	}</pre>
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	1316	</div>
				1317
				1318	<div class="method">
				1319	<code class="details" id="listErrors_next">listErrors_next(previous_request, previous_response)</code>
				1320	<pre>Retrieves the next page of results.
				1321
				1322	Args:
				1323	previous_request: The request for the previous page. (required)
				1324	previous_response: The response from the request for the previous page. (required)
				1325
				1326	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1327	A request object that you can call 'execute()' on to request the next
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	1328	page. Returns None if there are no more items in the collection.
				1329	</pre>
				1330	</div>
				1331
				1332	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	1333	<code class="details" id="listManagedInstances">listManagedInstances(project, region, instanceGroupManager, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	1334	<pre>Lists the instances in the managed instance group and instances that are scheduled to be created. The list includes any current actions that the group has scheduled for its instances. The orderBy query parameter is not supported.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	1335
				1336	Args:
				1337	project: string, Project ID for this request. (required)
				1338	region: string, Name of the region scoping this request. (required)
				1339	instanceGroupManager: string, The name of the managed instance group. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	1340	filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	1341
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	1342	For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	1343
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	1344	You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	1345
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1346	To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```
				1347	maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
				1348	orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
				1349
				1350	You 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.
				1351
				1352	Currently, only sorting by `name` or `creationTimestamp desc` is supported.
				1353	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.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1354	returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	1355
				1356	Returns:
				1357	An object of the form:
				1358
				1359	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1360	"managedInstances": [ # A list of managed instances.
				1361	{ # A Managed Instance resource.
				1362	"currentAction": "A String", # [Output Only] The current action that the managed instance group has scheduled for the instance. Possible values:
				1363	# - NONE The instance is running, and the managed instance group does not have any scheduled actions for this instance.
				1364	# - 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.
				1365	# - 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.
				1366	# - RECREATING The managed instance group is recreating this instance.
				1367	# - DELETING The managed instance group is permanently deleting this instance.
				1368	# - 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.
				1369	# - RESTARTING The managed instance group is restarting the instance.
				1370	# - 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.
				1371	# - VERIFYING The managed instance group has created the instance and it is in the process of being verified.
				1372	"id": "A String", # [Output only] The unique identifier for this resource. This field is empty when instance does not exist.
				1373	"instance": "A String", # [Output Only] The URL of the instance. The URL can exist even if the instance has not yet been created.
				1374	"instanceHealth": [ # [Output Only] Health state of the instance per health-check.
				1375	{
				1376	"detailedHealthState": "A String", # [Output Only] The current detailed instance health state.
				1377	"healthCheck": "A String", # [Output Only] The URL for the health check that verifies whether the instance is healthy.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	1378	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1379	],
				1380	"instanceStatus": "A String", # [Output Only] The status of the instance. This field is empty when the instance does not exist.
				1381	"lastAttempt": { # [Output Only] Information about the last attempt to create or delete the instance.
				1382	"errors": { # [Output Only] Encountered errors during the last attempt to create or delete the instance.
				1383	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
				1384	{
				1385	"code": "A String", # [Output Only] The error type identifier for this error.
				1386	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				1387	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1388	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1389	],
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1390	},
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	1391	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1392	"preservedStateFromConfig": { # Preserved state for a given instance. # [Output Only] Preserved state applied from per-instance config for this instance.
				1393	"disks": { # Preserved disks defined for this instance. This map is keyed with the device names of the disks.
				1394	"a_key": {
				1395	"autoDelete": "A String", # These stateful disks will never be deleted during autohealing, update, instance recreate operations. This flag is used to configure if the disk should be deleted after it is no longer used by the group, e.g. when the given instance or the whole MIG is deleted. Note: disks attached in READ_ONLY mode cannot be auto-deleted.
				1396	"mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
				1397	"source": "A String", # The URL of the disk resource that is stateful and should be attached to the VM instance.
				1398	},
				1399	},
				1400	"metadata": { # Preserved metadata defined for this instance.
				1401	"a_key": "A String",
				1402	},
				1403	},
				1404	"preservedStateFromPolicy": { # Preserved state for a given instance. # [Output Only] Preserved state generated based on stateful policy for this instance.
				1405	"disks": { # Preserved disks defined for this instance. This map is keyed with the device names of the disks.
				1406	"a_key": {
				1407	"autoDelete": "A String", # These stateful disks will never be deleted during autohealing, update, instance recreate operations. This flag is used to configure if the disk should be deleted after it is no longer used by the group, e.g. when the given instance or the whole MIG is deleted. Note: disks attached in READ_ONLY mode cannot be auto-deleted.
				1408	"mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
				1409	"source": "A String", # The URL of the disk resource that is stateful and should be attached to the VM instance.
				1410	},
				1411	},
				1412	"metadata": { # Preserved metadata defined for this instance.
				1413	"a_key": "A String",
				1414	},
				1415	},
				1416	"version": { # [Output Only] Intended version of this instance.
				1417	"instanceTemplate": "A String", # [Output Only] The intended template of the instance. This field is empty when current_action is one of { DELETING, ABANDONING }.
				1418	"name": "A String", # [Output Only] Name of the version.
				1419	},
				1420	},
				1421	],
				1422	"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.
				1423	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	1424	</div>
				1425
				1426	<div class="method">
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	1427	<code class="details" id="listManagedInstances_next">listManagedInstances_next(previous_request, previous_response)</code>
				1428	<pre>Retrieves the next page of results.
				1429
				1430	Args:
				1431	previous_request: The request for the previous page. (required)
				1432	previous_response: The response from the request for the previous page. (required)
				1433
				1434	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1435	A request object that you can call 'execute()' on to request the next
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	1436	page. Returns None if there are no more items in the collection.
				1437	</pre>
				1438	</div>
				1439
				1440	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	1441	<code class="details" id="listPerInstanceConfigs">listPerInstanceConfigs(project, region, instanceGroupManager, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	1442	<pre>Lists all of the per-instance configs defined for the managed instance group. The orderBy query parameter is not supported.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	1443
				1444	Args:
				1445	project: string, Project ID for this request. (required)
				1446	region: string, Name of the region scoping this request, should conform to RFC1035. (required)
				1447	instanceGroupManager: string, The name of the managed instance group. It should conform to RFC1035. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	1448	filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`.
				1449
				1450	For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
				1451
				1452	You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.
				1453
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1454	To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```
				1455	maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
				1456	orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
				1457
				1458	You 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.
				1459
				1460	Currently, only sorting by `name` or `creationTimestamp desc` is supported.
				1461	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.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1462	returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	1463
				1464	Returns:
				1465	An object of the form:
				1466
				1467	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1468	"items": [ # [Output Only] The list of PerInstanceConfig.
				1469	{
				1470	"fingerprint": "A String", # Fingerprint of this per-instance config. This field can be used in optimistic locking. It is ignored when inserting a per-instance config. An up-to-date fingerprint must be provided in order to update an existing per-instance config or the field needs to be unset.
				1471	"name": "A String", # The name of a per-instance config and its corresponding instance. Serves as a merge key during UpdatePerInstanceConfigs operations, that is, if a per-instance config with the same name exists then it will be updated, otherwise a new one will be created for the VM instance with the same name. An attempt to create a per-instance config for a VM instance that either doesn't exist or is not part of the group will result in an error.
				1472	"preservedState": { # Preserved state for a given instance. # The intended preserved state for the given instance. Does not contain preserved state generated from a stateful policy.
				1473	"disks": { # Preserved disks defined for this instance. This map is keyed with the device names of the disks.
				1474	"a_key": {
				1475	"autoDelete": "A String", # These stateful disks will never be deleted during autohealing, update, instance recreate operations. This flag is used to configure if the disk should be deleted after it is no longer used by the group, e.g. when the given instance or the whole MIG is deleted. Note: disks attached in READ_ONLY mode cannot be auto-deleted.
				1476	"mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
				1477	"source": "A String", # The URL of the disk resource that is stateful and should be attached to the VM instance.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	1478	},
				1479	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1480	"metadata": { # Preserved metadata defined for this instance.
				1481	"a_key": "A String",
				1482	},
				1483	},
				1484	"status": "A String", # The status of applying this per-instance config on the corresponding managed instance.
				1485	},
				1486	],
				1487	"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.
				1488	"warning": { # [Output Only] Informational warning message.
				1489	"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.
				1490	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				1491	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				1492	{
				1493	"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).
				1494	"value": "A String", # [Output Only] A warning data value corresponding to the key.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	1495	},
				1496	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1497	"message": "A String", # [Output Only] A human-readable description of the warning code.
				1498	},
				1499	}</pre>
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	1500	</div>
				1501
				1502	<div class="method">
				1503	<code class="details" id="listPerInstanceConfigs_next">listPerInstanceConfigs_next(previous_request, previous_response)</code>
				1504	<pre>Retrieves the next page of results.
				1505
				1506	Args:
				1507	previous_request: The request for the previous page. (required)
				1508	previous_response: The response from the request for the previous page. (required)
				1509
				1510	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1511	A request object that you can call 'execute()' on to request the next
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	1512	page. Returns None if there are no more items in the collection.
				1513	</pre>
				1514	</div>
				1515
				1516	<div class="method">
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	1517	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				1518	<pre>Retrieves the next page of results.
				1519
				1520	Args:
				1521	previous_request: The request for the previous page. (required)
				1522	previous_response: The response from the request for the previous page. (required)
				1523
				1524	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1525	A request object that you can call 'execute()' on to request the next
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	1526	page. Returns None if there are no more items in the collection.
				1527	</pre>
				1528	</div>
				1529
				1530	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	1531	<code class="details" id="patch">patch(project, region, instanceGroupManager, body=None, requestId=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	1532	<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 patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listmanagedinstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	1533
				1534	Args:
				1535	project: string, Project ID for this request. (required)
				1536	region: string, Name of the region scoping this request. (required)
				1537	instanceGroupManager: string, The name of the instance group manager. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	1538	body: object, The request body.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	1539	The object takes the form of:
				1540
yoshi-code-bot	c2cd326	2021-05-16 02:16:04 -0700	[diff] [blame]	1541	{ # Whether the instance is a standby. Properties of a standby instance comparing to the regular instance: ========================================================================= \| regular \| standby ========================================================================= managed by IGM? \| yes \| yes added to the IG? \| yes \| yes counts towards IGM's target size? \| yes \| no taken into account by Autoscaler? \| yes \| no receives traffic from LB? \| yes \| no =========================================================================
				1542	#
				1543	# Represents a Managed Instance Group resource.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	1544	#
				1545	# An instance group is a collection of VM instances that you can manage as a single entity. For more information, read Instance groups.
				1546	#
				1547	# For zonal Managed Instance Group, use the instanceGroupManagers resource.
				1548	#
				1549	# For regional Managed Instance Group, use the regionInstanceGroupManagers resource. (== resource_for {$api_version}.instanceGroupManagers ==) (== resource_for {$api_version}.regionInstanceGroupManagers ==)
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1550	"autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	1551	{
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1552	"healthCheck": "A String", # The URL for the health check that signals autohealing.
				1553	"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].
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	1554	},
				1555	],
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1556	"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.
				1557	"creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
				1558	"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.
				1559	"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.
				1560	"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.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	1561	#
				1562	# If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1563	"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.
				1564	"deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
				1565	"none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
				1566	"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.
				1567	"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.
				1568	"restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
				1569	"verifying": 42, # [Output Only] The number of instances in the managed instance group that are being verified. See the managedInstances[].currentAction property in the listManagedInstances method documentation.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	1570	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1571	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	1572	"distributionPolicy": { # Policy specifying the intended distribution of managed instances across zones in a regional managed instance group.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1573	"targetShape": "A String", # The distribution shape to which the group converges either proactively or on resize events (depending on the value set in updatePolicy.instanceRedistributionType).
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	1574	"zones": [ # Zones where the regional managed instance group will create and manage its instances.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	1575	{
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1576	"zone": "A String", # The URL of the zone. The zone must exist in the region where the managed instance group is located.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	1577	},
				1578	],
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	1579	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1580	"failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.
				1581	"fingerprint": "A String", # Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet.
				1582	#
				1583	# To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager.
				1584	"id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
				1585	"instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	1586	"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. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1587	"kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
				1588	"name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.
				1589	"namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
				1590	{ # The named port. For example: .
				1591	"name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
				1592	"port": 42, # The port number, which can be a value between 1 and 65535.
				1593	},
				1594	],
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1595	"region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).
				1596	"selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
				1597	"serviceAccount": "A String", # The service account to be used as credentials for all operations performed by the managed instance group on instances. The service accounts needs all permissions required to create and delete instances. By default, the service account {projectNumber}@cloudservices.gserviceaccount.com is used.
				1598	"statefulPolicy": { # Stateful configuration for this Instanced Group Manager
				1599	"preservedState": { # Configuration of preserved resources.
				1600	"disks": { # Disks created on the instances that will be preserved on instance delete, update, etc. This map is keyed with the device names of the disks.
				1601	"a_key": {
				1602	"autoDelete": "A String", # These stateful disks will never be deleted during autohealing, update or VM instance recreate operations. This flag is used to configure if the disk should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted. Note: disks attached in READ_ONLY mode cannot be auto-deleted.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	1603	},
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	1604	},
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	1605	},
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	1606	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1607	"status": { # [Output Only] The status of this managed instance group.
				1608	"autoscaler": "A String", # [Output Only] The URL of the Autoscaler that targets this instance group manager.
				1609	"isStable": True or False, # [Output Only] A bit indicating whether the managed instance group is in a stable state. A stable state means that: none of the instances in the managed instance group is currently undergoing any type of change (for example, creation, restart, or deletion); no future changes are scheduled for instances in the managed instance group; and the managed instance group itself is not being modified.
				1610	"stateful": { # [Output Only] Stateful status of the given Instance Group Manager.
				1611	"hasStatefulConfig": True or False, # [Output Only] A bit indicating whether the managed instance group has stateful configuration, that is, if you have configured any items in a stateful policy or in per-instance configs. The group might report that it has no stateful config even when there is still some preserved state on a managed instance, for example, if you have deleted all PICs but not yet applied those deletions.
				1612	"isStateful": True or False, # [Output Only] A bit indicating whether the managed instance group has stateful configuration, that is, if you have configured any items in a stateful policy or in per-instance configs. The group might report that it has no stateful config even when there is still some preserved state on a managed instance, for example, if you have deleted all PICs but not yet applied those deletions. This field is deprecated in favor of has_stateful_config.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	1613	"perInstanceConfigs": { # [Output Only] Status of per-instance configs on the instance.
				1614	"allEffective": True or False, # A bit indicating if all of the group's per-instance configs (listed in the output of a listPerInstanceConfigs API call) have status EFFECTIVE or there are no per-instance-configs.
				1615	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1616	},
				1617	"versionTarget": { # [Output Only] A status of consistency of Instances' versions with their target version specified by version field on Instance Group Manager.
				1618	"isReached": True or False, # [Output Only] A bit indicating whether version target has been reached in this managed instance group, i.e. all instances are in their target version. Instances' target version are specified by version field on Instance Group Manager.
				1619	},
				1620	},
				1621	"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.
				1622	"A String",
				1623	],
				1624	"targetSize": 42, # The target number of running instances for this managed instance group. You can reduce this number by using the instanceGroupManager deleteInstances or abandonInstances methods. Resizing the group also changes this number.
				1625	"updatePolicy": { # The update policy for this managed instance group.
				1626	"instanceRedistributionType": "A String", # The instance redistribution policy for regional managed instance groups. Valid values are:
				1627	# - PROACTIVE (default): The group attempts to maintain an even distribution of VM instances across zones in the region.
				1628	# - NONE: For non-autoscaled groups, proactive redistribution is disabled.
yoshi-code-bot	73a0aa3	2021-05-25 00:30:03 -0700	[diff] [blame]	1629	"maxSurge": { # Encapsulates numeric value that can be either absolute or relative. # The maximum number of instances that can be created above the specified targetSize during the update process. This value can be either a fixed number or, if the group has 10 or more instances, a percentage. If you set a percentage, the number of instances is rounded if necessary. The default value for maxSurge is a fixed value equal to the number of zones in which the managed instance group operates.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1630	#
				1631	# At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxSurge.
				1632	"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.
				1633	#
				1634	#
				1635	# - If the value is fixed, then the calculated value is equal to the fixed value.
yoshi-code-bot	73a0aa3	2021-05-25 00:30:03 -0700	[diff] [blame]	1636	# - If the value is a percent, then the calculated value is percent/100 * targetSize. For example, the calculated value of a 80% of a managed instance group with 150 instances would be (80/100 * 150) = 120 VM instances. If there is a remainder, the number is rounded.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1637	"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.
				1638	"percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.
				1639	},
				1640	"maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # The maximum number of instances that can be unavailable during the update process. An instance is considered available if all of the following conditions are satisfied:
				1641	#
				1642	#
				1643	# - The instance's status is RUNNING.
yoshi-code-bot	73a0aa3	2021-05-25 00:30:03 -0700	[diff] [blame]	1644	# - If there is a health check on the instance group, the instance's health check status must be HEALTHY at least once. If there is no health check on the group, then the instance only needs to have a status of RUNNING to be considered available. This value can be either a fixed number or, if the group has 10 or more instances, a percentage. If you set a percentage, the number of instances is rounded if necessary. The default value for maxUnavailable is a fixed value equal to the number of zones in which the managed instance group operates.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1645	#
				1646	# At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxUnavailable.
				1647	"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.
				1648	#
				1649	#
				1650	# - If the value is fixed, then the calculated value is equal to the fixed value.
yoshi-code-bot	73a0aa3	2021-05-25 00:30:03 -0700	[diff] [blame]	1651	# - If the value is a percent, then the calculated value is percent/100 * targetSize. For example, the calculated value of a 80% of a managed instance group with 150 instances would be (80/100 * 150) = 120 VM instances. If there is a remainder, the number is rounded.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1652	"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.
				1653	"percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.
				1654	},
				1655	"minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600].
				1656	"minimalAction": "A String", # Minimal action to be taken on an instance. You can specify either RESTART to restart existing instances or REPLACE to delete and create new instances from the target template. If you specify a RESTART, the Updater will attempt to perform that action only. However, if the Updater determines that the minimal action you specify is not enough to perform the update, it might perform a more disruptive action.
Anthonios Partheniou	10f4b67	2021-04-13 14:47:53 -0400	[diff] [blame]	1657	"mostDisruptiveAllowedAction": "A String", # Most disruptive action that is allowed to be taken on an instance. You can specify either NONE to forbid any actions, REFRESH to allow actions that do not need instance restart, RESTART to allow actions that can be applied without instance replacing or REPLACE to allow all possible actions. If the Updater determines that the minimal update action needed is more disruptive than most disruptive allowed action you specify it will not perform the update at all.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1658	"replacementMethod": "A String", # What action should be used to replace instances. See minimal_action.REPLACE
				1659	"type": "A String", # The type of update process. You can specify either PROACTIVE so that the instance group manager proactively executes actions in order to bring instances to their target versions or OPPORTUNISTIC so that no action is proactively executed but the update will be performed as part of other actions (for example, resizes or recreateInstances calls).
				1660	},
				1661	"versions": [ # Specifies the instance templates used by this managed instance group to create instances.
				1662	#
				1663	# Each version is defined by an instanceTemplate and a name. Every version can appear at most once per instance group. This field overrides the top-level instanceTemplate field. Read more about the relationships between these fields. Exactly one version must leave the targetSize field unset. That version will be applied to all remaining instances. For more information, read about canary updates.
				1664	{
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	1665	"instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create new instances in the managed instance group until the `targetSize` for this version is reached. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE; in those cases, existing instances are updated until the `targetSize` for this version is reached.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1666	"name": "A String", # Name of the version. Unique among all versions in the scope of this managed instance group.
				1667	"targetSize": { # Encapsulates numeric value that can be either absolute or relative. # Specifies the intended number of instances to be created from the instanceTemplate. The final number of instances created from the template will be equal to:
				1668	# - If expressed as a fixed number, the minimum of either targetSize.fixed or instanceGroupManager.targetSize is used.
yoshi-code-bot	73a0aa3	2021-05-25 00:30:03 -0700	[diff] [blame]	1669	# - if expressed as a percent, the targetSize would be (targetSize.percent/100 * InstanceGroupManager.targetSize) If there is a remainder, the number is rounded. If unset, this version will update any remaining instances not updated by another version. Read Starting a canary update for more information.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1670	"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.
				1671	#
				1672	#
				1673	# - If the value is fixed, then the calculated value is equal to the fixed value.
yoshi-code-bot	73a0aa3	2021-05-25 00:30:03 -0700	[diff] [blame]	1674	# - If the value is a percent, then the calculated value is percent/100 * targetSize. For example, the calculated value of a 80% of a managed instance group with 150 instances would be (80/100 * 150) = 120 VM instances. If there is a remainder, the number is rounded.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1675	"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.
				1676	"percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.
				1677	},
				1678	},
				1679	],
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	1680	"zone": "A String", # [Output Only] The URL of a zone where the managed instance group is located (for zonal resources).
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	1681	}
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	1682
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	1683	requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
				1684
				1685	For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
				1686
				1687	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	1688
				1689	Returns:
				1690	An object of the form:
				1691
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	1692	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1693	#
				1694	# Google Compute Engine has three Operation resources:
				1695	#
				1696	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				1697	#
				1698	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				1699	#
				1700	# Operations can be global, regional or zonal.
				1701	# - For global operations, use the `globalOperations` resource.
				1702	# - For regional operations, use the `regionOperations` resource.
				1703	# - For zonal operations, use the `zonalOperations` resource.
				1704	#
				1705	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				1706	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				1707	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				1708	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				1709	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				1710	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				1711	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1712	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1713	"code": "A String", # [Output Only] The error type identifier for this error.
				1714	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				1715	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1716	},
				1717	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1718	},
				1719	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				1720	"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.
				1721	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				1722	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				1723	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				1724	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1725	"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1726	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				1727	"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.
				1728	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				1729	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				1730	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				1731	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				1732	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				1733	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				1734	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
				1735	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				1736	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				1737	{
				1738	"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.
				1739	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				1740	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				1741	{
				1742	"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).
				1743	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				1744	},
				1745	],
				1746	"message": "A String", # [Output Only] A human-readable description of the warning code.
				1747	},
				1748	],
				1749	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				1750	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	1751	</div>
				1752
				1753	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	1754	<code class="details" id="patchPerInstanceConfigs">patchPerInstanceConfigs(project, region, instanceGroupManager, body=None, requestId=None)</code>
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1755	<pre>Inserts or patches per-instance configs for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	1756
				1757	Args:
				1758	project: string, Project ID for this request. (required)
				1759	region: string, Name of the region scoping this request, should conform to RFC1035. (required)
				1760	instanceGroupManager: string, The name of the managed instance group. It should conform to RFC1035. (required)
				1761	body: object, The request body.
				1762	The object takes the form of:
				1763
				1764	{ # RegionInstanceGroupManagers.patchPerInstanceConfigs
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1765	"perInstanceConfigs": [ # The list of per-instance configs to insert or patch on this managed instance group.
				1766	{
				1767	"fingerprint": "A String", # Fingerprint of this per-instance config. This field can be used in optimistic locking. It is ignored when inserting a per-instance config. An up-to-date fingerprint must be provided in order to update an existing per-instance config or the field needs to be unset.
				1768	"name": "A String", # The name of a per-instance config and its corresponding instance. Serves as a merge key during UpdatePerInstanceConfigs operations, that is, if a per-instance config with the same name exists then it will be updated, otherwise a new one will be created for the VM instance with the same name. An attempt to create a per-instance config for a VM instance that either doesn't exist or is not part of the group will result in an error.
				1769	"preservedState": { # Preserved state for a given instance. # The intended preserved state for the given instance. Does not contain preserved state generated from a stateful policy.
				1770	"disks": { # Preserved disks defined for this instance. This map is keyed with the device names of the disks.
				1771	"a_key": {
				1772	"autoDelete": "A String", # These stateful disks will never be deleted during autohealing, update, instance recreate operations. This flag is used to configure if the disk should be deleted after it is no longer used by the group, e.g. when the given instance or the whole MIG is deleted. Note: disks attached in READ_ONLY mode cannot be auto-deleted.
				1773	"mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
				1774	"source": "A String", # The URL of the disk resource that is stateful and should be attached to the VM instance.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	1775	},
				1776	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1777	"metadata": { # Preserved metadata defined for this instance.
				1778	"a_key": "A String",
				1779	},
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	1780	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1781	"status": "A String", # The status of applying this per-instance config on the corresponding managed instance.
				1782	},
				1783	],
				1784	}
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	1785
				1786	requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
				1787
				1788	For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
				1789
				1790	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
				1791
				1792	Returns:
				1793	An object of the form:
				1794
				1795	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1796	#
				1797	# Google Compute Engine has three Operation resources:
				1798	#
				1799	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				1800	#
				1801	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				1802	#
				1803	# Operations can be global, regional or zonal.
				1804	# - For global operations, use the `globalOperations` resource.
				1805	# - For regional operations, use the `regionOperations` resource.
				1806	# - For zonal operations, use the `zonalOperations` resource.
				1807	#
				1808	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				1809	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				1810	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				1811	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				1812	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				1813	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				1814	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1815	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1816	"code": "A String", # [Output Only] The error type identifier for this error.
				1817	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				1818	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1819	},
				1820	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1821	},
				1822	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				1823	"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.
				1824	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				1825	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				1826	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				1827	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1828	"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1829	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				1830	"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.
				1831	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				1832	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				1833	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				1834	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				1835	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				1836	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				1837	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
				1838	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				1839	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				1840	{
				1841	"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.
				1842	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				1843	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				1844	{
				1845	"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).
				1846	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				1847	},
				1848	],
				1849	"message": "A String", # [Output Only] A human-readable description of the warning code.
				1850	},
				1851	],
				1852	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				1853	}</pre>
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	1854	</div>
				1855
				1856	<div class="method">
				1857	<code class="details" id="recreateInstances">recreateInstances(project, region, instanceGroupManager, body=None, requestId=None)</code>
Anthonios Partheniou	10f4b67	2021-04-13 14:47:53 -0400	[diff] [blame]	1858	<pre>Flags the specified VM instances in the managed instance group to be immediately recreated. Each instance is recreated using the group's current configuration. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of each instance by checking its currentAction field; for more information, see Checking the status of managed instances.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	1859
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	1860	If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.
				1861
				1862	You can specify a maximum of 1000 instances with this method per request.
				1863
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	1864	Args:
				1865	project: string, Project ID for this request. (required)
				1866	region: string, Name of the region scoping this request. (required)
				1867	instanceGroupManager: string, Name of the managed instance group. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	1868	body: object, The request body.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	1869	The object takes the form of:
				1870
				1871	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1872	"instances": [ # The URLs of one or more instances to recreate. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].
				1873	"A String",
				1874	],
				1875	}
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	1876
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	1877	requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
				1878
				1879	For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
				1880
				1881	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	1882
				1883	Returns:
				1884	An object of the form:
				1885
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	1886	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1887	#
				1888	# Google Compute Engine has three Operation resources:
				1889	#
				1890	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				1891	#
				1892	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				1893	#
				1894	# Operations can be global, regional or zonal.
				1895	# - For global operations, use the `globalOperations` resource.
				1896	# - For regional operations, use the `regionOperations` resource.
				1897	# - For zonal operations, use the `zonalOperations` resource.
				1898	#
				1899	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				1900	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				1901	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				1902	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				1903	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				1904	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				1905	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1906	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1907	"code": "A String", # [Output Only] The error type identifier for this error.
				1908	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				1909	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1910	},
				1911	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1912	},
				1913	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				1914	"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.
				1915	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				1916	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				1917	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				1918	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1919	"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1920	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				1921	"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.
				1922	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				1923	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				1924	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				1925	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				1926	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				1927	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				1928	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
				1929	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				1930	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				1931	{
				1932	"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.
				1933	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				1934	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				1935	{
				1936	"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).
				1937	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				1938	},
				1939	],
				1940	"message": "A String", # [Output Only] A human-readable description of the warning code.
				1941	},
				1942	],
				1943	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				1944	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	1945	</div>
				1946
				1947	<div class="method">
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	1948	<code class="details" id="resize">resize(project, region, instanceGroupManager, size, requestId=None)</code>
				1949	<pre>Changes the intended size of 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 one or more instances.
				1950
				1951	The resize operation is marked DONE if the resize request is successful. The underlying actions take additional time. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	1952
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	1953	If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.
				1954
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	1955	Args:
				1956	project: string, Project ID for this request. (required)
				1957	region: string, Name of the region scoping this request. (required)
				1958	instanceGroupManager: string, Name of the managed instance group. (required)
				1959	size: integer, Number of instances that should exist in this instance group manager. (required)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	1960	requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
				1961
				1962	For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
				1963
				1964	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	1965
				1966	Returns:
				1967	An object of the form:
				1968
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	1969	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1970	#
				1971	# Google Compute Engine has three Operation resources:
				1972	#
				1973	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				1974	#
				1975	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				1976	#
				1977	# Operations can be global, regional or zonal.
				1978	# - For global operations, use the `globalOperations` resource.
				1979	# - For regional operations, use the `regionOperations` resource.
				1980	# - For zonal operations, use the `zonalOperations` resource.
				1981	#
				1982	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				1983	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				1984	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				1985	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				1986	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				1987	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				1988	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1989	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1990	"code": "A String", # [Output Only] The error type identifier for this error.
				1991	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				1992	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1993	},
				1994	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1995	},
				1996	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				1997	"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.
				1998	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				1999	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				2000	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				2001	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	2002	"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	2003	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				2004	"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.
				2005	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				2006	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				2007	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				2008	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				2009	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				2010	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				2011	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
				2012	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				2013	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				2014	{
				2015	"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.
				2016	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				2017	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				2018	{
				2019	"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).
				2020	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				2021	},
				2022	],
				2023	"message": "A String", # [Output Only] A human-readable description of the warning code.
				2024	},
				2025	],
				2026	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				2027	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	2028	</div>
				2029
				2030	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	2031	<code class="details" id="setAutoHealingPolicies">setAutoHealingPolicies(project, region, instanceGroupManager, body=None, requestId=None)</code>
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	2032	<pre>Modifies the autohealing policy for the instances in this managed instance group. [Deprecated] This method is deprecated. Use regionInstanceGroupManagers.patch instead.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	2033
				2034	Args:
				2035	project: string, Project ID for this request. (required)
				2036	region: string, Name of the region scoping this request. (required)
				2037	instanceGroupManager: string, Name of the managed instance group. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	2038	body: object, The request body.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	2039	The object takes the form of:
				2040
				2041	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	2042	"autoHealingPolicies": [
				2043	{
				2044	"healthCheck": "A String", # The URL for the health check that signals autohealing.
				2045	"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].
				2046	},
				2047	],
				2048	}
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	2049
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	2050	requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
				2051
				2052	For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
				2053
				2054	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	2055
				2056	Returns:
				2057	An object of the form:
				2058
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	2059	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	2060	#
				2061	# Google Compute Engine has three Operation resources:
				2062	#
				2063	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				2064	#
				2065	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				2066	#
				2067	# Operations can be global, regional or zonal.
				2068	# - For global operations, use the `globalOperations` resource.
				2069	# - For regional operations, use the `regionOperations` resource.
				2070	# - For zonal operations, use the `zonalOperations` resource.
				2071	#
				2072	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				2073	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				2074	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				2075	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				2076	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				2077	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				2078	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2079	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	2080	"code": "A String", # [Output Only] The error type identifier for this error.
				2081	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				2082	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2083	},
				2084	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	2085	},
				2086	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				2087	"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.
				2088	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				2089	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				2090	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				2091	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	2092	"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	2093	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				2094	"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.
				2095	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				2096	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				2097	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				2098	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				2099	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				2100	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				2101	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
				2102	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				2103	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				2104	{
				2105	"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.
				2106	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				2107	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				2108	{
				2109	"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).
				2110	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				2111	},
				2112	],
				2113	"message": "A String", # [Output Only] A human-readable description of the warning code.
				2114	},
				2115	],
				2116	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				2117	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	2118	</div>
				2119
				2120	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	2121	<code class="details" id="setInstanceTemplate">setInstanceTemplate(project, region, instanceGroupManager, body=None, requestId=None)</code>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	2122	<pre>Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected.
				2123
				2124	Args:
				2125	project: string, Project ID for this request. (required)
				2126	region: string, Name of the region scoping this request. (required)
				2127	instanceGroupManager: string, The name of the managed instance group. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	2128	body: object, The request body.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	2129	The object takes the form of:
				2130
				2131	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	2132	"instanceTemplate": "A String", # URL of the InstanceTemplate resource from which all new instances will be created.
				2133	}
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	2134
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	2135	requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
				2136
				2137	For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
				2138
				2139	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	2140
				2141	Returns:
				2142	An object of the form:
				2143
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	2144	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	2145	#
				2146	# Google Compute Engine has three Operation resources:
				2147	#
				2148	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				2149	#
				2150	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				2151	#
				2152	# Operations can be global, regional or zonal.
				2153	# - For global operations, use the `globalOperations` resource.
				2154	# - For regional operations, use the `regionOperations` resource.
				2155	# - For zonal operations, use the `zonalOperations` resource.
				2156	#
				2157	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				2158	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				2159	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				2160	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				2161	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				2162	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				2163	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2164	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	2165	"code": "A String", # [Output Only] The error type identifier for this error.
				2166	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				2167	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2168	},
				2169	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	2170	},
				2171	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				2172	"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.
				2173	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				2174	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				2175	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				2176	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	2177	"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	2178	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				2179	"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.
				2180	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				2181	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				2182	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				2183	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				2184	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				2185	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				2186	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
				2187	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				2188	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				2189	{
				2190	"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.
				2191	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				2192	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				2193	{
				2194	"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).
				2195	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				2196	},
				2197	],
				2198	"message": "A String", # [Output Only] A human-readable description of the warning code.
				2199	},
				2200	],
				2201	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				2202	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	2203	</div>
				2204
				2205	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	2206	<code class="details" id="setTargetPools">setTargetPools(project, region, instanceGroupManager, body=None, requestId=None)</code>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	2207	<pre>Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected.
				2208
				2209	Args:
				2210	project: string, Project ID for this request. (required)
				2211	region: string, Name of the region scoping this request. (required)
				2212	instanceGroupManager: string, Name of the managed instance group. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	2213	body: object, The request body.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	2214	The object takes the form of:
				2215
				2216	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	2217	"fingerprint": "A String", # Fingerprint of the target pools information, which is a hash of the contents. This field is used for optimistic locking when you update the target pool entries. This field is optional.
				2218	"targetPools": [ # The URL of all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
				2219	"A String",
				2220	],
				2221	}
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	2222
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	2223	requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
				2224
				2225	For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
				2226
				2227	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	2228
				2229	Returns:
				2230	An object of the form:
				2231
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	2232	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	2233	#
				2234	# Google Compute Engine has three Operation resources:
				2235	#
				2236	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				2237	#
				2238	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				2239	#
				2240	# Operations can be global, regional or zonal.
				2241	# - For global operations, use the `globalOperations` resource.
				2242	# - For regional operations, use the `regionOperations` resource.
				2243	# - For zonal operations, use the `zonalOperations` resource.
				2244	#
				2245	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				2246	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				2247	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				2248	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				2249	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				2250	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				2251	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2252	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	2253	"code": "A String", # [Output Only] The error type identifier for this error.
				2254	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				2255	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2256	},
				2257	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	2258	},
				2259	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				2260	"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.
				2261	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				2262	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				2263	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				2264	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	2265	"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	2266	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				2267	"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.
				2268	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				2269	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				2270	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				2271	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				2272	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				2273	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				2274	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
				2275	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				2276	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				2277	{
				2278	"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.
				2279	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				2280	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				2281	{
				2282	"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).
				2283	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				2284	},
				2285	],
				2286	"message": "A String", # [Output Only] A human-readable description of the warning code.
				2287	},
				2288	],
				2289	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				2290	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	2291	</div>
				2292
				2293	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	2294	<code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body=None)</code>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	2295	<pre>Returns permissions that a caller has on the specified resource.
				2296
				2297	Args:
				2298	project: string, Project ID for this request. (required)
				2299	region: string, The name of the region for this request. (required)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	2300	resource: string, Name or id of the resource for this request. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	2301	body: object, The request body.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	2302	The object takes the form of:
				2303
				2304	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	2305	"permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '' or 'storage.') are not allowed.
				2306	"A String",
				2307	],
				2308	}
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	2309
				2310
				2311	Returns:
				2312	An object of the form:
				2313
				2314	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	2315	"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
				2316	"A String",
				2317	],
				2318	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	2319	</div>
				2320
				2321	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	2322	<code class="details" id="update">update(project, region, instanceGroupManager, body=None, requestId=None)</code>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	2323	<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.
				2324
				2325	Args:
				2326	project: string, Project ID for this request. (required)
				2327	region: string, Name of the region scoping this request. (required)
				2328	instanceGroupManager: string, The name of the instance group manager. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	2329	body: object, The request body.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	2330	The object takes the form of:
				2331
yoshi-code-bot	c2cd326	2021-05-16 02:16:04 -0700	[diff] [blame]	2332	{ # Whether the instance is a standby. Properties of a standby instance comparing to the regular instance: ========================================================================= \| regular \| standby ========================================================================= managed by IGM? \| yes \| yes added to the IG? \| yes \| yes counts towards IGM's target size? \| yes \| no taken into account by Autoscaler? \| yes \| no receives traffic from LB? \| yes \| no =========================================================================
				2333	#
				2334	# Represents a Managed Instance Group resource.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	2335	#
				2336	# An instance group is a collection of VM instances that you can manage as a single entity. For more information, read Instance groups.
				2337	#
				2338	# For zonal Managed Instance Group, use the instanceGroupManagers resource.
				2339	#
				2340	# For regional Managed Instance Group, use the regionInstanceGroupManagers resource. (== resource_for {$api_version}.instanceGroupManagers ==) (== resource_for {$api_version}.regionInstanceGroupManagers ==)
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2341	"autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	2342	{
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2343	"healthCheck": "A String", # The URL for the health check that signals autohealing.
				2344	"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].
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	2345	},
				2346	],
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2347	"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.
				2348	"creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
				2349	"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.
				2350	"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.
				2351	"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.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	2352	#
				2353	# If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2354	"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.
				2355	"deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
				2356	"none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
				2357	"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.
				2358	"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.
				2359	"restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
				2360	"verifying": 42, # [Output Only] The number of instances in the managed instance group that are being verified. See the managedInstances[].currentAction property in the listManagedInstances method documentation.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	2361	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2362	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	2363	"distributionPolicy": { # Policy specifying the intended distribution of managed instances across zones in a regional managed instance group.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	2364	"targetShape": "A String", # The distribution shape to which the group converges either proactively or on resize events (depending on the value set in updatePolicy.instanceRedistributionType).
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	2365	"zones": [ # Zones where the regional managed instance group will create and manage its instances.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	2366	{
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2367	"zone": "A String", # The URL of the zone. The zone must exist in the region where the managed instance group is located.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	2368	},
				2369	],
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	2370	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2371	"failoverAction": "A String", # The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.
				2372	"fingerprint": "A String", # Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet.
				2373	#
				2374	# To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager.
				2375	"id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
				2376	"instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	2377	"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. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2378	"kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
				2379	"name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.
				2380	"namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
				2381	{ # The named port. For example: .
				2382	"name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
				2383	"port": 42, # The port number, which can be a value between 1 and 65535.
				2384	},
				2385	],
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2386	"region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).
				2387	"selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
				2388	"serviceAccount": "A String", # The service account to be used as credentials for all operations performed by the managed instance group on instances. The service accounts needs all permissions required to create and delete instances. By default, the service account {projectNumber}@cloudservices.gserviceaccount.com is used.
				2389	"statefulPolicy": { # Stateful configuration for this Instanced Group Manager
				2390	"preservedState": { # Configuration of preserved resources.
				2391	"disks": { # Disks created on the instances that will be preserved on instance delete, update, etc. This map is keyed with the device names of the disks.
				2392	"a_key": {
				2393	"autoDelete": "A String", # These stateful disks will never be deleted during autohealing, update or VM instance recreate operations. This flag is used to configure if the disk should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted. Note: disks attached in READ_ONLY mode cannot be auto-deleted.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	2394	},
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	2395	},
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	2396	},
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	2397	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2398	"status": { # [Output Only] The status of this managed instance group.
				2399	"autoscaler": "A String", # [Output Only] The URL of the Autoscaler that targets this instance group manager.
				2400	"isStable": True or False, # [Output Only] A bit indicating whether the managed instance group is in a stable state. A stable state means that: none of the instances in the managed instance group is currently undergoing any type of change (for example, creation, restart, or deletion); no future changes are scheduled for instances in the managed instance group; and the managed instance group itself is not being modified.
				2401	"stateful": { # [Output Only] Stateful status of the given Instance Group Manager.
				2402	"hasStatefulConfig": True or False, # [Output Only] A bit indicating whether the managed instance group has stateful configuration, that is, if you have configured any items in a stateful policy or in per-instance configs. The group might report that it has no stateful config even when there is still some preserved state on a managed instance, for example, if you have deleted all PICs but not yet applied those deletions.
				2403	"isStateful": True or False, # [Output Only] A bit indicating whether the managed instance group has stateful configuration, that is, if you have configured any items in a stateful policy or in per-instance configs. The group might report that it has no stateful config even when there is still some preserved state on a managed instance, for example, if you have deleted all PICs but not yet applied those deletions. This field is deprecated in favor of has_stateful_config.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	2404	"perInstanceConfigs": { # [Output Only] Status of per-instance configs on the instance.
				2405	"allEffective": True or False, # A bit indicating if all of the group's per-instance configs (listed in the output of a listPerInstanceConfigs API call) have status EFFECTIVE or there are no per-instance-configs.
				2406	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2407	},
				2408	"versionTarget": { # [Output Only] A status of consistency of Instances' versions with their target version specified by version field on Instance Group Manager.
				2409	"isReached": True or False, # [Output Only] A bit indicating whether version target has been reached in this managed instance group, i.e. all instances are in their target version. Instances' target version are specified by version field on Instance Group Manager.
				2410	},
				2411	},
				2412	"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.
				2413	"A String",
				2414	],
				2415	"targetSize": 42, # The target number of running instances for this managed instance group. You can reduce this number by using the instanceGroupManager deleteInstances or abandonInstances methods. Resizing the group also changes this number.
				2416	"updatePolicy": { # The update policy for this managed instance group.
				2417	"instanceRedistributionType": "A String", # The instance redistribution policy for regional managed instance groups. Valid values are:
				2418	# - PROACTIVE (default): The group attempts to maintain an even distribution of VM instances across zones in the region.
				2419	# - NONE: For non-autoscaled groups, proactive redistribution is disabled.
yoshi-code-bot	73a0aa3	2021-05-25 00:30:03 -0700	[diff] [blame]	2420	"maxSurge": { # Encapsulates numeric value that can be either absolute or relative. # The maximum number of instances that can be created above the specified targetSize during the update process. This value can be either a fixed number or, if the group has 10 or more instances, a percentage. If you set a percentage, the number of instances is rounded if necessary. The default value for maxSurge is a fixed value equal to the number of zones in which the managed instance group operates.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2421	#
				2422	# At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxSurge.
				2423	"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.
				2424	#
				2425	#
				2426	# - If the value is fixed, then the calculated value is equal to the fixed value.
yoshi-code-bot	73a0aa3	2021-05-25 00:30:03 -0700	[diff] [blame]	2427	# - If the value is a percent, then the calculated value is percent/100 * targetSize. For example, the calculated value of a 80% of a managed instance group with 150 instances would be (80/100 * 150) = 120 VM instances. If there is a remainder, the number is rounded.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2428	"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.
				2429	"percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.
				2430	},
				2431	"maxUnavailable": { # Encapsulates numeric value that can be either absolute or relative. # The maximum number of instances that can be unavailable during the update process. An instance is considered available if all of the following conditions are satisfied:
				2432	#
				2433	#
				2434	# - The instance's status is RUNNING.
yoshi-code-bot	73a0aa3	2021-05-25 00:30:03 -0700	[diff] [blame]	2435	# - If there is a health check on the instance group, the instance's health check status must be HEALTHY at least once. If there is no health check on the group, then the instance only needs to have a status of RUNNING to be considered available. This value can be either a fixed number or, if the group has 10 or more instances, a percentage. If you set a percentage, the number of instances is rounded if necessary. The default value for maxUnavailable is a fixed value equal to the number of zones in which the managed instance group operates.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2436	#
				2437	# At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxUnavailable.
				2438	"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.
				2439	#
				2440	#
				2441	# - If the value is fixed, then the calculated value is equal to the fixed value.
yoshi-code-bot	73a0aa3	2021-05-25 00:30:03 -0700	[diff] [blame]	2442	# - If the value is a percent, then the calculated value is percent/100 * targetSize. For example, the calculated value of a 80% of a managed instance group with 150 instances would be (80/100 * 150) = 120 VM instances. If there is a remainder, the number is rounded.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2443	"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.
				2444	"percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.
				2445	},
				2446	"minReadySec": 42, # Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600].
				2447	"minimalAction": "A String", # Minimal action to be taken on an instance. You can specify either RESTART to restart existing instances or REPLACE to delete and create new instances from the target template. If you specify a RESTART, the Updater will attempt to perform that action only. However, if the Updater determines that the minimal action you specify is not enough to perform the update, it might perform a more disruptive action.
Anthonios Partheniou	10f4b67	2021-04-13 14:47:53 -0400	[diff] [blame]	2448	"mostDisruptiveAllowedAction": "A String", # Most disruptive action that is allowed to be taken on an instance. You can specify either NONE to forbid any actions, REFRESH to allow actions that do not need instance restart, RESTART to allow actions that can be applied without instance replacing or REPLACE to allow all possible actions. If the Updater determines that the minimal update action needed is more disruptive than most disruptive allowed action you specify it will not perform the update at all.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2449	"replacementMethod": "A String", # What action should be used to replace instances. See minimal_action.REPLACE
				2450	"type": "A String", # The type of update process. You can specify either PROACTIVE so that the instance group manager proactively executes actions in order to bring instances to their target versions or OPPORTUNISTIC so that no action is proactively executed but the update will be performed as part of other actions (for example, resizes or recreateInstances calls).
				2451	},
				2452	"versions": [ # Specifies the instance templates used by this managed instance group to create instances.
				2453	#
				2454	# Each version is defined by an instanceTemplate and a name. Every version can appear at most once per instance group. This field overrides the top-level instanceTemplate field. Read more about the relationships between these fields. Exactly one version must leave the targetSize field unset. That version will be applied to all remaining instances. For more information, read about canary updates.
				2455	{
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	2456	"instanceTemplate": "A String", # The URL of the instance template that is specified for this managed instance group. The group uses this template to create new instances in the managed instance group until the `targetSize` for this version is reached. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE; in those cases, existing instances are updated until the `targetSize` for this version is reached.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2457	"name": "A String", # Name of the version. Unique among all versions in the scope of this managed instance group.
				2458	"targetSize": { # Encapsulates numeric value that can be either absolute or relative. # Specifies the intended number of instances to be created from the instanceTemplate. The final number of instances created from the template will be equal to:
				2459	# - If expressed as a fixed number, the minimum of either targetSize.fixed or instanceGroupManager.targetSize is used.
yoshi-code-bot	73a0aa3	2021-05-25 00:30:03 -0700	[diff] [blame]	2460	# - if expressed as a percent, the targetSize would be (targetSize.percent/100 * InstanceGroupManager.targetSize) If there is a remainder, the number is rounded. If unset, this version will update any remaining instances not updated by another version. Read Starting a canary update for more information.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2461	"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.
				2462	#
				2463	#
				2464	# - If the value is fixed, then the calculated value is equal to the fixed value.
yoshi-code-bot	73a0aa3	2021-05-25 00:30:03 -0700	[diff] [blame]	2465	# - If the value is a percent, then the calculated value is percent/100 * targetSize. For example, the calculated value of a 80% of a managed instance group with 150 instances would be (80/100 * 150) = 120 VM instances. If there is a remainder, the number is rounded.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2466	"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.
				2467	"percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.
				2468	},
				2469	},
				2470	],
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	2471	"zone": "A String", # [Output Only] The URL of a zone where the managed instance group is located (for zonal resources).
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	2472	}
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	2473
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	2474	requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
				2475
				2476	For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
				2477
				2478	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	2479
				2480	Returns:
				2481	An object of the form:
				2482
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	2483	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	2484	#
				2485	# Google Compute Engine has three Operation resources:
				2486	#
				2487	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				2488	#
				2489	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				2490	#
				2491	# Operations can be global, regional or zonal.
				2492	# - For global operations, use the `globalOperations` resource.
				2493	# - For regional operations, use the `regionOperations` resource.
				2494	# - For zonal operations, use the `zonalOperations` resource.
				2495	#
				2496	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				2497	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				2498	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				2499	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				2500	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				2501	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				2502	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2503	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	2504	"code": "A String", # [Output Only] The error type identifier for this error.
				2505	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				2506	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2507	},
				2508	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	2509	},
				2510	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				2511	"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.
				2512	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				2513	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				2514	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				2515	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	2516	"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	2517	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				2518	"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.
				2519	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				2520	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				2521	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				2522	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				2523	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				2524	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				2525	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
				2526	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				2527	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				2528	{
				2529	"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.
				2530	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				2531	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				2532	{
				2533	"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).
				2534	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				2535	},
				2536	],
				2537	"message": "A String", # [Output Only] A human-readable description of the warning code.
				2538	},
				2539	],
				2540	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				2541	}</pre>
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	2542	</div>
				2543
				2544	<div class="method">
				2545	<code class="details" id="updatePerInstanceConfigs">updatePerInstanceConfigs(project, region, instanceGroupManager, body=None, requestId=None)</code>
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	2546	<pre>Inserts or updates per-instance configs for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	2547
				2548	Args:
				2549	project: string, Project ID for this request. (required)
				2550	region: string, Name of the region scoping this request, should conform to RFC1035. (required)
				2551	instanceGroupManager: string, The name of the managed instance group. It should conform to RFC1035. (required)
				2552	body: object, The request body.
				2553	The object takes the form of:
				2554
				2555	{ # RegionInstanceGroupManagers.updatePerInstanceConfigs
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	2556	"perInstanceConfigs": [ # The list of per-instance configs to insert or patch on this managed instance group.
				2557	{
				2558	"fingerprint": "A String", # Fingerprint of this per-instance config. This field can be used in optimistic locking. It is ignored when inserting a per-instance config. An up-to-date fingerprint must be provided in order to update an existing per-instance config or the field needs to be unset.
				2559	"name": "A String", # The name of a per-instance config and its corresponding instance. Serves as a merge key during UpdatePerInstanceConfigs operations, that is, if a per-instance config with the same name exists then it will be updated, otherwise a new one will be created for the VM instance with the same name. An attempt to create a per-instance config for a VM instance that either doesn't exist or is not part of the group will result in an error.
				2560	"preservedState": { # Preserved state for a given instance. # The intended preserved state for the given instance. Does not contain preserved state generated from a stateful policy.
				2561	"disks": { # Preserved disks defined for this instance. This map is keyed with the device names of the disks.
				2562	"a_key": {
				2563	"autoDelete": "A String", # These stateful disks will never be deleted during autohealing, update, instance recreate operations. This flag is used to configure if the disk should be deleted after it is no longer used by the group, e.g. when the given instance or the whole MIG is deleted. Note: disks attached in READ_ONLY mode cannot be auto-deleted.
				2564	"mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
				2565	"source": "A String", # The URL of the disk resource that is stateful and should be attached to the VM instance.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	2566	},
				2567	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	2568	"metadata": { # Preserved metadata defined for this instance.
				2569	"a_key": "A String",
				2570	},
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	2571	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	2572	"status": "A String", # The status of applying this per-instance config on the corresponding managed instance.
				2573	},
				2574	],
				2575	}
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	2576
				2577	requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
				2578
				2579	For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
				2580
				2581	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
				2582
				2583	Returns:
				2584	An object of the form:
				2585
				2586	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	2587	#
				2588	# Google Compute Engine has three Operation resources:
				2589	#
				2590	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				2591	#
				2592	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				2593	#
				2594	# Operations can be global, regional or zonal.
				2595	# - For global operations, use the `globalOperations` resource.
				2596	# - For regional operations, use the `regionOperations` resource.
				2597	# - For zonal operations, use the `zonalOperations` resource.
				2598	#
				2599	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				2600	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				2601	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				2602	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				2603	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				2604	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				2605	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2606	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	2607	"code": "A String", # [Output Only] The error type identifier for this error.
				2608	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				2609	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2610	},
				2611	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	2612	},
				2613	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				2614	"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.
				2615	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				2616	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				2617	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				2618	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	2619	"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	2620	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				2621	"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.
				2622	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				2623	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				2624	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				2625	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				2626	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				2627	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				2628	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
				2629	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				2630	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				2631	{
				2632	"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.
				2633	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				2634	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				2635	{
				2636	"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).
				2637	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				2638	},
				2639	],
				2640	"message": "A String", # [Output Only] A human-readable description of the warning code.
				2641	},
				2642	],
				2643	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				2644	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	2645	</div>
				2646
				2647	</body></html>