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

blob: 1df74bf0b8b7e1bdcfbf45b80fa57c8ff3921ffb [file] [log] [blame]

Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[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_v1.html">Compute Engine API</a> . <a href="compute_v1.regionInstanceGroupManagers.html">regionInstanceGroupManagers</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
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>
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[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>
				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>
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[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>
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	95	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -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">
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[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>
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[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>
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[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>
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	116	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[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>
				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>
				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">
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[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>
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	131	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -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>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	134	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	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>
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[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>
				140	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	141	<code><a href="#setInstanceTemplate">setInstanceTemplate(project, region, instanceGroupManager, body=None, requestId=None)</a></code></p>
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	142	<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>
				143	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	144	<code><a href="#setTargetPools">setTargetPools(project, region, instanceGroupManager, body=None, requestId=None)</a></code></p>
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	145	<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>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	146	<p class="toc_element">
				147	<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]	148	<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>
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	149	<h3>Method Details</h3>
				150	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	151	<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]	152	<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.
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	153
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	154	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.
				155
				156	You can specify a maximum of 1000 instances with this method per request.
				157
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	158	Args:
				159	project: string, Project ID for this request. (required)
				160	region: string, Name of the region scoping this request. (required)
				161	instanceGroupManager: string, Name of the managed instance group. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	162	body: object, The request body.
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	163	The object takes the form of:
				164
				165	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	166	"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].
				167	"A String",
				168	],
				169	}
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	170
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	171	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.
				172
				173	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.
				174
				175	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	176
				177	Returns:
				178	An object of the form:
				179
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	180	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	181	#
				182	# Google Compute Engine has three Operation resources:
				183	#
				184	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				185	#
				186	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				187	#
				188	# Operations can be global, regional or zonal.
				189	# - For global operations, use the `globalOperations` resource.
				190	# - For regional operations, use the `regionOperations` resource.
				191	# - For zonal operations, use the `zonalOperations` resource.
				192	#
				193	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				194	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				195	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				196	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				197	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				198	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				199	"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]	200	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	201	"code": "A String", # [Output Only] The error type identifier for this error.
				202	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				203	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	204	},
				205	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	206	},
				207	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				208	"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.
				209	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				210	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				211	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				212	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	213	"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]	214	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				215	"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.
				216	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				217	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				218	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				219	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				220	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				221	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				222	"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.
				223	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				224	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				225	{
				226	"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.
				227	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				228	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				229	{
				230	"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).
				231	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				232	},
				233	],
				234	"message": "A String", # [Output Only] A human-readable description of the warning code.
				235	},
				236	],
				237	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				238	}</pre>
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	239	</div>
				240
				241	<div class="method">
				242	<code class="details" id="applyUpdatesToInstances">applyUpdatesToInstances(project, region, instanceGroupManager, body=None)</code>
				243	<pre>Apply updates to selected instances the managed instance group.
				244
				245	Args:
				246	project: string, Project ID for this request. (required)
				247	region: string, Name of the region scoping this request, should conform to RFC1035. (required)
				248	instanceGroupManager: string, The name of the managed instance group, should conform to RFC1035. (required)
				249	body: object, The request body.
				250	The object takes the form of:
				251
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	252	{ # RegionInstanceGroupManagers.applyUpdatesToInstances
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	253	"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.
				254	"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].
				255	"A String",
				256	],
				257	"minimalAction": "A String", # The minimal action that you want to perform on each instance during the update:
				258	# - REPLACE: At minimum, delete the instance and create it again.
				259	# - RESTART: Stop the instance and start it again.
				260	# - REFRESH: Do not stop the instance.
				261	# - 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.
				262	"mostDisruptiveAllowedAction": "A String", # The most disruptive action that you want to perform on each instance during the update:
				263	# - REPLACE: Delete the instance and create it again.
				264	# - RESTART: Stop the instance and start it again.
				265	# - REFRESH: Do not stop the instance.
				266	# - 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.
				267	}
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	268
				269
				270	Returns:
				271	An object of the form:
				272
				273	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	274	#
				275	# Google Compute Engine has three Operation resources:
				276	#
				277	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				278	#
				279	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				280	#
				281	# Operations can be global, regional or zonal.
				282	# - For global operations, use the `globalOperations` resource.
				283	# - For regional operations, use the `regionOperations` resource.
				284	# - For zonal operations, use the `zonalOperations` resource.
				285	#
				286	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				287	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				288	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				289	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				290	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				291	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				292	"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]	293	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	294	"code": "A String", # [Output Only] The error type identifier for this error.
				295	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				296	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	297	},
				298	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	299	},
				300	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				301	"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.
				302	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				303	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				304	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				305	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	306	"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]	307	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				308	"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.
				309	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				310	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				311	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				312	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				313	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				314	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				315	"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.
				316	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				317	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				318	{
				319	"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.
				320	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				321	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				322	{
				323	"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).
				324	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				325	},
				326	],
				327	"message": "A String", # [Output Only] A human-readable description of the warning code.
				328	},
				329	],
				330	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				331	}</pre>
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	332	</div>
				333
				334	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	335	<code class="details" id="close">close()</code>
				336	<pre>Close httplib2 connections.</pre>
				337	</div>
				338
				339	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	340	<code class="details" id="createInstances">createInstances(project, region, instanceGroupManager, body=None, requestId=None)</code>
				341	<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.
				342
				343	Args:
				344	project: string, Project ID for this request. (required)
				345	region: string, The name of the region where the managed instance group is located. It should conform to RFC1035. (required)
				346	instanceGroupManager: string, The name of the managed instance group. It should conform to RFC1035. (required)
				347	body: object, The request body.
				348	The object takes the form of:
				349
				350	{ # RegionInstanceGroupManagers.createInstances
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	351	"instances": [ # [Required] List of specifications of per-instance configs.
				352	{
				353	"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.
				354	"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.
				355	"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.
				356	"disks": { # Preserved disks defined for this instance. This map is keyed with the device names of the disks.
				357	"a_key": {
				358	"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.
				359	"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.
				360	"source": "A String", # The URL of the disk resource that is stateful and should be attached to the VM instance.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	361	},
				362	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	363	"metadata": { # Preserved metadata defined for this instance.
				364	"a_key": "A String",
				365	},
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	366	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	367	"status": "A String", # The status of applying this per-instance config on the corresponding managed instance.
				368	},
				369	],
				370	}
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	371
				372	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.
				373
				374	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.
				375
				376	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
				377
				378	Returns:
				379	An object of the form:
				380
				381	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	382	#
				383	# Google Compute Engine has three Operation resources:
				384	#
				385	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				386	#
				387	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				388	#
				389	# Operations can be global, regional or zonal.
				390	# - For global operations, use the `globalOperations` resource.
				391	# - For regional operations, use the `regionOperations` resource.
				392	# - For zonal operations, use the `zonalOperations` resource.
				393	#
				394	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				395	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				396	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				397	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				398	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				399	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				400	"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]	401	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	402	"code": "A String", # [Output Only] The error type identifier for this error.
				403	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				404	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	405	},
				406	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	407	},
				408	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				409	"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.
				410	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				411	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				412	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				413	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	414	"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]	415	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				416	"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.
				417	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				418	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				419	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				420	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				421	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				422	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				423	"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.
				424	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				425	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				426	{
				427	"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
				428	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				429	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				430	{
				431	"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).
				432	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				433	},
				434	],
				435	"message": "A String", # [Output Only] A human-readable description of the warning code.
				436	},
				437	],
				438	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				439	}</pre>
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	440	</div>
				441
				442	<div class="method">
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	443	<code class="details" id="delete">delete(project, region, instanceGroupManager, requestId=None)</code>
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	444	<pre>Deletes the specified managed instance group and all of the instances in that group.
				445
				446	Args:
				447	project: string, Project ID for this request. (required)
				448	region: string, Name of the region scoping this request. (required)
				449	instanceGroupManager: string, Name of the managed instance group to delete. (required)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	450	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.
				451
				452	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.
				453
				454	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	455
				456	Returns:
				457	An object of the form:
				458
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	459	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	460	#
				461	# Google Compute Engine has three Operation resources:
				462	#
				463	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				464	#
				465	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				466	#
				467	# Operations can be global, regional or zonal.
				468	# - For global operations, use the `globalOperations` resource.
				469	# - For regional operations, use the `regionOperations` resource.
				470	# - For zonal operations, use the `zonalOperations` resource.
				471	#
				472	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				473	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				474	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				475	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				476	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				477	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				478	"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]	479	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	480	"code": "A String", # [Output Only] The error type identifier for this error.
				481	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				482	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	483	},
				484	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	485	},
				486	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				487	"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.
				488	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				489	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				490	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				491	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	492	"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]	493	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				494	"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.
				495	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				496	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				497	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				498	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				499	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				500	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				501	"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.
				502	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				503	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				504	{
				505	"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.
				506	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				507	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				508	{
				509	"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).
				510	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				511	},
				512	],
				513	"message": "A String", # [Output Only] A human-readable description of the warning code.
				514	},
				515	],
				516	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				517	}</pre>
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	518	</div>
				519
				520	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	521	<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]	522	<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.
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	523
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	524	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.
				525
				526	You can specify a maximum of 1000 instances with this method per request.
				527
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	528	Args:
				529	project: string, Project ID for this request. (required)
				530	region: string, Name of the region scoping this request. (required)
				531	instanceGroupManager: string, Name of the managed instance group. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	532	body: object, The request body.
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	533	The object takes the form of:
				534
				535	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	536	"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].
				537	"A String",
				538	],
				539	}
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	540
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	541	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.
				542
				543	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.
				544
				545	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	546
				547	Returns:
				548	An object of the form:
				549
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	550	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	551	#
				552	# Google Compute Engine has three Operation resources:
				553	#
				554	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				555	#
				556	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				557	#
				558	# Operations can be global, regional or zonal.
				559	# - For global operations, use the `globalOperations` resource.
				560	# - For regional operations, use the `regionOperations` resource.
				561	# - For zonal operations, use the `zonalOperations` resource.
				562	#
				563	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				564	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				565	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				566	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				567	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				568	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				569	"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]	570	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	571	"code": "A String", # [Output Only] The error type identifier for this error.
				572	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				573	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	574	},
				575	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	576	},
				577	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				578	"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.
				579	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				580	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				581	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				582	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	583	"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]	584	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				585	"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.
				586	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				587	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				588	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				589	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				590	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				591	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				592	"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.
				593	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				594	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				595	{
				596	"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.
				597	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				598	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				599	{
				600	"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).
				601	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				602	},
				603	],
				604	"message": "A String", # [Output Only] A human-readable description of the warning code.
				605	},
				606	],
				607	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				608	}</pre>
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	609	</div>
				610
				611	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	612	<code class="details" id="deletePerInstanceConfigs">deletePerInstanceConfigs(project, region, instanceGroupManager, body=None)</code>
				613	<pre>Deletes selected per-instance configs for the managed instance group.
				614
				615	Args:
				616	project: string, Project ID for this request. (required)
				617	region: string, Name of the region scoping this request, should conform to RFC1035. (required)
				618	instanceGroupManager: string, The name of the managed instance group. It should conform to RFC1035. (required)
				619	body: object, The request body.
				620	The object takes the form of:
				621
				622	{ # RegionInstanceGroupManagers.deletePerInstanceConfigs
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	623	"names": [ # The list of instance names for which we want to delete per-instance configs on this managed instance group.
				624	"A String",
				625	],
				626	}
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	627
				628
				629	Returns:
				630	An object of the form:
				631
				632	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	633	#
				634	# Google Compute Engine has three Operation resources:
				635	#
				636	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				637	#
				638	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				639	#
				640	# Operations can be global, regional or zonal.
				641	# - For global operations, use the `globalOperations` resource.
				642	# - For regional operations, use the `regionOperations` resource.
				643	# - For zonal operations, use the `zonalOperations` resource.
				644	#
				645	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				646	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				647	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				648	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				649	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				650	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				651	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	652	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	653	"code": "A String", # [Output Only] The error type identifier for this error.
				654	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				655	"message": "A String", # [Output Only] An optional, human-readable error message.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	656	},
				657	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	658	},
				659	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				660	"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.
				661	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				662	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				663	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				664	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	665	"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]	666	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				667	"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.
				668	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				669	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				670	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				671	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				672	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				673	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				674	"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.
				675	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				676	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				677	{
				678	"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.
				679	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				680	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				681	{
				682	"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).
				683	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				684	},
				685	],
				686	"message": "A String", # [Output Only] A human-readable description of the warning code.
				687	},
				688	],
				689	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				690	}</pre>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	691	</div>
				692
				693	<div class="method">
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	694	<code class="details" id="get">get(project, region, instanceGroupManager)</code>
				695	<pre>Returns all of the details about the specified managed instance group.
				696
				697	Args:
				698	project: string, Project ID for this request. (required)
				699	region: string, Name of the region scoping this request. (required)
				700	instanceGroupManager: string, Name of the managed instance group to return. (required)
				701
				702	Returns:
				703	An object of the form:
				704
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	705	{ # Represents a Managed Instance Group resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	706	#
				707	# An instance group is a collection of VM instances that you can manage as a single entity. For more information, read Instance groups.
				708	#
				709	# For zonal Managed Instance Group, use the instanceGroupManagers resource.
				710	#
				711	# For regional Managed Instance Group, use the regionInstanceGroupManagers resource. (== resource_for {$api_version}.instanceGroupManagers ==) (== resource_for {$api_version}.regionInstanceGroupManagers ==)
				712	"autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.
				713	{
				714	"healthCheck": "A String", # The URL for the health check that signals autohealing.
				715	"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	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	716	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	717	],
				718	"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.
				719	"creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
				720	"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.
				721	"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.
				722	"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]	723	#
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	724	# If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.
				725	"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.
				726	"deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
				727	"none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
				728	"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.
				729	"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.
				730	"restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
				731	"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.
				732	},
				733	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				734	"distributionPolicy": { # Policy specifying the intended distribution of managed instances across zones in a regional managed instance group.
Anthonios Partheniou	10f4b67	2021-04-13 14:47:53 -0400	[diff] [blame^]	735	"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]	736	"zones": [ # Zones where the regional managed instance group will create and manage its instances.
				737	{
				738	"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]	739	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	740	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	741	},
				742	"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.
				743	#
				744	# To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager.
				745	"id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
				746	"instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
				747	"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.
				748	"kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
				749	"name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.
				750	"namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
				751	{ # The named port. For example: .
				752	"name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
				753	"port": 42, # The port number, which can be a value between 1 and 65535.
				754	},
				755	],
				756	"region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).
				757	"selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
				758	"statefulPolicy": { # Stateful configuration for this Instanced Group Manager
				759	"preservedState": { # Configuration of preserved resources.
				760	"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.
				761	"a_key": {
				762	"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.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	763	},
				764	},
				765	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	766	},
				767	"status": { # [Output Only] The status of this managed instance group.
				768	"autoscaler": "A String", # [Output Only] The URL of the Autoscaler that targets this instance group manager.
				769	"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.
				770	"stateful": { # [Output Only] Stateful status of the given Instance Group Manager.
				771	"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.
				772	"perInstanceConfigs": { # [Output Only] Status of per-instance configs on the instance.
				773	"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]	774	},
				775	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	776	"versionTarget": { # [Output Only] A status of consistency of Instances' versions with their target version specified by version field on Instance Group Manager.
				777	"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.
				778	},
				779	},
				780	"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.
				781	"A String",
				782	],
				783	"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.
				784	"updatePolicy": { # The update policy for this managed instance group.
				785	"instanceRedistributionType": "A String", # The instance redistribution policy for regional managed instance groups. Valid values are:
				786	# - PROACTIVE (default): The group attempts to maintain an even distribution of VM instances across zones in the region.
				787	# - NONE: For non-autoscaled groups, proactive redistribution is disabled.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	788	"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 up 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]	789	#
				790	# At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxSurge.
				791	"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]	792	#
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	793	#
				794	# - If the value is fixed, then the calculated value is equal to the fixed value.
				795	# - 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 up.
				796	"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.
				797	"percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.
				798	},
				799	"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:
				800	#
				801	#
				802	# - The instance's status is RUNNING.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	803	# - 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 up 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]	804	#
				805	# At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxUnavailable.
				806	"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.
				807	#
				808	#
				809	# - If the value is fixed, then the calculated value is equal to the fixed value.
				810	# - 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 up.
				811	"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.
				812	"percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.
				813	},
				814	"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.
				815	"replacementMethod": "A String", # What action should be used to replace instances. See minimal_action.REPLACE
				816	"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).
				817	},
				818	"versions": [ # Specifies the instance templates used by this managed instance group to create instances.
				819	#
				820	# 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.
				821	{
				822	"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.
				823	"name": "A String", # Name of the version. Unique among all versions in the scope of this managed instance group.
				824	"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:
				825	# - If expressed as a fixed number, the minimum of either targetSize.fixed or instanceGroupManager.targetSize is used.
				826	# - if expressed as a percent, the targetSize would be (targetSize.percent/100 * InstanceGroupManager.targetSize) If there is a remainder, the number is rounded up. 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]	827	"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	828	#
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	829	#
				830	# - If the value is fixed, then the calculated value is equal to the fixed value.
				831	# - 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 up.
				832	"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.
				833	"percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.
				834	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	835	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	836	],
				837	"zone": "A String", # [Output Only] The URL of a zone where the managed instance group is located (for zonal resources).
				838	}</pre>
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	839	</div>
				840
				841	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	842	<code class="details" id="insert">insert(project, region, body=None, requestId=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	843	<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.
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	844
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	845	A regional managed instance group can contain up to 2000 instances.
				846
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	847	Args:
				848	project: string, Project ID for this request. (required)
				849	region: string, Name of the region scoping this request. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	850	body: object, The request body.
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	851	The object takes the form of:
				852
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	853	{ # Represents a Managed Instance Group resource.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	854	#
				855	# An instance group is a collection of VM instances that you can manage as a single entity. For more information, read Instance groups.
				856	#
				857	# For zonal Managed Instance Group, use the instanceGroupManagers resource.
				858	#
				859	# For regional Managed Instance Group, use the regionInstanceGroupManagers resource. (== resource_for {$api_version}.instanceGroupManagers ==) (== resource_for {$api_version}.regionInstanceGroupManagers ==)
				860	"autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.
				861	{
				862	"healthCheck": "A String", # The URL for the health check that signals autohealing.
				863	"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]	864	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	865	],
				866	"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.
				867	"creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
				868	"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.
				869	"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.
				870	"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.
				871	#
				872	# If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.
				873	"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.
				874	"deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
				875	"none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
				876	"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.
				877	"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.
				878	"restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
				879	"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.
				880	},
				881	"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]	882	"distributionPolicy": { # Policy specifying the intended distribution of managed instances across zones in a regional managed instance group.
Anthonios Partheniou	10f4b67	2021-04-13 14:47:53 -0400	[diff] [blame^]	883	"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]	884	"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]	885	{
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	886	"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]	887	},
				888	],
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	889	},
				890	"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.
				891	#
				892	# To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager.
				893	"id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
				894	"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]	895	"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]	896	"kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
				897	"name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.
				898	"namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
				899	{ # The named port. For example: .
				900	"name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
				901	"port": 42, # The port number, which can be a value between 1 and 65535.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	902	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	903	],
				904	"region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).
				905	"selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	906	"statefulPolicy": { # Stateful configuration for this Instanced Group Manager
				907	"preservedState": { # Configuration of preserved resources.
				908	"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.
				909	"a_key": {
				910	"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.
				911	},
				912	},
				913	},
				914	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	915	"status": { # [Output Only] The status of this managed instance group.
				916	"autoscaler": "A String", # [Output Only] The URL of the Autoscaler that targets this instance group manager.
				917	"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.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	918	"stateful": { # [Output Only] Stateful status of the given Instance Group Manager.
				919	"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.
				920	"perInstanceConfigs": { # [Output Only] Status of per-instance configs on the instance.
				921	"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.
				922	},
				923	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	924	"versionTarget": { # [Output Only] A status of consistency of Instances' versions with their target version specified by version field on Instance Group Manager.
				925	"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.
				926	},
				927	},
				928	"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.
				929	"A String",
				930	],
				931	"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.
				932	"updatePolicy": { # The update policy for this managed instance group.
				933	"instanceRedistributionType": "A String", # The instance redistribution policy for regional managed instance groups. Valid values are:
				934	# - PROACTIVE (default): The group attempts to maintain an even distribution of VM instances across zones in the region.
				935	# - NONE: For non-autoscaled groups, proactive redistribution is disabled.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	936	"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 up 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]	937	#
				938	# At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxSurge.
				939	"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	940	#
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	941	#
				942	# - If the value is fixed, then the calculated value is equal to the fixed value.
				943	# - 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 up.
				944	"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.
				945	"percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.
				946	},
				947	"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:
				948	#
				949	#
				950	# - The instance's status is RUNNING.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	951	# - 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 up 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]	952	#
				953	# At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxUnavailable.
				954	"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.
				955	#
				956	#
				957	# - If the value is fixed, then the calculated value is equal to the fixed value.
				958	# - 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 up.
				959	"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.
				960	"percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.
				961	},
				962	"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.
				963	"replacementMethod": "A String", # What action should be used to replace instances. See minimal_action.REPLACE
				964	"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).
				965	},
				966	"versions": [ # Specifies the instance templates used by this managed instance group to create instances.
				967	#
				968	# 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.
				969	{
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	970	"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]	971	"name": "A String", # Name of the version. Unique among all versions in the scope of this managed instance group.
				972	"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:
				973	# - If expressed as a fixed number, the minimum of either targetSize.fixed or instanceGroupManager.targetSize is used.
				974	# - if expressed as a percent, the targetSize would be (targetSize.percent/100 * InstanceGroupManager.targetSize) If there is a remainder, the number is rounded up. If unset, this version will update any remaining instances not updated by another version. Read Starting a canary update for more information.
				975	"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	976	#
				977	#
				978	# - If the value is fixed, then the calculated value is equal to the fixed value.
				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 up.
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%.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	982	},
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	983	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	984	],
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	985	"zone": "A String", # [Output Only] The URL of a zone where the managed instance group is located (for zonal resources).
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	986	}
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	987
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	988	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.
				989
				990	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.
				991
				992	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	993
				994	Returns:
				995	An object of the form:
				996
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	997	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	998	#
				999	# Google Compute Engine has three Operation resources:
				1000	#
				1001	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				1002	#
				1003	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				1004	#
				1005	# Operations can be global, regional or zonal.
				1006	# - For global operations, use the `globalOperations` resource.
				1007	# - For regional operations, use the `regionOperations` resource.
				1008	# - For zonal operations, use the `zonalOperations` resource.
				1009	#
				1010	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				1011	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				1012	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				1013	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				1014	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				1015	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				1016	"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]	1017	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1018	"code": "A String", # [Output Only] The error type identifier for this error.
				1019	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				1020	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1021	},
				1022	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1023	},
				1024	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				1025	"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.
				1026	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				1027	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				1028	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				1029	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1030	"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]	1031	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				1032	"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.
				1033	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				1034	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				1035	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				1036	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				1037	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				1038	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				1039	"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.
				1040	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				1041	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				1042	{
				1043	"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.
				1044	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				1045	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				1046	{
				1047	"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).
				1048	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				1049	},
				1050	],
				1051	"message": "A String", # [Output Only] A human-readable description of the warning code.
				1052	},
				1053	],
				1054	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				1055	}</pre>
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	1056	</div>
				1057
				1058	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	1059	<code class="details" id="list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	1060	<pre>Retrieves the list of managed instance groups that are contained within the specified region.
				1061
				1062	Args:
				1063	project: string, Project ID for this request. (required)
				1064	region: string, Name of the region scoping this request. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	1065	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 `<`.
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	1066
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	1067	For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	1068
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	1069	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.
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	1070
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1071	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) ```
				1072	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`)
				1073	orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
				1074
				1075	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.
				1076
				1077	Currently, only sorting by `name` or `creationTimestamp desc` is supported.
				1078	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]	1079	returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	1080
				1081	Returns:
				1082	An object of the form:
				1083
				1084	{ # Contains a list of managed instance groups.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1085	"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
				1086	"items": [ # A list of InstanceGroupManager resources.
				1087	{ # Represents a Managed Instance Group resource.
				1088	#
				1089	# An instance group is a collection of VM instances that you can manage as a single entity. For more information, read Instance groups.
				1090	#
				1091	# For zonal Managed Instance Group, use the instanceGroupManagers resource.
				1092	#
				1093	# For regional Managed Instance Group, use the regionInstanceGroupManagers resource. (== resource_for {$api_version}.instanceGroupManagers ==) (== resource_for {$api_version}.regionInstanceGroupManagers ==)
				1094	"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]	1095	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1096	"healthCheck": "A String", # The URL for the health check that signals autohealing.
				1097	"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]	1098	},
				1099	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1100	"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.
				1101	"creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
				1102	"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.
				1103	"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.
				1104	"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.
				1105	#
				1106	# If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.
				1107	"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.
				1108	"deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
				1109	"none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
				1110	"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.
				1111	"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.
				1112	"restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
				1113	"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.
				1114	},
				1115	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				1116	"distributionPolicy": { # Policy specifying the intended distribution of managed instances across zones in a regional managed instance group.
Anthonios Partheniou	10f4b67	2021-04-13 14:47:53 -0400	[diff] [blame^]	1117	"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]	1118	"zones": [ # Zones where the regional managed instance group will create and manage its instances.
				1119	{
				1120	"zone": "A String", # The URL of the zone. The zone must exist in the region where the managed instance group is located.
				1121	},
				1122	],
				1123	},
				1124	"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.
				1125	#
				1126	# To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager.
				1127	"id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
				1128	"instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
				1129	"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.
				1130	"kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
				1131	"name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.
				1132	"namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
				1133	{ # The named port. For example: .
				1134	"name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
				1135	"port": 42, # The port number, which can be a value between 1 and 65535.
				1136	},
				1137	],
				1138	"region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).
				1139	"selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
				1140	"statefulPolicy": { # Stateful configuration for this Instanced Group Manager
				1141	"preservedState": { # Configuration of preserved resources.
				1142	"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.
				1143	"a_key": {
				1144	"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.
				1145	},
				1146	},
				1147	},
				1148	},
				1149	"status": { # [Output Only] The status of this managed instance group.
				1150	"autoscaler": "A String", # [Output Only] The URL of the Autoscaler that targets this instance group manager.
				1151	"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.
				1152	"stateful": { # [Output Only] Stateful status of the given Instance Group Manager.
				1153	"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.
				1154	"perInstanceConfigs": { # [Output Only] Status of per-instance configs on the instance.
				1155	"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.
				1156	},
				1157	},
				1158	"versionTarget": { # [Output Only] A status of consistency of Instances' versions with their target version specified by version field on Instance Group Manager.
				1159	"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.
				1160	},
				1161	},
				1162	"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.
				1163	"A String",
				1164	],
				1165	"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.
				1166	"updatePolicy": { # The update policy for this managed instance group.
				1167	"instanceRedistributionType": "A String", # The instance redistribution policy for regional managed instance groups. Valid values are:
				1168	# - PROACTIVE (default): The group attempts to maintain an even distribution of VM instances across zones in the region.
				1169	# - NONE: For non-autoscaled groups, proactive redistribution is disabled.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1170	"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 up 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]	1171	#
				1172	# At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxSurge.
				1173	"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.
				1174	#
				1175	#
				1176	# - If the value is fixed, then the calculated value is equal to the fixed value.
				1177	# - 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 up.
				1178	"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.
				1179	"percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.
				1180	},
				1181	"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:
				1182	#
				1183	#
				1184	# - The instance's status is RUNNING.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1185	# - 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 up 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]	1186	#
				1187	# At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxUnavailable.
				1188	"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.
				1189	#
				1190	#
				1191	# - If the value is fixed, then the calculated value is equal to the fixed value.
				1192	# - 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 up.
				1193	"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.
				1194	"percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.
				1195	},
				1196	"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.
				1197	"replacementMethod": "A String", # What action should be used to replace instances. See minimal_action.REPLACE
				1198	"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).
				1199	},
				1200	"versions": [ # Specifies the instance templates used by this managed instance group to create instances.
				1201	#
				1202	# 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.
				1203	{
				1204	"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.
				1205	"name": "A String", # Name of the version. Unique among all versions in the scope of this managed instance group.
				1206	"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:
				1207	# - If expressed as a fixed number, the minimum of either targetSize.fixed or instanceGroupManager.targetSize is used.
				1208	# - if expressed as a percent, the targetSize would be (targetSize.percent/100 * InstanceGroupManager.targetSize) If there is a remainder, the number is rounded up. If unset, this version will update any remaining instances not updated by another version. Read Starting a canary update for more information.
				1209	"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.
				1210	#
				1211	#
				1212	# - If the value is fixed, then the calculated value is equal to the fixed value.
				1213	# - 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 up.
				1214	"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.
				1215	"percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.
				1216	},
				1217	},
				1218	],
				1219	"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]	1220	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1221	],
				1222	"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.
				1223	"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.
				1224	"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
				1225	"warning": { # [Output Only] Informational warning message.
				1226	"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.
				1227	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				1228	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				1229	{
				1230	"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).
				1231	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				1232	},
				1233	],
				1234	"message": "A String", # [Output Only] A human-readable description of the warning code.
				1235	},
				1236	}</pre>
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	1237	</div>
				1238
				1239	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	1240	<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]	1241	<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]	1242
				1243	Args:
				1244	project: string, Project ID for this request. (required)
				1245	region: string, Name of the region scoping this request. This should conform to RFC1035. (required)
				1246	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]	1247	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 `<`.
				1248
				1249	For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
				1250
				1251	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.
				1252
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1253	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) ```
				1254	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`)
				1255	orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
				1256
				1257	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.
				1258
				1259	Currently, only sorting by `name` or `creationTimestamp desc` is supported.
				1260	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]	1261	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]	1262
				1263	Returns:
				1264	An object of the form:
				1265
				1266	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1267	"items": [ # [Output Only] The list of errors of the managed instance group.
				1268	{
				1269	"error": { # [Output Only] Contents of the error.
				1270	"code": "A String", # [Output Only] Error code.
				1271	"message": "A String", # [Output Only] Error message.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	1272	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1273	"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.
				1274	"action": "A String", # [Output Only] Action that managed instance group was executing on the instance when the error occurred. Possible values:
				1275	"instance": "A String", # [Output Only] The URL of the instance. The URL can be set even if the instance has not yet been created.
				1276	"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.
				1277	"instanceTemplate": "A String", # [Output Only] The intended template of the instance. This field is empty when current_action is one of { DELETING, ABANDONING }.
				1278	"name": "A String", # [Output Only] Name of the version.
				1279	},
				1280	},
				1281	"timestamp": "A String", # [Output Only] The time that this error occurred. This value is in RFC3339 text format.
				1282	},
				1283	],
				1284	"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.
				1285	}</pre>
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	1286	</div>
				1287
				1288	<div class="method">
				1289	<code class="details" id="listErrors_next">listErrors_next(previous_request, previous_response)</code>
				1290	<pre>Retrieves the next page of results.
				1291
				1292	Args:
				1293	previous_request: The request for the previous page. (required)
				1294	previous_response: The response from the request for the previous page. (required)
				1295
				1296	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1297	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]	1298	page. Returns None if there are no more items in the collection.
				1299	</pre>
				1300	</div>
				1301
				1302	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	1303	<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]	1304	<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.
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	1305
				1306	Args:
				1307	project: string, Project ID for this request. (required)
				1308	region: string, Name of the region scoping this request. (required)
				1309	instanceGroupManager: string, The name of the managed instance group. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	1310	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]	1311
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	1312	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]	1313
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	1314	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]	1315
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1316	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) ```
				1317	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`)
				1318	orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
				1319
				1320	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.
				1321
				1322	Currently, only sorting by `name` or `creationTimestamp desc` is supported.
				1323	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]	1324	returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	1325
				1326	Returns:
				1327	An object of the form:
				1328
				1329	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1330	"managedInstances": [ # A list of managed instances.
				1331	{ # A Managed Instance resource.
				1332	"currentAction": "A String", # [Output Only] The current action that the managed instance group has scheduled for the instance. Possible values:
				1333	# - NONE The instance is running, and the managed instance group does not have any scheduled actions for this instance.
				1334	# - 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.
				1335	# - 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.
				1336	# - RECREATING The managed instance group is recreating this instance.
				1337	# - DELETING The managed instance group is permanently deleting this instance.
				1338	# - 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.
				1339	# - RESTARTING The managed instance group is restarting the instance.
				1340	# - 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.
				1341	# - VERIFYING The managed instance group has created the instance and it is in the process of being verified.
				1342	"id": "A String", # [Output only] The unique identifier for this resource. This field is empty when instance does not exist.
				1343	"instance": "A String", # [Output Only] The URL of the instance. The URL can exist even if the instance has not yet been created.
				1344	"instanceHealth": [ # [Output Only] Health state of the instance per health-check.
				1345	{
				1346	"detailedHealthState": "A String", # [Output Only] The current detailed instance health state.
				1347	"healthCheck": "A String", # [Output Only] The URL for the health check that verifies whether the instance is healthy.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1348	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1349	],
				1350	"instanceStatus": "A String", # [Output Only] The status of the instance. This field is empty when the instance does not exist.
				1351	"lastAttempt": { # [Output Only] Information about the last attempt to create or delete the instance.
				1352	"errors": { # [Output Only] Encountered errors during the last attempt to create or delete the instance.
				1353	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
				1354	{
				1355	"code": "A String", # [Output Only] The error type identifier for this error.
				1356	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				1357	"message": "A String", # [Output Only] An optional, human-readable error message.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	1358	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1359	],
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1360	},
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	1361	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1362	"preservedStateFromConfig": { # Preserved state for a given instance. # [Output Only] Preserved state applied from per-instance config for this instance.
				1363	"disks": { # Preserved disks defined for this instance. This map is keyed with the device names of the disks.
				1364	"a_key": {
				1365	"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.
				1366	"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.
				1367	"source": "A String", # The URL of the disk resource that is stateful and should be attached to the VM instance.
				1368	},
				1369	},
				1370	"metadata": { # Preserved metadata defined for this instance.
				1371	"a_key": "A String",
				1372	},
				1373	},
				1374	"preservedStateFromPolicy": { # Preserved state for a given instance. # [Output Only] Preserved state generated based on stateful policy for this instance.
				1375	"disks": { # Preserved disks defined for this instance. This map is keyed with the device names of the disks.
				1376	"a_key": {
				1377	"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.
				1378	"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.
				1379	"source": "A String", # The URL of the disk resource that is stateful and should be attached to the VM instance.
				1380	},
				1381	},
				1382	"metadata": { # Preserved metadata defined for this instance.
				1383	"a_key": "A String",
				1384	},
				1385	},
				1386	"version": { # [Output Only] Intended version of this instance.
				1387	"instanceTemplate": "A String", # [Output Only] The intended template of the instance. This field is empty when current_action is one of { DELETING, ABANDONING }.
				1388	"name": "A String", # [Output Only] Name of the version.
				1389	},
				1390	},
				1391	],
				1392	"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.
				1393	}</pre>
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	1394	</div>
				1395
				1396	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	1397	<code class="details" id="listManagedInstances_next">listManagedInstances_next(previous_request, previous_response)</code>
				1398	<pre>Retrieves the next page of results.
				1399
				1400	Args:
				1401	previous_request: The request for the previous page. (required)
				1402	previous_response: The response from the request for the previous page. (required)
				1403
				1404	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1405	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]	1406	page. Returns None if there are no more items in the collection.
				1407	</pre>
				1408	</div>
				1409
				1410	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	1411	<code class="details" id="listPerInstanceConfigs">listPerInstanceConfigs(project, region, instanceGroupManager, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>
				1412	<pre>Lists all of the per-instance configs defined for the managed instance group. The orderBy query parameter is not supported.
				1413
				1414	Args:
				1415	project: string, Project ID for this request. (required)
				1416	region: string, Name of the region scoping this request, should conform to RFC1035. (required)
				1417	instanceGroupManager: string, The name of the managed instance group. It should conform to RFC1035. (required)
				1418	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 `<`.
				1419
				1420	For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
				1421
				1422	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.
				1423
				1424	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) ```
				1425	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`)
				1426	orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
				1427
				1428	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.
				1429
				1430	Currently, only sorting by `name` or `creationTimestamp desc` is supported.
				1431	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]	1432	returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	1433
				1434	Returns:
				1435	An object of the form:
				1436
				1437	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1438	"items": [ # [Output Only] The list of PerInstanceConfig.
				1439	{
				1440	"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.
				1441	"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.
				1442	"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.
				1443	"disks": { # Preserved disks defined for this instance. This map is keyed with the device names of the disks.
				1444	"a_key": {
				1445	"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.
				1446	"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.
				1447	"source": "A String", # The URL of the disk resource that is stateful and should be attached to the VM instance.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	1448	},
				1449	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1450	"metadata": { # Preserved metadata defined for this instance.
				1451	"a_key": "A String",
				1452	},
				1453	},
				1454	"status": "A String", # The status of applying this per-instance config on the corresponding managed instance.
				1455	},
				1456	],
				1457	"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.
				1458	"warning": { # [Output Only] Informational warning message.
				1459	"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.
				1460	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				1461	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				1462	{
				1463	"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).
				1464	"value": "A String", # [Output Only] A warning data value corresponding to the key.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	1465	},
				1466	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1467	"message": "A String", # [Output Only] A human-readable description of the warning code.
				1468	},
				1469	}</pre>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	1470	</div>
				1471
				1472	<div class="method">
				1473	<code class="details" id="listPerInstanceConfigs_next">listPerInstanceConfigs_next(previous_request, previous_response)</code>
				1474	<pre>Retrieves the next page of results.
				1475
				1476	Args:
				1477	previous_request: The request for the previous page. (required)
				1478	previous_response: The response from the request for the previous page. (required)
				1479
				1480	Returns:
				1481	A request object that you can call 'execute()' on to request the next
				1482	page. Returns None if there are no more items in the collection.
				1483	</pre>
				1484	</div>
				1485
				1486	<div class="method">
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	1487	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				1488	<pre>Retrieves the next page of results.
				1489
				1490	Args:
				1491	previous_request: The request for the previous page. (required)
				1492	previous_response: The response from the request for the previous page. (required)
				1493
				1494	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1495	A request object that you can call 'execute()' on to request the next
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	1496	page. Returns None if there are no more items in the collection.
				1497	</pre>
				1498	</div>
				1499
				1500	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	1501	<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]	1502	<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.
				1503
				1504	Args:
				1505	project: string, Project ID for this request. (required)
				1506	region: string, Name of the region scoping this request. (required)
				1507	instanceGroupManager: string, The name of the instance group manager. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	1508	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	1509	The object takes the form of:
				1510
				1511	{ # Represents a Managed Instance Group resource.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1512	#
				1513	# An instance group is a collection of VM instances that you can manage as a single entity. For more information, read Instance groups.
				1514	#
				1515	# For zonal Managed Instance Group, use the instanceGroupManagers resource.
				1516	#
				1517	# For regional Managed Instance Group, use the regionInstanceGroupManagers resource. (== resource_for {$api_version}.instanceGroupManagers ==) (== resource_for {$api_version}.regionInstanceGroupManagers ==)
				1518	"autoHealingPolicies": [ # The autohealing policy for this managed instance group. You can specify only one value.
				1519	{
				1520	"healthCheck": "A String", # The URL for the health check that signals autohealing.
				1521	"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]	1522	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1523	],
				1524	"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.
				1525	"creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
				1526	"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.
				1527	"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.
				1528	"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.
				1529	#
				1530	# If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.
				1531	"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.
				1532	"deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
				1533	"none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
				1534	"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.
				1535	"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.
				1536	"restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
				1537	"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.
				1538	},
				1539	"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]	1540	"distributionPolicy": { # Policy specifying the intended distribution of managed instances across zones in a regional managed instance group.
Anthonios Partheniou	10f4b67	2021-04-13 14:47:53 -0400	[diff] [blame^]	1541	"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]	1542	"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]	1543	{
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1544	"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]	1545	},
				1546	],
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1547	},
				1548	"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.
				1549	#
				1550	# To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager.
				1551	"id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
				1552	"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]	1553	"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]	1554	"kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
				1555	"name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.
				1556	"namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
				1557	{ # The named port. For example: .
				1558	"name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
				1559	"port": 42, # The port number, which can be a value between 1 and 65535.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	1560	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1561	],
				1562	"region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources).
				1563	"selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	1564	"statefulPolicy": { # Stateful configuration for this Instanced Group Manager
				1565	"preservedState": { # Configuration of preserved resources.
				1566	"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.
				1567	"a_key": {
				1568	"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.
				1569	},
				1570	},
				1571	},
				1572	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1573	"status": { # [Output Only] The status of this managed instance group.
				1574	"autoscaler": "A String", # [Output Only] The URL of the Autoscaler that targets this instance group manager.
				1575	"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.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	1576	"stateful": { # [Output Only] Stateful status of the given Instance Group Manager.
				1577	"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.
				1578	"perInstanceConfigs": { # [Output Only] Status of per-instance configs on the instance.
				1579	"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.
				1580	},
				1581	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1582	"versionTarget": { # [Output Only] A status of consistency of Instances' versions with their target version specified by version field on Instance Group Manager.
				1583	"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.
				1584	},
				1585	},
				1586	"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.
				1587	"A String",
				1588	],
				1589	"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.
				1590	"updatePolicy": { # The update policy for this managed instance group.
				1591	"instanceRedistributionType": "A String", # The instance redistribution policy for regional managed instance groups. Valid values are:
				1592	# - PROACTIVE (default): The group attempts to maintain an even distribution of VM instances across zones in the region.
				1593	# - NONE: For non-autoscaled groups, proactive redistribution is disabled.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1594	"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 up 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]	1595	#
				1596	# At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxSurge.
				1597	"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	1598	#
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1599	#
				1600	# - If the value is fixed, then the calculated value is equal to the fixed value.
				1601	# - 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 up.
				1602	"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.
				1603	"percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.
				1604	},
				1605	"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:
				1606	#
				1607	#
				1608	# - The instance's status is RUNNING.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1609	# - 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 up 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]	1610	#
				1611	# At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxUnavailable.
				1612	"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.
				1613	#
				1614	#
				1615	# - If the value is fixed, then the calculated value is equal to the fixed value.
				1616	# - 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 up.
				1617	"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.
				1618	"percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.
				1619	},
				1620	"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.
				1621	"replacementMethod": "A String", # What action should be used to replace instances. See minimal_action.REPLACE
				1622	"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).
				1623	},
				1624	"versions": [ # Specifies the instance templates used by this managed instance group to create instances.
				1625	#
				1626	# 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.
				1627	{
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	1628	"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]	1629	"name": "A String", # Name of the version. Unique among all versions in the scope of this managed instance group.
				1630	"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:
				1631	# - If expressed as a fixed number, the minimum of either targetSize.fixed or instanceGroupManager.targetSize is used.
				1632	# - if expressed as a percent, the targetSize would be (targetSize.percent/100 * InstanceGroupManager.targetSize) If there is a remainder, the number is rounded up. If unset, this version will update any remaining instances not updated by another version. Read Starting a canary update for more information.
				1633	"calculated": 42, # [Output Only] Absolute value of VM instances calculated based on the specific mode.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	1634	#
				1635	#
				1636	# - If the value is fixed, then the calculated value is equal to the fixed value.
				1637	# - 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 up.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1638	"fixed": 42, # Specifies a fixed number of VM instances. This must be a positive integer.
				1639	"percent": 42, # Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	1640	},
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	1641	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1642	],
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	1643	"zone": "A String", # [Output Only] The URL of a zone where the managed instance group is located (for zonal resources).
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1644	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	1645
				1646	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.
				1647
				1648	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.
				1649
				1650	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
				1651
				1652	Returns:
				1653	An object of the form:
				1654
				1655	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1656	#
				1657	# Google Compute Engine has three Operation resources:
				1658	#
				1659	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				1660	#
				1661	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				1662	#
				1663	# Operations can be global, regional or zonal.
				1664	# - For global operations, use the `globalOperations` resource.
				1665	# - For regional operations, use the `regionOperations` resource.
				1666	# - For zonal operations, use the `zonalOperations` resource.
				1667	#
				1668	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				1669	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				1670	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				1671	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				1672	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				1673	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				1674	"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]	1675	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1676	"code": "A String", # [Output Only] The error type identifier for this error.
				1677	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				1678	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1679	},
				1680	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1681	},
				1682	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				1683	"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.
				1684	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				1685	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				1686	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				1687	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1688	"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]	1689	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				1690	"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.
				1691	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				1692	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				1693	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				1694	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				1695	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				1696	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				1697	"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.
				1698	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				1699	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				1700	{
				1701	"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.
				1702	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				1703	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				1704	{
				1705	"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).
				1706	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				1707	},
				1708	],
				1709	"message": "A String", # [Output Only] A human-readable description of the warning code.
				1710	},
				1711	],
				1712	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				1713	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	1714	</div>
				1715
				1716	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	1717	<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]	1718	<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.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	1719
				1720	Args:
				1721	project: string, Project ID for this request. (required)
				1722	region: string, Name of the region scoping this request, should conform to RFC1035. (required)
				1723	instanceGroupManager: string, The name of the managed instance group. It should conform to RFC1035. (required)
				1724	body: object, The request body.
				1725	The object takes the form of:
				1726
				1727	{ # RegionInstanceGroupManagers.patchPerInstanceConfigs
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1728	"perInstanceConfigs": [ # The list of per-instance configs to insert or patch on this managed instance group.
				1729	{
				1730	"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.
				1731	"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.
				1732	"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.
				1733	"disks": { # Preserved disks defined for this instance. This map is keyed with the device names of the disks.
				1734	"a_key": {
				1735	"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.
				1736	"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.
				1737	"source": "A String", # The URL of the disk resource that is stateful and should be attached to the VM instance.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	1738	},
				1739	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1740	"metadata": { # Preserved metadata defined for this instance.
				1741	"a_key": "A String",
				1742	},
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	1743	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1744	"status": "A String", # The status of applying this per-instance config on the corresponding managed instance.
				1745	},
				1746	],
				1747	}
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	1748
				1749	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.
				1750
				1751	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.
				1752
				1753	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
				1754
				1755	Returns:
				1756	An object of the form:
				1757
				1758	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1759	#
				1760	# Google Compute Engine has three Operation resources:
				1761	#
				1762	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				1763	#
				1764	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				1765	#
				1766	# Operations can be global, regional or zonal.
				1767	# - For global operations, use the `globalOperations` resource.
				1768	# - For regional operations, use the `regionOperations` resource.
				1769	# - For zonal operations, use the `zonalOperations` resource.
				1770	#
				1771	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				1772	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				1773	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				1774	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				1775	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				1776	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				1777	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	1778	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1779	"code": "A String", # [Output Only] The error type identifier for this error.
				1780	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				1781	"message": "A String", # [Output Only] An optional, human-readable error message.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	1782	},
				1783	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1784	},
				1785	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				1786	"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.
				1787	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				1788	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				1789	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				1790	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1791	"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]	1792	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				1793	"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.
				1794	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				1795	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				1796	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				1797	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				1798	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				1799	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				1800	"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.
				1801	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				1802	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				1803	{
				1804	"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.
				1805	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				1806	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				1807	{
				1808	"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).
				1809	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				1810	},
				1811	],
				1812	"message": "A String", # [Output Only] A human-readable description of the warning code.
				1813	},
				1814	],
				1815	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				1816	}</pre>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	1817	</div>
				1818
				1819	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	1820	<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^]	1821	<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.
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	1822
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	1823	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.
				1824
				1825	You can specify a maximum of 1000 instances with this method per request.
				1826
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	1827	Args:
				1828	project: string, Project ID for this request. (required)
				1829	region: string, Name of the region scoping this request. (required)
				1830	instanceGroupManager: string, Name of the managed instance group. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	1831	body: object, The request body.
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	1832	The object takes the form of:
				1833
				1834	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1835	"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].
				1836	"A String",
				1837	],
				1838	}
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	1839
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	1840	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.
				1841
				1842	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.
				1843
				1844	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	1845
				1846	Returns:
				1847	An object of the form:
				1848
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	1849	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1850	#
				1851	# Google Compute Engine has three Operation resources:
				1852	#
				1853	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				1854	#
				1855	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				1856	#
				1857	# Operations can be global, regional or zonal.
				1858	# - For global operations, use the `globalOperations` resource.
				1859	# - For regional operations, use the `regionOperations` resource.
				1860	# - For zonal operations, use the `zonalOperations` resource.
				1861	#
				1862	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				1863	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				1864	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				1865	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				1866	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				1867	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				1868	"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]	1869	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1870	"code": "A String", # [Output Only] The error type identifier for this error.
				1871	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				1872	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1873	},
				1874	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1875	},
				1876	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				1877	"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.
				1878	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				1879	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				1880	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				1881	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1882	"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]	1883	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				1884	"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.
				1885	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				1886	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				1887	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				1888	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				1889	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				1890	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				1891	"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.
				1892	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				1893	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				1894	{
				1895	"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.
				1896	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				1897	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				1898	{
				1899	"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).
				1900	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				1901	},
				1902	],
				1903	"message": "A String", # [Output Only] A human-readable description of the warning code.
				1904	},
				1905	],
				1906	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				1907	}</pre>
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	1908	</div>
				1909
				1910	<div class="method">
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	1911	<code class="details" id="resize">resize(project, region, instanceGroupManager, size, requestId=None)</code>
				1912	<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.
				1913
				1914	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.
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	1915
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	1916	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.
				1917
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	1918	Args:
				1919	project: string, Project ID for this request. (required)
				1920	region: string, Name of the region scoping this request. (required)
				1921	instanceGroupManager: string, Name of the managed instance group. (required)
				1922	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]	1923	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.
				1924
				1925	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.
				1926
				1927	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	1928
				1929	Returns:
				1930	An object of the form:
				1931
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	1932	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1933	#
				1934	# Google Compute Engine has three Operation resources:
				1935	#
				1936	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				1937	#
				1938	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				1939	#
				1940	# Operations can be global, regional or zonal.
				1941	# - For global operations, use the `globalOperations` resource.
				1942	# - For regional operations, use the `regionOperations` resource.
				1943	# - For zonal operations, use the `zonalOperations` resource.
				1944	#
				1945	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				1946	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				1947	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				1948	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				1949	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				1950	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				1951	"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]	1952	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1953	"code": "A String", # [Output Only] The error type identifier for this error.
				1954	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				1955	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1956	},
				1957	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	1958	},
				1959	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				1960	"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.
				1961	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				1962	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				1963	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				1964	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	1965	"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]	1966	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				1967	"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.
				1968	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				1969	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				1970	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				1971	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				1972	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				1973	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				1974	"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.
				1975	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				1976	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				1977	{
				1978	"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.
				1979	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				1980	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				1981	{
				1982	"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).
				1983	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				1984	},
				1985	],
				1986	"message": "A String", # [Output Only] A human-readable description of the warning code.
				1987	},
				1988	],
				1989	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				1990	}</pre>
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	1991	</div>
				1992
				1993	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	1994	<code class="details" id="setInstanceTemplate">setInstanceTemplate(project, region, instanceGroupManager, body=None, requestId=None)</code>
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	1995	<pre>Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected.
				1996
				1997	Args:
				1998	project: string, Project ID for this request. (required)
				1999	region: string, Name of the region scoping this request. (required)
				2000	instanceGroupManager: string, The name of the managed instance group. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	2001	body: object, The request body.
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	2002	The object takes the form of:
				2003
				2004	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	2005	"instanceTemplate": "A String", # URL of the InstanceTemplate resource from which all new instances will be created.
				2006	}
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	2007
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	2008	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.
				2009
				2010	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.
				2011
				2012	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	2013
				2014	Returns:
				2015	An object of the form:
				2016
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	2017	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	2018	#
				2019	# Google Compute Engine has three Operation resources:
				2020	#
				2021	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				2022	#
				2023	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				2024	#
				2025	# Operations can be global, regional or zonal.
				2026	# - For global operations, use the `globalOperations` resource.
				2027	# - For regional operations, use the `regionOperations` resource.
				2028	# - For zonal operations, use the `zonalOperations` resource.
				2029	#
				2030	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				2031	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				2032	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				2033	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				2034	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				2035	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				2036	"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]	2037	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	2038	"code": "A String", # [Output Only] The error type identifier for this error.
				2039	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				2040	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2041	},
				2042	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	2043	},
				2044	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				2045	"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.
				2046	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				2047	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				2048	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				2049	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	2050	"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]	2051	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				2052	"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.
				2053	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				2054	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				2055	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				2056	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				2057	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				2058	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				2059	"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.
				2060	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				2061	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				2062	{
				2063	"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.
				2064	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				2065	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				2066	{
				2067	"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).
				2068	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				2069	},
				2070	],
				2071	"message": "A String", # [Output Only] A human-readable description of the warning code.
				2072	},
				2073	],
				2074	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				2075	}</pre>
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	2076	</div>
				2077
				2078	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	2079	<code class="details" id="setTargetPools">setTargetPools(project, region, instanceGroupManager, body=None, requestId=None)</code>
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	2080	<pre>Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected.
				2081
				2082	Args:
				2083	project: string, Project ID for this request. (required)
				2084	region: string, Name of the region scoping this request. (required)
				2085	instanceGroupManager: string, Name of the managed instance group. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	2086	body: object, The request body.
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	2087	The object takes the form of:
				2088
				2089	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	2090	"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.
				2091	"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.
				2092	"A String",
				2093	],
				2094	}
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	2095
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	2096	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.
				2097
				2098	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.
				2099
				2100	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	2101
				2102	Returns:
				2103	An object of the form:
				2104
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	2105	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	2106	#
				2107	# Google Compute Engine has three Operation resources:
				2108	#
				2109	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				2110	#
				2111	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				2112	#
				2113	# Operations can be global, regional or zonal.
				2114	# - For global operations, use the `globalOperations` resource.
				2115	# - For regional operations, use the `regionOperations` resource.
				2116	# - For zonal operations, use the `zonalOperations` resource.
				2117	#
				2118	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				2119	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				2120	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				2121	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				2122	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				2123	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				2124	"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]	2125	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	2126	"code": "A String", # [Output Only] The error type identifier for this error.
				2127	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				2128	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	2129	},
				2130	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	2131	},
				2132	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				2133	"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.
				2134	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				2135	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				2136	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				2137	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	2138	"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]	2139	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				2140	"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.
				2141	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				2142	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				2143	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				2144	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				2145	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				2146	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				2147	"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.
				2148	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				2149	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				2150	{
				2151	"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.
				2152	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				2153	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				2154	{
				2155	"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).
				2156	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				2157	},
				2158	],
				2159	"message": "A String", # [Output Only] A human-readable description of the warning code.
				2160	},
				2161	],
				2162	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				2163	}</pre>
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	2164	</div>
				2165
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	2166	<div class="method">
				2167	<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]	2168	<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.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	2169
				2170	Args:
				2171	project: string, Project ID for this request. (required)
				2172	region: string, Name of the region scoping this request, should conform to RFC1035. (required)
				2173	instanceGroupManager: string, The name of the managed instance group. It should conform to RFC1035. (required)
				2174	body: object, The request body.
				2175	The object takes the form of:
				2176
				2177	{ # RegionInstanceGroupManagers.updatePerInstanceConfigs
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	2178	"perInstanceConfigs": [ # The list of per-instance configs to insert or patch on this managed instance group.
				2179	{
				2180	"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.
				2181	"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.
				2182	"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.
				2183	"disks": { # Preserved disks defined for this instance. This map is keyed with the device names of the disks.
				2184	"a_key": {
				2185	"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.
				2186	"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.
				2187	"source": "A String", # The URL of the disk resource that is stateful and should be attached to the VM instance.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	2188	},
				2189	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	2190	"metadata": { # Preserved metadata defined for this instance.
				2191	"a_key": "A String",
				2192	},
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	2193	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	2194	"status": "A String", # The status of applying this per-instance config on the corresponding managed instance.
				2195	},
				2196	],
				2197	}
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	2198
				2199	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.
				2200
				2201	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.
				2202
				2203	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
				2204
				2205	Returns:
				2206	An object of the form:
				2207
				2208	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	2209	#
				2210	# Google Compute Engine has three Operation resources:
				2211	#
				2212	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				2213	#
				2214	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				2215	#
				2216	# Operations can be global, regional or zonal.
				2217	# - For global operations, use the `globalOperations` resource.
				2218	# - For regional operations, use the `regionOperations` resource.
				2219	# - For zonal operations, use the `zonalOperations` resource.
				2220	#
				2221	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				2222	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				2223	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				2224	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				2225	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				2226	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				2227	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	2228	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	2229	"code": "A String", # [Output Only] The error type identifier for this error.
				2230	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				2231	"message": "A String", # [Output Only] An optional, human-readable error message.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	2232	},
				2233	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	2234	},
				2235	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				2236	"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.
				2237	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				2238	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				2239	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				2240	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	2241	"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]	2242	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				2243	"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.
				2244	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				2245	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				2246	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				2247	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				2248	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				2249	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				2250	"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.
				2251	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				2252	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				2253	{
				2254	"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.
				2255	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				2256	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				2257	{
				2258	"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).
				2259	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				2260	},
				2261	],
				2262	"message": "A String", # [Output Only] A human-readable description of the warning code.
				2263	},
				2264	],
				2265	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				2266	}</pre>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	2267	</div>
				2268
Jon Wayne Parrott	692617a	2017-01-06 09:58:29 -0800	[diff] [blame]	2269	</body></html>