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

blob: d1e674a6034a3c787380cac9e74a794870d2f9c7 [file] [log] [blame]

Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	1	<html><body>
				2	<style>
				3
				4	body, h1, h2, h3, div, span, p, pre, a {
				5	margin: 0;
				6	padding: 0;
				7	border: 0;
				8	font-weight: inherit;
				9	font-style: inherit;
				10	font-size: 100%;
				11	font-family: inherit;
				12	vertical-align: baseline;
				13	}
				14
				15	body {
				16	font-size: 13px;
				17	padding: 1em;
				18	}
				19
				20	h1 {
				21	font-size: 26px;
				22	margin-bottom: 1em;
				23	}
				24
				25	h2 {
				26	font-size: 24px;
				27	margin-bottom: 1em;
				28	}
				29
				30	h3 {
				31	font-size: 20px;
				32	margin-bottom: 1em;
				33	margin-top: 1em;
				34	}
				35
				36	pre, code {
				37	line-height: 1.5;
				38	font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
				39	}
				40
				41	pre {
				42	margin-top: 0.5em;
				43	}
				44
				45	h1, h2, h3, p {
				46	font-family: Arial, sans serif;
				47	}
				48
				49	h1, h2, h3 {
				50	border-bottom: solid #CCC 1px;
				51	}
				52
				53	.toc_element {
				54	margin-top: 0.5em;
				55	}
				56
				57	.firstline {
				58	margin-left: 2 em;
				59	}
				60
				61	.method {
				62	margin-top: 1em;
				63	border: solid 1px #CCC;
				64	padding: 1em;
				65	background: #EEE;
				66	}
				67
				68	.details {
				69	font-weight: bold;
				70	font-size: 14px;
				71	}
				72
				73	</style>
				74
				75	<h1><a href="compute_beta.html">Compute Engine API</a> . <a href="compute_beta.instanceGroups.html">instanceGroups</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	78	<code><a href="#addInstances">addInstances(project, zone, instanceGroup, body=None, requestId=None)</a></code></p>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	79	<p class="firstline">Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. Read Adding instances for more information.</p>
				80	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	81	<code><a href="#aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</a></code></p>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	82	<p class="firstline">Retrieves the list of instance groups and sorts them by zone.</p>
				83	<p class="toc_element">
				84	<code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p>
				85	<p class="firstline">Retrieves the next page of results.</p>
				86	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	87	<code><a href="#close">close()</a></code></p>
				88	<p class="firstline">Close httplib2 connections.</p>
				89	<p class="toc_element">
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	90	<code><a href="#delete">delete(project, zone, instanceGroup, requestId=None)</a></code></p>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	91	<p class="firstline">Deletes the specified instance group. The instances in the group are not deleted. Note that instance group must not belong to a backend service. Read Deleting an instance group for more information.</p>
				92	<p class="toc_element">
				93	<code><a href="#get">get(project, zone, instanceGroup)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	94	<p class="firstline">Returns the specified zonal instance group. Get a list of available zonal instance groups by making a list() request.</p>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	95	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	96	<code><a href="#insert">insert(project, zone, body=None, requestId=None)</a></code></p>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	97	<p class="firstline">Creates an instance group in the specified project using the parameters that are included in the request.</p>
				98	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	99	<code><a href="#list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</a></code></p>
				100	<p class="firstline">Retrieves the list of zonal instance group resources contained within the specified zone.</p>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	101	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	102	<code><a href="#listInstances">listInstances(project, zone, instanceGroup, body=None, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</a></code></p>
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	103	<p class="firstline">Lists the instances in the specified instance group. The orderBy query parameter is not supported.</p>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	104	<p class="toc_element">
				105	<code><a href="#listInstances_next">listInstances_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="#list_next">list_next(previous_request, previous_response)</a></code></p>
				109	<p class="firstline">Retrieves the next page of results.</p>
				110	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	111	<code><a href="#removeInstances">removeInstances(project, zone, instanceGroup, body=None, requestId=None)</a></code></p>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	112	<p class="firstline">Removes one or more instances from the specified instance group, but does not delete those instances.</p>
				113	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	114	<code><a href="#setNamedPorts">setNamedPorts(project, zone, instanceGroup, body=None, requestId=None)</a></code></p>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	115	<p class="firstline">Sets the named ports for the specified instance group.</p>
				116	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	117	<code><a href="#testIamPermissions">testIamPermissions(project, zone, resource, body=None)</a></code></p>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	118	<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
				119	<h3>Method Details</h3>
				120	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	121	<code class="details" id="addInstances">addInstances(project, zone, instanceGroup, body=None, requestId=None)</code>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	122	<pre>Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. Read Adding instances for more information.
				123
				124	Args:
				125	project: string, Project ID for this request. (required)
				126	zone: string, The name of the zone where the instance group is located. (required)
				127	instanceGroup: string, The name of the instance group where you are adding instances. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	128	body: object, The request body.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	129	The object takes the form of:
				130
				131	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	132	"instances": [ # The list of instances to add to the instance group.
				133	{
				134	"instance": "A String", # The URL for a specific instance.
				135	},
				136	],
				137	}
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	138
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	139	requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
				140
				141	For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
				142
				143	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	144
				145	Returns:
				146	An object of the form:
				147
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	148	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	149	#
				150	# Google Compute Engine has three Operation resources:
				151	#
				152	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				153	#
				154	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				155	#
				156	# Operations can be global, regional or zonal.
				157	# - For global operations, use the `globalOperations` resource.
				158	# - For regional operations, use the `regionOperations` resource.
				159	# - For zonal operations, use the `zonalOperations` resource.
				160	#
				161	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				162	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				163	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				164	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				165	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				166	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				167	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	168	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	169	"code": "A String", # [Output Only] The error type identifier for this error.
				170	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				171	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	172	},
				173	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	174	},
				175	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				176	"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.
				177	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				178	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				179	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				180	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame^]	181	"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	182	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				183	"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.
				184	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				185	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				186	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				187	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				188	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				189	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				190	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
				191	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				192	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				193	{
				194	"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.
				195	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				196	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				197	{
				198	"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).
				199	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				200	},
				201	],
				202	"message": "A String", # [Output Only] A human-readable description of the warning code.
				203	},
				204	],
				205	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				206	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	207	</div>
				208
				209	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	210	<code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	211	<pre>Retrieves the list of instance groups and sorts them by zone.
				212
				213	Args:
				214	project: string, Project ID for this request. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	215	filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	216
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	217	For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	218
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	219	You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	220
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	221	To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	222	includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	223	maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
				224	orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
				225
				226	You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
				227
				228	Currently, only sorting by `name` or `creationTimestamp desc` is supported.
				229	pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame^]	230	returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	231
				232	Returns:
				233	An object of the form:
				234
				235	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	236	"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
				237	"items": { # A list of InstanceGroupsScopedList resources.
				238	"a_key": { # The name of the scope that contains this set of instance groups.
				239	"instanceGroups": [ # [Output Only] The list of instance groups that are contained in this scope.
				240	{ # Represents an Instance Group resource.
				241	#
				242	# Instance Groups can be used to configure a target for load balancing.
				243	#
				244	# Instance groups can either be managed or unmanaged.
				245	#
				246	# To create managed instance groups, use the instanceGroupManager or regionInstanceGroupManager resource instead.
				247	#
				248	# Use zonal unmanaged instance groups if you need to apply load balancing to groups of heterogeneous instances or if you need to manage the instances yourself. You cannot create regional unmanaged instance groups.
				249	#
				250	# For more information, read Instance groups.
				251	#
				252	# (== resource_for {$api_version}.instanceGroups ==) (== resource_for {$api_version}.regionInstanceGroups ==)
				253	"creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance group in RFC3339 text format.
				254	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				255	"fingerprint": "A String", # [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.
				256	"id": "A String", # [Output Only] A unique identifier for this instance group, generated by the server.
				257	"kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups.
				258	"name": "A String", # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.
				259	"namedPorts": [ # Assigns a name to a port number. For example: {name: "http", port: 80}
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	260	#
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	261	# This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "http", port: 80},{name: "http", port: 8080}]
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	262	#
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	263	# Named ports apply to all instances in this instance group.
				264	{ # The named port. For example: .
				265	"name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
				266	"port": 42, # The port number, which can be a value between 1 and 65535.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	267	},
				268	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	269	"network": "A String", # [Output Only] The URL of the network to which all instances in the instance group belong. If your instance has multiple network interfaces, then the network and subnetwork fields only refer to the network and subnet used by your primary interface (nic0).
				270	"region": "A String", # [Output Only] The URL of the region where the instance group is located (for regional resources).
				271	"selfLink": "A String", # [Output Only] The URL for this instance group. The server generates this URL.
				272	"size": 42, # [Output Only] The total number of instances in the instance group.
				273	"subnetwork": "A String", # [Output Only] The URL of the subnetwork to which all instances in the instance group belong. If your instance has multiple network interfaces, then the network and subnetwork fields only refer to the network and subnet used by your primary interface (nic0).
				274	"zone": "A String", # [Output Only] The URL of the zone where the instance group is located (for zonal resources).
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	275	},
				276	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	277	"warning": { # [Output Only] An informational warning that replaces the list of instance groups when the list is empty.
				278	"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.
				279	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				280	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				281	{
				282	"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).
				283	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				284	},
				285	],
				286	"message": "A String", # [Output Only] A human-readable description of the warning code.
				287	},
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	288	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	289	},
				290	"kind": "compute#instanceGroupAggregatedList", # [Output Only] The resource type, which is always compute#instanceGroupAggregatedList for aggregated lists of instance groups.
				291	"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.
				292	"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
				293	"unreachables": [ # [Output Only] Unreachable resources.
				294	"A String",
				295	],
				296	"warning": { # [Output Only] Informational warning message.
				297	"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.
				298	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				299	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				300	{
				301	"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).
				302	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				303	},
				304	],
				305	"message": "A String", # [Output Only] A human-readable description of the warning code.
				306	},
				307	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	308	</div>
				309
				310	<div class="method">
				311	<code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
				312	<pre>Retrieves the next page of results.
				313
				314	Args:
				315	previous_request: The request for the previous page. (required)
				316	previous_response: The response from the request for the previous page. (required)
				317
				318	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	319	A request object that you can call 'execute()' on to request the next
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	320	page. Returns None if there are no more items in the collection.
				321	</pre>
				322	</div>
				323
				324	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	325	<code class="details" id="close">close()</code>
				326	<pre>Close httplib2 connections.</pre>
				327	</div>
				328
				329	<div class="method">
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	330	<code class="details" id="delete">delete(project, zone, instanceGroup, requestId=None)</code>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	331	<pre>Deletes the specified instance group. The instances in the group are not deleted. Note that instance group must not belong to a backend service. Read Deleting an instance group for more information.
				332
				333	Args:
				334	project: string, Project ID for this request. (required)
				335	zone: string, The name of the zone where the instance group is located. (required)
				336	instanceGroup: string, The name of the instance group to delete. (required)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	337	requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
				338
				339	For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
				340
				341	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	342
				343	Returns:
				344	An object of the form:
				345
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	346	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	347	#
				348	# Google Compute Engine has three Operation resources:
				349	#
				350	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				351	#
				352	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				353	#
				354	# Operations can be global, regional or zonal.
				355	# - For global operations, use the `globalOperations` resource.
				356	# - For regional operations, use the `regionOperations` resource.
				357	# - For zonal operations, use the `zonalOperations` resource.
				358	#
				359	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				360	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				361	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				362	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				363	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				364	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				365	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	366	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	367	"code": "A String", # [Output Only] The error type identifier for this error.
				368	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				369	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	370	},
				371	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	372	},
				373	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				374	"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.
				375	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				376	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				377	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				378	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame^]	379	"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	380	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				381	"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.
				382	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				383	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				384	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				385	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				386	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				387	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				388	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
				389	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				390	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				391	{
				392	"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.
				393	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				394	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				395	{
				396	"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).
				397	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				398	},
				399	],
				400	"message": "A String", # [Output Only] A human-readable description of the warning code.
				401	},
				402	],
				403	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				404	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	405	</div>
				406
				407	<div class="method">
				408	<code class="details" id="get">get(project, zone, instanceGroup)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	409	<pre>Returns the specified zonal instance group. Get a list of available zonal instance groups by making a list() request.
				410
				411	For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	412
				413	Args:
				414	project: string, Project ID for this request. (required)
				415	zone: string, The name of the zone where the instance group is located. (required)
				416	instanceGroup: string, The name of the instance group. (required)
				417
				418	Returns:
				419	An object of the form:
				420
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	421	{ # Represents an Instance Group resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	422	#
				423	# Instance Groups can be used to configure a target for load balancing.
				424	#
				425	# Instance groups can either be managed or unmanaged.
				426	#
				427	# To create managed instance groups, use the instanceGroupManager or regionInstanceGroupManager resource instead.
				428	#
				429	# Use zonal unmanaged instance groups if you need to apply load balancing to groups of heterogeneous instances or if you need to manage the instances yourself. You cannot create regional unmanaged instance groups.
				430	#
				431	# For more information, read Instance groups.
				432	#
				433	# (== resource_for {$api_version}.instanceGroups ==) (== resource_for {$api_version}.regionInstanceGroups ==)
				434	"creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance group in RFC3339 text format.
				435	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				436	"fingerprint": "A String", # [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.
				437	"id": "A String", # [Output Only] A unique identifier for this instance group, generated by the server.
				438	"kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups.
				439	"name": "A String", # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.
				440	"namedPorts": [ # Assigns a name to a port number. For example: {name: "http", port: 80}
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	441	#
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	442	# This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "http", port: 80},{name: "http", port: 8080}]
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	443	#
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	444	# Named ports apply to all instances in this instance group.
				445	{ # The named port. For example: .
				446	"name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
				447	"port": 42, # The port number, which can be a value between 1 and 65535.
				448	},
				449	],
				450	"network": "A String", # [Output Only] The URL of the network to which all instances in the instance group belong. If your instance has multiple network interfaces, then the network and subnetwork fields only refer to the network and subnet used by your primary interface (nic0).
				451	"region": "A String", # [Output Only] The URL of the region where the instance group is located (for regional resources).
				452	"selfLink": "A String", # [Output Only] The URL for this instance group. The server generates this URL.
				453	"size": 42, # [Output Only] The total number of instances in the instance group.
				454	"subnetwork": "A String", # [Output Only] The URL of the subnetwork to which all instances in the instance group belong. If your instance has multiple network interfaces, then the network and subnetwork fields only refer to the network and subnet used by your primary interface (nic0).
				455	"zone": "A String", # [Output Only] The URL of the zone where the instance group is located (for zonal resources).
				456	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	457	</div>
				458
				459	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	460	<code class="details" id="insert">insert(project, zone, body=None, requestId=None)</code>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	461	<pre>Creates an instance group in the specified project using the parameters that are included in the request.
				462
				463	Args:
				464	project: string, Project ID for this request. (required)
				465	zone: string, The name of the zone where you want to create the instance group. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	466	body: object, The request body.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	467	The object takes the form of:
				468
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	469	{ # Represents an Instance Group resource.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	470	#
				471	# Instance Groups can be used to configure a target for load balancing.
				472	#
				473	# Instance groups can either be managed or unmanaged.
				474	#
				475	# To create managed instance groups, use the instanceGroupManager or regionInstanceGroupManager resource instead.
				476	#
				477	# Use zonal unmanaged instance groups if you need to apply load balancing to groups of heterogeneous instances or if you need to manage the instances yourself. You cannot create regional unmanaged instance groups.
				478	#
				479	# For more information, read Instance groups.
				480	#
				481	# (== resource_for {$api_version}.instanceGroups ==) (== resource_for {$api_version}.regionInstanceGroups ==)
				482	"creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance group in RFC3339 text format.
				483	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				484	"fingerprint": "A String", # [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.
				485	"id": "A String", # [Output Only] A unique identifier for this instance group, generated by the server.
				486	"kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups.
				487	"name": "A String", # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.
				488	"namedPorts": [ # Assigns a name to a port number. For example: {name: "http", port: 80}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	489	#
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	490	# This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "http", port: 80},{name: "http", port: 8080}]
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	491	#
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	492	# Named ports apply to all instances in this instance group.
				493	{ # The named port. For example: .
				494	"name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
				495	"port": 42, # The port number, which can be a value between 1 and 65535.
				496	},
				497	],
				498	"network": "A String", # [Output Only] The URL of the network to which all instances in the instance group belong. If your instance has multiple network interfaces, then the network and subnetwork fields only refer to the network and subnet used by your primary interface (nic0).
				499	"region": "A String", # [Output Only] The URL of the region where the instance group is located (for regional resources).
				500	"selfLink": "A String", # [Output Only] The URL for this instance group. The server generates this URL.
				501	"size": 42, # [Output Only] The total number of instances in the instance group.
				502	"subnetwork": "A String", # [Output Only] The URL of the subnetwork to which all instances in the instance group belong. If your instance has multiple network interfaces, then the network and subnetwork fields only refer to the network and subnet used by your primary interface (nic0).
				503	"zone": "A String", # [Output Only] The URL of the zone where the instance group is located (for zonal resources).
				504	}
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	505
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	506	requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
				507
				508	For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
				509
				510	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	511
				512	Returns:
				513	An object of the form:
				514
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	515	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	516	#
				517	# Google Compute Engine has three Operation resources:
				518	#
				519	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				520	#
				521	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				522	#
				523	# Operations can be global, regional or zonal.
				524	# - For global operations, use the `globalOperations` resource.
				525	# - For regional operations, use the `regionOperations` resource.
				526	# - For zonal operations, use the `zonalOperations` resource.
				527	#
				528	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				529	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				530	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				531	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				532	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				533	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				534	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	535	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	536	"code": "A String", # [Output Only] The error type identifier for this error.
				537	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				538	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	539	},
				540	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	541	},
				542	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				543	"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.
				544	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				545	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				546	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				547	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame^]	548	"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	549	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				550	"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.
				551	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				552	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				553	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				554	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				555	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				556	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				557	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
				558	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				559	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				560	{
				561	"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.
				562	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				563	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				564	{
				565	"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).
				566	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				567	},
				568	],
				569	"message": "A String", # [Output Only] A human-readable description of the warning code.
				570	},
				571	],
				572	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				573	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	574	</div>
				575
				576	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	577	<code class="details" id="list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>
				578	<pre>Retrieves the list of zonal instance group resources contained within the specified zone.
				579
				580	For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	581
				582	Args:
				583	project: string, Project ID for this request. (required)
				584	zone: string, The name of the zone where the instance group is located. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	585	filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	586
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	587	For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	588
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	589	You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	590
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	591	To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```
				592	maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
				593	orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
				594
				595	You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
				596
				597	Currently, only sorting by `name` or `creationTimestamp desc` is supported.
				598	pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame^]	599	returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	600
				601	Returns:
				602	An object of the form:
				603
				604	{ # A list of InstanceGroup resources.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	605	"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
				606	"items": [ # A list of InstanceGroup resources.
				607	{ # Represents an Instance Group resource.
				608	#
				609	# Instance Groups can be used to configure a target for load balancing.
				610	#
				611	# Instance groups can either be managed or unmanaged.
				612	#
				613	# To create managed instance groups, use the instanceGroupManager or regionInstanceGroupManager resource instead.
				614	#
				615	# Use zonal unmanaged instance groups if you need to apply load balancing to groups of heterogeneous instances or if you need to manage the instances yourself. You cannot create regional unmanaged instance groups.
				616	#
				617	# For more information, read Instance groups.
				618	#
				619	# (== resource_for {$api_version}.instanceGroups ==) (== resource_for {$api_version}.regionInstanceGroups ==)
				620	"creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance group in RFC3339 text format.
				621	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				622	"fingerprint": "A String", # [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.
				623	"id": "A String", # [Output Only] A unique identifier for this instance group, generated by the server.
				624	"kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups.
				625	"name": "A String", # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.
				626	"namedPorts": [ # Assigns a name to a port number. For example: {name: "http", port: 80}
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	627	#
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	628	# This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "http", port: 80},{name: "http", port: 8080}]
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	629	#
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	630	# Named ports apply to all instances in this instance group.
				631	{ # The named port. For example: .
				632	"name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
				633	"port": 42, # The port number, which can be a value between 1 and 65535.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	634	},
				635	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	636	"network": "A String", # [Output Only] The URL of the network to which all instances in the instance group belong. If your instance has multiple network interfaces, then the network and subnetwork fields only refer to the network and subnet used by your primary interface (nic0).
				637	"region": "A String", # [Output Only] The URL of the region where the instance group is located (for regional resources).
				638	"selfLink": "A String", # [Output Only] The URL for this instance group. The server generates this URL.
				639	"size": 42, # [Output Only] The total number of instances in the instance group.
				640	"subnetwork": "A String", # [Output Only] The URL of the subnetwork to which all instances in the instance group belong. If your instance has multiple network interfaces, then the network and subnetwork fields only refer to the network and subnet used by your primary interface (nic0).
				641	"zone": "A String", # [Output Only] The URL of the zone where the instance group is located (for zonal resources).
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	642	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	643	],
				644	"kind": "compute#instanceGroupList", # [Output Only] The resource type, which is always compute#instanceGroupList for instance group lists.
				645	"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.
				646	"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
				647	"warning": { # [Output Only] Informational warning message.
				648	"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.
				649	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				650	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				651	{
				652	"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).
				653	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				654	},
				655	],
				656	"message": "A String", # [Output Only] A human-readable description of the warning code.
				657	},
				658	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	659	</div>
				660
				661	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	662	<code class="details" id="listInstances">listInstances(project, zone, instanceGroup, body=None, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	663	<pre>Lists the instances in the specified instance group. The orderBy query parameter is not supported.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	664
				665	Args:
				666	project: string, Project ID for this request. (required)
				667	zone: string, The name of the zone where the instance group is located. (required)
				668	instanceGroup: string, The name of the instance group from which you want to generate a list of included instances. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	669	body: object, The request body.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	670	The object takes the form of:
				671
				672	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	673	"instanceState": "A String", # A filter for the state of the instances in the instance group. Valid options are ALL or RUNNING. If you do not specify this parameter the list includes all instances regardless of their state.
				674	}
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	675
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	676	filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	677
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	678	For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	679
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	680	You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	681
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	682	To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```
				683	maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
				684	orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
				685
				686	You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
				687
				688	Currently, only sorting by `name` or `creationTimestamp desc` is supported.
				689	pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame^]	690	returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	691
				692	Returns:
				693	An object of the form:
				694
				695	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	696	"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
				697	"items": [ # A list of InstanceWithNamedPorts resources.
				698	{
				699	"instance": "A String", # [Output Only] The URL of the instance.
				700	"namedPorts": [ # [Output Only] The named ports that belong to this instance group.
				701	{ # The named port. For example: .
				702	"name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
				703	"port": 42, # The port number, which can be a value between 1 and 65535.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	704	},
				705	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	706	"status": "A String", # [Output Only] The status of the instance.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	707	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	708	],
				709	"kind": "compute#instanceGroupsListInstances", # [Output Only] The resource type, which is always compute#instanceGroupsListInstances for the list of instances in the specified instance group.
				710	"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.
				711	"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
				712	"warning": { # [Output Only] Informational warning message.
				713	"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.
				714	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				715	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				716	{
				717	"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).
				718	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				719	},
				720	],
				721	"message": "A String", # [Output Only] A human-readable description of the warning code.
				722	},
				723	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	724	</div>
				725
				726	<div class="method">
				727	<code class="details" id="listInstances_next">listInstances_next(previous_request, previous_response)</code>
				728	<pre>Retrieves the next page of results.
				729
				730	Args:
				731	previous_request: The request for the previous page. (required)
				732	previous_response: The response from the request for the previous page. (required)
				733
				734	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	735	A request object that you can call 'execute()' on to request the next
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	736	page. Returns None if there are no more items in the collection.
				737	</pre>
				738	</div>
				739
				740	<div class="method">
				741	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				742	<pre>Retrieves the next page of results.
				743
				744	Args:
				745	previous_request: The request for the previous page. (required)
				746	previous_response: The response from the request for the previous page. (required)
				747
				748	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	749	A request object that you can call 'execute()' on to request the next
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	750	page. Returns None if there are no more items in the collection.
				751	</pre>
				752	</div>
				753
				754	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	755	<code class="details" id="removeInstances">removeInstances(project, zone, instanceGroup, body=None, requestId=None)</code>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	756	<pre>Removes one or more instances from the specified instance group, but does not delete those instances.
				757
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	758	If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration before the VM instance is removed or deleted.
				759
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	760	Args:
				761	project: string, Project ID for this request. (required)
				762	zone: string, The name of the zone where the instance group is located. (required)
				763	instanceGroup: string, The name of the instance group where the specified instances will be removed. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	764	body: object, The request body.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	765	The object takes the form of:
				766
				767	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	768	"instances": [ # The list of instances to remove from the instance group.
				769	{
				770	"instance": "A String", # The URL for a specific instance.
				771	},
				772	],
				773	}
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	774
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	775	requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
				776
				777	For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
				778
				779	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	780
				781	Returns:
				782	An object of the form:
				783
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	784	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	785	#
				786	# Google Compute Engine has three Operation resources:
				787	#
				788	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				789	#
				790	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				791	#
				792	# Operations can be global, regional or zonal.
				793	# - For global operations, use the `globalOperations` resource.
				794	# - For regional operations, use the `regionOperations` resource.
				795	# - For zonal operations, use the `zonalOperations` resource.
				796	#
				797	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				798	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				799	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				800	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				801	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				802	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				803	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	804	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	805	"code": "A String", # [Output Only] The error type identifier for this error.
				806	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				807	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	808	},
				809	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	810	},
				811	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				812	"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.
				813	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				814	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				815	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				816	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame^]	817	"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	818	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				819	"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.
				820	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				821	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				822	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				823	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				824	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				825	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				826	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
				827	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				828	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				829	{
				830	"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.
				831	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				832	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				833	{
				834	"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).
				835	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				836	},
				837	],
				838	"message": "A String", # [Output Only] A human-readable description of the warning code.
				839	},
				840	],
				841	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				842	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	843	</div>
				844
				845	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	846	<code class="details" id="setNamedPorts">setNamedPorts(project, zone, instanceGroup, body=None, requestId=None)</code>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	847	<pre>Sets the named ports for the specified instance group.
				848
				849	Args:
				850	project: string, Project ID for this request. (required)
				851	zone: string, The name of the zone where the instance group is located. (required)
				852	instanceGroup: string, The name of the instance group where the named ports are updated. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	853	body: object, The request body.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	854	The object takes the form of:
				855
				856	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	857	"fingerprint": "A String", # The fingerprint of the named ports information for this instance group. Use this optional property to prevent conflicts when multiple users change the named ports settings concurrently. Obtain the fingerprint with the instanceGroups.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request. A request with an incorrect fingerprint will fail with error 412 conditionNotMet.
				858	"namedPorts": [ # The list of named ports to set for this instance group.
				859	{ # The named port. For example: .
				860	"name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.
				861	"port": 42, # The port number, which can be a value between 1 and 65535.
				862	},
				863	],
				864	}
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	865
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	866	requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
				867
				868	For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
				869
				870	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	871
				872	Returns:
				873	An object of the form:
				874
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	875	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	876	#
				877	# Google Compute Engine has three Operation resources:
				878	#
				879	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				880	#
				881	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				882	#
				883	# Operations can be global, regional or zonal.
				884	# - For global operations, use the `globalOperations` resource.
				885	# - For regional operations, use the `regionOperations` resource.
				886	# - For zonal operations, use the `zonalOperations` resource.
				887	#
				888	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				889	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				890	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				891	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				892	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				893	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				894	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	895	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	896	"code": "A String", # [Output Only] The error type identifier for this error.
				897	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				898	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	899	},
				900	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	901	},
				902	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				903	"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.
				904	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				905	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				906	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				907	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame^]	908	"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	909	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				910	"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.
				911	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				912	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				913	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				914	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				915	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				916	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				917	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
				918	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				919	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				920	{
				921	"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.
				922	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				923	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				924	{
				925	"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).
				926	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				927	},
				928	],
				929	"message": "A String", # [Output Only] A human-readable description of the warning code.
				930	},
				931	],
				932	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				933	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	934	</div>
				935
				936	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	937	<code class="details" id="testIamPermissions">testIamPermissions(project, zone, resource, body=None)</code>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	938	<pre>Returns permissions that a caller has on the specified resource.
				939
				940	Args:
				941	project: string, Project ID for this request. (required)
				942	zone: string, The name of the zone for this request. (required)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	943	resource: string, Name or id of the resource for this request. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	944	body: object, The request body.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	945	The object takes the form of:
				946
				947	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	948	"permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '' or 'storage.') are not allowed.
				949	"A String",
				950	],
				951	}
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	952
				953
				954	Returns:
				955	An object of the form:
				956
				957	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	958	"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
				959	"A String",
				960	],
				961	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	962	</div>
				963
				964	</body></html>