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

blob: a28dbafe07e99cd9e6ccd08f8d03cf172198e691 [file] [log] [blame]

Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	1	<html><body>
				2	<style>
				3
				4	body, h1, h2, h3, div, span, p, pre, a {
				5	margin: 0;
				6	padding: 0;
				7	border: 0;
				8	font-weight: inherit;
				9	font-style: inherit;
				10	font-size: 100%;
				11	font-family: inherit;
				12	vertical-align: baseline;
				13	}
				14
				15	body {
				16	font-size: 13px;
				17	padding: 1em;
				18	}
				19
				20	h1 {
				21	font-size: 26px;
				22	margin-bottom: 1em;
				23	}
				24
				25	h2 {
				26	font-size: 24px;
				27	margin-bottom: 1em;
				28	}
				29
				30	h3 {
				31	font-size: 20px;
				32	margin-bottom: 1em;
				33	margin-top: 1em;
				34	}
				35
				36	pre, code {
				37	line-height: 1.5;
				38	font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
				39	}
				40
				41	pre {
				42	margin-top: 0.5em;
				43	}
				44
				45	h1, h2, h3, p {
				46	font-family: Arial, sans serif;
				47	}
				48
				49	h1, h2, h3 {
				50	border-bottom: solid #CCC 1px;
				51	}
				52
				53	.toc_element {
				54	margin-top: 0.5em;
				55	}
				56
				57	.firstline {
				58	margin-left: 2 em;
				59	}
				60
				61	.method {
				62	margin-top: 1em;
				63	border: solid 1px #CCC;
				64	padding: 1em;
				65	background: #EEE;
				66	}
				67
				68	.details {
				69	font-weight: bold;
				70	font-size: 14px;
				71	}
				72
				73	</style>
				74
				75	<h1><a href="compute_v1.html">Compute Engine API</a> . <a href="compute_v1.instanceGroupManagers.html">instanceGroupManagers</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
				78	<code><a href="#abandonInstances">abandonInstances(project, zone, instanceGroupManager, body)</a></code></p>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	79	<p class="firstline">Schedules a group action to remove the specified instances from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method.</p>
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	80	<p class="toc_element">
				81	<code><a href="#aggregatedList">aggregatedList(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	82	<p class="firstline">Retrieves the list of managed instance groups and groups them by zone.</p>
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	83	<p class="toc_element">
				84	<code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p>
				85	<p class="firstline">Retrieves the next page of results.</p>
				86	<p class="toc_element">
				87	<code><a href="#delete">delete(project, zone, instanceGroupManager)</a></code></p>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	88	<p class="firstline">Deletes the specified managed instance group and all of the instances in that group. Note that the instance group must not belong to a backend service. Read Deleting an instance group for more information.</p>
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	89	<p class="toc_element">
				90	<code><a href="#deleteInstances">deleteInstances(project, zone, instanceGroupManager, body)</a></code></p>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	91	<p class="firstline">Schedules a group action to delete the specified instances in the managed instance group. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method.</p>
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	92	<p class="toc_element">
				93	<code><a href="#get">get(project, zone, instanceGroupManager)</a></code></p>
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame^]	94	<p class="firstline">Returns all of the details about the specified managed instance group. Get a list of available managed instance groups by making a list() request.</p>
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	95	<p class="toc_element">
				96	<code><a href="#insert">insert(project, zone, body)</a></code></p>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	97	<p class="firstline">Creates a managed instance group using the information that you specify in the request. After the group is created, it schedules an action to create instances in the group using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method.</p>
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	98	<p class="toc_element">
				99	<code><a href="#list">list(project, zone, maxResults=None, pageToken=None, filter=None)</a></code></p>
				100	<p class="firstline">Retrieves a list of managed instance groups that are contained within the specified project and zone.</p>
				101	<p class="toc_element">
				102	<code><a href="#listManagedInstances">listManagedInstances(project, zone, instanceGroupManager)</a></code></p>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	103	<p class="firstline">Lists all of the instances in the managed instance group. Each instance in the list has a currentAction, which indicates the action that the managed instance group is performing on the instance. For example, if the group is still creating an instance, the currentAction is CREATING. If a previous action failed, the list displays the errors for that failed action.</p>
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	104	<p class="toc_element">
				105	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				106	<p class="firstline">Retrieves the next page of results.</p>
				107	<p class="toc_element">
				108	<code><a href="#recreateInstances">recreateInstances(project, zone, instanceGroupManager, body)</a></code></p>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	109	<p class="firstline">Schedules a group action to recreate the specified instances in the managed instance group. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the action is scheduled even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method.</p>
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	110	<p class="toc_element">
				111	<code><a href="#resize">resize(project, zone, instanceGroupManager, size)</a></code></p>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	112	<p class="firstline">Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.</p>
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	113	<p class="toc_element">
				114	<code><a href="#setInstanceTemplate">setInstanceTemplate(project, zone, instanceGroupManager, body)</a></code></p>
				115	<p class="firstline">Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you recreate them.</p>
				116	<p class="toc_element">
				117	<code><a href="#setTargetPools">setTargetPools(project, zone, instanceGroupManager, body)</a></code></p>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	118	<p class="firstline">Modifies the target pools to which all instances in this managed instance group are assigned. The target pools automatically apply to all of the instances in the managed instance group. This operation is marked DONE when you make the request even if the instances have not yet been added to their target pools. The change might take some time to apply to all of the instances in the group depending on the size of the group.</p>
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	119	<h3>Method Details</h3>
				120	<div class="method">
				121	<code class="details" id="abandonInstances">abandonInstances(project, zone, instanceGroupManager, body)</code>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	122	<pre>Schedules a group action to remove the specified instances from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	123
				124	Args:
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	125	project: string, Project ID for this request. (required)
				126	zone: string, The name of the zone where the managed instance group is located. (required)
				127	instanceGroupManager: string, The name of the managed instance group. (required)
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	128	body: object, The request body. (required)
				129	The object takes the form of:
				130
				131	{
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	132	"instances": [ # The URL for one or more instances to abandon from the managed instance group.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	133	"A String",
				134	],
				135	}
				136
				137
				138	Returns:
				139	An object of the form:
				140
				141	{ # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	142	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				143	"clientOperationId": "A String", # [Output Only] Reserved for future use.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	144	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	145	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				146	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
				147	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				148	"operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	149	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	150	"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.
				151	"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.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	152	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	153	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
				154	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	155	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				156	{
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	157	"message": "A String", # [Output Only] A human-readable description of the warning code.
				158	"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.
				159	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				160	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	161	{
				162	"value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame^]	163	"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).
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	164	},
				165	],
				166	},
				167	],
				168	"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	169	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				170	"kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	171	"name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	172	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	173	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				174	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
				175	{
				176	"message": "A String", # [Output Only] An optional, human-readable error message.
				177	"code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame^]	178	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	179	},
				180	],
				181	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	182	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	183	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	184	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	185	}</pre>
				186	</div>
				187
				188	<div class="method">
				189	<code class="details" id="aggregatedList">aggregatedList(project, maxResults=None, pageToken=None, filter=None)</code>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	190	<pre>Retrieves the list of managed instance groups and groups them by zone.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	191
				192	Args:
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	193	project: string, Project ID for this request. (required)
				194	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.
				195	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.
				196	filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	197
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	198	The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	199
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame^]	200	For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	201
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame^]	202	Compute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	203
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame^]	204	The Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	205
				206	Returns:
				207	An object of the form:
				208
				209	{
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	210	"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.
				211	"items": { # [Output Only] A map of filtered managed instance group lists.
				212	"a_key": { # [Output Only] The name of the scope that contains this set of managed instance groups.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	213	"warning": { # [Output Only] The warning that replaces the list of managed instance groups when the list is empty.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	214	"message": "A String", # [Output Only] A human-readable description of the warning code.
				215	"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.
				216	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				217	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	218	{
				219	"value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame^]	220	"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).
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	221	},
				222	],
				223	},
				224	"instanceGroupManagers": [ # [Output Only] The list of managed instance groups that are contained in the specified project and zone.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	225	{
				226	"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.
				227	"none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	228	"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.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	229	"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 one of these instances, it tries again until it creates the instance successfully.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	230	"restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	231	"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.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	232	"deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
				233	"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.
				234	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	235	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				236	"zone": "A String", # The name of the zone where the managed instance group is located.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	237	"targetSize": 42, # The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	238	"instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	239	"kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	240	"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.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	241	"A String",
				242	],
				243	"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.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame^]	244	"fingerprint": "A String", # [Output Only] The fingerprint of the resource data. You can use this optional field for optimistic locking when you update the resource.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	245	"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.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	246	"namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
				247	{ # The named port. For example: .
				248	"name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
				249	"port": 42, # The port number, which can be a value between 1 and 65535.
				250	},
				251	],
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	252	"creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	253	"id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
				254	"selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	255	"name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.
				256	},
				257	],
				258	},
				259	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	260	"kind": "compute#instanceGroupManagerAggregatedList", # [Output Only] The resource type, which is always compute#instanceGroupManagerAggregatedList for an aggregated list of managed instance groups.
				261	"id": "A String", # [Output Only] A unique identifier for this aggregated list of managed instance groups. The server generates this identifier.
				262	"selfLink": "A String", # [Output Only] The URL for this resource type. The server generates this URL.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	263	}</pre>
				264	</div>
				265
				266	<div class="method">
				267	<code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
				268	<pre>Retrieves the next page of results.
				269
				270	Args:
				271	previous_request: The request for the previous page. (required)
				272	previous_response: The response from the request for the previous page. (required)
				273
				274	Returns:
				275	A request object that you can call 'execute()' on to request the next
				276	page. Returns None if there are no more items in the collection.
				277	</pre>
				278	</div>
				279
				280	<div class="method">
				281	<code class="details" id="delete">delete(project, zone, instanceGroupManager)</code>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	282	<pre>Deletes the specified managed instance group and all of the instances in that group. Note that the instance group must not belong to a backend service. Read Deleting an instance group for more information.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	283
				284	Args:
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	285	project: string, Project ID for this request. (required)
				286	zone: string, The name of the zone where the managed instance group is located. (required)
				287	instanceGroupManager: string, The name of the managed instance group to delete. (required)
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	288
				289	Returns:
				290	An object of the form:
				291
				292	{ # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	293	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				294	"clientOperationId": "A String", # [Output Only] Reserved for future use.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	295	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	296	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				297	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
				298	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				299	"operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	300	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	301	"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.
				302	"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.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	303	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	304	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
				305	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	306	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				307	{
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	308	"message": "A String", # [Output Only] A human-readable description of the warning code.
				309	"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.
				310	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				311	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	312	{
				313	"value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame^]	314	"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).
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	315	},
				316	],
				317	},
				318	],
				319	"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	320	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				321	"kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	322	"name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	323	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	324	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				325	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
				326	{
				327	"message": "A String", # [Output Only] An optional, human-readable error message.
				328	"code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame^]	329	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	330	},
				331	],
				332	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	333	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	334	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	335	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	336	}</pre>
				337	</div>
				338
				339	<div class="method">
				340	<code class="details" id="deleteInstances">deleteInstances(project, zone, instanceGroupManager, body)</code>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	341	<pre>Schedules a group action to delete the specified instances in the managed instance group. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	342
				343	Args:
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	344	project: string, Project ID for this request. (required)
				345	zone: string, The name of the zone where the managed instance group is located. (required)
				346	instanceGroupManager: string, The name of the managed instance group. (required)
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	347	body: object, The request body. (required)
				348	The object takes the form of:
				349
				350	{
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	351	"instances": [ # The list of instances to delete from this managed instance group. Specify one or more instance URLs.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	352	"A String",
				353	],
				354	}
				355
				356
				357	Returns:
				358	An object of the form:
				359
				360	{ # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	361	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				362	"clientOperationId": "A String", # [Output Only] Reserved for future use.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	363	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	364	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				365	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
				366	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				367	"operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	368	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	369	"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
				370	"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	371	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	372	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
				373	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	374	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				375	{
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	376	"message": "A String", # [Output Only] A human-readable description of the warning code.
				377	"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
				378	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				379	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	380	{
				381	"value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame^]	382	"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	383	},
				384	],
				385	},
				386	],
				387	"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	388	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				389	"kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	390	"name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	391	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	392	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				393	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
				394	{
				395	"message": "A String", # [Output Only] An optional, human-readable error message.
				396	"code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame^]	397	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	398	},
				399	],
				400	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	401	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	402	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	403	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	404	}</pre>
				405	</div>
				406
				407	<div class="method">
				408	<code class="details" id="get">get(project, zone, instanceGroupManager)</code>
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame^]	409	<pre>Returns all of the details about the specified managed instance group. Get a list of available managed instance groups by making a list() request.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	410
				411	Args:
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	412	project: string, Project ID for this request. (required)
				413	zone: string, The name of the zone where the managed instance group is located. (required)
				414	instanceGroupManager: string, The name of the managed instance group. (required)
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	415
				416	Returns:
				417	An object of the form:
				418
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	419	{
				420	"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.
				421	"none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	422	"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.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	423	"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 one of these instances, it tries again until it creates the instance successfully.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	424	"restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	425	"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.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	426	"deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
				427	"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.
				428	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	429	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				430	"zone": "A String", # The name of the zone where the managed instance group is located.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	431	"targetSize": 42, # The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	432	"instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	433	"kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	434	"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.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	435	"A String",
				436	],
				437	"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.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame^]	438	"fingerprint": "A String", # [Output Only] The fingerprint of the resource data. You can use this optional field for optimistic locking when you update the resource.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	439	"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.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	440	"namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
				441	{ # The named port. For example: .
				442	"name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
				443	"port": 42, # The port number, which can be a value between 1 and 65535.
				444	},
				445	],
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	446	"creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	447	"id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
				448	"selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	449	"name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.
				450	}</pre>
				451	</div>
				452
				453	<div class="method">
				454	<code class="details" id="insert">insert(project, zone, body)</code>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	455	<pre>Creates a managed instance group using the information that you specify in the request. After the group is created, it schedules an action to create instances in the group using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	456
				457	Args:
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	458	project: string, Project ID for this request. (required)
				459	zone: string, The name of the zone where you want to create the managed instance group. (required)
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	460	body: object, The request body. (required)
				461	The object takes the form of:
				462
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	463	{
				464	"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.
				465	"none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	466	"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.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	467	"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 one of these instances, it tries again until it creates the instance successfully.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	468	"restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	469	"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.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	470	"deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
				471	"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.
				472	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	473	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				474	"zone": "A String", # The name of the zone where the managed instance group is located.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	475	"targetSize": 42, # The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	476	"instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	477	"kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	478	"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.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	479	"A String",
				480	],
				481	"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.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame^]	482	"fingerprint": "A String", # [Output Only] The fingerprint of the resource data. You can use this optional field for optimistic locking when you update the resource.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	483	"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.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	484	"namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
				485	{ # The named port. For example: .
				486	"name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
				487	"port": 42, # The port number, which can be a value between 1 and 65535.
				488	},
				489	],
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	490	"creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	491	"id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
				492	"selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	493	"name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.
				494	}
				495
				496
				497	Returns:
				498	An object of the form:
				499
				500	{ # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	501	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				502	"clientOperationId": "A String", # [Output Only] Reserved for future use.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	503	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	504	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				505	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
				506	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				507	"operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	508	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	509	"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.
				510	"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.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	511	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	512	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
				513	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	514	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				515	{
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	516	"message": "A String", # [Output Only] A human-readable description of the warning code.
				517	"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.
				518	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				519	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	520	{
				521	"value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame^]	522	"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).
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	523	},
				524	],
				525	},
				526	],
				527	"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	528	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				529	"kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	530	"name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	531	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	532	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				533	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
				534	{
				535	"message": "A String", # [Output Only] An optional, human-readable error message.
				536	"code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame^]	537	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	538	},
				539	],
				540	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	541	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	542	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	543	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	544	}</pre>
				545	</div>
				546
				547	<div class="method">
				548	<code class="details" id="list">list(project, zone, maxResults=None, pageToken=None, filter=None)</code>
				549	<pre>Retrieves a list of managed instance groups that are contained within the specified project and zone.
				550
				551	Args:
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	552	project: string, Project ID for this request. (required)
				553	zone: string, The name of the zone where the managed instance group is located. (required)
				554	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.
				555	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.
				556	filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	557
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	558	The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	559
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame^]	560	For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	561
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame^]	562	Compute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	563
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame^]	564	The Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	565
				566	Returns:
				567	An object of the form:
				568
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	569	{ # [Output Only] A list of managed instance groups.
				570	"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.
				571	"items": [ # [Output Only] A list of managed instance groups.
				572	{
				573	"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.
				574	"none": 42, # [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	575	"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.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	576	"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 one of these instances, it tries again until it creates the instance successfully.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	577	"restarting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	578	"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.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	579	"deleting": 42, # [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.
				580	"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.
				581	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	582	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				583	"zone": "A String", # The name of the zone where the managed instance group is located.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	584	"targetSize": 42, # The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	585	"instanceGroup": "A String", # [Output Only] The URL of the Instance Group resource.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	586	"kind": "compute#instanceGroupManager", # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	587	"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.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	588	"A String",
				589	],
				590	"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.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame^]	591	"fingerprint": "A String", # [Output Only] The fingerprint of the resource data. You can use this optional field for optimistic locking when you update the resource.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	592	"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.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	593	"namedPorts": [ # Named ports configured for the Instance Groups complementary to this Instance Group Manager.
				594	{ # The named port. For example: .
				595	"name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
				596	"port": 42, # The port number, which can be a value between 1 and 65535.
				597	},
				598	],
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	599	"creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	600	"id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
				601	"selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	602	"name": "A String", # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.
				603	},
				604	],
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	605	"kind": "compute#instanceGroupManagerList", # [Output Only] The resource type, which is always compute#instanceGroupManagerList for a list of managed instance groups.
				606	"id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
				607	"selfLink": "A String", # [Output Only] The URL for this resource type. The server generates this URL.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	608	}</pre>
				609	</div>
				610
				611	<div class="method">
				612	<code class="details" id="listManagedInstances">listManagedInstances(project, zone, instanceGroupManager)</code>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	613	<pre>Lists all of the instances in the managed instance group. Each instance in the list has a currentAction, which indicates the action that the managed instance group is performing on the instance. For example, if the group is still creating an instance, the currentAction is CREATING. If a previous action failed, the list displays the errors for that failed action.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	614
				615	Args:
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	616	project: string, Project ID for this request. (required)
				617	zone: string, The name of the zone where the managed instance group is located. (required)
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	618	instanceGroupManager: string, The name of the managed instance group. (required)
				619
				620	Returns:
				621	An object of the form:
				622
				623	{
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	624	"managedInstances": [ # [Output Only] The list of instances in the managed instance group.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	625	{
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	626	"currentAction": "A String", # [Output Only] The current action that the managed instance group has scheduled for the instance. Possible values:
				627	# - NONE The instance is running, and the managed instance group does not have any scheduled actions for this instance.
				628	# - 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.
				629	# - 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 target_size value is decreased.
				630	# - RECREATING The managed instance group is recreating this instance.
				631	# - DELETING The managed instance group is permanently deleting this instance.
				632	# - 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.
				633	# - RESTARTING The managed instance group is restarting the instance.
				634	# - 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.
				635	"instance": "A String", # [Output Only] The URL of the instance. The URL can exist even if the instance has not yet been created.
				636	"lastAttempt": { # [Output Only] Information about the last attempt to create or delete the instance.
				637	"errors": { # [Output Only] Encountered errors during the last attempt to create or delete the instance.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	638	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
				639	{
				640	"message": "A String", # [Output Only] An optional, human-readable error message.
				641	"code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame^]	642	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	643	},
				644	],
				645	},
				646	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	647	"id": "A String", # [Output only] The unique identifier for this resource. This field is empty when instance does not exist.
				648	"instanceStatus": "A String", # [Output Only] The status of the instance. This field is empty when the instance does not exist.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	649	},
				650	],
				651	}</pre>
				652	</div>
				653
				654	<div class="method">
				655	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				656	<pre>Retrieves the next page of results.
				657
				658	Args:
				659	previous_request: The request for the previous page. (required)
				660	previous_response: The response from the request for the previous page. (required)
				661
				662	Returns:
				663	A request object that you can call 'execute()' on to request the next
				664	page. Returns None if there are no more items in the collection.
				665	</pre>
				666	</div>
				667
				668	<div class="method">
				669	<code class="details" id="recreateInstances">recreateInstances(project, zone, instanceGroupManager, body)</code>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	670	<pre>Schedules a group action to recreate the specified instances in the managed instance group. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the action is scheduled even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	671
				672	Args:
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	673	project: string, Project ID for this request. (required)
				674	zone: string, The name of the zone where the managed instance group is located. (required)
				675	instanceGroupManager: string, The name of the managed instance group. (required)
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	676	body: object, The request body. (required)
				677	The object takes the form of:
				678
				679	{
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	680	"instances": [ # The URL for one or more instances to recreate.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	681	"A String",
				682	],
				683	}
				684
				685
				686	Returns:
				687	An object of the form:
				688
				689	{ # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	690	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				691	"clientOperationId": "A String", # [Output Only] Reserved for future use.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	692	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	693	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				694	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
				695	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				696	"operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	697	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	698	"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.
				699	"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.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	700	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	701	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
				702	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	703	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				704	{
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	705	"message": "A String", # [Output Only] A human-readable description of the warning code.
				706	"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.
				707	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				708	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	709	{
				710	"value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame^]	711	"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).
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	712	},
				713	],
				714	},
				715	],
				716	"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	717	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				718	"kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	719	"name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	720	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	721	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				722	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
				723	{
				724	"message": "A String", # [Output Only] An optional, human-readable error message.
				725	"code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame^]	726	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	727	},
				728	],
				729	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	730	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	731	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	732	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	733	}</pre>
				734	</div>
				735
				736	<div class="method">
				737	<code class="details" id="resize">resize(project, zone, instanceGroupManager, size)</code>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	738	<pre>Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	739
				740	Args:
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	741	project: string, Project ID for this request. (required)
				742	zone: string, The name of the zone where the managed instance group is located. (required)
				743	instanceGroupManager: string, The name of the managed instance group. (required)
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	744	size: integer, The number of running instances that the managed instance group should maintain at any given time. The group automatically adds or removes instances to maintain the number of instances specified by this parameter. (required)
				745
				746	Returns:
				747	An object of the form:
				748
				749	{ # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	750	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				751	"clientOperationId": "A String", # [Output Only] Reserved for future use.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	752	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	753	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				754	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
				755	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				756	"operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	757	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	758	"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.
				759	"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.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	760	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	761	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
				762	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	763	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				764	{
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	765	"message": "A String", # [Output Only] A human-readable description of the warning code.
				766	"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.
				767	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				768	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	769	{
				770	"value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame^]	771	"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).
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	772	},
				773	],
				774	},
				775	],
				776	"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	777	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				778	"kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	779	"name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	780	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	781	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				782	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
				783	{
				784	"message": "A String", # [Output Only] An optional, human-readable error message.
				785	"code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame^]	786	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	787	},
				788	],
				789	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	790	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	791	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	792	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	793	}</pre>
				794	</div>
				795
				796	<div class="method">
				797	<code class="details" id="setInstanceTemplate">setInstanceTemplate(project, zone, instanceGroupManager, body)</code>
				798	<pre>Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you recreate them.
				799
				800	Args:
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	801	project: string, Project ID for this request. (required)
				802	zone: string, The name of the zone where the managed instance group is located. (required)
				803	instanceGroupManager: string, The name of the managed instance group. (required)
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	804	body: object, The request body. (required)
				805	The object takes the form of:
				806
				807	{
				808	"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.
				809	}
				810
				811
				812	Returns:
				813	An object of the form:
				814
				815	{ # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	816	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				817	"clientOperationId": "A String", # [Output Only] Reserved for future use.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	818	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	819	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				820	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
				821	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				822	"operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	823	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	824	"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.
				825	"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.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	826	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	827	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
				828	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	829	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				830	{
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	831	"message": "A String", # [Output Only] A human-readable description of the warning code.
				832	"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.
				833	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				834	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	835	{
				836	"value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame^]	837	"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).
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	838	},
				839	],
				840	},
				841	],
				842	"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	843	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				844	"kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	845	"name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	846	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	847	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				848	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
				849	{
				850	"message": "A String", # [Output Only] An optional, human-readable error message.
				851	"code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame^]	852	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	853	},
				854	],
				855	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	856	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	857	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	858	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	859	}</pre>
				860	</div>
				861
				862	<div class="method">
				863	<code class="details" id="setTargetPools">setTargetPools(project, zone, instanceGroupManager, body)</code>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	864	<pre>Modifies the target pools to which all instances in this managed instance group are assigned. The target pools automatically apply to all of the instances in the managed instance group. This operation is marked DONE when you make the request even if the instances have not yet been added to their target pools. The change might take some time to apply to all of the instances in the group depending on the size of the group.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	865
				866	Args:
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	867	project: string, Project ID for this request. (required)
				868	zone: string, The name of the zone where the managed instance group is located. (required)
				869	instanceGroupManager: string, The name of the managed instance group. (required)
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	870	body: object, The request body. (required)
				871	The object takes the form of:
				872
				873	{
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	874	"targetPools": [ # The list of target pool URLs that instances in this managed instance group belong to. The managed instance group applies these target pools to all of the instances in the group. Existing instances and new instances in the group all receive these target pool settings.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	875	"A String",
				876	],
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	877	"fingerprint": "A String", # The fingerprint of the target pools information. Use this optional property to prevent conflicts when multiple users change the target pools settings concurrently. Obtain the fingerprint with the instanceGroupManagers.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	878	}
				879
				880
				881	Returns:
				882	An object of the form:
				883
				884	{ # An Operation resource, used to manage asynchronous API requests.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	885	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				886	"clientOperationId": "A String", # [Output Only] Reserved for future use.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	887	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	888	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				889	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
				890	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				891	"operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	892	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	893	"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.
				894	"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.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	895	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	896	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
				897	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	898	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				899	{
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	900	"message": "A String", # [Output Only] A human-readable description of the warning code.
				901	"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.
				902	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				903	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	904	{
				905	"value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame^]	906	"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).
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	907	},
				908	],
				909	},
				910	],
				911	"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	912	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				913	"kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	914	"name": "A String", # [Output Only] Name of the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	915	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	916	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				917	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
				918	{
				919	"message": "A String", # [Output Only] An optional, human-readable error message.
				920	"code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott	0a471d3	2016-05-19 10:54:38 -0700	[diff] [blame^]	921	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	922	},
				923	],
				924	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	925	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	926	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	927	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	928	}</pre>
				929	</div>
				930
				931	</body></html>